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

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

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, input the information required to create the service, and select detailed options.

   • Image and Version Selection area, select the required information.

     Category	Required status	Detailed description
     image	Required	Select the type of image provided Elasticsearch Enterprise, OpenSearch
     Image version	Required	Select version of the chosen image Provide a list of versions for the server image

     Table. Search Engine image and version selection items
   • In the Service Information Input area, enter or select the required information.

     Category	Required status	Detailed description
     Server name Prefix	Required	The server name where Elasticsearch will be installed must start with a lowercase English letter, and using lowercase letters, numbers, and special characters (-) be entered with 3 to 13 characters Based on the server name, a postfix such as 001, 002 is appended to generate 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 installation of MasterNode > Number of MasterNodes	Required	Number of Master nodes Master nodes are fixed at three units for recovery (Fail-over)
     Separate installation of MasterNode > Server type	Required	Master node server type Standard: standard specifications commonly used High Capacity: large‑capacity server with 24 vCores or more For detailed information about the server types provided by Search Engine, refer to Search Engine 서버 타입
     Separate MasterNode installation > Planned Compute	Selection	Planned Compute가 설정된 자원 현황 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 Planned Compute 신청하기
     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 Select the storage type and then 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 Enter the capacity 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 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
     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 of 24 vCore or more
     Service Type > Planned Compute	Selection	Status of resources with Planned Compute configured In Use: Number of resources with Planned Compute configured that are currently in use Configured: Number of resources with Planned Compute configured Coverage Preview: Amount applied per resource by Planned Compute Apply for Planned Compute Service: Go to the Planned Compute service application page For more details, refer to Planned Compute 신청하기
     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 details on each Block Storage type, refer to Create Block Storage) SSD: High‑performance standard volume HDD: Standard volume SSD_KMS/HDD_KMS: Additional encrypted volume using a KMS (Key Management System) encryption key Capacity must be entered as a multiple of 8 within the range 16 ~ 5,120 Add Disk: Additional storage area for data and backups After selecting Use, enter the storage purpose, capacity Click the + button to add storage, or the x button to delete. Up to 9 can be added. Capacity can be entered as a multiple of 8 within the range 16 ~ 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	Planned Compute가 설정된 자원 현황 In Use: Planned Compute가 설정된 자원 중 사용 중인 개수 Configured: Planned Compute가 설정된 자원의 개수 Coverage Preview: 자원별 Planned Compute로 적용된 금액 Apply for Planned Compute Service: Planned Compute 서비스 신청 페이지로 이동 For more details, see Planned Compute 신청하기
     Kibana > Block Storage	Required	Block Storage type to be used on the server where Kibana is installed Base OS: Area where the engine is installed
     Network > Common Settings	Required	Network settings for the servers created by the service Select when you want to apply the same settings to all installed servers Select a pre‑created VPC and Subnet Each server’s IP is generated automatically Public NAT settings are only possible in per‑server configuration
     Network > Server-specific Settings	Required	Network settings where servers generated by the service are installed Select when you want to apply different settings for each installed server Select a pre‑created VPC and Subnet IP: Enter the IP for each server Public NAT feature is available only when the VPC is connected to an Internet Gateway; checking Use allows selection from the reserved IPs in the VPC product’s Public IP pool. For 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, a separate Security Group policy configuration is not required. 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, set the day of the 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 patch operations within that time are 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 failing to perform within the period.

     Table. Search Engine service information input items
   • Enter required database configuration information In this area, input or select the necessary information.

     	required status	Detailed description
     Backup > Use	Selection	Whether to use node backup When selecting node backup usage, choose the retention period and backup start time
     Backup > Retention Period	Selection	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 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	Selection	ServiceWatch log collection status Select Use to configure the ServiceWatch log collection feature Provided free up to 5 GB for all services within the Account, and charges apply based on storage size for usage exceeding 5 GB When collected, log groups and log streams are created automatically, and they 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 ~ 65535can be entered as any value between 1200 and 65535, and the internal Elasticsearch port 9300 and Kibana port 5301 cannot be used
     Elastic username	Required	Elasticsearch username Enter using lowercase English letters, within 2 to 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 login password letters, numbers, and special characters (“, ‘, \ excluded) entered as 8 to 30 characters
     Verify 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	Selection	The standard time zone for the service

     Table. Required input items for Search Engine Database configuration
   • Additional Information Input area, please enter or select the required information.

     	Required status	Detailed description
     tag	Selection	Add 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 The 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 charges generated in the panel, and click the Complete button.

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

