Search Engine

• 1: Overview
• 1.1: Server Type
• 1.2: Monitoring Metrics
• 2: How-to guides
• 3: API Reference
• 4: CLI Reference
• 5: Release Note

1 - Overview

Service Overview

Search Engine provides automated creation and configuration of the distributed search and analytics engines Elasticsearch and OpenSearch through a web-based console. Users can select a server type that fits the system configuration to set up a cluster, and it supports the data analysis and visualization tools Kibana and the OpenSearch dashboard.

Search Engine Cluster consists of multiple master nodes and data nodes. Data nodes can be installed from a minimum of 1 up to a maximum of 10, and are usually installed with three or more. If a separate master node is not installed, the data node also performs the role of the master node, and up to 10 can be installed. When a separate master node is installed, data nodes can be up to 50.

Provided Features

Search Engine provides the following functions.

• Auto Provisioning (Auto Provisioning): You can configure and set up Elasticsearch and OpenSearch clusters via the UI.
• Operation Control Management: Provides a function to control the status of running servers. It allows restarting to apply configuration values, in addition to starting and stopping the cluster.
• Backup and Recovery: Backup is possible using the built-in backup function, and recovery is possible to the point in time of the backup file.
• Data Node Addition: If cluster expansion is needed, you can add nodes with the same specifications as the data nodes in use. Up to 10 nodes can be added within the cluster.
• Visualization tool support: Provides data analysis and visualization tools, and supports Elasticsearch Kibana or OpenSearch dashboards.
• Monitoring: CPU, Memory, cluster performance monitoring information can be checked through the Cloud Monitoring service.

Components

Search Engine provides pre-validated engine versions and various server types according to the open source support policy. Users can select and use them according to the scale of the service they want to configure.

Engine Version

Search Engine the supported engine versions are as follows.

Technical support can be used until the supplier’s EoTS (End of Technical Service) date, and the EOS date when new creation is stopped is set to six months before the EoTS date.

According to the supplier’s policy, the EOS and EoTS dates may change, so please refer to the supplier’s license management policy page for details.

• Elasticsearch: https://www.enterprisedb.com/resources/platform-compatibility

• OpenSearch: https://opensearch.org/releases/

Server Type

The server types supported by Search Engine are as follows.

For detailed information about the server types provided by Search Engine, please refer to Search Engine Server Type.

Standard se1v2m4

Preliminary Service

This is a list of services that must be pre-configured before creating the service. Please refer to the guide provided for each service for details and prepare in advance.

1.1 - Server Type

Search Engine server type

Search Engine provides a server type composed of various combinations such as CPU, Memory, Network Bandwidth, etc. When creating a Search Engine, Elastic Search is installed according to the server type selected to match the purpose of use.

The server types supported by the Search Engine are as follows.

Standard ses1v2m4

ses1 server type

The ses1 server type of Search Engine is provided with standard specifications (vCPU, Memory) and is suitable for various database workloads.

• Up to 3.3Ghz Intel 3rd generation (Ice Lake) Xeon Gold 6342 Processor
• Supports up to 16 vCPUs and 256 GB of memory
• Up to 12.5 Gbps networking speed

ses2 server type

The ses1 server type of Search Engine is provided with standard specifications (vCPU, Memory) and is suitable for various database workloads.

• Up to 3.2GHz Intel 4th generation (Sapphire Rapids) Xeon Gold 6448H Processor
• Supports up to 16 vCPUs and 256 GB of memory
• Up to 12.5 Gbps networking speed

SEH2 server type

The seh2 server type of Search Engine is provided with large-capacity server specifications and is suitable for database workloads for large-scale data processing.

• Up to 3.2GHz Intel 4th generation (Sapphire Rapids) Xeon Gold 6448H Processor
• Supports up to 72 vCPUs and 288 GB of memory
• Up to 25Gbps networking speed

1.2 - Monitoring Metrics

Search Engine Monitoring Metrics

The following table shows the performance monitoring metrics of Event Streams that can be checked through Cloud Monitoring. For detailed Cloud Monitoring usage, please refer to the Cloud Monitoring guide.

For server monitoring metrics of the Search Engine, please refer to the Virtual Server Monitoring Metrics guide.

2 - How-to guides

The user can enter the necessary information of the Search Engine through the Samsung Cloud Platform Console and create the service by selecting detailed options.

