How-to guides

The user can enter the necessary information of Event Streams through the Samsung Cloud Platform Console and create the service by selecting detailed options.

Creating Event Streams

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

To create Event Streams, follow these procedures.

1. Click All services > Data Analytics > Event Streams menu. It moves to the Service Home page of Event Streams.

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

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

   • Image and Version Selection area, please select the necessary information.

     Classification	Necessity	Detailed Description
     Image Version	Required	Provides a list of Event Streams versions

     Table. Event Streams service information input items

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

     Classification	Necessity	Detailed Description
     Server Name Prefix	Required	The server name where Apache Kafka will be installed Starts with lowercase English letters, and uses lowercase letters, numbers, and special characters(-) to input 3 ~ 13 characters A postfix such as 001, 002 is attached based on the server name to create the actual server name
     Cluster Name	Required	Name of the cluster that the servers are configured in Enter in English, 3-20 characters A cluster is a unit that bundles multiple servers
     Broker > Broker Node count	required	Broker Node count
     Broker > Server Type	Required	The type of server on which the Broker will be installed Standard: Standard specification commonly used High Capacity: High-capacity server with 24vCore or more For more information about the server types provided by Event Streams, see Event Streams server types
     Broker > Planned Compute	Selection	Current status of resources with Planned Compute set In use: Number of resources with Planned Compute set that are currently in use Settings: Number of resources with Planned Compute set Coverage preview: Amount applied by resource-based Planned Compute Apply for Planned Compute service: Move to the Planned Compute service application page For more information, see How to apply for Planned Compute
     Broker > Block Storage	Required	Block Storage type to be used for Broker node Base OS: Area where the engine is installed DATA: Area for storing data files Please select the storage type and enter the capacity. (For more information on each Block Storage type, see Creating 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 key Capacity should be entered in multiples of 8 within the range of 16 to 5,120
     Zookeeper separate installation > use	selection	Whether to install Zookeeper node separately Use is selected, Zookeeper nodes are installed separately. If Zookeeper nodes are not installed separately, Broker nodes also perform the Zookeeper role.
     Zookeeper separate installation > Server type	Selection	The server type where Zookeeper will be installed Zookeeper node provides vCPU 1, Memory 2G or vCPU 2, Memory 4G
     Zookeeper separate installation > Planned Compute	selection	Current status of resources with Planned Compute set In use: Number of resources in use among those with Planned Compute set Settings: Number of resources with Planned Compute set Coverage preview: Amount applied by resource-based Planned Compute Apply for Planned Compute service: Move to the Planned Compute service application page For more details, refer to Apply for Planned Compute
     Zookeeper separate installation > Block Storage	required	Block Storage type to be used for Zookeeper node Basic OS: area where the engine is installed DATA: area for storing data files After selecting the storage type, enter the capacity. (For more information on each Block Storage type, see Creating 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 key Capacity should be entered in multiples of 8 within the range of 16 to 5,120
     AKHQ > Use	Required	Whether AKHQ is installed Use is selected, AKHQ will be installed.
     AKHQ > Server Type	Required	The type of server where AKHQ will be installed AKHQ only provides vCPU 2, Memory 4G type
     AKHQ > Planned Compute	Selection	Current status of resources with Planned Compute set In use: Number of resources with Planned Compute set that are in use Settings: Number of resources with Planned Compute set Coverage preview: Amount applied by resource-based Planned Compute Apply for Planned Compute service: Move to the Planned Compute service application page For more information, see Apply for Planned Compute
     AKHQ > Block Storage	required	The type of Block Storage to be used on the server where AKHQ will be installed Basic OS: The area where the engine is installed
     AKHQ > AKHQ account	required	AKHQ account Use lowercase English letters to enter 2-20 characters
     AKHQ > AKHQ password	required	AKHQ account password Enter 8-30 characters, including English, numbers, and special characters (excluding " ’)
     AKHQ > AKHQ password confirmation	required	AKHQ account password confirmation 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 if you want to apply the same settings to all servers being installed Select pre-created VPC and Subnet IP: Only automatic creation is possible Public NAT settings are only possible in server-specific settings.
     Network > Server-specific settings	Required	Network settings for installing servers created by the service Select to apply different settings for each server being installed Select pre-created VPC and Subnet IP: Enter the IP for each server Public NAT feature is available only when the VPC is connected to the Internet Gateway, checking Use allows selection from the reserved IP in the VPC product’s Public IP. For more information, see Creating Public IP
     IP Access Control	Select	Set service access policy Set access policy for IP entered on the page, so you don’t need to set Security Group policy separately. 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 the entered IP, click the x button next to the entered IP
     Maintenance period	Select	Event Streams maintenance period Use Select the day, start time, and duration It is recommended to set the maintenance period for stable management of the service. Patch work will be carried out at the set time and service interruption may occur Issues caused by not applying patches (setting to not in use) are not the responsibility of our company

     Table. Event Streams Service Configuration Items

   • Database Configuration Required Information Input area, please enter or select the required information.

     Classification	Necessity	Detailed Description
     Zookeeper SASL account	required	Zookeeper account Use lowercase English letters, 2-20 characters
     Zookeeper SASL password	required	Zookeeper account password Enter 8-30 characters including English, numbers, and special characters (excluding " ’)
     Zookeeper SASL password confirmation	required	Confirm Zookeeper account password Re-enter the Zookeeper SASL account password identically
     Zookeeper Port number	required	Zookeeper port number 1,024 ~ 65,535 can be entered as one of them, and Broker port or 2888, 3888 cannot be used
     Broker SASL account	required	Kafka connection account Enter within 2-20 characters using lowercase English letters
     Broker SASL password	required	Kafka connection account password Enter 8-30 characters, including English, numbers, and special characters (excluding " ’)
     Broker SASL password confirmation	required	Kafka connection account password confirmation Re-enter the Broker SASL account password identically
     Broker Port number	required	Kafka port number 1,024 ~ 65,435 can be entered as one of them, and Broker port or 2888, 3888 cannot be used
     Parameter	Required	Event Streams configuration parameters Inquiry button can be clicked to check detailed information of parameters Parameter modification is possible after service creation is completed, and restart is required when modified
     Time Zone	Selection	Standard Time Zone where the service will be used

     Table. Essential information input items for Event Streams Database configuration

   • Enter Additional Information Enter or select the required information in the area.

     Classification	Necessity	Detailed Description
     Tag	Selection	Tag addition Tag addition button to create and add tags or add existing tags Up to 50 tags can be added Newly added tags are applied after service creation is completed

     Table. Event Streams service additional information input items

4. In the Summary panel, review the detailed information and estimated charges, and click the Complete button.

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

Event Streams detailed information check

The Event Streams service allows you to view and modify the list of all resources and detailed information. The Event Streams details page consists of Details, Tags, Activity tabs.

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

1. Click All services > Data Analytics > Event Streams menu. It moves to the Service Home page of Event Streams.
2. On the Service Home page, click the Event Streams menu. It moves to the Event Streams list page.
3. Event Streams list page, click on the resource to check the detailed information. Move to the Event Streams details page.
   • Event Streams details page top shows status information and additional function information.

Detailed Information

On the Event Streams list page, you can check the detailed information of the selected resource and modify the information if necessary.

Tag

On the Event Streams list page, you can check the tag information of the selected resource, and add, change, or delete it.

Work History

You can check the operation history of the selected resource on the Event Streams list page.

Managing Event Streams Resources

If you need to change the existing setup options for the generated Event Streams resource or manage Parameters, or configure additional Broker Nodes, you can perform the task from the Event Streams details page.

Operating Control

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

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

1. Click All services > Data Analytics > Event Streams menu. It moves to the Service Home page of Event Streams.
2. On the Service Home page, click the Event Streams menu. It moves to the Event Streams list page.
3. Event Streams list page, click the resource to control the operation. Move to the Event Streams details page.
4. Check the status of Event Streams and complete the change through the control buttons below.
   • Start: The server where the Event Streams service is installed and the Event Streams service is running.
   • 중지: Event Streams service installed server and Event Streams service will be stopped.
   • Restart: Only the Event Streams service will be restarted.

Synchronizing 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 procedures.

1. Click All services > Data Analytics > Event Streams menu. It moves to the Service Home page of Event Streams.
2. On the Service Home page, click the Event Streams menu. It moves to the Event Streams list page.
3. On the Event Streams list page, click the resource to query the service status. It moves to the Event Streams details page.
4. Service Status Synchronization button should be clicked. It takes a little time to retrieve, and during retrieval, the cluster changes to Synchronizing status.
5. Once the inquiry is completed, the status of the server information item is updated, and the cluster is changed to the Running state.

Managing Parameters

It provides parameter inquiry and modification functions.

To view or modify the configuration parameters, follow these steps.

1. 모든 서비스 > Data Analytics > Event Streams menu should be clicked. It moves to the Service Home page of Event Streams.
2. Service Home page, click the Event Streams menu. It moves to the Event Streams list page.
3. Event Streams list page, click the resource you want to query and modify parameters. It moves to the Event Streams detail page.
4. Click the Parameter Management button. It moves to the Parameter Management page.
5. On the Parameter Management page, click the Search button. The Database Search popup window opens.
6. To inquire about parameter information, click the Confirm button. It may take some time to retrieve.
   • You can modify the Parameter information after performing the inquiry.
7. To modify the Parameter information, click the Modify button and enter the modification details in the Custom Value area of the Parameter to be modified.
   • If the application type is dynamic, it is reflected immediately, and if it is static, a service restart is required, so the service is stopped.
8. When the input is complete, click the Save button.

Changing the Server Type

You can change the configured server type.

To change the server type, follow these steps.

1. Click All services > Data Analytics > Event Streams menu. It moves to the Service Home page of Event Streams.
2. On the Service Home page, click the Event Streams menu. It moves 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. It moves to the Event Streams detail page.
4. Click the Edit button of the server type you want to change at the bottom of the detailed information. The Server Type Edit popup window opens.
5. Server Type Modification In the server type modification popup window, select the server type and click the OK button.

Expanding Storage

The storage added to the data area can be expanded up to a maximum of 5TB based on the initially allocated capacity. Storage can be expanded without interrupting Event Streams, and if configured as a cluster, all nodes are expanded simultaneously.

To increase the storage capacity, follow the next procedure.

1. Click All services > Data Analytics > Event Streams menu. It moves to the Service Home page of Event Streams.
2. Service Home page, click the Event Streams menu. It moves 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. It moves to the Event Streams details page.
4. Click the Edit button of the additional Disk you want to add at the bottom of the detailed information. The Disk Edit popup window opens.
5. In the Disk Modification popup window, enter the expansion capacity and click the Confirm button.

Add Broker Node

If Event Streams cluster expansion is needed, nodes can be added with the same specifications as the Broker Node in use. The added nodes are added to the existing cluster without server downtime, and the existing data is automatically distributed.

To add a Broker node, follow these steps.

1. Click All services > Data Analytics > Event Streams menu. It moves to the Service Home page of Event Streams.
2. On the Service Home page, click the Event Streams menu. It moves to the Event Streams list page.
3. Event Streams Resource Click the resource you want to recover from the list page of Event Streams Resources. It moves to the Event Streams Details page.
4. Click the Add Broker Node button. It moves to the Add Broker Node page.
5. Required Information Input area, enter the corresponding information, and then click the Complete button.

Cancel Event Streams

You can cancel unused Event Streams to reduce operating costs. However, when canceling the service, the operating service may be stopped immediately, so you should consider the impact of stopping the service sufficiently before proceeding with the cancellation work.

To cancel Event Streams, follow these procedures.

1. Click All services > Data Analytics > Event Streams menu. It moves to the Service Home page of Event Streams.
2. Service Home page, click the Event Streams menu. It moves to the Event Streams list page.
3. Event Streams list page, select the resource to be canceled and click the Service Cancellation button.
4. Once the cancellation is complete, check if the resource has been cancelled on the Event Streams listing page.