Data Analytics

• 1: Event Streams
• 1.1: Overview
• 1.1.1: Server Type
• 1.1.2: Monitoring Metrics
• 1.1.3: ServiceWatch Metrics
• 1.2: How-to guides
• 1.3: API Reference
• 1.4: CLI Reference
• 1.5: Release Note
• 2: Search Engine
• 2.1: Overview
• 2.1.1: Server Type
• 2.1.2: Monitoring metrics
• 2.2: How-to guides
• 2.3: API Reference
• 2.4: CLI Reference
• 2.5: Release Note
• 3: Vertica(DBaaS)
• 3.1: Overview
• 3.1.1: Server Type
• 3.1.2: Monitoring metrics
• 3.2: How-to guides
• 3.2.1: Backing up and restoring Vertica
• 3.3: API Reference
• 3.4: CLI Reference
• 3.5: Release Note
• 4: Data Flow
• 4.1: Overview
• 4.1.1: ServiceWatch metric
• 4.2: How-to guides
• 4.2.1: Data Flow Services
• 4.2.2: Install Ingress Controller
• 4.3: API Reference
• 4.4: CLI Reference
• 4.5: Release Note
• 5: Data Ops
• 5.1: Overview
• 5.1.1: ServiceWatch metric
• 5.2: How-to guides
• 5.2.1: Data Ops Services
• 5.2.2: Installing Ingress Controller
• 5.3: API Reference
• 5.4: CLI Reference
• 5.5: Release Note
• 6: Quick Query
• 6.1: Overview
• 6.1.1: ServiceWatch metric
• 6.2: How-to guides
• 6.3: API Reference
• 6.4: CLI Reference
• 6.5: Release Note
• 7: Cloud Hadoop
• 7.1: Overview
• 7.1.1: ServiceWatch metric
• 7.2: How-to guides
• 7.3: API Reference
• 7.4: Release Note

1 - Event Streams

1.1 - Overview

Service Overview

Event Streams provides fully managed creation and configuration of the open-source Apache Kafka for large-scale, high-volume message data processing. Samsung Cloud Platform automates the creation and configuration of Apache Kafka through a web-based console, allowing users to configure the main components of Apache Kafka—Broker, Zookeeper, and AKHQ—in either a single or clustered setup.

The Event Streams cluster consists of multiple Broker nodes; you can install between 1 and 10 Brokers, typically deploying three or more. Zookeeper can be installed separately to manage the distributed Brokers, but if not installed separately, it is installed on the Broker nodes. Additionally, we provide AKHQ (Apache Kafka HQ), a tool for managing Kafka, allowing users to perform cluster operation and management through it.

Provided features

Event Streams provides the following features.

• Auto Provisioning: You can configure and set up an Apache Kafka cluster via the UI.
• Operation Control Management: Provides functionality to control the status of running servers. In addition to starting and stopping the cluster, restarting is possible to apply configuration changes.
• AKHQ provision: We provide AKHQ, a tool for managing Kafka, enabling users to manage and monitor clusters.
• Add Broker node: If expansion is required to improve cluster performance and stability, you can add a node with the same specifications as the existing Broker nodes.
• Parameter management: You can configure and modify parameters related to performance improvement and security.
• Monitoring: CPU, memory, performance monitoring information can be accessed via Cloud Monitoring and Servicewatch.

Component

Event Streams provides pre‑validated engine versions and various server types in accordance with its open‑source support policy. Users can select and use them based on the scale of the service they wish to configure.

Engine version

The engine versions supported by Event Streams are as follows.

Technical support can be used until the supplier’s EoTS (End of Technical Service) date, and the EOS date when new creation is stopped is set to six months before the EoTS date.

The EOS and EoTS dates may change according to the supplier’s policy, so please refer to the supplier’s license management policy page for details.

• Apache Kafka: https://docs.confluent.io/platform/current/installation/versions-interoperability.html

Server Type

The server types supported by Event Streams are as follows.

For detailed information about the server types provided by Event Streams, refer to Event Streams Server Types.

Standard ess1v2m4

Preliminary Service

This is a list of services that must be pre-configured before creating the service. Please refer to the guide provided for each service and prepare in advance.

1.1.1 - Server Type

Event Streams server type

Event Streams provides server types composed of various combinations such as CPU, Memory, and Network Bandwidth. When creating Event Streams, Apache kafka is installed according to the server type selected for the intended purpose.

The server types supported by Event Streams are as follows.

Standard ess1v2m4

ess1 server type

The ess1 server type of Event Streams is offered with standard specifications (vCPU, Memory) and is suitable for various database workloads.

• Intel 3rd‑generation (Ice Lake) Xeon Gold 6342 Processor up to 3.3 GHz
• Supports up to 16 vCPUs and 64 GB of memory
• Maximum networking speed of 12.5 Gbps

ess2 server type

The ess2 server type of Event Streams is offered with standard specifications (vCPU, Memory) and is suitable for various database workloads.

• Intel 4th‑generation (Sapphire Rapids) Xeon Gold 6448H Processor up to 3.2 GHz
• Supports up to 16 vCPUs and 64 GB of memory
• Maximum networking speed of 12.5 Gbps

esh2 server type

The esh2 server type of Event Streams is offered with high-capacity server specifications and is suitable for database workloads that require large-scale data processing.

• Intel 4th‑generation (Sapphire Rapids) Xeon Gold 6448H Processor up to 3.2 GHz
• Supports up to 32 vCPUs and 128 GB of memory
• Up to 25 Gbps networking speed

1.1.2 - Monitoring Metrics

Event Streams monitoring metrics

The table below shows the performance monitoring metrics for Event Streams that can be viewed through Cloud Monitoring. For detailed Cloud Monitoring usage, see the Cloud Monitoring guide.

For Event Streams server monitoring metrics, refer to the Virtual Server Monitoring Metrics guide.

1.1.3 - ServiceWatch Metrics

Event Streams sends metrics to ServiceWatch. The metrics provided by default monitoring are data collected at 1‑minute intervals.

Basic Metrics

The following are the basic metrics for the Event Streams namespace.

Indicators whose names are shown in bold below are the indicators selected as key metrics among the default metrics provided by Event Streams. Key metrics are used to build service dashboards that are automatically created for each service in ServiceWatch.

Each metric provides guidance in the user guide about which statistical value is meaningful when querying that metric, and among the meaningful statistics, the statistical values displayed in bold text are the primary statistics. In the service dashboard, primary metrics can be viewed using the primary statistical values.

OS Basic Metrics

Event Streams basic metrics

1.2 - How-to guides

Users can create the service by entering the required information for Event Streams and selecting detailed options through the Samsung Cloud Platform Console.

Create Event Streams

You can create and use the Event Streams service in the Samsung Cloud Platform Console.

To create Event Streams, follow these steps.

1. All Services > Data Analytics > Event Streams click the menu. 1. Navigate to the Service Home page of Event Streams.

2. On the Service Home page, click the Create Event Streams button. 2. Go to the Create Event Streams page.

