How-to guides

Users can create the service by entering the required information for Vertica (DBaaS) and selecting detailed options through the Samsung Cloud Platform Console.

Vertica(DBaaS) Create

You can create and use the Vertica (DBaaS) service from the Samsung Cloud Platform Console.

Follow these steps to create Vertica(DBaaS).

1. All Services > Data Analytics > Vertica(DBaaS) Click the menu. 1. Go to the Service Home page of Vertica(DBaaS).

2. On the Service Home page, click the Create Vertica (DBaaS) button. 2. Go to the Create page.

3. Vertica(DBaaS) Creation page: enter the information required to create the service and select detailed options.

   • Image and Version Selection area, select the required information.

     Category	required status	Detailed description
     Image version	Required	Provide a list of Vertica (DBaaS) versions

     Table. Vertica(DBaaS) image and version input items
   • Enter or select the required information in the Service Information Input area.

     Category	Required status	Detailed description
     Server name Prefix	Essential	The server name where Vertica will be installed must start with a lowercase English letter, and using lowercase letters, numbers, and special characters (-) be entered with 3 ~ 13 characters Based on the server name, a postfix such as 001, 002 is appended to create the actual server name
     Cluster name	Required	Cluster name composed of servers Enter using English letters, 3 ~ 20 characters A cluster is a unit that groups multiple servers
     Number of nodes	Required	Number of data nodes Enter the number of nodes within the range of 1-10 If you configure the cluster by entering a Node count of 2 or more, you achieve high availability (High Availability)
     Service Type > Server Type	Required	Data node server type Standard: Standard specification commonly used High Capacity: Large-capacity server with 24 vCores or more For detailed information about the server types provided by Vertica (DBaaS), refer to Vertica(DBaaS) 서버 타입
     Service Type > Planned Compute	Selection	Status of resources with Planned Compute configured In Use: Number of resources with Planned Compute configured that are currently in use Configured: Number of resources with Planned Compute configured Coverage Preview: Amount applied per resource by Planned Compute Apply for Planned Compute Service: Go to the Planned Compute service application page For more details, refer to Planned Compute 신청하기
     Service Type > Block Storage	Required	Block Storage type to be used for data nodes Base OS: Area where the engine is installed DATA: Data file storage area After selecting the storage type, enter the capacity (see Block Storage 생성하기 for details on each Block Storage type) SSD: Standard Block Storage SSD_KMS: Additional encrypted volume using KMS (Key Management System) encryption keys The configured storage type is applied identically to additional storage Capacity must be entered as a multiple of 8 within the range 16 to 5,120 Add: DATA, Backup data storage area After selecting Use, enter the storage purpose and capacity To add storage, click the Add button; to delete, click the x button. Up to 9 can be added Capacity can be entered as a multiple of 8 within the range 16 to 5,120, and up to 9 can be created
     Management Console	selection	If you select Use, you can configure the Node’s server type and Block Storage for cluster management and monitoring.
     Management Console > Server Type	Required	Selecting a data node server type for cluster management and monitoring
     Management Console > Block Storage	Required	Select the Block Storage type to be used for data nodes for cluster management and monitoring
     Network > Common Settings	Required	Network settings where servers generated by the service are installed Select when you want to apply the same settings to all installed servers Select a pre‑created VPC and Subnet Each server’s IP is generated automatically Public NAT setting is only available in per‑server settings
     Network > Server-specific Settings	Required	Network settings where servers generated by the service are installed Select when you want to apply different settings for each installed server Select a pre‑created VPC and Subnet IP: Enter the IP for each server Public NAT feature is available only when the VPC is connected to an Internet Gateway, if you check use, you can select a reserved IP from the VPC product’s Public IP pool. For more details, refer to Public IP 생성하기
     IP access control	Selection	Service Access Policy Configuration Since the access policy is set for the IP entered on the page, you do not need to configure a separate Security Group policy Enter in IP format (example: 192.168.10.1) or CIDR format (example: 192.168.10.0/24, 192.168.10.1/32) and click the Add button To delete an entered IP, click the x button next to the entered IP
     Maintenance period	Selection	DB maintenance window If you select Use, you can set the day, start time, and duration The maintenance window is a feature that lets the user define the time slot for patch operations, and any patch work within that period must be performed directly by the user. We ask you to set a maintenance window for the stable operation of the system, and we are not responsible for any issues arising from not setting it or from failure to perform tasks within the window.

     Table. Vertica(DBaaS) Service Configuration Items
   • Enter required database configuration information In this area, enter or select the required information.

     	Required status	Detailed description
     Database name	Required	Server name applied during DB installation must start with an English letter and be entered using English letters and numbers, 3 to 20 characters long
     Database username	Required	DB user name An account with the same name is also created on the OS Enter using lowercase English letters, 2 to 20 characters Restricted database user names can be viewed in the Console
     Database password	Required	Password to use when accessing the DB Include letters, numbers, and special characters (“ ‘ excluded) and enter 8 to 30 characters
     Check database password	Required	Re-enter the same password to use for DB access
     Database Port number	Required	Port number required for DB connection Enter the DB port within the range 1200 ~ 65535
     Backup > Use	Selection	Node backup usage Use to select node backup retention period and backup start time
     Backup > Retention period	selection	Backup retention period Select the backup retention period. Set the file retention period from 7 days to 35 days Backup files incur additional charges based on size
     Backup > Backup Start Time	Selection	Backup start time Select backup start time The minutes when the backup runs (minutes) are set randomly, and the backup end time cannot be set
     ServiceWatch log collection	Selection	ServiceWatch log collection status Select Use to configure the ServiceWatch log collection feature It is provided free of charge up to 5 GB for all services within the Account, and charges apply based on storage size for usage exceeding 5 GB. When collected, log groups and log streams are created automatically, and they cannot be deleted until the resources are removed. To prevent exceeding 5 GB, it is recommended to delete log data directly or shorten the retention period.
     License Key	Required	Enter the Vertica License Key owned by the customer If the entered license key is invalid, service creation is not possible
     DB Locale	Required	Settings related to string handling, numeric/currency/date/time display formats, etc., to be used in Vertica (DBaaS) The database is created with default settings based on the selected locale
     Time zone	Required	Standard time zone to use with Vertica (DBaaS)

     Table. Vertica (DBaaS) required configuration items
   • In the Additional Information Input area, enter or select the required information.

     	Required	Detailed description
     tag	Selection	Add Tag Up to 50 per resource can be added After clicking the Add Tag button, enter or select Key, Value values

     Table. Vertica (DBaaS) additional information input fields

