This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

How-to guides

    The user can enter the required information for Event Streams through the Samsung Cloud Platform Console, select detailed options, and create the service.

    Event Streams Create

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

    Notice

    Before creating the service, please configure the VPC’s Subnet type as General.

    • If the Subnet type is Local, the creation of the corresponding Database service is not possible.

    To create Event Streams, follow these steps.

    1. Click the All Services > Data Analytics > Event Streams menu. Navigate to the Service Home page of Event Streams.
    2. On the Service Home page, click the Create Event Streams button. You will be taken to the Create Event Streams page.
    3. Create Event Streams page, enter the information required to create the service, and select detailed options.
    • Image and version selection area, select the required information.
      Category
      Required or not
      Detailed description
      Image versionRequiredProvide version list of Event Streams
      Table. Event Streams Service Information Input Items
      • Service Information Input area, input or select the required information.
        Category
        Required or not
        Detailed description
        Server Name PrefixRequiredServer name where Apache Kafka will be installed
        • Start with a lowercase English letter, and use lowercase letters, numbers, and the special character (-) to input 3 to 13 characters
        • A postfix such as 001, 002 is attached based on the server name to create the actual server name
        Cluster NameRequiredCluster name of the servers
        • Enter using English letters, 3 ~ 20 characters
        • A cluster is a unit that groups multiple servers
        Broker > Broker Node countrequiredBroker Node count
        Broker > Server TypeRequiredServer type where the Broker will be installed
        • Standard: Standard specifications commonly used
        • High Capacity: Large-capacity server with 24 vCore or more
        Broker > Planned ComputeSelectStatus of resources with Planned Compute set
        • In Use: Number of resources with Planned Compute set that are currently in use
        • Configured: Number of resources with Planned Compute set
        • Coverage Preview: Amount applied by Planned Compute per resource
        • Apply for Planned Compute Service: Go to the Planned Compute service application page
        Broker > Block StorageRequiredBlock Storage type to be used for the Broker node
        • Base OS: Area where the engine is installed
        • DATA: Data file storage area
          • Select the storage type and then enter the capacity. (For detailed information 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 Samsung Cloud Platform KMS (Key Management System) encryption key
          • Enter capacity as a multiple of 8 within the range 16 ~ 5,120
        Zookeeper separate installation > UseSelectZookeeper node separate installation option
        • If Use is selected, install Zookeeper node separately
        • If Zookeeper node is not installed separately, the Broker node also performs the Zookeeper role
        Zookeeper separate installation > server typeselectServer type where Zookeeper will be installed
        • Zookeeper node provides vCPU 1, Memory 2G or vCPU 2, Memory 4G
        Zookeeper separate installation > Planned ComputeSelectStatus of resources with Planned Compute set
        • In use: Number of resources with Planned Compute set that are currently in use
        • Configured: Number of resources with Planned Compute set
        • Coverage preview: Amount applied per resource by Planned Compute
        • Apply for Planned Compute service: Go to Planned Compute service application page
        Zookeeper separate installation > Block StorageRequiredBlock Storage type to be used on Zookeeper nodes
        • Base OS: Area where the engine is installed
        • DATA: Data file storage area
          • Select the storage type and then enter the capacity. (For detailed information on each Block Storage type, refer to 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 keys
          • Enter capacity as a multiple of 8 within the range 16 to 5,120
        AKHQ > UseRequiredAKHQ installation status
        • If Use is selected, AKHQ will be installed
        AKHQ > Server TypeRequiredServer type where AKHQ will be installed
        • AKHQ only provides vCPU 2, Memory 4G type
        AKHQ > Planned ComputeSelectStatus of resources with Planned Compute set
        • In use: Number of resources with Planned Compute that are currently in use
        • Configured: Number of resources with Planned Compute set
        • Coverage preview: Amount applied per resource by Planned Compute
        • Apply for Planned Compute service: Go to the Planned Compute service application page
        AKHQ > Block StorageRequiredBlock Storage type to be used on the server where AKHQ is installed
        • Base OS: Area where the engine is installed
        AKHQ > AKHQ accountRequiredAKHQ account
        • Enter using lowercase English letters, 2 to 20 characters
        AKHQ > AKHQ passwordRequiredAKHQ account password
        • Enter 8 ~ 30 characters including English letters, numbers and special characters (excluding “ ‘)
        AKHQ > AKHQ Password ConfirmationRequiredAKHQ Account Password Confirmation
        • Re-enter the same AKHQ account password
        AKHQ > AKHQ Port NumberRequiredAKHQ connection port number
        • Port number is automatically set to 8080 and cannot be modified
        Network > Common SettingsRequiredNetwork settings where servers generated by the service are installed
        • Choose if 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 settings
        Network > Per-Server SettingsRequiredNetwork 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 each server’s IP
        • Public NAT feature is available only when the VPC is connected to an Internet Gateway; if you check Use, you can select from reserved IPs in the VPC product’s Public IP. For details, see Create Public IP
        IP Access ControlSelectService Access Policy Settings
        • Since the access policy is set for the IP entered on the page, you do not need to separately configure Security Group policies.
        • 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 PeriodSelectEvent Streams Maintenance Period
        • Select Use to set day of week, start time, and duration
        • It is recommended to set a maintenance period for stable service management. Patch work will be performed at the set time, and service interruption may occur
        • We are not responsible for issues arising from patches not applied (set as not used)
        Table. Event Streams service configuration items
    • Database configuration required information input Please enter or select the required information in this area.
      Category
      Required or not
      Detailed description
      Zookeeper SASL accountRequiredZookeeper account
      • Enter using lowercase English letters, 2 ~ 20 characters
      Zookeeper SASL passwordRequiredZookeeper account password
      • Enter 8 to 30 characters including letters, numbers, and special characters (excluding )
      Zookeeper SASL password verificationRequiredZookeeper account password verification
      • Re-enter the Zookeeper SASL account password identically
      Zookeeper Port numberrequiredZookeeper port number
      • 1200 ~ 65535 can be entered, but the Broker port or 2888, 3888 cannot be used
      Broker SASL AccountRequiredKafka connection account
      • Enter using lowercase English letters, 2 to 20 characters
      Broker SASL passwordRequiredKafka connection account password
      • Enter 8 to 30 characters including English letters, numbers, and special characters (excluding “ and ‘)
      Broker SASL password verificationRequiredCheck Kafka connection account password
      • Re-enter the Broker SASL account password identically
      Broker Port numberRequiredKafka port number
      • 1200 ~ 65535 can be entered, and Broker port or 2888, 3888 cannot be used
      ParameterRequiredEvent Streams configuration parameters
      • View button click to view detailed information of the parameter
      • Parameters can be modified after the service creation is completed, and a restart is required when modified
      Time zoneSelectionStandard time zone used by the service
      ServiceWatch log collectionSelectWhether to collect ServiceWatch logs
      • Select Use to set up the ServiceWatch log collection feature
      • Provided free up to 5 GB for all services within the account, and charges apply based on storage size if exceeding 5 GB
      • When collecting, log groups and log streams are automatically created and cannot be deleted until the resources are removed
      • To prevent exceeding 5 GB, direct deletion of log data or shortening the retention period is recommended
      Table. Required information input items for Event Streams Database configuration
      • Additional Information Input Enter or select the required information in the area.
        Category
        Required or not
        Detailed description
        TagSelectAdd Tag
        • Add Tag button can be clicked to create and add a tag, or add an existing tag
        • Up to 50 tags can be added
        • Added new tags are applied after the service creation is completed
        Table. Event Streams Service Additional Information Input Items
    1. Summary Check the detailed information and estimated billing amount generated in the panel, and click the Create button.
      • Once creation is complete, check the created resource on the Resource List page.

    Event Streams Check Detailed Information

    Event Streams service can view and edit the full resource list and 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 Click the menu. Navigate to the Service Home page of Event Streams.
    2. On the Service Home page, click the Event Streams menu. It navigates to the Event Streams List page.
    3. Click the resource to view detailed information on the Event Streams List page. It navigates to the Event Streams Details page.
      • Event Streams Details The top of the page displays status information and information about additional features.
        CategoryDetailed description
        Cluster StatusCluster Status
        • Creating: Cluster is being created
        • Editing: Cluster is changing to a state of performing operation
        • Error: Cluster is in a state where a failure occurred while performing a task
          • If it occurs continuously, contact the administrator
        • Failed: Cluster is in a failed state during creation
        • Restarting: Cluster is restarting
        • Running: Cluster is operating normally
        • Starting: Cluster is starting
        • Stopped: Cluster is stopped
        • Stopping: Cluster is being stopped
        • Synchronizing: Cluster is synchronizing
        • Terminating: Cluster is terminating
        • Unknown: Cluster status is unknown
          • If it occurs continuously, contact the administrator
        • Upgrading: Cluster is changing to an upgrade execution state
        Cluster ControlButton to change cluster state
        • Start: Start a stopped cluster
        • Stop: Stop a running cluster
        • Restart: Restart a running cluster
        More additional featuresCluster-related management button
        • Service status synchronization: Can query current server status and synchronize to the Console
        • Parameter management: Can view and modify service configuration parameters
        • Add Broker Node: Add a Broker Node
          • If configured as a cluster, the Add Broker Node button is displayed
        Service terminationButton to cancel the service
        Table. Event Streams status information and additional features

    Detailed Information

    Event Streams list page you can view the detailed information of the selected resource and, if necessary, edit the information.

    CategoryDetailed description
    Server InformationServer information configured in the respective cluster
    • Category: Server type (Zookeeper&Broker,Broker, Zookeeper, AKHQ)
    • Server Name: Server name
    • IP:Port: Server IP and port
    • NAT IP: NAT IP
    • Status: Server status
    serviceservice name
    Resource TypeResource Type
    SRNUnique resource ID in Samsung Cloud Platform
    • Means cluster SRN
    Resource NameResource Name
    • means cluster name
    Resource IDUnique resource ID in the service
    CreatorUser who created the service
    Creation Date/TimeService Creation Date/Time
    ModifierUser who edited the service information
    Modification Date/TimeDate/Time Service Information Was Modified
    Image VersionInstalled service image and version information
    • Click the Edit button to upgrade the version
    Cluster NameName of the cluster composed of servers
    Planned ComputeResource status with Planned Compute set
    Maintenance PeriodPatch Work Period Setting Status
    • If maintenance period setting is required, click the Edit button to set
    Time ZoneStandard time zone used by the service
    Zookeeper Port NumberZookeeper Port Number
    Broker Port numberKafka port number
    AKHQ connection informationAKHQ connection information
    ServiceWatch log collectionServiceWatch log collection configuration status
    • If log collection configuration is required, click the Edit button next to log collection to set it
    NetworkInstalled network information (VPC, Subnet)
    IP Access ControlService Access Policy Settings
    • If you need to add or delete an IP, click the Edit button to set
    ZookeeperServer type, default OS, additional Disk information for Zookeeper node
    • If you need to modify the server type, click the Edit button next to the server type to set it
      • Modifying the server type requires a server restart
    • If you need to expand storage, click the Edit button next to the storage capacity to expand
    BrokerServer type, default OS, additional Disk information for the Broker node
    • If you need to modify the server type, click the Edit button next to the server type to set it
      • Modifying the server type requires a server restart
    • If storage expansion is needed, click the Edit button next to the storage capacity to expand
    AKHQServer type and basic OS information for AKHQ node
    • If you need to modify the server type, click the Edit button next to the server type to set it
      • Modifying the server type requires a server restart
    Table. Event Streams detailed information items

    Tag

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

    CategoryDetailed description
    Tag ListTag List
    • You can view the Key, Value information of tags
    • Up to 50 tags can be added per resource
    • When entering tags, search and select from the previously created Key and Value list
    Table. Event Streams Tag Tab Items

    Work History

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

    CategoryDetailed description
    Work History ListResource Change History
    • Work details, work date/time, resource type, resource ID, resource name, event topic, work result, worker information verification
    • Detailed Search button provides detailed search function
    Table. Event Streams Job History Tab Detailed Information Items

    Event Streams Resource Management

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

    Operating Control

    If changes occur to the running Event Streams resources, you can start, stop, or restart.

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

    1. All Services > Data Analytics > Event Streams Click the menu. Navigate to the Service Home page of Event Streams.
    2. Click the Event Streams menu on the Service Home page. Navigate to the Event Streams List page.
    3. On the Event Streams List page, click the resource to control operation. It navigates to the Event Streams Details page.
    4. Check the Event Streams status and complete the changes using the control button below.
      • Start: the server where the Event Streams service is installed and the Event Streams service is 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 the steps below.

    1. All Services > Data Analytics > Event Streams Click the menu. Navigate to the Service Home page of Event Streams.
    2. Click the Event Streams menu on the Service Home page. Navigate to the Event Streams List page.
    3. Event Streams list 페이지에서 서비스 상태를 조회할 자원을 클릭하세요. Event Streams details 페이지로 이동합니다.
    4. Click the Service Status Synchronization button. It takes a little time to retrieve, and while retrieving, the cluster changes to Synchronizing state.
    5. When the query is completed, the status in the server information item is updated, and the cluster changes to Running state.

    Parameter Management

    Provides parameter query and modification functions.

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

    1. All Services > Data Analytics > Event Streams Click the menu. Navigate to the Service Home page of Event Streams.
    2. Click the Event Streams menu on the Service Home page. Navigate to the Event Streams List page.
    3. Event Streams List Click the resource whose parameters you want to view and edit on the page. Event Streams Details You will be moved to the page.
    4. Click the Parameter Management button. You will be taken to the Parameter Management page.
    5. Parameter Management on the page, click the Search button. Database Search popup window opens.
    6. To view the Parameter information, click the Confirm button. It takes a little time to retrieve.
      • 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 area of the Parameter to be edited.
    • When the application type is dynamic, it is applied immediately, and when it is static, a service restart is required, causing service interruption.
    1. When input is complete, click the Save button.

    Change Server Type

    You can change the configured server type.

    To change the server type, follow the steps below.

    Caution
    • If the server type is configured as Standard, it cannot be changed to High Capacity. If you want to change to High Capacity, create a new service.
    • If you modify the server type, a server reboot is required. Please separately verify any SW license changes or SW settings and reflections due to spec changes.
    1. Click the All Services > Data Analytics > Event Streams menu. Navigate to the Service Home page of Event Streams.
    2. Click the Event Streams menu on the Service Home page. Navigate to the Event Streams list page.
    3. On the Event Streams list page, click the resource to change the server type. You will be taken to the Event Streams details page.
    4. Click the Edit button of the server type you want to change at the bottom of the detailed information. The 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

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

    Notice
    • If encryption is set on the existing Block Storage, encryption will also be applied to the additional Disk.
    • Disk size modification is only possible to increase by at least 16GB over the current disk size.

    To increase storage capacity, follow the steps below.

    1. All Services > Data Analytics > Event Streams Click the menu. Navigate to the Service Home page of Event Streams.
    2. Click the Event Streams menu on the Service Home page. Navigate to the Event Streams List page.
    3. On the Event Streams list page, click the resource whose server type you want to change. You will be taken 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. The Disk Edit popup window opens.
    5. Disk edit In the popup window, after entering the expanded capacity, click the Confirm button.

    Add Broker Node

    If Event Streams cluster expansion is required, you can add nodes with the same specifications as the Broker Node you are using. The added nodes are added to the existing cluster without server downtime, and the existing data is automatically distributed.

    Notice
    • Up to 10 nodes can be used within the cluster. Please note that additional charges apply for created nodes.
    • Adding nodes may degrade cluster performance.

    To add a Broker node, follow the steps below.

    1. All Services > Data Analytics > Event Streams Click the menu. Navigate to the Service Home page of Event Streams.
    2. On the Service Home page, click the Event Streams menu. Navigate to the Event Streams list page.
    3. Event Streams resource On the list page, click the resource you want to recover. Event Streams details page will be opened.
    4. Click the Broker Node Add button. Navigate to the Broker Node Add page.
    5. Enter required information after entering the relevant information in the area, click the Complete button.
      Category
      Required
      Detailed description
      Server NameRequiredServer name where Broker is installed
      • It is set to the server name configured in the original cluster.
      Cluster NameRequiredCluster Name
      • It will be set to the cluster name set in the original cluster.
      Number of additional NodesRequiredNumber of Nodes to add
      • Use up to 10 nodes per cluster
      Service Type > Server TypeRequiredServer type where the Broker will be installed
      • It is set to be the same as the server type set in the original cluster.
      Service Type > Planned ComputeSelectStatus of resources with Planned Compute set
      • In Use: Number of resources with Planned Compute that are currently in use
      • Configured: Number of resources with Planned Compute set
      • Coverage Preview: Amount applied per resource by Planned Compute
      • Planned Compute Service Application: Go to the Planned Compute service application page
      Service Type > Block StorageRequiredBlock Storage settings to be used on Broker nodes
      • The Storage type and capacity set in the original cluster are applied identically
      NetworkRequiredNetwork where servers are installed
      • Apply the same network as set in the original cluster
      Table. Event Streams Broker Node Additional Items

    Event Streams Cancel

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

    To cancel Event Streams, follow the steps below.

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