3. Event Streams creation page, enter the information required to create the service and select detailed options.

   • Select the required information in the Image and version selection area.

     Category	required status	Detailed description
     Image version	Required	Provide a list of Event Streams versions

     Table. Event Streams service information input items
   • In the Service Information Input area, enter or select the required information.

     Category	required status	Detailed description
     Server name Prefix	Required	The server name where Apache Kafka will be installed must start with a lowercase English letter and be entered using lowercase letters, numbers, and the special character (-) with a length of 3 to 13 characters A postfix such as 001, 002 is appended to the base server name to generate the actual server name
     Cluster name	Required	Cluster name of the servers Enter using English letters, 3 ~ 20 characters A cluster is a unit that groups multiple servers
     Broker > Number of Broker Nodes	Required	Number of Broker Nodes
     Broker > server type	Required	Server type for installing the Broker Standard: Standard specification commonly used High Capacity: Large-capacity server with 24 vCores or more For detailed information about the server types provided by Event Streams, see Event Streams server types.
     Broker > Planned Compute	Select	Status of resources with Planned Compute configured In Use: Number of resources with Planned Compute 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, see Planned Compute 신청하기
     Broker > Block Storage	Required	Block Storage type to be used for the Broker node Base OS: The area where the engine is installed DATA: Data file storage area Select the storage type and then enter the capacity (for details on each Block Storage type, see Block Storage 생성하기) SSD: High‑performance general volume HDD: General volume SSD_KMS/HDD_KMS: Additional encrypted volume using Samsung Cloud Platform KMS (Key Management System) encryption keys Enter the capacity as a multiple of 8 within the range 16 to 5,120
     Zookeeper separate installation > use	Select	Whether to install Zookeeper nodes separately If you select Use, install Zookeeper nodes separately If Zookeeper nodes are not installed separately, the Broker node also performs the Zookeeper role
     Zookeeper separate installation > server type	Select	Server type on which Zookeeper will be installed Zookeeper nodes provide vCPU 1, Memory 2G or vCPU 2, Memory 4G
     Zookeeper separate installation > Planned Compute	Select	Status of resources with Planned Compute configured In Use: Number of resources with Planned Compute 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, see Planned Compute Apply
     Separate Zookeeper installation > Block Storage	Required	Block Storage type to be used for Zookeeper nodes Default 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: High‑performance general volume HDD: General volume SSD_KMS/HDD_KMS: Additional encrypted volume using Samsung Cloud Platform KMS (Key Management System) encryption keys Enter the capacity as a multiple of 8 within the range 16 to 5,120
     AKHQ > Use	Required	Whether to install AKHQ If you select Use, AKHQ will be installed
     AKHQ > Server Type	Required	Server type on which AKHQ will be installed AKHQ only provides the vCPU 2, Memory 4G type
     AKHQ > Planned Compute	Select	Status of resources with Planned Compute configured In Use: Number of resources with Planned Compute 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, see Planned Compute 신청하기
     AKHQ > Block Storage	Required	Block Storage type to be used on the server where AKHQ is installed Base OS: area where the engine is installed
     AKHQ > AKHQ account	Required	AKHQ account Enter using lowercase English letters, 2 ~ 20 characters
     AKHQ > AKHQ password	Required	AKHQ account password English letters, numbers, and special characters (“ ‘ excluded) including 8 ~ 30 characters
     AKHQ > Verify AKHQ password	Required	Confirm AKHQ account password Re-enter the AKHQ account password identically
     AKHQ > AKHQ Port number	Required	AKHQ connection port number The port number is automatically set to 8080 and cannot be modified
     Network > Common Settings	Required	Network settings for servers created by the service Select when you want to apply the same settings to all installed servers Select a pre‑created VPC and Subnet IP: only automatic generation is possible For Public NAT settings, it is only possible in per‑server configuration
     Network > Server-specific Settings	Required	Network settings where servers generated by the service are installed Select if you want to apply different settings per 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; checking Use allows selection from the reserved IPs in the VPC product’s Public IP pool. For details, see Public IP 생성하기
     IP access control	Select	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 the IP in IP format (e.g., 192.168.10.1) or CIDR format (e.g., 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 IP
     maintenance period	Select	Event Streams maintenance window If you select Use, set the day of week, start time, and duration It is recommended to set a maintenance window for stable service management. Patch operations will be performed at the scheduled time, and service interruption may occur We are not responsible for issues arising from patches not being applied (set as not used)

     Table. Event Streams service configuration items
   • Enter required database configuration information In this area, enter or select the required information.

     Category	required status	Detailed description
     Zookeeper SASL account	Required	Zookeeper account Enter using lowercase English letters, 2 to 20 characters
     Zookeeper SASL password	Required	Zookeeper account password including English letters, numbers, and special characters (“ ‘ excluded) and enter 8 to 30 characters
     Check Zookeeper SASL password	Required	Verify Zookeeper account password Re-enter the Zookeeper SASL account password identically
     Zookeeper Port number	Required	Zookeeper port number 1200 ~ 65535 must be entered as one of them, and the Broker port or 2888, 3888 cannot be used
     Broker SASL account	Required	Kafka login account Enter using lowercase English letters, 2 ~ 20 characters
     Broker SASL password	Required	Kafka login account password Enter 8 to 30 characters, including English letters, numbers, and special characters (excluding “ ‘)
     Verify Broker SASL password	Required	Verify Kafka connection account password Re-enter the Broker SASL account password identically
     Broker Port number	Required	Kafka port number 1200 ~ 65535 can be entered as one of , and the Broker port or 2888, 3888 cannot be used
     Parameter	Required	Event Streams configuration parameters View button can be clicked to view detailed information of the parameters Parameters can be modified after the service creation is complete, and a restart is required when modified
     time zone	Select	Standard time zone for the service
     ServiceWatch log collection	Select	ServiceWatch log collection status Use to configure the ServiceWatch log collection feature For details about the collected logs, refer to ServiceWatch 지표 It is provided free of charge up to 5 GB for all services within the account, and charges apply based on storage usage for amounts exceeding 5 GB When collecting, 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

     Table. Required input items for configuring Event Streams Database
   • In the Additional Information Input area, enter or select the required information.

     Category	required status	Detailed description
     tag	Select	Add Tag Add Tag Click the button to create and add a tag, or add an existing tag You can add up to 50 tags The newly added tags are applied after the service creation is completed

     Table. Event Streams service additional information input fields

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

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

View Event Streams details

The Event Streams service lets you view and modify the complete list of resources and their detailed information. The Event Streams Details page consists of the Details, Tags, Activity Log tabs.

To view detailed information about the Event Streams service, follow these steps.

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

     Category	Detailed description
     Cluster status	Cluster status Creating: The cluster is being created Editing: The cluster is being changed to an operational state Error: The cluster encountered a failure while performing a task If this persists, contact the administrator Failed: The cluster failed during creation Restarting: The cluster is restarting Running: The cluster is operating normally Starting: The cluster is starting Stopped: The cluster is stopped Stopping: The cluster is stopping Synchronizing: The cluster is synchronizing Terminating: The cluster is being terminated Unknown: The cluster status is unknown If this persists, contact the administrator Upgrading: The cluster is being upgraded
     Cluster control	Button to change the cluster state Start: Start a stopped cluster Stop: Stop a running cluster Restart: Restart a running cluster
     See more features	Cluster management buttons Service status synchronization: Retrieve the current server status and synchronize it to the Console Parameter management: View and modify service configuration parameters Add Broker Node: Add a Broker Node When configured as a cluster, the Add Broker Node button is displayed
     Service cancellation	Cancel service button

     Table. Event Streams status information and additional features

Detailed information

Event Streams List page allows you to view detailed information of the selected resource and, if necessary, edit the information.

tag

Event Streams List page lets you view the tag information of the selected resource, and you can add, modify, or delete it.

Work History

On the Event Streams List page, you can view the operation history of the selected resource.

Managing Event Streams Resources

If you need to change the existing configuration options of a created Event Streams resource, manage parameters, or add a Broker Node configuration, you can perform the tasks on the Event Streams Details page.

Control operation

If changes occur to a running Event Streams resource, you can start, stop, or restart it.

To control the operation of Event Streams, follow these steps.

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

Synchronize service status

You can query the current server status and synchronize it to the Console.

To synchronize the service status of Event Streams, follow these steps.

1. All Services > Data Analytics > Event Streams Click the menu. 1. Navigate to the Service Home page of Event Streams.
2. On the Service Home page, click the Event Streams menu. 2. Go to the Event Streams list page.
3. On the Event Streams List page, click the resource to view the service status. 3. Go to the Event Streams Details page.
4. Service Status Sync Click the button. 4. The query takes a short amount of time, and while it is being performed, the cluster changes to the Synchronizing state.
5. When the query completes, the status in the server information field is updated, and the cluster changes to the Running state.

Manage Parameters

Provides parameter lookup and edit functionality.

To view and modify configuration parameters, follow the steps below.

1. Click the All Services > Data Analytics > Event Streams menu. 1. Navigate to the Service Home page of Event Streams.
2. On the Service Home page, click the Event Streams menu. 2. Navigate to the Event Streams list page.
3. On the Event Streams List page, click the resource whose parameters you want to view and edit. 3. Go to the Event Streams Details page.
4. Click the Parameter Management button. 4. Go to the Parameter Management page.
5. On the Parameter Management page, click the Search button. 5. Database query The popup window opens.
6. To view the Parameter information, click the Confirm button. 6. Retrieving may take a short amount of time.
   • You can modify the Parameter information after performing a query.
7. To edit the Parameter information, click the Edit button and then enter the changes in the Custom Value field of the Parameter you want to modify.
   • When the Application Type is Dynamic, it takes effect immediately, and when it is Static, a service restart is required, causing service interruption.
8. When the input is complete, click the Save button.

Change server type

You can change the configured server type.

To change the server type, follow these steps.

1. All Services > Data Analytics > Event Streams Click the menu. 1. Navigate to the Service Home page of Event Streams.
2. On the Service Home page, click the Event Streams menu. 2. Event Streams List navigate to the page.
3. On the Event Streams list page, click the resource whose server type you want to change. 3. Go to the Event Streams Details page.
4. Click the Edit button for the server type you want to change at the bottom of the detailed information. 4. Edit Server Type popup window opens.
5. Server Type Edit After selecting the server type in the popup window, click the Confirm button.

Expand 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 Event Streams, and when configured as a cluster, all nodes are expanded simultaneously.

To increase storage capacity, follow the steps below.

1. All Services > Data Analytics > Event Streams click the menu. 1. Navigate to the Service Home page of Event Streams.
2. On the Service Home page, click the Event Streams menu. 2. Go to the Event Streams list page.
3. On the Event Streams list page, click the resource for which you want to change the server type. 3. Go to the Event Streams Details page.
4. Click the Edit button for the added Disk you want to expand at the bottom of the detailed information. 4. Disk Edit The popup window opens.
5. Disk Edit After entering the expanded capacity in the popup window, click the Confirm button.

Add Broker Node

If you need to expand the Event Streams cluster, you can add nodes with the same specifications as the Broker Node you are using. The added nodes are incorporated into the existing cluster without server downtime, and the existing data is automatically redistributed.

To add a Broker node, follow these steps.

1. All Services > Data Analytics > Event Streams menu, please click. 1. Navigate to the Service Home page of Event Streams.
2. On the Service Home page, click the Event Streams menu. 2. Go to the Event Streams list page.
3. On the Event Streams resource list page, click the resource you want to recover. 3. Navigate to the Event Streams Details page.
4. Click the Add Broker Node button. 4. Go to the Add Broker Node page.
5. After entering the relevant information in the Enter required information area, click the Complete button.

   Category	required status	Detailed description
   Server name	Required	The server name where the Broker is installed It is set to the server name configured in the original cluster.
   Cluster name	Required	Cluster name It is set to the cluster name configured in the original cluster.
   Additional Node Count	Required	Number of Nodes to add Use up to 10 nodes per cluster
   Service Type > Server Type	Required	The server type on which the Broker will be installed is set to be the same as the server type configured in the original cluster.
   Service Type > Planned Compute	Select	Status of resources with Planned Compute configured In Use: Number of resources with Planned Compute 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, see Planned Compute 신청하기
   Service Type > Block Storage	Required	Block Storage settings for the Broker node The storage type and capacity configured in the original cluster are applied identically
   Network	Required	The network on which the servers are installed is applied identically to the network configured in the original cluster

   Table. Additional items for Event Streams Broker Node

Cancel Event Streams

You can cancel unused Event Streams to reduce operating costs. However, if you terminate the service, the running service may be stopped immediately, so you should proceed with the termination only after fully considering the impact that may arise from service interruption.

To cancel Event Streams, follow these steps.

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

1.3 - API Reference

1.4 - CLI Reference

1.5 - Release Note

Event Streams

2 - Search Engine

2.1 - Overview

Service Overview

Search Engine provides automated creation and configuration of the distributed search and analytics engines Elasticsearch and OpenSearch through a web-based console. Users can select a server type that matches the system configuration to set up a cluster, and it supports the data analysis and visualization tools Kibana and the OpenSearch dashboard.

The Search Engine Cluster consists of multiple master nodes and data nodes. Data nodes can be installed from a minimum of one up to a maximum of ten, and are typically deployed with three or more. If a master node is not installed separately, the data nodes also perform the master node role, and up to ten can be installed. When master nodes are installed separately, up to 50 data nodes are possible.

Provided features

Search Engine provides the following features.

• Auto Provisioning (Auto Provisioning): You can configure and set up Elasticsearch and OpenSearch clusters via the UI.
• Operation Control Management: Provides functionality to control the status of running servers. In addition to starting and stopping the cluster, it can be restarted to apply configuration values.
• Backup and Recovery: You can back up using the built-in backup feature, and you can restore to the point in time of the backup file.
• Add Data Node: If cluster expansion is required, you can add nodes with the same specifications as the existing data nodes. Up to 10 nodes can be added within the cluster.
• Visualization Tool Support: Provides data analysis and visualization tools, and supports Elasticsearch Kibana or OpenSearch dashboards.
• Monitoring: CPU, memory, and cluster performance monitoring information can be accessed through the Cloud Monitoring service.

Component

Search Engine provides pre‑validated engine versions and various server types in accordance with its open‑source support policy. Users can select and use them based on the scale of the service they wish to configure.

Engine version

The engine versions supported by Search Engine are as follows.

Technical support can be used until the supplier’s EoTS (End of Technical Service) date, and the EOS date when new creation is halted is set to six months before the EoTS date.

The EOS and EoTS dates may change according to the supplier’s policy, so please refer to the supplier’s license management policy page for details.

• Elasticsearch: https://www.elastic.co/kr/support/eol

• OpenSearch: https://opensearch.org/releases/

Server Type

The server types supported by Search Engine are as follows.

For detailed information about the server types provided by Search Engine, see Search Engine Server Types.

Standard se1v2m4

Preliminary Service

This is a list of services that must be pre-configured before creating the service. Please refer to the guide provided for each service and prepare in advance.

2.1.1 - Server Type

Search Engine server type

Search Engine provides server types composed of various combinations such as CPU, Memory, and Network Bandwidth. When creating a Search Engine, Elastic Search is installed according to the server type selected for the intended use.

The server types supported by Search Engine are as follows.

Standard ses1v2m4

ses1 server type

The ses1 server type of Search Engine is offered with standard specifications (vCPU, Memory) and is suitable for various database workloads.

• Intel 3rd‑generation (Ice Lake) Xeon Gold 6342 Processor up to 3.3 GHz
• Supports up to 16 vCPUs and 256 GB of memory
• Maximum networking speed of 12.5 Gbps

ses2 server type

The ses1 server type of Search Engine is offered with standard specifications (vCPU, Memory) and is suitable for various database workloads.

• Intel 4th‑generation (Sapphire Rapids) Xeon Gold 6448H Processor up to 3.2 GHz
• Supports up to 16 vCPUs and 256 GB of memory
• Maximum networking speed of 12.5 Gbps

seh2 server type

The seh2 server type of Search Engine is offered with high-capacity server specifications and is suitable for database workloads for large-scale data processing.

• Intel 4th‑generation (Sapphire Rapids) Xeon Gold 6448H Processor up to 3.2 GHz
• Supports up to 72 vCPUs and 288 GB of memory
• Networking speed up to 25 Gbps

2.1.2 - Monitoring metrics

Search Engine Monitoring Metrics

The table below shows the performance monitoring metrics for Event Streams that can be viewed through Cloud Monitoring. For detailed Cloud Monitoring usage, refer to the Cloud Monitoring guide.

Refer to the Virtual Server Monitoring Metrics guide for the Search Engine server monitoring metrics.

2.2 - How-to guides

Users can create the service by entering the required information for the Search Engine and selecting detailed options through the Samsung Cloud Platform Console.

Create Search Engine

You can create and use the Search Engine service in the Samsung Cloud Platform Console.

To create a Search Engine, follow the steps below.

1. All Services > Database > Search Engine Click the menu. 1. Navigate to the Search Engine’s Service Home page.

2. On the Service Home page, click the Create Search Engine button. 2. Go to the Create Search Engine page.

3. Search Engine creation page: enter the information required to create the service and select detailed options.

   • Select the required information in the Image and Version Selection area.

     Category	required status	Detailed description
     image	Required	Select the type of image provided Elasticsearch Enterprise, OpenSearch
     Image version	Required	Select version of the selected image Provide a version list of the offered server image

     Table. Search Engine image and version selection options
   • In the Service Information Input area, enter or select the required information.

     Category	required status	Detailed description
     Server name Prefix	Required	The server name where Elasticsearch will be installed must start with a lowercase English letter, and using lowercase letters, numbers, and special characters (-) be entered with 3 to 13 characters based on the server name, a postfix such as 001, 002 is appended to generate the actual server name
     Cluster name	Required	Cluster name of the servers Enter using English letters, 3 ~ 20 characters A cluster is a unit that groups multiple servers
     Separate MasterNode installation > Use	Required	Whether to install the Master node separately If you select Use, install the Master node separately If the Master node is not installed separately, the data node also performs the master role
     Separate MasterNode installation > Number of MasterNodes	Required	Number of Master nodes Master nodes are fixed at three units for recovery (Fail-over)
     Separate installation of MasterNode > Server type	Required	Master 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 Search Engine, refer to Search Engine Server Types
     Separate MasterNode installation > Planned Compute	Select	Status of resources with Planned Compute configured In Use: Number of resources with Planned Compute 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, see Planned Compute Apply
     Separate MasterNode installation > Block Storage	Required	Block Storage type to be used for the Master node Basic OS: Area where the engine is installed DATA: Data file storage area After selecting the storage type, enter the capacity. (For details on each Block Storage type, refer to Create Block Storage) SSD: High‑performance general volume HDD: General volume SSD_KMS/HDD_KMS: Additional encrypted volume using KMS (Key Management System) encryption keys Capacity must be entered as a multiple of 8 within the range 16 to 5,120 Add Disk: Data storage area After selecting Use, enter the storage capacity Click the + button to add storage, or the x button to delete. 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
     Number of nodes	Required	Number of data nodes When installing the Master node separately, you must select at least 2; otherwise, you must select at least 1.
     Service Type > Server Type	Required	Data node server type Standard: Standard specification commonly used High Capacity: Large-capacity server with 24 vCores or more
     Service Type > Planned Compute	Select	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, see Planned Compute Apply
     Service Type > Block Storage	Required	Block Storage types to be used for data nodes Basic OS: Area where the engine is installed DATA: Data file storage area After selecting the storage type, enter the capacity. (For details on each Block Storage type, refer to Block Storage 생성하기) SSD: High‑performance general volume HDD: General volume SSD_KMS/HDD_KMS: Additional encrypted volume using KMS (Key Management System) encryption keys Enter the capacity as a multiple of 8 within the range 16 to 5,120 Add Disk: Additional storage area for data and backup After selecting Use, enter the storage purpose, capacity Click the + button to add storage, and the x button to delete. 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.
     Kibana > Server Type	Required	Server type for Kibana installation Standard: standard specification commonly used
     Kibana > Planned Compute	Select	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, see Planned Compute Apply
     Kibana > Block Storage	Required	Block storage type to be used on the server where Kibana is installed Base OS: Area where the engine is installed
     Network > Common Settings	Required	Network settings for servers created by the service Select when you want to apply the same settings to all installed servers Select a pre‑created VPC and Subnet IP: Only automatic generation is possible Public NAT settings are only available in per‑server configuration.
     Network > Server-specific Settings	Required	Network settings where servers generated by the service are installed Select if you want to apply different settings per 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; checking Use allows you to select from reserved IPs in the VPC product’s Public IP. For more information, see Public IP 생성하기
     IP access control	Select	Service Access Policy Settings 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 the IP in IP format (e.g., 192.168.10.1) or CIDR format (e.g., 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 IP
     maintenance period	Select	Search Engine maintenance period If you select Use, set the day of week, start time, and duration We recommend setting a maintenance period for the stable management of the service. Patch operations will be performed at the scheduled time, which may cause service interruptions If set to not use, we are not responsible for any issues arising from patches not being applied.

     Table. Search Engine Service Information Input Items
   • In the Database Configuration Required Information Input area, enter or select the required information.

     Category	required status	Detailed description
     Backup > Use	Select	Whether to use node backup When selecting node backup usage, choose the retention period and backup start time
     Backup > Retention Period	Select	Backup retention period Select the backup retention period. Set the file retention period to 7 days ~ 35 days Backup files incur additional charges based on size.
     Backup > Backup Start Time	Select	Backup start time Select backup start time The minutes during which the backup runs (minutes) are set randomly, and the backup end time cannot be set
     Cluster Port number	Required	Elasticsearch connection port number 1200 ~ 65535can be entered as one of them, and the internal Elasticsearch port 9300 and Kibana port 5301 cannot be used
     Elastic username	Required	Elasticsearch username Enter using lowercase English letters, 2 to 20 characters The following usernames cannot be used. apm_system, beats_system, elastic, kibana, kibana_system, logstash_system, remote_monitoring_user, scp_kibana_system, scp_manager, maxigent_cl
     Elastic password	Required	Elasticsearch login password Enter 8 to 30 characters, including letters, numbers, and special characters (excluding “, ‘, \)
     Check Elastic password	Required	Check Elasticsearch connection password Re-enter the Elasticsearch connection password identically
     License Key	Required	Elasticsearch License Key Enter the entire contents of the issued license file (.json) If the entered license key is invalid, the service may not be created. OpenSearch does not require a License Key.
     time zone	Select	Standard time zone for the service

     Table. Required input fields for Search Engine Database configuration
   • Enter or select the required information in the Additional Information Input area.

     Category	required status	Detailed description
     Tag	Select	Add tag Add tag Click the button to create and add a tag, or add an existing tag You can add up to 50 tags The newly added tags are applied after the service creation is completed

     Table. Search Engine service additional information input fields

4. Summary Check the detailed information and estimated charges generated in the panel, and click the Complete button.

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

Check Search Engine Details

The Search Engine service allows you to view and edit the complete resource list and detailed information. Search Engine Details page includes Detail Information, Tags, Activity Log tabs.

To view detailed information about the Search Engine service, follow these steps.

1. All Services > Data Analytics > Search Engine menu, click it. 1. Navigate to the Search Engine’s Service Home page.
2. On the Service Home page, click the Search Engine menu. 2. Go to the Search Engine list page.
3. Search Engine list page: click the resource to view detailed information. 3. Search Engine Details Navigate to the page.
   • Search Engine Details At the top of the page, status information and additional feature information are displayed.

     Category	Detailed description
     Cluster status	Cluster status Creating: Cluster is being created Editing: Cluster is being changed to an operational state Error: Cluster encountered a failure while performing a task If this persists, contact the administrator Failed: Cluster failed during creation Restarting: Cluster is restarting Running: Cluster is operating normally Starting: Cluster is starting Stopped: Cluster is stopped Stopping: Cluster is stopping Synchronizing: Cluster is synchronizing Terminating: Cluster is being terminated Unknown: Cluster status is unknown If this persists, contact the administrator Upgrading: Cluster is being upgraded
     Cluster control	Button to change the cluster state Start: Starts a stopped cluster. Stop: Stops a running cluster. Restart: Restarts a running cluster
     View more add-ons	Cluster management buttons Service status synchronization: Retrieve the current server status and synchronize it to the Console Backup history: When backup is configured, check whether the backup executed successfully and view its history Cluster recovery: Recover the cluster based on a specific point in time. Add Node: Add a data node.
     Service cancellation	Cancel service button

     Table. Search Engine status information and additional features

Detailed Information

Search Engine list page lets you view detailed information of the selected resource and, if needed, modify the information.

Tag

Search Engine List page allows you to view the tag information of the selected resource, and you can add, modify, or delete it.

Job History

On the Search Engine List page, you can view the operation history of the selected resource.

Search Engine Resource Management

If you need to change the existing configuration options of a created Search Engine resource, manage parameters, or add node configurations, you can perform the tasks on the Search Engine Detailed Information page.

Control Operation

If changes occur to a running Search Engine resource, you can start, stop, or restart it.

To control the operation of the Search Engine, follow these steps.

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

Synchronize Service Status

You can query the current server status and synchronize it to the Console.

To synchronize the service status of the Search Engine, follow these steps.

1. All Services > Data Analytics > Search Engine menu, click. 1. Navigate to the Search Engine’s Service Home page.
2. On the Service Home page, click the Search Engine menu. 2. Go to the Search Engine list page.
3. On the Search Engine List page, click the resource to view the service status. 3. Navigate to the Search Engine Details page.
4. Click the Service Status Synchronization button. 4. The query takes a short amount of time, and while it is being performed, the cluster changes to the Synchronizing state.
5. When the query completes, the status in the server information field is updated, and the cluster changes to the 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 > Search Engine Click the menu. 1. Navigate to the Service Home page of Search Engine.
2. On the Service Home page, click the Search Engine menu. 2. Go to the Search Engine list page.
3. On the Search Engine list page, click the resource to change the server type. 3. Navigate to the Search Engine Details page.
4. Click the edit button for the server type you want to change at the bottom of the detailed information. 4. Edit Server Type popup window opens.
5. Edit Server Type After selecting the server type in the popup window, 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 the Search Engine, and if configured as a cluster, all nodes are expanded simultaneously.

To increase storage capacity, follow the steps below.

1. Click the All Services > Data Analytics > Search Engine menu. 1. Navigate to the Service Home page of Search Engine.
2. On the Service Home page, click the Search Engine menu. 2. Go to the Search Engine list page.
3. On the Search Engine list page, click the resource to change the server type. 3. Search Engine Details Navigate to the page.
4. Click the Edit button for the added Disk you want to expand at the bottom of the detailed information. 4. Disk Edit The popup window opens.
5. Disk Edit after entering the additional capacity in the popup window, click the Confirm button.

Add storage

If you need more than 5 TB of data storage space, you can add additional storage.

To add storage capacity, follow the steps below.

1. All Services > Data Analytics > Search Engine menu, click. 1. Navigate to the Service Home page of Search Engine.
2. On the Service Home page, click the Search Engine menu. 2. Go to the Search Engine list page.
3. On the Search Engine List page, click the resource to add storage. 3. Navigate to the Search Engine Details page.
4. Click the Add Disk button at the bottom of the detailed information. 4. Add Disk The popup window opens.
5. Add Disk In the popup window, after entering the purpose and size, click the Confirm button.

Search Engine Backup

Through the backup configuration feature, users can set the data retention period and start interval, and through the backup history feature, they can view and delete backup records.

Configure Backup

When creating a Search Engine and setting up backup, refer to the Creating a Search Engine guide, and to modify the backup configuration of the created resource, follow the steps below.

1. Click the All Services > Data Analytics > Search Engine menu. 1. Navigate to the Service Home page of Search Engine.
2. On the Service Home page, click the Search Engine menu. 2. Go to the Search Engine list page.
3. On the Search Engine list page, click the resource to set up backup. 3. Navigate to the Search Engine Details page.
4. Click the Edit button of the backup item. 4. Backup Edit The popup window opens.
5. When setting up a backup, click Use in the Backup Edit popup, select retention period, backup start time, and Archive backup interval, then click the Confirm button.
   • If you stop the backup setting, uncheck Use in the Edit Backup popup window, and authenticate via the logged-in user’s mobile phone.

Check backup history

To view the backup history, follow these steps.

1. All Services > Data Analytics > Search Engine Click the menu. 1. Navigate to the Search Engine’s Service Home page.
2. On the Service Home page, click the Search Engine menu. 2. Go to the Search Engine list page.
3. On the Search Engine List page, click the resource to view the backup history. 3. Go to the Search Engine Details page.
4. Click the Backup History button. 4. Backup History popup window opens.
5. Backup History In the popup window, you can view the backup status, version, backup start time, backup completion time, and size.

Delete backup file

To delete the backup history, follow these steps.

1. All Services > Data Analytics > Search Engine Click the menu. 1. Navigate to the Search Engine’s Service Home page.
2. On the Service Home page, click the Search Engine menu. 2. Go to the Search Engine list page.
3. Search Engine List page, click the resource to view the backup history. 3. Navigate to the Search Engine Details page.
4. Click the Backup History button. 4. The Backup History popup window opens.
5. Backup History In the popup window, check the files you want to delete, then authenticate using the logged-in user’s mobile phone.

Restore Search Engine

If a failure or data loss requires restoration from a backup file, you can recover to a specific point in time using the cluster recovery feature.

To restore the Search Engine, follow these steps.

1. Click the All Services > Data Analytics > Search Engine menu. 1. Navigate to the Search Engine’s Service Home page.
2. On the Service Home page, click the Search Engine menu. 2. Go to the Search Engine list page.
3. Search Engine Resource On the list page, click the resource you wish to recover. 3. Navigate to the Search Engine Details page.
4. Click the Cluster Recovery button. 4. Go to the Cluster Recovery page.
5. After entering the relevant information in the Cluster Recovery Configuration area, click the Complete button.

   Category	required status	Detailed description
   Recovery point	Required	Set the point in time the user wants to recover Select from the list of backup file timestamps displayed
   Server name Prefix	Required	Recovery server name Start with a lowercase English letter and use lowercase letters, numbers, and special characters (-) to enter 3 to 16 characters Based on the server name, a postfix such as 001, 002 is appended to generate the actual server name
   Cluster name	Required	Recovery server cluster name Enter using English letters, 3 ~ 20 characters A cluster is a unit that groups multiple servers
   Number of nodes	Required	Number of data nodes Set to be the same as the number of nodes configured in the original cluster.
   Service Type > Server Type	Required	Data node server type It is set to the same number of nodes as configured in the original cluster.
   Service Type > Planned Compute	Select	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, see Planned Compute Apply
   Service Type > Block Storage	Required	Block Storage to be used for data nodes Basic OS: area where the engine is installed DATA: data file storage area Applied identically as the storage type set in the original cluster Enter capacity as a multiple of 8 within the range 16 to 5,120 Add Disk: additional storage area for data and backup After selecting Use, enter the storage purpose and capacity Click the + button to add storage, and the x button to delete Capacity can be entered as a multiple of 8 within the range 16 to 5,120, and up to 9 can be created
   Separate MasterNode installation > Use	Required	Whether to install the Master node separately Apply the same based on the installation status of the original cluster
   Separate MasterNode installation > Number of MasterNodes	Required	Number of Master nodes
   Separate installation of MasterNode > Server type	Required	Master node server type It is set to be the same as the number of nodes configured in the original cluster.
   Separate MasterNode installation > Planned Compute	Select	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, see Planned Compute 신청하기
   Separate MasterNode installation > Block Storage	Required	Block Storage to be used on the Master node Basic OS: Area where the engine is installed DATA: Data file storage area Applied identically with the storage type set in the original cluster Enter capacity as a multiple of 8 within the range 16 to 5,120 Add Disk: Additional data storage area After selecting Use, enter the storage capacity Click the + button to add storage, or the x button to delete Capacity can be entered as a multiple of 8 within the range 16 to 5,120, and up to 9 can be created
   Kibana > Server Type	Required	Kibana node server type It is set to be the same as the number of nodes configured in the original cluster.
   Kibana > Planned Compute	Select	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, see Planned Compute 신청하기
   Kibana > Block Storage	Required	Block Storage to be used on the Kibana node Base OS: the area where the engine is installed
   Cluster Port number	Required	Elasticsearch connection port number It is set to the same port number configured in the original cluster.
   Licnese Key	Required	Elasticsearch License Key Enter the entire contents of the issued license file (.json) If the entered license key is invalid, the service may not be created. OpenSearch does not require a License Key.
   IP access control	Select	Service Access Policy Settings 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 the IP 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 IP
   maintenance period	Select	maintenance window If you select Use, you can set the day of week, start time, and duration We recommend setting a maintenance window for stable service management. Patch operations will be performed at the scheduled time, causing service interruption If set to not use, we are not responsible for issues arising from unapplied patches.

   Table. Search Engine Recovery Configuration Items

Add Node

If you need to expand the Search Engine cluster, you can add nodes with the same specifications as the data nodes in use.

To add a node, follow the steps below.

1. All Services > Data Analytics > Search Engine Click the menu. 1. Navigate to the Service Home page of Search Engine.
2. On the Service Home page, click the Search Engine menu. 2. Go to the Search Engine list page.
3. Search Engines Resources Click the resource you want to restore on the list page. 3. Search Engine Details Navigate to the page.
4. Click the Add Broker Node button. 4. Go to the Add Broker Node page.
5. After entering the relevant information in the Required Information Input area, click the Complete button.

   Category	required status	Detailed description
   Server name Prefix	Required	Data node server name It is set to the server name configured in the original cluster.
   Cluster name	Required	Cluster name It is set to the cluster name configured in the original cluster.
   Additional Node Count	Required	Number of Nodes to add Use up to 10 nodes per cluster
   Service Type > Server Type	Required	Data node server type It is set the same as the server type configured in the original cluster.
   Service Type > Planned Compute	Select	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, see Planned Compute 신청하기
   Service Type > Block Storage	Required	Block Storage configuration to be used for data nodes The storage type and capacity set in the source cluster are applied identically
   Network	Required	the network where the servers are installed applied identically to the network configured in the original cluster

   Table. Search Engine Node additional items

Terminate Search Engine

You can cancel unused Search Engines to reduce operating costs. However, if you terminate the service, the running service may be stopped immediately, so you should proceed with the termination only after fully considering the impact that may occur when the service is discontinued.

To cancel the Search Engine, follow these steps.

1. All Services > Data Analytics > Search Engine Click the menu. 1. Navigate to the Search Engine’s Service Home page.
2. On the Service Home page, click the Search Engine menu. 2. Go to the Search Engine List page.
3. On the Search Engine List page, select the resource to cancel, and click the Cancel Service button.
4. When the termination is complete, verify on the Search Engine list page whether the resource has been terminated.

2.3 - API Reference

2.4 - CLI Reference

2.5 - Release Note

Search Engine

3 - Vertica(DBaaS)

3.1 - Overview

Service Overview

Vertica(DBaaS) is a high-availability enterprise database built on a Data Warehouse for large-scale data analysis and processing. Through a single engine, it serves as a data analytics platform that can perform basic analyses such as querying data from various sources without moving them, as well as AI analyses like machine learning. In the Samsung Cloud Platform, DB management functions such as high‑availability configuration, backup/recovery, patching, parameter management, and monitoring are added to ensure stable management of single instances or critical data, enabling automation of tasks throughout the database lifecycle. Additionally, it provides an automatic backup feature at user‑specified times to support data recovery at the desired point in case of DB server or data issues.

Service Architecture Diagram

Provided features

Vertica(DBaaS) provides the following features.

• Auto Provisioning (Auto Provisioning): Automatically installs the standard version of the Samsung Cloud Platform database based on Virtual Servers of various specifications.
• Cluster Configuration: Provides a self-high-availability architecture in a masterless form.
• Operation Control Management: Provides functionality to control the status of running servers. You can start or stop a server, and it can be restarted if there is a database issue or to apply configuration changes.
• Backup and Recovery: Provides data backup functionality based on proprietary backup commands. Users can set the backup retention period and start time, and additional fees apply based on backup size. It also offers a recovery feature for backed‑up data; when a user initiates recovery, a separate database is created and restored to the point selected by the user (backup creation time or a custom point). For database recovery, you can choose to install the Management Console for use.
• Service Status Query: You can view the final status of the current DB service.
• Monitoring: CPU, memory, DB performance monitoring information can be accessed through the Cloud Monitoring service.
• High-Performance Processing of Large-Scale Data: It guarantees stable performance in a Mixed Workload environment of massive parallel processing (MPP, Massively Parallel Processing) and SQL queries. Vertica processes queries through distributed processing and is designed so that queries can be initiated from any node, eliminating a Single Point of Failure where queries would not execute if a specific node fails.

Component

Vertica(DBaaS) provides pre‑validated engine versions and various server types. Users can select and use them according to the scale of the service they wish to configure.

Engine version

The engine versions supported by Vertica (DBaaS) are as follows.

Technical support can be used until the supplier’s EoTS (End of Technical Service) date, and the EOS date when new creation is halted is set to six months before the EoTS date.

The EOS and EoTS dates may change according to the supplier’s policy, so please refer to the supplier’s license management policy page for details.

Server type

The server types supported by Vertica (DBaaS) are as follows.

For detailed information about the server types provided by Vertica (DBaaS), see Vertica Server Types.

Preliminary Service

This is a list of services that must be pre-configured before creating the service. Please refer to the guide provided for each service and prepare in advance.

3.1.1 - Server Type

Vertica(DBaaS) server type

Vertica (DBaaS) offers server types configured with various combinations of CPU, memory, and network bandwidth. When creating Vertica(DBaaS), the Database Engine is installed according to the server type selected for the intended use.

The server types supported by Vertica (DBaaS) are as follows.

Standard db1v2m4

db1 server type

The db1 server type of Vertica(DBaaS) is provided with standard specifications (vCPU, Memory) and is suitable for various database workloads.

• Intel 3rd‑generation (Ice Lake) Xeon Gold 6342 Processor up to 3.3 GHz
• Supports up to 16 vCPUs and 256 GB of memory
• Maximum networking speed of 12.5 Gbps

db2 server type

The db2 server type of Vertica(DBaaS) is provided with standard specifications (vCPU, Memory) and is suitable for various database workloads.

• Intel 4th‑generation (Sapphire Rapids) Xeon Gold 6448H Processor up to 3.2 GHz
• Supports up to 16 vCPUs and 256 GB of memory
• Maximum networking speed of 12.5 Gbps

dbh2 server type

The dbh2 server type of Vertica (DBaaS) is offered with high-capacity server specifications and is suitable for database workloads that require large-scale data processing.

• Intel 4th‑generation (Sapphire Rapids) Xeon Gold 6448H Processor up to 3.2 GHz
• Supports up to 128 vCPUs and 1,536 GB of memory
• Networking speed up to 25 Gbps

3.1.2 - Monitoring metrics

Vertica(DBaaS) Monitoring Metrics

The table below shows the performance monitoring metrics for Vertica (DBaaS) that can be viewed through Cloud Monitoring. For detailed Cloud Monitoring usage, see the Cloud Monitoring guide.

The server monitoring metrics for Vertica (DBaaS) are described in the Virtual Server Monitoring Metrics guide.

3.2 - 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.

Create Vertica (DBaaS)

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

To create 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) Create button. 2. Create navigate to the page.

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

   • Select the required information in the Image and Version Selection area.

     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	Required	The server name where Vertica will be installed must start with a lowercase English letter, and using lowercase letters, numbers, and special characters(-) input 3 to 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 in the range of 1-10 If you configure the cluster by entering the number of nodes as 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) Server Type
     Service Type > Planned Compute	Select	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, see Planned Compute Apply
     Service Type > Block Storage	Essential	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 also applied 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’s purpose, 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 settings 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 for servers created by the service Select when you want to apply the same settings to all installed servers Select a pre‑created VPC and Subnet IP: Enter each server’s IP Public NAT setting is only available in per‑server settings
     Network > Server-specific Settings	Required	Network settings for the servers created by the service Select when you want to apply different settings per installed server Choose a pre‑created VPC and Subnet IP: Enter the IP for each server Public NAT requires the VPC to be connected to an Internet Gateway; when use is checked, you can select a reserved IP from the VPC product’s Public IP pool. For details, see Public IP 생성하기.
     IP access control	Selection	Service Access Policy Configuration Since the access policy is set for the IP entered on the page, a separate Security Group policy configuration is not required. 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	Database maintenance window If you select Use, set the day, start time, and duration It is recommended to set a maintenance window for stable DB management. Patch operations will be performed at the scheduled time, causing service interruption If set to unused, Samsung SDS is not responsible for issues arising from unapplied patches.

     Table. Vertica (DBaaS) service configuration items
   • Enter required database configuration information Enter or select the required information in this area.

     Category	required status	Detailed description
     Database name	Essential	Server name applied during DB installation must start with an English letter and be entered using English letters and numbers, 3 to 20 characters
     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 checked in the Console
     Database password	Essential	Password to use when accessing the DB English letters, numbers, and special characters (“ ‘ excluded) and enter 8~30 characters
     Database password verification	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	Select	Node backup usage Select Use to choose the node backup retention period and backup start time
     Backup > Retention Period	Select	Backup retention period Select the backup retention period. Set the file retention period to 7 days ~ 35 days Backup files incur additional charges based on size
     Backup > Backup Start Time	Select	Backup start time Select backup start time The minute(s) at which the backup runs is set randomly, and the backup end time cannot be set
     License Key	Required	Enter the Vertica License Key held by the customer If the entered license key is invalid, the service cannot be created
     DB Locale	Required	Settings related to string handling, numeric/currency/date/time display formats, etc., to be used with 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.

     Category	required status	Detailed description
     tag	Select	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.

   • Once creation is complete, verify the created resource on the Resource List page.