4. Summary Review the detailed information and estimated charges generated in the panel, then click the Create button.

   • When creation is complete, check the created resource on the Resource List page.

Vertica(DBaaS) Check detailed information

The Vertica (DBaaS) service allows you to view and edit the full list of resources and detailed information. The Vertica(DBaaS) Details page consists of Details, Tags, Job History tabs.

Follow the steps below to view detailed information about the Vertica (DBaaS) service.

1. Click the All Services > Data Analytics > Vertica(DBaaS) menu. 1. Go to the Service Home page of Vertica(DBaaS).
2. On the Service Home page, click the Vertica(DBaaS) menu. 2. Vertica(DBaaS) List Go to the page.
3. Vertica(DBaaS) List Click the resource on the page to view detailed information. 3. Navigate to the Vertica(DBaaS) Details page.
   • Vertica(DBaaS) Details At the top of the page, status information and additional feature information are displayed.

     Detailed description

     The cluster is currently in a stopped state. It will be automatically started when a new job is submitted. If you want to start it manually, click the Start button. If you want to stop it, click the Stop button. If you want to delete the cluster, click the Delete button. If you want to edit the cluster, click the Edit button. If you want to view the cluster details, click the Details button. If you want to view the cluster logs, click the Logs button. If you want to view the cluster metrics, click the Metrics button. If you want to view the cluster configuration, click the Configuration button. If you want to view the cluster status, click the Status button. If you want to view the cluster health, click the Health button. If you want to view the cluster usage, click the Usage button. If you want to view the cluster cost, click the Cost button. If you want to view the cluster billing, click the Billing button. If you want to view the cluster usage history, click the Usage History button. If you want to view the cluster cost history, click the Cost History button. If you want to view the cluster billing history, click the Billing History button. If you want to view the cluster usage summary, click the Usage Summary button. If you want to view the cluster cost summary, click the Cost Summary button. If you want to view the cluster billing summary, click the Billing Summary button. If you want to view the cluster usage details, click the Usage Details button. If you want

     ---

     title: “Cluster Management” date: 2023-01-01 tags: [“cluster”, “management”]

     cluster:
       name: "my-cluster"
       status: "stopped"
       nodes: 3
       type: "m5.large"
     

     def start_cluster():
         # code to start the cluster
         pass
     ``` | Cluster status: **Creating**: Creating the cluster<ul><li>**Error**: Error occurred while creating the cluster</li></ul>If it persists, contact the administrator<ul><li></li></ul><ul><li>**Failed**: Failed during cluster creation<ul><li></li></ul>**Restarting**: Restarting the cluster</li></ul><ul><li>**Running**: Cluster is running normally</li></ul><ul><li>**Starting**: Starting the cluster</li></ul><ul><li>**Stopped**: Cluster is stopped</li></ul><ul><li>**Stopping**: Stopping the cluster</li></ul><ul><li>**Synchronizing**: Synchronizing the cluster</li></ul><ul><li>**Terminating**: Terminating the cluster</li></ul><ul><li>**Unknown**: Unknown cluster status</li></ul>If it persists, contact the administrator<ul><li></li></ul><ul><li>**Upgrading**: Upgrading the cluster<ul><li></li> |
     | Cluster control | Buttons to change the cluster state<ul><li>**Start**: Start a stopped cluster</li></ul><ul><li>**Stop**: Stop a running cluster</li></ul><ul><li>**Restart**: Restart a running cluster</li></ul> |
     | View more features | Cluster management buttons<ul><li>**Service status synchronization**: Real-time DB service status lookup</li></ul><ul><li>**Backup history**: When backup is configured, check whether the backup runs correctly and view its history</li></ul><ul><li>**Database recovery**: Recover the DB based on a specific point in time</li></ul> |
     | Service cancellation | Button to cancel the service |
     <div class="figure-caption">
       Table. Vertica (DBaaS) status information and additional features
     </div>
     
       
     

Detailed Information

Vertica(DBaaS) List page lets you view detailed information of the selected resource and, if needed, modify the information.

tag

Vertica(DBaaS) List page lets you view the tag information of the selected resource, and add, modify, or delete it.

Job History

On the Vertica(DBaaS) List page, you can view the operation history of the selected resource.

Vertica(DBaaS) Managing Resources

If you need to change the existing configuration options of a created Vertica(DBaaS) resource or add storage, you can perform the task on the Vertica(DBaaS) Details page.

Operation Control

If changes occur to a running Vertica (DBaaS) resource, you can start, stop, or restart it.

To control the operation of Vertica (DBaaS), follow the steps below.

1. All Services > Data Analytics > Vertica(DBaaS) Click the menu. 1. Go to the Vertica(DBaaS) Service Home page.
2. On the Service Home page, click the Vertica(DBaaS) menu. 2. Vertica(DBaaS) List Navigate to the page.
3. Vertica(DBaaS) List On the page, click the resource you want to control. 3. Vertica(DBaaS) Details Navigate to the page.
4. Check the Vertica (DBaaS) status and complete the change using the control button below.
   • Start: Vertica(DBaaS) service is installed on the server and the Vertica(DBaaS) service is running (Running).
   • Stop: The server on which the Vertica (DBaaS) service is installed and the Vertica (DBaaS) service will be stopped (Stopped).
   • Restart: Only the Vertica(DBaaS) service will be restarted.

Synchronize service status

You can synchronize the real-time service status of Vertica (DBaaS).

To check the service status of Vertica (DBaaS), follow these steps.

1. All Services > Data Analytics > Vertica(DBaaS) Click the menu. 1. Go to the Service Home page of Vertica(DBaaS).
2. On the Service Home page, click the Vertica(DBaaS) menu. 2. Vertica(DBaaS) List Navigate to the page.
3. Vertica(DBaaS) List Click the resource on the page to view the service status. 3. Navigate to the Vertica(DBaaS) Details page.
4. Service status synchronization Click the button. 4. While it is being queried, the cluster changes to Synchronizing state.
5. Once the query is complete, the status in the server information item is updated, and the cluster changes to Running state.

Change Server Type

You can change the configured server type.

To change the server type, follow these steps.

1. All Services > Data Analytics > Vertica(DBaaS) Click the menu. 1. Go to the Service Home page of Vertica(DBaaS).
2. On the Service Home page, click the Vertica(DBaaS) menu. 2. Vertica(DBaaS) List Go to the page.
3. Vertica(DBaaS) List On the page, click the resource to change the server type. 3. Vertica(DBaaS) Details Navigate to the page.
4. Click the Edit icon of the server type you want to change at the bottom of the detailed information. 4. Edit Server Type The popup window opens.
5. Edit Server Type After selecting the server type in the popup window, click the Confirm button.

Add storage

If you need more than 5 TB of data storage, you can add additional storage. In a high‑availability configuration (HA cluster), expanding or adding storage capacity is applied simultaneously to all databases.

To add storage, follow these steps.

1. All Services > Data Analytics > Vertica(DBaaS) Click the menu. 1. Navigate to the Service Home page of Vertica (DBaaS).
2. On the Service Home page, click the Vertica(DBaaS) menu. 2. Vertica(DBaaS) List Navigate to the page.
3. Vertica(DBaaS) List On the page, click the resource to add storage. 3. Vertica(DBaaS) Details Go to the page.
4. Click the Add Disk button at the bottom of the detailed information. 4. Additional Storage Request The popup window opens.
5. Additional Storage Request In the popup window, after entering the purpose and capacity, click the Confirm button.

Expanding Storage

Storage added to the data area can be expanded up to a maximum of 5 TB based on the initially allocated capacity. You can expand storage without stopping Vertica (DBaaS), and if it is configured as a cluster, all nodes are expanded simultaneously.

To increase storage capacity, follow the steps below.

1. All Services > Data Analytics > Vertica(DBaaS) Click the menu. 1. Navigate to the Service Home page of Vertica (DBaaS).
2. On the Service Home page, click the Vertica(DBaaS) menu. 2. Vertica(DBaaS) List Navigate to the page.
3. On the Vertica(DBaaS) List page, click the resource to change the server type. 3. Vertica(DBaaS) Details Navigate to the page.
4. Click the Edit button for the additional Disk you want to add at the bottom of the detailed information. 4. Edit Additional Storage popup opens.
5. Edit Additional Storage After entering the expansion capacity in the popup window, click the Confirm button.

Changing the Recovery DB instance type

After DB recovery is complete, you can change the instance type on the Recovery details screen.

To change the Recovery DB instance type, follow these steps.

1. All Services > Data Analytics > Vertica(DBaaS) menu, click it. 1. Navigate to the Service Home page of Vertica (DBaaS).
2. On the Service Home page, click the Vertica(DBaaS) menu. 2. Vertica(DBaaS) List Go to the page.
3. On the Vertica(DBaaS) List page, click the resource to change the Recovery DB instance type. 3. Vertica(DBaaS) Details Go to the page.
4. Click the Change Instance Type button. 4. Change Instance Type A confirmation dialog will appear.

• The DB instance type is changed from Recovery to Active to perform the same function as a single DB.

Vertica(DBaaS) Terminate

You can cancel the unused Vertica (DBaaS) to reduce operating costs. However, if you terminate the service, the running service may be discontinued immediately, so you should proceed with the termination only after fully considering the impact of the service interruption.

To cancel Vertica(DBaaS), follow the steps below.

1. All Services > Data Analytics > Vertica(DBaaS) Click the menu. 1. Navigate to the Service Home page of Vertica (DBaaS).
2. On the Service Home page, click the Vertica(DBaaS) menu. 2. Vertica(DBaaS) List Navigate to the page.
3. On the Vertica(DBaaS) List page, select the resource to cancel, and click the Cancel Service button.
4. When the termination is complete, check on the Vertica(DBaaS) list page whether the resource has been terminated.