Search Engine View Detailed Information

Search Engine service can view and edit the full resource list and detailed information. Search Engine Detail page consists of Detailed Information, Tags, Activity History tabs.

To view detailed information about the Search Engine service, 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 view detailed information. 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.

     	Detailed description
     Cluster status	Cluster status Creating: The cluster is being created Editing: The cluster is changing to an operational state Error: The cluster encountered a failure while performing a task If it occurs continuously, contact the administrator Failed: The cluster failed during the creation process Restarting: The cluster is restarting Running: The cluster is operating normally Starting: The cluster is starting Stopped: The cluster is stopped Stopping: The cluster is being stopped Synchronizing: The cluster is synchronizing Terminating: The cluster is being terminated Unknown: The cluster status is unknown If it occurs continuously, contact the administrator Upgrading: The cluster is transitioning to an upgrading state
     Cluster control	Button to change the cluster state Start: Starts a stopped cluster. Stop: Stops a running cluster. Restart: Restarts a running cluster
     View more features	Cluster management buttons Service status synchronization: Retrieves the current server status and can synchronize it to the Console Backup history: When backup is configured, checks whether backups run correctly and view the history Cluster recovery: Restores 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

Search Engine list page allows you to view detailed information of the selected resource and edit the information if needed.

tag

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

Job History

You can view the operation history of the selected resource on the Search Engine List 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 Detail 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 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 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: Search Engine service is installed on the server and Search Engine service is running (Running).
   • Stop: The server where 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 query the current server status and synchronize it to the Console.

To synchronize the service status of the Search Engine, follow these steps.

1. All Services > Data Analytics > Search Engine Click the menu. 1. Go 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. On the Search Engine List page, click the resource to view the service status. 3. Search Engine Details Navigate to the page.
4. Click the Service status synchronization button. 4. The query takes a short amount of time, and while it is being retrieved, the cluster changes to Synchronizing state.
5. 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. Click the All Services > Data Analytics > Search Engine 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 change the server type. 3. Navigate to the Search Engine Detail page.
4. Click the Edit button for the Server Type you want to change at the bottom of the detailed information. 4. Edit Server Type A popup window opens.
5. Edit Server Type In the popup window, after selecting the server type, click the Confirm button.

Expanding storage

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

To increase storage capacity, follow the steps below.

1. Click the All Services > Data Analytics > Search Engine menu. 1. Navigate to the Service Home page of Search Engine.
2. On the Service Home page, click the Search Engine menu. 2. Search Engine List go to the page.
3. On the Search Engine list page, click the resource to change the server type. 3. Go to the Search Engine 상세 page.
4. Click the Edit button of the added Disk you want to expand at the bottom of the detailed information. 4. Disk Edit The popup window opens.
5. Disk Edit After entering the expanded capacity in the popup window, click the Confirm button.

Add Storage

If you need more than 5 TB of data storage, 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 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 add storage. 3. Search Engine Details Navigate to the page.
4. Click the Add Disk button at the bottom of the detailed information. 4. Add Disk The popup window opens.
5. Add Disk After entering the purpose and size in the popup window, click the Confirm button.

Search Engine Backup

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, refer to the Search Engine 생성하기 guide for backup configuration procedures, and follow the steps below to modify the backup settings of the created resource.