View Vertica (DBaaS) 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 is composed of Details, Tags, Job History tabs.

To view detailed information about the Vertica (DBaaS) service, 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. Navigate to the Vertica(DBaaS) List page.
3. On the Vertica(DBaaS) List page, click the resource to view detailed information. 3. Vertica(DBaaS) Details Navigate to the page.
   • Vertica(DBaaS) Details At the top of the page, status information and additional feature information are displayed.

     Category	Detailed description
     Cluster status	Cluster status Creating: Creating cluster Editing: Cluster is changing to an Operation execution state Error: Cluster encountered a failure while performing tasks If it occurs continuously, contact the administrator Failed: Cluster failed during creation Restarting: Cluster is restarting Running: Cluster is running normally Starting: Cluster is starting Stopped: Cluster is stopped Stopping: Cluster is stopping Synchronizing: Cluster is synchronizing Terminating: Cluster is terminating Unknown: Cluster status is unknown If it occurs continuously, contact the administrator Upgrading: Cluster is upgrading
     Cluster control	Button to change the cluster state Start: Start a stopped cluster Stop: Stop a running cluster Restart: Restart a running cluster
     View more features	Cluster-related management buttons Service status synchronization: Real-time DB service status lookup Backup history: When backup is configured, check whether the backup runs correctly and view its history Database recovery: Recover the DB based on a specific point in time
     Service termination	Button to cancel the service

     Table. Vertica (DBaaS) status information and additional features

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.