Creating Search Engine

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

To create a Search Engine, follow the next procedure.

1. All Services > Database > Search Engine menu, click. It moves to the Service Home page of Search Engine.

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

3. Search Engine Creation page where you enter the information needed to create a service and select detailed options.

   • Image and Version Selection area, please select the necessary information.

     Classification	Necessity	Detailed Description
     Image	Required	Select the type of image provided Elasticsearch Enterprise, OpenSearch
     Image Version	Required	Select the version of the selected image Provide a list of versions of the server image provided

     Fig. Search Engine image and version selection items

   • Enter Service Information area, please enter or select the necessary information.

     Classification	Necessity	Detailed Description
     Server Name Prefix	Required	The name of the server where Elasticsearch will be installed Starts with a lowercase letter, using 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 Name	Required	Name of the cluster that the servers are configured in Enter in English, 3-20 characters The cluster is a unit that bundles multiple servers
     MasterNode separate installation > use	essential	Whether to install the Master node separately Use is selected, the Master node is installed separately. If the Master node is not installed separately, the data node also performs the master role.
     MasterNode separate installation > MasterNode count	required	Number of Master nodes The master node is installed with a fixed 3 units for failover recovery.
     MasterNode separate installation > Server type	Required	Master node server type Standard: Standard specification commonly used High Capacity: High-capacity server with 24vCore or more For more information on the server type provided by Search Engine, refer to Search Engine server type
     MasterNode separate installation > Planned Compute	selection	Current 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 For more information, see Apply for Planned Compute
     MasterNode separate installation > Block Storage	required	Master node block storage type Basic OS: area where the engine is installed DATA: data file storage area 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 KMS (Key Management System) encryption key Capacity can be entered in multiples of 8 in the range of 16 to 5,120 Add Disk: data storage area After selecting Use, enter the Capacity of the storage To add storage, click the + button, and to delete, click the x button. Up to 9 can be added. Capacity can be entered in multiples of 8 in the range of 16 to 5,120, and up to 9 can be created
     Number of Nodes	Required	Number of Data Nodes In cases where the Master node is installed separately, 2 or more nodes are required, and in other cases, 1 or more nodes must be selected.
     Service Type > Server Type	Required	Data Node Server Type Standard: generally used standard specification High Capacity: high-capacity server with 24vCore or more
     Service Type > Planned Compute	Selection	Current 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 Planned Compute for each resource Apply for Planned Compute Service: Move to the Planned Compute service application page For more information, see How to Apply for Planned Compute
     Service Type > Block Storage	Required	Type of Block Storage to be used for data node Basic OS: Area where the engine is installed DATA: Data file storage area Please select the storage type and enter the capacity. (For more information on each Block Storage type, refer to Creating Block Storage) SSD: High-performance general volume HDD: General volume SSD_KMS/HDD_KMS: Additional encrypted volume using KMS (Key Management System) encryption key Capacity can be entered in multiples of 8 within the range of 16 to 5,120 Disk Add: Additional storage area for data, backup Select Use and enter the Purpose and Capacity of the storage To add storage, click the + button, and to delete, click the x button. Up to 9 can be added. Capacity can be entered in multiples of 8 within the range of 16 to 5,120, and up to 9 can be created
     Kibana > Server Type	Required	The type of server where Kibana will be installed Standard: Standard specification commonly used
     Kibana > Planned Compute	Selection	Current 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 For more information, see How to apply for Planned Compute
     Kibana > Block Storage	required	The type of Block Storage to be used on the server where Kibana will be installed Basic OS: The area where the engine is installed
     Network > Common Settings	Required	Network 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 Settings	Required	Network 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 The Public NAT function is available only when the VPC is connected to the Internet Gateway, and if Use is checked, you can select from the reserved IP in the VPC product’s Public IP. For more information, see Creating Public IP
     IP Access Control	Select	Set service access policy Set access policy for IPs 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 period	Select	Search Engine maintenance period Use Selecting the day of the week, start time, and duration It is recommended to set the maintenance period for stable management of the service. Patch work is performed at the set time and service interruption occurs If set to unused, problems that occur due to non-application of patches are not the responsibility of our company.

     Table. Search Engine service information input items

   • Database Configuration Required Information Input area, please enter or select the required information.

     Classification	Necessity	Detailed Description
     Backup > Use	Selection	Whether to use node backup If node backup is selected, select the storage period and backup start time
     Backup > Retention Period	Select	Backup Retention Period Please select the backup retention period. The file retention period can be set from 7 to 35 days Backup files may incur additional charges depending on capacity.
     Backup > Backup start time	Select	Backup start time Select the backup start time The minutes when the backup is performed are set randomly, and the backup end time cannot be set
     Cluster Port number	Required	Elasticsearch connection port number 1,024 ~ 65,535 can be entered as one of them, and Elasticsearch internal port 9300 and Kibana port 5301 are not available
     Elastic username	required	Elasticsearch username Enter within 2-20 characters using lowercase English letters 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-30 characters, including English, numbers, and special characters (excluding " ’ </code>)
     Elastic password confirmation	required	Confirm 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 not valid, service creation may not be possible. OpenSearch does not require a License Key.
     Time Zone	Selection	Standard Time Zone where the service will be used

     Fig. Search Engine Database Configuration Required Information Input Items

   • Enter Additional Information Enter or select the required information in the area.

     Classification	Necessity	Detailed Description
     Tag	Select	Add Tag Add Tag button to create and add a tag or add an existing tag Up to 50 tags can be added Newly added tags will be applied after service creation is complete

     Fig. Search Engine service additional information input items

4. In the Summary panel, review the detailed information and estimated charges, then click the Complete button.

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

Search Engine detailed information check

The Search Engine service can check and modify the entire resource list and detailed information. The Search Engine details page consists of detailed information, tags, and work history tabs.

To check the detailed information of the Search Engine service, follow the next procedure.

1. All services > Data Analytics > Search Engine menu, click. It moves to the Service Home page of Search Engine.
2. On the Service Home page, click the Search Engine menu. It moves to the Search Engine list page.
3. Search Engine list page, click on the resource to check the detailed information. Move to the Search Engine details page.
   • Search Engine Details The top of the page displays status information and additional features.

Detailed Information

On the Search Engine List page, you can check the detailed information of the selected resource and modify the information if necessary.

Tag

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

Work History

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

Search Engine Resource Management

If you need to change the existing setting options of the generated Search Engine resource or manage Parameters, or configure additional Nodes, you can perform the task on the Search Engine details page.

Operating Control

If there are changes to the Search Engine resources in operation, you can start, stop, and restart them.

To control the operation of the Search Engine, follow the next procedure.

1. Click on the menu of all services > Data Analytics > Search Engine. It moves to the Service Home page of Search Engine.
2. On the Service Home page, click the Search Engine menu. It moves to the Search Engine list page.
3. Search Engine list page, click the resource to control the operation. Move to the Search Engine details page.
4. Check the Search Engine status and complete the change through the control button below.
   • Start: The Search Engine service is installed on the server and the Search Engine service is running.
   • Stop: The Search Engine service installed on the server and the Search Engine service will be stopped.
   • Restart: Only the Search Engine 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 the Search Engine, follow the next procedure.

1. Click All Services > Data Analytics > Search Engine menu. It moves to the Service Home page of Search Engine.
2. On the Service Home page, click the Search Engine menu. It moves to the Search Engine list page.
3. Search Engine list page, click on the resource to check the service status. Move to the Search Engine details page.
4. Service Status Synchronization button should be clicked. It takes some time to retrieve, and during retrieval, the cluster changes to Synchronizing status.
5. When the query is complete, the status in the server information item is updated, and the cluster changes to Running status.

Changing Server Type

You can change the configured server type.

To change the server type, follow these steps.

1. All services > Data Analytics > Search Engine menu is clicked. It moves to the Service Home page of Search Engine.
2. Service Home page, click the Search Engine menu. Move to the Search Engine list page.
3. Search Engine list page, click the resource to change the server type. Move to the Search Engine details page.
4. Click the Edit button of the Server Type you want to change at the bottom of the detailed information. The Edit Server Type popup window opens.
5. In the Server Type Modification popup window, select the server type and click the Confirm 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 stopping the Search Engine, and if configured in a cluster, all nodes are expanded simultaneously.

To increase the storage capacity, follow the procedure below.

1. All services > Data Analytics > Search Engine menu is clicked. It moves to the Service Home page of Search Engine.
2. On the Service Home page, click the Search Engine menu. It moves to the Search Engine list page.
3. Search Engine list page, click the resource to change the server type. It moves to the Search Engine details page.
4. Click the Modify button of the additional Disk you want to add at the bottom of the detailed information. The Disk Modification popup window opens.
5. In the Disk Modification popup window, enter the expansion capacity and click the Confirm button.

Adding Storage

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

To add storage capacity, follow these steps.

1. All services > Data Analytics > Search Engine menu is clicked. It moves to the Service Home page of Search Engine.
2. On the Service Home page, click the Search Engine menu. It moves to the Search Engine list page.
3. Search Engine list page, click the resource to add storage. Move to the Search Engine details page.
4. Click the Add Disk button at the bottom of the detailed information. The Add Disk popup window opens.
5. In the Add Disk popup window, enter the purpose and capacity, then click the OK button.

Search Engine Backup

Through the backup settings function, users can set the data retention period and start cycle, and perform backup history inquiry and deletion through the backup history function.

Setting up backup

While creating the Search Engine, the procedure for setting up the backup is to refer to the Search Engine creation guide, and to modify the backup settings of the created resource, follow the following procedure.

1. All Services > Data Analytics > Search Engine menu is clicked. It moves to the Service Home page of Search Engine.
2. On the Service Home page, click the Search Engine menu. It moves to the Search Engine list page.
3. Search Engine list page, click the resource to set the backup. Move to the Search Engine details page.
4. Click the Edit button of the backup item. The Backup Edit popup window opens.
5. If you set up a backup, click Use in the Backup Modification popup window, select the storage period, backup start time, and Archive backup cycle, and then click the Confirm button.
   • If you want to stop the backup settings, uncheck Use in the Backup Modification popup window and click the OK button.

Check Backup History

To view the backup history, follow these steps.

1. All Services > Data Analytics > Search Engine menu is clicked. It moves to the Service Home page of Search Engine.
2. On the Service Home page, click the Search Engine menu. It moves to the Search Engine list page.
3. Search Engine list page, click the resource to check the backup history. Move to the Search Engine details page.
4. Click the Backup History button. The Backup History popup window opens.
5. Backup History popup window where you can check the backup status, version, backup start time, backup completion time, and capacity.

Deleting backup files

To delete the backup history, follow these steps.

1. Click on the menu for all services > Data Analytics > Search Engine. It moves to the Service Home page of the Search Engine.
2. On the Service Home page, click the Search Engine menu. It moves to the Search Engine list page.
3. Search Engine list page, click the resource to check the backup history. Move to the Search Engine details page.
4. Click the Backup History button. The Backup History popup window opens.
5. In the backup history popup window, check the file you want to delete and click the Delete button.

Search Engine recovery

In the event of a failure or data loss that requires restoration from a backup file, cluster recovery allows recovery based on a specific point in time.

To restore the Search Engine, follow the following procedure.

1. All Servives > Data Analytics > Search Engine menu should be clicked. It moves to the Service Home page of Search Engine.
2. On the Service Home page, click the Search Engine menu. It moves to the Search Engine list page.
3. Search Engine Resource Click on the resource you want to restore from the list page. It moves to the Search Engine Details page.
4. Click the Cluster Recovery button. It moves to the Cluster Recovery page.
5. Enter the corresponding information in the Cluster Recovery Configuration area, and then click the Complete button.

Add Node

If Search Engine cluster expansion is needed, you can add nodes with the same specifications as the data node in use.

To add a node, follow these steps.

1. All Services > Data Analytics > Search Engine menu should be clicked. It moves to the Service Home page of Search Engine.
2. On the Service Home page, click the Search Engine menu. It moves to the Search Engine list page.
3. Search Engines Resource menu should be clicked. It moves to the Search Engine Detail 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.

Search Engine cancellation

You can cancel the unused Search Engine to reduce operating costs. However, if you cancel 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 the Search Engine, follow the next procedure.

1. All services > Data Analytics > Search Engine menu is clicked. It moves to the Service Home page of Search Engine.
2. On the Service Home page, click the Search Engine menu. It moves to the Search Engine list page.
3. Search Engine list page, select the resource to be canceled and click the Service Cancellation button.
4. Once the cancellation is complete, please check if the resource has been cancelled on the Search Engine list page.

3 - API Reference

4 - CLI Reference

5 - Release Note

Search Engine