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

    Notice

    Please configure the Subnet type of VPC to General before creating the service.

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

    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 VersionRequiredProvides 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 PrefixRequiredThe 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 NameRequiredName 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 countrequiredBroker Node count
        Broker > Server TypeRequiredThe type of server on which the Broker will be installed
        • Standard: Standard specification commonly used
        • High Capacity: High-capacity server with 24vCore or more
        Broker > Planned ComputeSelectionCurrent 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
        Broker > Block StorageRequiredBlock 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 > useselectionWhether 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 typeSelectionThe server type where Zookeeper will be installed
        • Zookeeper node provides vCPU 1, Memory 2G or vCPU 2, Memory 4G
        Zookeeper separate installation > Planned ComputeselectionCurrent 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
        Zookeeper separate installation > Block StoragerequiredBlock 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 > UseRequiredWhether AKHQ is installed
        • Use is selected, AKHQ will be installed.
        AKHQ > Server TypeRequiredThe type of server where AKHQ will be installed
        • AKHQ only provides vCPU 2, Memory 4G type
        AKHQ > Planned ComputeSelectionCurrent 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
        AKHQ > Block StoragerequiredThe 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 accountrequiredAKHQ account
        • Use lowercase English letters to enter 2-20 characters
        AKHQ > AKHQ passwordrequiredAKHQ account password
        • Enter 8-30 characters, including English, numbers, and special characters (excluding " )
        AKHQ > AKHQ password confirmationrequiredAKHQ account password confirmation
        • Re-enter the AKHQ account password identically
        AKHQ > AKHQ Port numberrequiredAKHQ connection port number
        • The port number is automatically set to 8080 and cannot be modified
        Network > Common SettingsRequiredNetwork 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 settingsRequiredNetwork 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 ControlSelectSet 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 periodSelectEvent 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 accountrequiredZookeeper account
        • Use lowercase English letters, 2-20 characters
        Zookeeper SASL passwordrequiredZookeeper account password
        • Enter 8-30 characters including English, numbers, and special characters (excluding " )
        Zookeeper SASL password confirmationrequiredConfirm Zookeeper account password
        • Re-enter the Zookeeper SASL account password identically
        Zookeeper Port numberrequiredZookeeper port number
        • 1,024 ~ 65,535 can be entered as one of them, and Broker port or 2888, 3888 cannot be used
        Broker SASL accountrequiredKafka connection account
        • Enter within 2-20 characters using lowercase English letters
        Broker SASL passwordrequiredKafka connection account password
        • Enter 8-30 characters, including English, numbers, and special characters (excluding " )
        Broker SASL password confirmationrequiredKafka connection account password confirmation
        • Re-enter the Broker SASL account password identically
        Broker Port numberrequiredKafka port number
        • 1,024 ~ 65,435 can be entered as one of them, and Broker port or 2888, 3888 cannot be used
        ParameterRequiredEvent 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 ZoneSelectionStandard 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
        TagSelectionTag 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.
    DivisionDetailed Description
    Cluster StatusCluster Status
    • Creating: The cluster is being created
    • Editing: The cluster is being changed to an operational state
    • Error: The cluster has failed to perform an operation
      • If this occurs continuously, please contact the administrator
    • Failed: The cluster has failed during the creation process
    • Restarting: The cluster is being restarted
    • Running: The cluster is operating normally
    • Starting: The cluster is being started
    • Stopped: The cluster has been stopped
    • Stopping: The cluster is being stopped
    • Synchronizing: The cluster is being synchronized
    • Terminating: The cluster is being deleted
    • Unknown: The cluster status is unknown
      • If this occurs continuously, please contact the administrator
    • Upgrading: The cluster is being changed to an upgrade state
    Cluster ControlButtons that can change the cluster status
    • Start: Starts a stopped cluster.
    • Stop: Stops a running cluster.
    • Restart: Restarts a running cluster
    Additional features moreCluster related management buttons
    • Service status synchronization: Possible to synchronize the current server status to the Console
    • Parameter management: Possible to inquire and modify service configuration parameters
    • Add Broker Node: Add a Broker Node
      • If it is a cluster configuration, the Broker Node addition button is displayed
    Service CancellationButton to cancel the service
    Table. Event Streams status information and additional features

    Detailed Information

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

    ClassificationDetailed Description
    Server InformationServer information configured in the corresponding 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 TimeTime when the service was created
    ModifierService information modified user
    Modified DateDate when service information was modified
    Image/VersionInstalled service image and version information
    Cluster NameServer cluster name composed of servers
    Planned ComputePlanned Compute settings for current resources
    Maintenance periodPatch work period setting status
    • If maintenance period setting is required, click the Modify button to set
    Time ZoneStandard time zone where the service will be used
    Zookeeper Port numberZookeeper port number
    Broker Port numberKafka port number
    AKHQ Connection InformationAKHQ Connection Information
    NetworkInstalled network information(VPC, Subnet)
    IP Access ControlService Access Policy Setting
    • If IP addition or deletion is required, click the Modify button to set
    ZookeeperZookeeper node’s server type, default OS, additional disk information
    • if server type modification is required, click the Modify button next to the server type to set
      • server restart is required when modifying the server type
    • if storage expansion is required, click the Modify button next to the storage capacity to expand
    BrokerBroker node’s server type, default OS, additional disk information
    • if server type modification is required, click the Modify button next to the server type to set
      • modifying server type requires server restart
    • if storage expansion is required, click the Modify button next to the storage capacity to expand
    AKHQAKHQ node’s server type, basic OS information
    • In case of modifying the server type, click the Modify button next to the server type to set
      • Modifying the server type requires a server restart
    Fig. Event Streams detailed information items

    Tag

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

    ClassificationDetailed Description
    Tag listTag list
    • Check Key, Value information of the tag
    • Up to 50 tags can be added per resource
    • When entering a tag, search and select from the existing list of created Key and Value
    Fig. Event Streams tags tab items

    Work History

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

    ClassificationDetailed Description
    Work history listResource change history
    • Work details, work time, resource type, resource ID, resource name, event topic, work result, worker information confirmation
    • Detailed search button provides detailed search function
    Fig. Event Streams work history tab detailed information items

    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.

    Caution
    • If the server type is configured as Standard, it cannot be changed to High Capacity. If you want to change to High Capacity, please create a new service.
    • Modifying the server type requires a server restart. Please check separately for SW license modifications and SW settings due to specification changes.
    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.

    Notice
    • If encryption is set for the existing Block Storage, encryption will also be applied to the additional Disk.
    • Disk size modification is only possible if it is 16GB or more larger than the current disk size.

    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.

    Notice
    • You can use up to 10 nodes within the cluster. Please note that additional nodes created will be charged extra.
    • The cluster performance may be degraded while adding nodes.

    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.
    Classification
    Necessity
    Detailed Description
    Server NameRequiredServer name where Broker is installed
    • It is set to the server name set in the original cluster.
    Cluster NameRequiredCluster Name
    • It is set as the cluster name set in the original cluster.
    Additional Node countRequiredNumber of Nodes to add
    • Up to 10 nodes can be used in a single cluster
    Service Type > Server TypeRequiredThe type of server where the Broker will be installed
    • It will be set to the same server type as the original cluster.
    Service Type > Planned ComputeSelectionCurrent 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
    Service Type > Block StorageRequiredBlock Storage settings to be used for Broker nodes
    • The Storage type and capacity set in the original cluster are applied equally
    NetworkRequiredThe network where servers are installed
    • Applied the same as the network set in the original cluster
    Fig. Event Streams Broker Node Additional Items

    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.