Work History

You can view the operation history of the selected resource on the Vertica(DBaaS) List page.

Managing Vertica (DBaaS) Resources

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

Control operation

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

To control the operation 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. Click the Vertica(DBaaS) menu on the Service Home page. 2. Navigate to the Vertica(DBaaS) List page.
3. Vertica(DBaaS) List page, click the resource to control its operation. 3. Vertica(DBaaS) Details Navigate to the page.
4. Check the Vertica (DBaaS) status and complete the change using the control button below.
   • Start: The server where the Vertica(DBaaS) service is installed and the Vertica(DBaaS) service is 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 view 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. Go to the Vertica(DBaaS) List page.
3. On the Vertica(DBaaS) List page, click the resource to view the service status. 3. Vertica(DBaaS) Details Go to the page.
4. Click the Service Status Sync button. 4. While it is being queried, the cluster changes to Synchronizing state.
5. When the query completes, the status in the server information field is updated, and the cluster changes to the 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. Go to the Vertica(DBaaS) List 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 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. Go to the Service Home page of Vertica (DBaaS).
2. On the Service Home page, click the Vertica(DBaaS) menu. 2. Navigate to the Vertica(DBaaS) List page.
3. On the Vertica(DBaaS) List page, click the resource to add storage. 3. Vertica(DBaaS) Details Navigate to the page.
4. Click the Add Disk button at the bottom of the detailed view. 4. Additional Storage Request The popup window opens.
5. Additional Storage Request In the popup window, after entering the purpose and size, click the Confirm button.