1. All Services > Data Analytics > Search Engine menu, please click. 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 set up backup. 3. Navigate to the Search Engine Details page.
4. Click the Edit button of the backup item. 4. Backup Edit The 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 interval, then click the Confirm button.
   • If you stop the backup setting, uncheck Use in the Edit Backup popup window, and authenticate via 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. Search Engine List page, click the resource to perform an immediate backup. 3. Go to the Search Engine Detail 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 menu, please click. 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 view the backup history. 3. Navigate to the Search Engine Details page.
4. Backup History Click the 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. All Services > Data Analytics > Search Engine Click the menu. 1. Go 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. On the Search Engine List page, click the resource to view the backup history. 3. Go to the Search Engine Detail page.
4. Backup History Click the button. 4. Backup History popup window opens.
5. Backup History In the popup window, check the files you want to delete, then authenticate via the logged-in user’s mobile phone.

Search Engine Restore

If a failure or data loss requires restoration from a backup file, recovery to 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 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. Search Engine Resource Click the resource you want to restore on the list page. 3. Go to the Search Engine Detail 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 the timestamp from the list of backup files displayed
   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 Based on the server name, a postfix such as 001, 002 is appended to generate the actual 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 It is set to be the same as the number of nodes configured in the original cluster.
   Service Type > Server Type	Required	Data node server type Set to the same number of nodes as configured in the original cluster.
   Service Type > Planned Compute	Selection	Planned Compute가 설정된 자원 현황 In Use: Number of resources with Planned Compute configured that are currently in use Configured: Number of resources with Planned Compute configured Coverage Preview: Amount applied per resource by Planned Compute Apply for Planned Compute Service: Go to the Planned Compute service application page For more details, see Planned Compute 신청하기
   Service Type > Block Storage	Required	Block Storage to be used for data nodes Basic OS: area where the engine is installed DATA: data file storage area Applied identically with the storage type 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 After selecting Use, enter the storage purpose and capacity Click the + button to add storage, and click 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
   Install MasterNode separately > Use	Required	Whether to install the Master node separately Apply the same based on the installation status of the original cluster
   Separate installation of MasterNode > 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 MasterNode installation > 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 Planned Compute 신청하기
   Separate MasterNode installation > Block Storage	Required	Block Storage for the Master node Base OS: Area where the engine is installed DATA: Data file storage area Applied identically with the storage type 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 be the same as the number of nodes configured in the original cluster.
   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, see Planned Compute 신청하기
   Kibana > Block Storage	Required	Block Storage to be used on the Kibana node Base OS: the area where the engine is installed
   Cluster Port number	Required	Elasticsearch connection port number It is set to the same port number as 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 the IP in IP format (example: 192.168.10.1) or CIDR format (example: 192.168.10.0/24, 192.168.10.1/32) and click the Add button To delete an entered IP, click the x button next to the IP.
   maintenance period	Selection	Maintenance window If you select Use, you can set the day, start time, and duration The maintenance window is a feature that lets the user define the time slot for patch operations, and patch tasks within that period are performed directly by the user. For the stable operation of the system, please set a maintenance window; we are not responsible for any problems caused by not setting it or failing to perform 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 these steps.

1. Click the All Services > Data Analytics > Search Engine 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. Search Engines Resources On the list page, click the resource you want to restore. 3. Go to the Search Engine Detail page.
4. Click the Add Broker Node button. 4. Go to the Add Broker Node page.
5. After entering the required 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	Selection	Planned Compute가 설정된 자원 현황 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, refer to Planned Compute 신청하기
   Service Type > Block Storage	Required	Block Storage configuration to be used for data nodes The storage type and capacity set in the source cluster are applied identically
   Network	Required	the network where the servers are installed applied identically to the network configured in the original cluster

   Table. Additional items for Search Engine Node

Terminate Search Engine

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

To cancel the Search Engine, follow the steps below.

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. Navigate to the Search Engine List page.
3. On the Search Engine List page, select the resource to cancel, and click the Cancel Service button.
4. Once the termination is complete, check on the Search Engine list page whether the resource has been terminated.