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

To create a Search Engine, follow the steps below.

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

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

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

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

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

     Table. Search Engine image and version selection 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 on which Elasticsearch 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, creating 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
     Install MasterNode separately > 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 Three master nodes are permanently installed 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 vCore or more For detailed information about the server types provided by Search Engine, refer to Search Engine 서버 타입.
     Separate installation of MasterNode > 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 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, 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
     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	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 Apply
     Service Type > Block Storage	Required	Block Storage type 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 detailed information on each Block Storage type, see 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: additional storage area for data and backup After selecting Use, enter the storage’s purpose, capacity Click the + button to add storage, and click 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	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, refer to Apply for Planned Compute
     Kibana > Block Storage	Required	Block Storage type to be used on the server where Kibana is installed Basic OS: the area where the engine is installed
     Network > Common Settings	Required	Network configuration for the servers created by the service Select this 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 configuration is only possible in per‑server settings
     Network > Server Settings	required	Network settings for servers generated by the service Select this option to apply different settings to each installed server Select a pre-created VPC and Subnet IP: Enter the IP address for each server The Public NAT feature is available only when the VPC is connected to an Internet Gateway. Selecting Use allows you to choose 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 (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	Selection	Search Engine maintenance period If you select Use, you can set the day of week, 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 is the user’s responsibility. 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. Search Engine service information input items
   • In the Enter required Database configuration information area, input or select the necessary information.

     Category	Required status	Detailed description
     Backup > Use	Selection	Whether to use node backup When selecting node backup usage, select retention period and backup start time
     Backup > Retention Period	Select	Backup retention period Please select the backup retention period. Set the file retention period from 7 days to 35 days Backup files incur additional charges based on their 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
     ServiceWatch log collection	Select	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 if 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, direct deletion of log data or shortening the retention period is recommended.
     Cluster Port number	required	Elasticsearch connection port number 1200 ~ 65535 can 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 ~ 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 connection 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 configuring the Search Engine Database
   • In the Additional Information Input area, please enter or select the required information.

     Category	whether required	Detailed description
     tag	Selection	Tag addition Tag addition Click the button to create and add tags, or add existing tags Up to 50 tags can be added 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 billing amount generated in the panel, and click the Done button.

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

Search Engine Check detailed information

The Search Engine service lets you view and modify the complete resource list and detailed information. Search Engine Details page consists of Detailed Information, Tags, Operation History tabs.

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

1. All Services > Data Analytics > Search Engine Click the menu. 1. Go to the Service Home page of Search Engine.
2. On the Service Home page, click the Search Engine menu. 2. Navigate to the Search Engine list page.
3. Click the resource to view detailed information on the Search Engine List page. 3. Navigate to the Search Engine Details 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 changing to an operational state 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 being terminated Unknown: Cluster status is unknown If it occurs continuously, contact the administrator Upgrading: Cluster is changing to an upgrading state
     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 features	Cluster-related management buttons Service status synchronization: Retrieves the current server status and can synchronize it to the Console Backup history: If backup is configured, checks whether the backup ran successfully and view its history Cluster recovery: Recovers the cluster based on a specific point in time. Add Node: Adds a data node.
     Service cancellation	Cancel service button

     Table. Search Engine status information and additional features

Detailed Information

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

tag

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

Job History

Search Engine List You can view the operation history of the selected resource on the page.

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 Details 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 the steps below.

1. Click the All Services > Data Analytics > Search Engine menu. 1. Navigate to the Search Engine’s Service Home page.
2. Click the Search Engine menu on the Service Home page. 2. Search Engine List Go to the page.
3. Search Engine list On the page, click the resource to control operation. 3. Go to the Search Engine Detail page.
4. Check the Search Engine status and complete the change using the control button below.
   • Start: the server with the Search Engine service installed and the Search Engine service 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 retrieve the current server status and synchronize it to the Console.

Follow these steps to synchronize the service status of the Search Engine.

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. Search Engine List Navigate to the page.
3. Search Engine List page, click the resource to view the service status. 3. Go 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 item is updated, and the cluster changes to 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 the Search Engine.
2. On the Service Home page, click the Search Engine menu. 2. Go to the Search Engine List page.
3. Search Engine list on the page, click the resource to change the server type. 3. Search Engine Details navigate to the page.
4. Click the Edit button of 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 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. 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. On the Search Engine list page, click the resource to change the server type. 3. Go to the Search Engine 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 popup window opens.
5. Disk Modify In the popup window, after entering the expanded capacity, 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. Click the All Services > Data Analytics > Search Engine menu. 1. Navigate to the Service Home page of the Search Engine.
2. Click the Search Engine menu on the Service Home page. 2. Navigate 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 popup window opens.
5. Add Disk In the popup window, after entering the purpose and size, click the Confirm button.

Backup Search Engine

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 configuring backup, refer to the Create Search Engine guide, and follow the steps below to modify the backup settings of the created resource.

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. Search Engine List Go to the page.
3. Click the resource to set up backup on the Search Engine List page. 3. Navigate to the Search Engine Details page.
4. Click the Edit button of the backup item. 4. Backup Edit popup window opens.
5. When configuring a backup, click Use in the Backup Edit popup, select the retention period, backup start time, and Archive backup cycle, then click the Confirm button.
   • If you stop the backup setting, uncheck Use in the Edit Backup popup window, and authenticate using the logged-in user’s mobile phone.

Perform Immediate Backup

If additional data protection is needed, you can quickly create a backup using the instant backup feature.

To perform an immediate backup, 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 perform an immediate backup. 3. Go to the Search Engine Details page.
4. Click the Immediate Backup button of the backup item. 4. The immediate backup notification popup opens.
5. Click the Confirm button in the notification popup.

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. Search Engine List Navigate to the page.
3. On the Search Engine list page, click the resource to view the backup history. 3. Search Engine Details Go to the page.
4. Click the Backup History button. 4. Backup History The 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. Click the All Services > Data Analytics > Search Engine menu. 1. Navigate to the Service Home page of the Search Engine.
2. On the Service Home page, click the Search Engine menu. 2. Navigate to the Search Engine List page.
3. Search Engine List page, click the resource to view the backup history. 3. Search Engine 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, select the files you wish to delete, then authenticate via the logged-in user’s mobile phone.

Restore Search Engine

If a failure or data loss requires restoration from a backup file, recovery at a specific point in time is possible using the cluster recovery feature.

To restore the Search Engine, follow the steps below.

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. Search Engine List Go to the page.
3. Search Engine Resource On the list page, click the resource you want to restore. 3. Search Engine Details Navigate to the page.
4. Click the Cluster Recovery button. 4. Navigate 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 in the list
   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 A real server name is generated by appending a postfix such as 001, 002 to the base 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 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, see Apply for Planned Compute
   Service Type > Block Storage	required	Block Storage to be used for data nodes Base OS: area where the engine is installed DATA: data file storage area Apply the same storage type as 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 Use: after selecting, enter the storage purpose and capacity To add storage, click the + button; to delete, click the x button Capacity can be entered as a multiple of 8 within the range 16 to 5,120, and up to 9 can be created
   Install MasterNode separately > Use	required	Whether to install the Master node separately Apply the same way depending 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 installation of MasterNode > 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 by Planned Compute per resource 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 to be used on the Master node Basic OS: Area where the engine is installed DATA: Data file storage area Apply the same Storage type as 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 the same number of nodes as configured in the original cluster.
   Kibana > Planned Compute	Selection	Status 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 Request: Go to the Planned Compute service request page For more details, see Apply for Planned Compute
   Kibana > Block Storage	Required	Block Storage to be used on the Kibana node Basic OS: 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	Selection	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 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	Select	maintenance window If you select Use, set the day of week, start time, and duration The maintenance window is a feature that allows the user to set the time slot for performing patch operations, and patch operations within that time are performed directly by the user. For the stable operation of the system, please set a maintenance window; we are not responsible for any issues arising from not setting it or not performing tasks within the window.

   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. Click the All Services > Data Analytics > Search Engine menu. 1. Navigate to the Service Home page of the Search Engine.
2. On the Service Home page, click the Search Engine menu. 2. Search Engine List navigate to the page.
3. Search Engines Resource Click the resource you want to restore on the list page. 3. Search Engine Details page.
4. Add Broker Node Click the 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 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 For more details, see Apply for Planned Compute
   Service Type > Block Storage	Required	Block Storage settings to be used on data nodes The same storage type and capacity configured in the source cluster are applied
   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

Search Engine Termination

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 of the service interruption.

If you want to cancel Search Engine, follow the steps below.

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. On the Search Engine List page, select the resource to unsubscribe and click the Service Unsubscribe button.
4. After termination is complete, verify on the Search Engine list page whether the resource has been terminated.