Expand 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 expand storage capacity, follow the steps below.

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. On the Vertica(DBaaS) List page, click the resource to change the server type. 3. Go to the Vertica(DBaaS) Details 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 A popup window opens.
5. Edit Additional Storage In the popup window, after entering the expansion capacity, click the Confirm button.

Changing the Recovery DB instance type

After the 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. 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. Navigate to the Vertica(DBaaS) List 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 provide the same functionality as a single DB.

Cancel Vertica (DBaaS)

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

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

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. Navigate to the Vertica(DBaaS) List page.
3. On the Vertica(DBaaS) List page, select the resource to cancel and click the Cancel Service button.
4. After termination is complete, check on the Vertica(DBaaS) list page whether the resource has been terminated.

3.2.1 - Backing up and restoring Vertica

Users can set up backups for Vertica (DBaaS) via the Samsung Cloud Platform Console and restore from the backed‑up files.

Backing up Vertica (DBaaS)

You can configure the backup feature to ensure that user data is stored securely. Additionally, you can verify whether a backup completed successfully using the backup history feature, and you can also delete backed‑up files.

Configure Backup

For backup configuration of Vertica(DBaaS), please refer to Create Vertica(DBaaS).

To modify the backup settings of Vertica (DBaaS), follow the steps below.

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. Go to the Vertica(DBaaS) List page.
3. Vertica(DBaaS) List page, click the resource to configure a backup. 3. Vertica(DBaaS) Details Navigate to the page.
4. Click the Edit button of the backup item. 4. Backup Settings The popup window opens.
5. When setting up a backup, click Backup Settings in the popup window, click Enable, select the retention period and backup start time, and click the Confirm button.
   • If you want to stop the backup configuration, deselect Use in the Backup Settings popup and authenticate via the logged‑in user’s mobile phone.
     Once user authentication is completed, the backup configuration will be disabled and backup execution will stop.

