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 from the Samsung Cloud Platform Console.

To create Event Streams, follow these steps.

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 Create Event Streams button. 2. Go to the Create Event Streams page.

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

   • In the Image and version selection area, select the required information.

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

     Table. Event Streams service information input items
   • Enter or select the required information in the Service Information Input area.

     Category	Required status	Detailed description
     Server name Prefix	Required	Server name where Apache Kafka will be installed must start with a lowercase English letter, and using lowercase letters, numbers, and the special character (-) 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
     Broker > Number of Broker Nodes	Required	Number of Broker Nodes
     Broker > Server Type	Required	Server type on which the Broker will be installed 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 서버 타입
     Broker > 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 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 ~ 5,120
     Zookeeper separate installation > use	Selection	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	Selection	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	Selection	Status of resources with Planned Compute configured In Use: Number of resources with Planned Compute configured that are currently in use Configured: Number of resources with Planned Compute configured Coverage preview: Amount applied per resource by Planned Compute Planned Compute Service Application: Go to the Planned Compute service application page For more details, refer to Planned Compute 신청하기
     Zookeeper separate 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 standard volume HDD: Standard 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	AKHQ installation status if you select Use, install AKHQ
     AKHQ > Server Type	Required	Server type on which AKHQ will be installed AKHQ provides only vCPU 2, Memory 4G type
     AKHQ > 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 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 Basic OS: the area where the engine is installed
     AKHQ > AKHQ account	Required	AKHQ account Enter using lowercase English letters, 2 to 20 characters
     AKHQ > AKHQ password	Required	AKHQ account password English letters, numbers, and special characters (“ ‘ excluded) including 8 ~ 30 characters
     AKHQ > AKHQ Password verification	Required	Confirm AKHQ account password Re-enter the AKHQ account password identically
     AKHQ > AKHQ Port number	Required	AKHQ access port number The port number is automatically set to 8080 and cannot be changed
     Network > Common Settings	Required	Network settings where servers generated by the service are installed Select when you want to apply the same settings to all installed servers Select a pre‑created VPC and Subnet Each server’s IP is generated automatically Public NAT settings are only possible in per‑server configuration
     Network > Server-specific Settings	Required	Network settings where servers generated by the service are installed Select when you want to apply different settings per installed server Select a pre‑created VPC and Subnet IP: Enter each server’s IP Public NAT feature is available only when the VPC is connected to an Internet Gateway; checking use allows selection from reserved IPs in the VPC product’s Public IP. For more 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, 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	Selection	Event Streams maintenance period If you select Use, you can set the day, start time, and duration The maintenance period is a feature that allows the user to set the time window for performing patch operations, and any patch work within that window must be performed directly by the user. We ask you to set a maintenance period for the stable operation of the system, and we are not responsible for any issues arising from not setting it or from not performing tasks within the period.

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

     	Required status	Detailed description
     Zookeeper SASL account	Required	Zookeeper account Enter using lowercase English letters, 2 to 20 characters
     Zookeeper SASL password	Required	Enter the Zookeeper account password including English letters, numbers, and special characters (excluding “ ‘) with a length of 8 to 30 characters.
     Check Zookeeper SASL password	Required	Check Zookeeper account password Re-enter the Zookeeper SASL account password identically
     Zookeeper Port number	Required	Zookeeper port number 1200 ~ 65535 can be entered as one of, Broker port or 2888, 3888 cannot be used
     Broker SASL account	Required	Kafka access account enter using lowercase English letters, within 2 ~ 20 characters
     Broker SASL password	Required	Kafka login account password English letters, numbers, and special characters (“ ‘ excluded) including 8 to 30 characters
     Check Broker SASL password	Required	Verify the 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	Selection	The standard time zone for the service
     ServiceWatch log collection	Selection	ServiceWatch log collection status Select Use to configure the ServiceWatch log collection feature Provided free up to 5 GB for all services within the Account, and charges apply based on storage size for usage exceeding 5 GB When collected, log groups and log streams are created automatically and 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. Event Streams Database required configuration input items
   • In the Additional Information Input area, enter or select the required information.

     	Required status	Detailed description
     tag	Selection	Add tags Add tags Click the button to create and add tags, or add existing tags 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 items

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

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

