How-to guides

Users can create the Search Engine service by entering required information and selecting detailed options through Samsung Cloud Platform Console.

Create Search Engine

You can create and use the Search Engine service in Samsung Cloud Platform Console.

Follow the procedure below to create a Search Engine.

1. Click All Services > Database > Search Engine menu. You will be moved to the Service Home page of Search Engine.

2. Click the Create Search Engine button on the Service Home page. You will be moved to the Create Search Engine page.

3. Enter the information required to create the service and select detailed options on the Create Search Engine page.

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

     Division	Required	Description
     Image	Required	Select the type of image provided Elasticsearch Enterprise, OpenSearch
     Image Version	Required	Select the version of the selected image List of versions of provided server images

     Table. Search Engine Image and Version Selection Items
   • Enter or select the required information in the Service Information Input area.

     Division	Required	Description
     Server Name Prefix	Required	Server name where Elasticsearch is installed Start with lowercase English letters, and enter 3 to 13 characters using lowercase letters, numbers, and special characters (-) Actual server name is created with postfix such as 001, 002 based on the server name
     Cluster Name	Required	Cluster name where servers are configured Enter 3 to 20 characters using English letters Cluster is a unit that bundles multiple servers
     Install MasterNode Separately > Use	Required	Whether to install Master node separately If Use is selected, Master node is installed separately If Master node is not installed separately, data node performs master role as well
     Install MasterNode Separately > MasterNode Count	Required	Number of Master nodes Master nodes are installed with fixed 3 units for recovery (Fail-over)
     Install MasterNode Separately > Server Type	Required	Master node server type Standard: Standard specifications commonly used High Capacity: Large capacity servers with 24vCore or more For more information about server types provided by Search Engine, refer to Search Engine Server Type
     Install MasterNode Separately > Planned Compute	Optional	Resource status where Planned Compute is set In Use: Number of resources in use among resources where Planned Compute is set Set: Number of resources where Planned Compute is set Coverage Preview: Amount applied with Planned Compute for each resource Apply for Planned Compute Service: Move to Planned Compute service application page For more information, refer to Apply for Planned Compute
     Install MasterNode Separately > Block Storage	Required	Block Storage type to be used for Master node Basic OS: Area where engine is installed DATA: Data file storage area Select storage type and enter capacity (for more details about 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 KMS(Key Management System) encryption key Enter capacity in multiples of 8 in the range of 16 ~ 5,120 Add Disk: Data storage area Select Use and enter storage Capacity Click + button to add storage, and click x button to delete. You can add up to 9. Enter capacity in multiples of 8 in the range of 16 ~ 5,120, and you can create up to 9
     Node Count	Required	Number of data nodes If Master node is installed separately, select 2 or more; otherwise, select 1 or more
     Service Type > Server Type	Required	Data node server type Standard: Standard specifications commonly used High Capacity: Large capacity servers with 24vCore or more
     Service Type > Planned Compute	Optional	Resource status where Planned Compute is set In Use: Number of resources in use among resources where Planned Compute is set Set: Number of resources where Planned Compute is set Coverage Preview: Amount applied with Planned Compute for each resource Apply for Planned Compute Service: Move to Planned Compute service application page For more information, refer to Apply for Planned Compute
     Service Type > Block Storage	Required	Block Storage type to be used for data nodes Basic OS: Area where engine is installed DATA: Data file storage area Select storage type and enter capacity (for more details about 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 KMS(Key Management System) encryption key Enter capacity in multiples of 8 in the range of 16 ~ 5,120 Add Disk: Data, backup additional storage area Select Use and enter storage Purpose, Capacity Click + button to add storage, and click x button to delete. You can add up to 9. Enter capacity in multiples of 8 in the range of 16 ~ 5,120, and you can create up to 9
     Kibana > Server Type	Required	Server type where Kibana is installed Standard: Standard specifications commonly used
     Kibana > Planned Compute	Optional	Resource status where Planned Compute is set In Use: Number of resources in use among resources where Planned Compute is set Set: Number of resources where Planned Compute is set Coverage Preview: Amount applied with Planned Compute for each resource Apply for Planned Compute Service: Move to Planned Compute service application page For more information, refer to Apply for Planned Compute
     Kibana > Block Storage	Required	Block Storage type to be used for server where Kibana is installed Basic OS: Area where engine is installed
     Network > Common Settings	Required	Network settings where servers created in the service are installed Select to apply the same settings to all servers being installed Select previously created VPC and Subnet IP: Only automatic creation is possible Public NAT settings are only possible with per-server settings
     Network > Per-Server Settings	Required	Network settings where servers created in the service are installed Select to apply different settings for each server being installed Select previously created VPC and Subnet IP: Enter IP for each server Public NAT function can be used only when VPC is connected to Internet Gateway. If Use is checked, you can select from reserved IPs in Public IP of VPC product. For more information, refer to Create Public IP
     IP Access Control	Optional	Service access policy settings Access policy is set for IPs entered on the page, so separate Security Group policy settings are not required 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 Add button To delete entered IP, click x button next to the entered IP
     Maintenance Window	Optional	Search Engine maintenance window If Use is selected, set day of week, start time, and duration It is recommended to set a maintenance window for stable service management. Patch work proceeds at the set time and service interruption occurs If set to Not Used, problems caused by not applying patches are not the responsibility of the company

     Table. Search Engine Service Information Input Items
   • Enter or select the required information in the Database Configuration Required Information Input area.

     Division	Required	Description
     Backup > Use	Optional	Whether to use node backup If node backup is selected, select retention period and backup start time
     Backup > Retention Period	Optional	Backup retention period Select backup retention period. File retention period can be set from 7 days to 35 days Separate charges occur for backup files depending on capacity
     Backup > Backup Start Time	Optional	Backup start time Select backup start time Backup execution minutes are set randomly, and backup end time cannot be set
     Cluster Port Number	Required	Elasticsearch connection port number Can enter one of 1200 ~ 65535, but cannot use 9300 which is Elasticsearch internal port and 5301 which is Kibana port
     Elastic Username	Required	Elasticsearch username Enter within 2 to 20 characters using lowercase English letters 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 English letters, numbers, and special characters (excluding ", ’, \)
     Elastic Password Confirmation	Required	Elasticsearch connection password confirmation Re-enter the Elasticsearch connection password identically
     License Key	Required	Elasticsearch License Key Enter the entire content in the issued license file (.json) If the entered license key is invalid, service creation may not be possible OpenSearch does not require License Key
     Time Zone	Optional	Standard time zone where the service is used

     Table. Search Engine Database Configuration Required Information Input Items
   • Enter or select the required information in the Additional Information Input area.

     Division	Required	Description
     Tags	Optional	Add tags Create and add tags by clicking Add Tag button or add existing tags Can add up to 50 tags Added new tags are applied after service creation is completed

     Table. Search Engine Service Additional Information Input Items

4. Check the detailed information and estimated billing amount in the Summary panel, and click the Complete button.

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

Check Search Engine Detailed Information

Search Engine service can check and modify the entire resource list and detailed information. The Search Engine Details page consists of Details, Tags, Operation History tabs.

Follow the procedure below to check the detailed information of Search Engine service.

1. Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
2. Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
3. Click the resource for which you want to check detailed information on the Search Engine List page. You will be moved to the Search Engine Details page.
   • Status information and additional feature information are displayed at the top of the Search Engine Details page.

     Division	Description
     Cluster Status	Cluster status Creating: Cluster is being created Editing: Cluster is changing to state where Operation is being performed Error: Cluster failed while performing operation If it occurs continuously, contact administrator Failed: Cluster failed during creation process Restarting: Cluster is being restarted Running: Cluster is operating normally Starting: Cluster is being started Stopped: Cluster is stopped Stopping: Cluster is in stopping state Synchronizing: Cluster is being synchronized Terminating: Cluster is being deleted Unknown: Cluster status is unknown If it occurs continuously, contact administrator Upgrading: Cluster is changing to state where upgrade is being performed
     Cluster Control	Buttons to change cluster status Start: Starts the stopped cluster Stop: Stops the running cluster Restart: Restarts the running cluster
     Additional Features More	Cluster-related management buttons Synchronize Service Status: Can synchronize to Console by checking current server status Backup History: If backup is set, check whether backup is executed normally and history Cluster Recovery: Recovers cluster based on specific time point Add Node: Adds data nodes
     Service Termination	Button to terminate service

     Table. Search Engine Status Information and Additional Features

Details

You can check the detailed information of the resource selected on the Search Engine List page and modify information if necessary.

Tags

You can check the tag information of the resource selected on the Search Engine List page and add, change, or delete tags.

Operation History

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

Manage Search Engine Resources

If you need to change existing configuration options of created Search Engine resources, manage parameters, or add Node configuration, you can perform tasks on the Search Engine Details page.

Control Operation

If there are changes to running Search Engine resources, you can start, stop, or restart.

Follow the procedure below to control the operation of Search Engine.

1. Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
2. Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
3. Click the resource for which you want to control operation on the Search Engine List page. You will be moved to the Search Engine Details page.
4. Check Search Engine status and complete changes through the following control buttons.
   • Start: Server where Search Engine service is installed and Search Engine service become running.
   • Stop: Server where Search Engine service is installed and Search Engine service become stopped.
   • Restart: Only Search Engine service is restarted.

Synchronize Service Status

You can check the current server status and synchronize it to Console.

Follow the procedure below to synchronize the service status of Search Engine.

1. Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
2. Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
3. Click the resource for which you want to check service status on the Search Engine List page. You will be moved to the Search Engine Details page.
4. Click Synchronize Service Status button. It takes some time to check, and cluster changes to Synchronizing status during checking.
5. When checking is completed, status is updated in the server information item, and cluster changes to Running status.

Change Server Type

You can change the configured server type.

Follow the procedure below to change the server type.

1. Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
2. Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
3. Click the resource for which you want to change server type on the Search Engine List page. You will be moved to the Search Engine Details page.
4. Click Modify button of the Server Type you want to change at the bottom of detailed information. Modify Server Type popup window opens.
5. Select server type in the Modify Server Type popup window, and click Confirm button.

Expand Storage

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

Follow the procedure below to expand storage capacity.

1. Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
2. Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
3. Click the resource for which you want to change server type on the Search Engine List page. You will be moved to the Search Engine Details page.
4. Click Modify button of the Additional Disk you want to expand at the bottom of detailed information. Modify Disk popup window opens.
5. Enter expansion capacity in the Modify Disk popup window, and click Confirm button.

Add Storage

If you need more than 5TB of data storage space, you can add storage.

Follow the procedure below to add storage capacity.

1. Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
2. Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
3. Click the resource for which you want to add storage on the Search Engine List page. You will be moved to the Search Engine Details page.
4. Click Add Disk button at the bottom of detailed information. Add Disk popup window opens.
5. Enter purpose and capacity in the Add Disk popup window, and click Confirm button.

Backup Search Engine

Through backup setting functionality, users can set data retention period and start cycle, and can perform backup history lookup and deletion through backup history functionality.

Set Backup

For the procedure of setting backup while creating Search Engine, refer to Create Search Engine guide, and follow the procedure below to modify backup settings of created resources.

1. Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
2. Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
3. Click the resource for which you want to set backup on the Search Engine List page. You will be moved to the Search Engine Details page.
4. Click Modify button in the backup item. Modify Backup popup window opens.
5. If setting backup, click Use in the Modify Backup popup window, select retention period, backup start time, Archive backup cycle, and click Confirm button.
   • If stopping backup setting, uncheck Use in the Modify Backup popup window, and click Confirm button.

Check Backup History

Follow the procedure below to check backup history.

1. Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
2. Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
3. Click the resource for which you want to check backup history on the Search Engine List page. You will be moved to the Search Engine Details page.
4. Click Backup History button. Backup History popup window opens.
5. In the Backup History popup window, you can check backup status, version, backup start date and time, backup completion date and time, and capacity.

Delete Backup File

Follow the procedure below to delete backup history.

1. Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
2. Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
3. Click the resource for which you want to check backup history on the Search Engine List page. You will be moved to the Search Engine Details page.
4. Click Backup History button. Backup History popup window opens.
5. Check the file you want to delete in the Backup History popup window, and click Delete button.

Recover Search Engine

If recovery is needed from backup file due to failure or data loss, recovery is possible based on specific time point through cluster recovery functionality.

Follow the procedure below to recover Search Engine.

1. Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
2. Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
3. Click the resource you want to recover on the Search Engine Resource list page. You will be moved to the Search Engine Details page.
4. Click Cluster Recovery button. You will be moved to the Cluster Recovery page.
5. Enter the corresponding information in the Cluster Recovery Configuration area, and click Complete button.

   Division	Required	Description
   Recovery Time Point	Required	Set the time point user wants to recover Select from the list of time points of backup files displayed in the list
   Server Name Prefix	Required	Recovery server name Start with lowercase English letters and enter 3 to 16 characters using lowercase letters, numbers, and special characters (-) Actual server name is created with postfix such as 001, 002 based on server name
   Cluster Name	Required	Recovery server cluster name Enter 3 to 20 characters using English letters Cluster is a unit that bundles multiple servers
   Node Count	Required	Number of data nodes Set to the same as the number of nodes set in the original cluster
   Service Type > Server Type	Required	Data node server type Set to the same as the number of nodes set in the original cluster
   Service Type > Planned Compute	Optional	Resource status where Planned Compute is set In Use: Number of resources in use among resources where Planned Compute is set Set: Number of resources where Planned Compute is set Coverage Preview: Amount applied with Planned Compute for each resource Apply for Planned Compute Service: Move to Planned Compute service application page For more information, refer to Apply for Planned Compute
   Service Type > Block Storage	Required	Block Storage to be used for data nodes Basic OS: Area where engine is installed DATA: Data file storage area Applied identically to the Storage type set in the original cluster Enter capacity in multiples of 8 in the range of 16 ~ 5,120 Add Disk: Data, backup additional storage area Select Use and enter storage purpose and capacity Click + button to add storage, and click x button to delete Enter capacity in multiples of 8 in the range of 16 ~ 5,120, and you can create up to 9
   Install MasterNode Separately > Use	Required	Whether to install Master node separately Applied identically to the installation status of the original cluster
   Install MasterNode Separately > MasterNode Count	Required	Number of Master nodes
   Install MasterNode Separately > Server Type	Required	Master node server type Set to the same as the number of nodes set in the original cluster
   Install MasterNode Separately > Planned Compute	Optional	Resource status where Planned Compute is set In Use: Number of resources in use among resources where Planned Compute is set Set: Number of resources where Planned Compute is set Coverage Preview: Amount applied with Planned Compute for each resource Apply for Planned Compute Service: Move to Planned Compute service application page For more information, refer to Apply for Planned Compute
   Install MasterNode Separately > Block Storage	Required	Block Storage to be used for Master node Basic OS: Area where engine is installed DATA: Data file storage area Applied identically to the Storage type set in the original cluster Enter capacity in multiples of 8 in the range of 16 ~ 5,120 Add Disk: Data additional storage area Select Use and enter storage capacity Click + button to add storage, and click x button to delete Enter capacity in multiples of 8 in the range of 16 ~ 5,120, and you can create up to 9
   Kibana > Server Type	Required	Kibana node server type Set to the same as the number of nodes set in the original cluster
   Kibana > Planned Compute	Optional	Resource status where Planned Compute is set In Use: Number of resources in use among resources where Planned Compute is set Set: Number of resources where Planned Compute is set Coverage Preview: Amount applied with Planned Compute for each resource Apply for Planned Compute Service: Move to Planned Compute service application page For more information, refer to Apply for Planned Compute
   Kibana > Block Storage	Required	Block Storage to be used for Kibana node Basic OS: Area where engine is installed
   Cluster Port Number	Required	Elasticsearch connection port number Set identically to the port number set in the original cluster
   License Key	Required	Elasticsearch License Key Enter the entire content in the issued license file (.json) If the entered license key is invalid, service creation may not be possible OpenSearch does not require License Key
   IP Access Control	Optional	Service access policy settings Access policy is set for IPs entered on the page, so separate Security Group policy settings are not required 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 Add button To delete entered IP, click x button next to the entered IP
   Maintenance Window	Optional	Maintenance window If Use is selected, set day of week, start time, and duration It is recommended to set a maintenance window for stable service management. Patch work proceeds at the set time and service interruption occurs If set to Not Used, problems caused by not applying patches are not the responsibility of the company

   Table. Search Engine Recovery Configuration Items

Add Node

If Search Engine cluster expansion is needed, you can add nodes with the same specifications as currently used data nodes.

Follow the procedure below to add nodes.

1. Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
2. Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
3. Click the resource you want to recover on the Search Engine Resources list page. You will be moved to the Search Engine Details page.
4. Click Add Broker Node button. You will be moved to the Add Broker Node page.
5. Enter the corresponding information in the Required Information Input area, and click Complete button.

   Division	Required	Description
   Server Name Prefix	Required	Data node server name Set to the server name set in the original cluster
   Cluster Name	Required	Cluster name Set to the cluster name set in the original cluster
   Additional Node Count	Required	Number of Nodes to add Use up to 10 nodes in one cluster
   Service Type > Server Type	Required	Data node server type Set identically to the server type set in the original cluster
   Service Type > Planned Compute	Optional	Resource status where Planned Compute is set In Use: Number of resources in use among resources where Planned Compute is set Set: Number of resources where Planned Compute is set Coverage Preview: Amount applied with Planned Compute for each resource Apply for Planned Compute Service: Move to Planned Compute service application page For more information, refer to Apply for Planned Compute
   Service Type > Block Storage	Required	Block Storage settings to be used for data nodes Storage type and capacity set in the original cluster are applied identically
   Network	Required	Network where servers are installed Applied identically to the network set in the original cluster

   Table. Search Engine Node Addition Items

Terminate Search Engine

You can reduce operating costs by terminating unused Search Engine. However, if you terminate the service, the running service may stop immediately, so you should fully consider the impact of service interruption before proceeding with termination work.

Follow the procedure below to terminate Search Engine.

1. Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
2. Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
3. Select the resource to terminate on the Search Engine List page, and click Terminate Service button.
4. When termination is completed, check if the resource is terminated on the Search Engine list page.