Check backup history

To view the backup history, 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. Navigate to the Vertica(DBaaS) List page.
3. On the Vertica(DBaaS) List page, click the resource to view the backup history. 3. Vertica (DBaaS) Details Navigate to the page.
4. Click the Backup History button. 4. The Backup History popup window opens.
5. Backup History In the popup window, you can view the backup status, version, backup start time, backup completion time, and size.

Delete backup files

To delete the backup history, 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. Go to the Vertica(DBaaS) List page.
3. Vertica(DBaaS) List page, click the resource to view the backup history. 3. Vertica(DBaaS) Details Navigate to the page.
4. Click the Backup History button. 4. Backup History The popup window opens.
5. Backup History In the popup window, check the files you want to delete, then authenticate using the logged-in user’s mobile phone.
   • When user authentication is completed, the backup file is deleted.

Recover Vertica(DBaaS)

If a failure or data loss requires restoration from backup files, you can use the cluster recovery feature to recover based on a specific point in time.

To restore Vertica(DBaaS), follow these steps.

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. Go to the Vertica(DBaaS) List page.
3. On the Vertica(DBaaS) resource list page, click the resource you want to recover. 3. Vertica(DBaaS) Details Go to the page.
4. Database Recovery button, click it. 4. Database(DBaaS) Recovery Navigate to the page.
5. After entering the relevant information in the Database Recovery area, click the Complete button.

   Category	required status	Detailed description
   Recovery Type	Required	Set the point in time the user wants to recover Backup point (recommended): Recover based on the backup file. Select from the list of backup file timestamps displayed Recovery point: Choose the date and time to recover. Can be selected from the start time of the backup history
   Server name Prefix	Essential	Recovery DB server name Start with a lowercase English letter and use lowercase letters, numbers, and special characters (-) to enter 3 to 16 characters Based on the server name, a postfix such as 001, 002 is appended to generate the actual server name
   Cluster name	Required	Recovery DB cluster name Enter using English letters, 3 to 20 characters A cluster is a unit that groups multiple servers
   Number of nodes	Selection	Data node count Set to be the same as the number of nodes configured in the original cluster
   Service Type > Server Type	Required	Recovery DB server type Standard: standard specification commonly used High Capacity: large-capacity server with 24 vCores or more
   Service Type > Planned Compute	Selection	Status of resources with Planned Compute configured In Use: Number of resources with Planned Compute that are currently in use Configured: Number of resources with Planned Compute configured Coverage preview: Amount applied per resource by Planned Compute Planned Compute Service Application: Go to the Planned Compute service application page For more details, refer to Planned Compute Apply
   Service Type > Block Storage	Required	Block Storage settings used by the recovery DB Basic OS: Area where the DB engine is installed DATA: Storage area for table data, archive files, etc. Applied identically with the storage type set in the original cluster After selecting Use, enter the storage purpose and capacity To add storage, click the Add button; to delete, click the x button Capacity can be entered in multiples of 8 within the range 16 to 5,120, and up to 9 can be created
   Management Console > Server Type	Essential	Management Console server type After selecting Use, select the storage purpose and capacity Standard: standard specification commonly used High Capacity: large-capacity server with 24vCore or more
   Management Console > Block Storage	Required	Block Storage settings used by the Management Console Select Use, then select Default OS
   Database username	Required	Database username Apply the same username set in the original cluster
   Database password	Essential	Database password Apply the same password set in the original cluster
   Database Port number	Required	Database Port number Apply the same Port number as set in the original cluster
   IP access control	Select	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 (e.g., 192.168.10.1) or CIDR format (e.g., 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	Select	Database maintenance window If you select Use, set the day of week, start time, and duration It is recommended to set a maintenance window for stable management of the database. Patch operations will be performed at the scheduled time, causing service interruption If set to not use, Samsung SDS is not responsible for issues arising from patches not being applied.
   License Key	Required	Enter the Vertica License Key to recover If the entered license key is invalid, the service cannot be created
   tag	Selection	Add Tag After clicking the Add Tag button, enter or select Key, Value values

   Table. Vertica (DBaaS) recovery configuration items

3.3 - API Reference

3.4 - CLI Reference

3.5 - Release Note

Vertica(DBaaS)

4 - Data Flow

4.1 - Overview

Service Overview

Data Flow is a data processing workflow tool that visually creates processing flows for extracting large volumes of data from various data sources and for transforming and transmitting stream/batch data, and it provides the open-source Apache NiFi. Data Flow can be used independently in the Kubernetes Engine cluster environment of Samsung Cloud Platform, or together with other application software.

Provided features

Data Flow provides the following functions.

• Convenient Installation and Management: Data Flow can be easily installed in a standard Kubernetes cluster environment via the web-based Samsung Cloud Platform Console. It automatically configures the architecture required for scalable clustering based on the open-source Apache NiFi, automatically installing ZooKeeper, Registry, and management modules. With Data Flow, you can configure and deploy configuration files, NiFi templates, and other assets needed for service integration.
• Easy Data Flow Management: You can easily create processing flows for stream/batch data in a GUI that matches the user environment, and by authoring data processing flows in a GUI, you can efficiently extract, transmit, and process data between systems.
• NiFi Template Gallery: You can share/distribute reference NiFi templates. Data Flow provides work files for data processing flows commonly used in the field as a gallery, and users can share the data processing flow work they have created.

Component

Data Flow consists of Manager and Service modules, and is provided packaged with Apache NiFi.

Data Flow Manager

Data Flow Manager provides various management functions to enable more efficient use of NiFi.

• You can upload the Nar file created by the customer through the Data Flow Manager for use in the Processor, and upload configuration files to share them.
• Frequently used NiFi templates are packaged as assets and offered in the Gallery, ready for use with a single click.
• Provides real-time monitoring of multiple services configured for the native NiFi service, as well as resource status monitoring.
• You can easily provision configuration information for NiFi components within the cluster.

Data Flow Service

• We provide a data flow management service based on Apache NiFi.
• Automatically configures the architecture required for scalable clustering based on Apache NiFi, and automatically installs the Nifi, ZooKeeper, and Nifi Registry modules.
• When providing Nifi, you can set the Description, required resource size, connection ID/PW, and Host Alias.
• After creating the service, you can modify the Description, required resource size, connection password, Host Alias, and other settings, and apply the changes to the service.

Server spec type

When creating a Data Flow service, check the following.

• Recommended Service Installation Specifications: CPU 21 core, Memory 57 GB, Storage at least 100 GB

Provision status by region

Data Flow is available in the environments below.

Preliminary Service

This is a list of services that must be pre‑configured before creating the service. Please refer to the guide provided for each service and prepare in advance.

4.1.1 - ServiceWatch metric

In ServiceWatch, you can view Kubernetes Engine metrics for the Kubernetes Engine created by Data Flow. As with Kubernetes Engine, the metrics provided by default monitoring are data collected at one‑minute intervals.

Basic Metrics

The following are the default metrics for the Kubernetes Engine namespace.

The metrics whose names are displayed in bold below are the key metrics selected from the default metrics provided by Kubernetes Engine. Key metrics are used to build service dashboards that are automatically created for each service in ServiceWatch.

Each metric provides guidance in the user guide on which statistical values are meaningful when querying that metric, and among the meaningful statistics, the values shown in bold are the primary statistics. In the service dashboard, you can view key metrics using primary statistical values.

4.2 - How-to guides

Users can create the service by entering the required Data Flow information and selecting detailed options through the Samsung Cloud Platform Console.

Create Data Flow

You can create and use the Data Flow service in the Samsung Cloud Platform Console.

To create a Data Flow, follow these steps.

1. Click the All Services > Data Analytics > Data Flow menu. Navigate to the Service Home page of Data Flow.

2. On the Service Home page, click the Create Data Flow button. You will be taken to the Create Data Flow page.

3. On the Data Flow creation page, enter the information required to create the service and select detailed options.

   • Version selection area, select the required information.

     Category	Required or optional	Detailed description
     Data Flow version	Required	Select version of the selected image Provide a list of versions for the provided server image

     Table. Data Flow version selection item
   • Enter or select the required information in the Cluster Selection area. To install Data Flow, you must first create nodes for the Kubernetes cluster and the working environment.

     Category	Required status	Detailed description
     Cluster name	Required	Select the cluster to use
     Ingress Controller	Required	Select the Ingress Controller installed in the cluster In the Details tab of the installed Ingress Controller, add the following information to the ConfigMap entry. Key: allow-snippet-annotations Value: true

     Table. Data Flow cluster selection options
   • Enter or select the required information in the Service Information Input area.

     Category	Required	Detailed description
     Data Flow name	Required	Enter Data Flow name starting with a lowercase English letter and not ending with a special character (-), using lowercase English letters, numbers, and special characters (-) to input 3 ~ 30 characters
     Storage Class	Required	Select the storage class used by the selected cluster
     description	Select	Enter additional information or description about Data Flow within 150 characters.
     Domain Settings	Required	Enter Data Flow domain Start with a lowercase English letter and ensure it does not end with special characters (-), using lowercase letters, numbers, and special characters (-) to enter 3 ~ 50 characters {Data Flow name}.{configured domain} becomes the Data Flow access URL.
     Node Selector	Required	To install on a specific node, enter a distinguishable label among the node’s labels If you enter an incorrect node label, installation errors may occur, so verify the node label in advance Node labels can be found in the node’s yaml file
     account	Required	Enter Data Flow Manager account ID: Enter a value between 6 and 30 characters, starting with a lowercase English letter and using lowercase letters and numbers Password: Enter 8 to 50 characters, including uppercase letters, lowercase letters, numbers, and special characters (! @ # $ % ^ & *) Confirm Password: Re-enter the password exactly the same
     Host Alias	Selection	Add host information to be linked with Data Flow (up to 20 total, including defaults) Select Use, then click the + button Hostname: Enter a hostname or domain format using lowercase letters, numbers, and special characters (-) with a length of 3 to 63 characters IP: Enter in IP format Click the X button to delete The added host information can be used only if the firewall between the cluster and the server is open

     Table. Data Flow service information entry items
   • In the Additional Information Input area, enter or select the required information.

     Category	Required status	Detailed description
     tag	Selection	Add Tag Add Tag Click the button to create and add a tag, or add an existing tag. You can add up to 50 tags. The newly added tags will be applied after the service creation is completed.

     Table. Data Flow additional information input fields

4. Summary Check the detailed information and estimated billing amount generated in the panel, and click the Complete button.

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

Check detailed information of Data Flow

You can view and edit the full list of resources and detailed information of a Data Flow. The Data Flow Details page consists of Details, Tags, Activity Log tabs.

To view detailed information of the Data Flow, follow these steps.

1. Click the All Services > Data Analytics > Data Flow menu. Navigate to the Service Home page of Data Flow.
2. On the Service Home page, click the Data Flow menu. You will be taken to the Data Flow List page.
3. On the Data Flow List page, click the resource to view detailed information. You will be taken to the Data Flow Detail page.
   • Data Flow Details At the top of the page, status information and additional feature information are displayed.

     Category	Detailed description
     Status indicator	Data Flow status Creating: Creating Running: Running, Data Flow Services can be created Updating: Updating settings Terminating: Terminating Error: error occurred during creation or service abnormal state
     Hosts file configuration information	Button to view and copy the host file information for accessing Data Flow
     Service termination	Cancel Service button

     Table. Data Flow status information and additional functions

Detailed Information

On the Data Flow list page, you can view detailed information of the selected resource and edit the information if needed.

tag

Data Flow List page lets you view the tag information of the selected resource, and you can add, modify, or delete it.

Job History

You can view the operation history of the selected resource on the Data Flow List page.

Terminate Data Flow

You can cancel unused Data Flow to reduce operating costs. However, if you cancel a service, the running service may be terminated immediately, so you should thoroughly consider the impact of service interruption before proceeding with the cancellation.

To cancel the Data Flow, follow the steps below.

1. Click the All Services > Data Analytics > Data Flow menu. Navigate to the Service Home page of Data Flow.
2. On the Service Home page, click the Data Flow menu. You will be taken to the Data Flow List page.
3. On the Data Flow List page, select the resource to cancel, and click the Cancel Service button.
4. When termination is complete, check on the Data Flow List page whether the resource has been terminated.

4.2.1 - Data Flow Services

Users can create the service by entering the required information for Data Flow Services within the Data Flow service through the Samsung Cloud Platform Console and selecting detailed options.

Creating Data Flow Services

Users can add a service by selecting detailed options for Data Flow or by entering configuration values.

To create Data Flow Services, follow these steps.

1. Click the All Services > Data Analytics > Data Flow menu. You will be taken to the Data Flow Service Home page.

2. From the Service Home page, click Data Flow Servies. Navigate to the Data Flow Services list page.

3. On the Data Flow Services List page, click the Data Flow Services Create button. You will be taken to the Data Flow Services Create page.

4. Data Flow Services Creation page: enter the information required to create the service and select detailed options.

   • Enter or select the required information in the Service Information Input area.

     Category	Required	Detailed description
     Data Flow name	Required	Select Data Flow
     Flow Service name	Required	Enter Data Flow Services name Start with a lowercase English letter and ensure it does not end with a special character (-), using lowercase letters, numbers, and special characters (-) to enter 3 to 30 characters
     Storage Class	Required	Select the storage class used by the selected cluster
     description	Selection	Enter additional information or description about Data Flow Services within 150 characters.
     Domain Settings	Required	Data Flow Services domain input Start with a lowercase English letter and ensure it does not end with a special character (-), using lowercase letters, numbers, and special characters (-) to enter 3 to 50 characters {Data Flow Services name}.{configured domain} becomes the Data Flow Services access URL.
     Node Selector	Required	To install on a specific node, enter a distinguishable label among the node’s Labels If you enter an incorrect node label, installation errors may occur, so verify the node label in advance The node label can be found in the node’s yaml file
     Service Workload	Required	Nifi: Module that provides Apache Nifi’s services and UI Nifi Registry: Module that configures and deploys Nifi templates Zookeeper: Module that supports proper distributed processing of Nifi across multiple nodes
     account	Required	Enter Nifi account ID: Enter a value between 6 and 30 characters, starting with a lowercase English letter and using lowercase letters and numbers Password: Enter 8 to 50 characters, including uppercase letters, lowercase letters, numbers, and special characters(!@#$%^&*) Confirm Password: Re-enter the password exactly the same

     Table. Data Flow Services service information input items
   • In the Additional Information Input area, enter or select the required information.

     Category	Required	Detailed description
     Host Alias	Selection	Add host information to be linked with Data Flow (up to 20 total, including defaults) Select Use, then click the + button Hostname: Enter a hostname or domain format using lowercase letters, numbers, and special characters (-) with a length of 3 to 63 characters IP: Enter in IP format To delete, click the X button The added host information can be used only if the firewall between the cluster and the server is open
     tag	Selection	Add Tag Add Tag Click the button to create and add a tag, or add an existing tag. You can add up to 50 tags. The newly added tags will be applied after the service creation is completed.

     Table. Data Flow additional information input fields

5. Summary Verify the detailed information and estimated billing amount generated in the panel, then click the Complete button.

   • Once creation is complete, check the created resources on the Data Flow Services List page.