Check detailed information of Event Streams

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

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

1. All Services > Data Analytics > Event Streams Please 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. Navigate to the Event Streams Details page.
   • Event Streams Details At the top of the page, status information and additional feature information are displayed.

     	Detailed description
     Cluster status	Cluster status Creating: The cluster is being created Editing: The cluster is changing to an operational state Error: The cluster encountered a failure while performing a task If it occurs continuously, contact the administrator Failed: The cluster failed during the creation process 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 being stopped Synchronizing: The cluster is synchronizing Terminating: The cluster is being terminated Unknown: The cluster status is unknown If it occurs continuously, contact the administrator Upgrading: The cluster is transitioning to an upgrading state
     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 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 lets you view detailed information of the selected resource and edit the information if needed.

tag

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

Job History

Event Streams 목록 page allows you to view the operation history of the selected resource.

Event Streams Managing 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 상세 정보 page.

Operation Control

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. Go 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 control its operation. 3. Navigate to the Event Streams Details page.
4. Check the Event Streams status and complete the changes using the control buttons below.
   • Start: Event Streams service is installed on the server and the Event Streams service is running (Running).
   • Stop: The server on which 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. Navigate to the Event Streams list page.
3. Event Streams List page, click the resource to view the service status. 3. Navigate to the Event Streams Details page.
4. Click the Service status synchronization button. 4. The query takes a short amount of time, and while it is being retrieved, the cluster changes to Synchronizing state.
5. Once the query is completed, the status in the server information item is updated, and the cluster changes to Running state.

Managing Parameters

Provides parameter lookup and modification functionality.

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

1. All Services > Data Analytics > Event Streams menu, click it. 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 whose parameters you want to view and edit. 3. Event Streams Details navigate to the page.
4. Parameter Management Click the 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 the query.
7. To edit the Parameter information, click the Edit button and then enter the changes in the custom value area of the Parameter you wish to edit.
   • Application type is dynamic, it takes effect immediately, while static requires a service restart, 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. Go to the Event Streams list page.
3. On the Event Streams list page, click the resource to change the server type. 3. Navigate 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 The popup window opens.
5. Server Type Edit In the popup window, after selecting the server type, 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 Event Streams, and if it is configured as a cluster, all nodes are expanded simultaneously.

To increase storage capacity, follow the steps below.

1. All Services > Data Analytics > 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. Event Streams list On this page, click the resource whose server type you want to change. 3. Navigate to the Event Streams Details page.
4. Click the Edit button of the added Disk you want to expand at the bottom of the detailed information. 4. Disk Edit The popup window opens.
5. Disk Edit in the popup window, after entering the additional capacity, 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 any server downtime, and the existing data is automatically redistributed.

To add a Broker node, 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. Event Streams resource Click the resource you want to recover on the list page. 3. Event Streams Details page is opened.
4. Click the Add Broker Node button. 4. Navigate 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	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.
   Number of additional nodes	Required	Number of Nodes to add Use up to 10 nodes per cluster
   Service Type > Server Type	Required	Server type where the Broker will be installed It is set to be the same as the server type configured in the original cluster.
   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 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 on the Broker node The storage type and capacity set in the original cluster are applied identically
   Network	Required	the network where the servers are installed applied identically to the network configured in the original cluster

   Table. Event Streams Broker Node additional items

Terminate Event Streams

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

To cancel Event Streams, follow these steps.

1. All Services > Data Analytics > Event Streams Click the menu. 1. Go 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. Event Streams List page, select the resource to cancel, and click the Service Cancel button.
4. Once the termination is complete, check on the Event Streams list page whether the resource has been terminated.