This is the multi-page printable view of this section. Click here to print.
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 provides Elasticsearch Enterprise version and OpenSearch version.
- Elasticsearch Enterprise’s software license uses a Bring Your Own License (BYOL), and the software license policy in cloud environments must follow the supplier’s policy.
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 3 or more. If a master node is not installed separately, the data node also performs the role of the master node and can be installed up to a maximum of 10. When a master node is installed separately, 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 UI.
- Operation Control Management: Provides functionality to control the status of running servers. Restart is possible for reflecting configuration values, along with starting and stopping the cluster.
- Backup and Recovery: Backup is possible using the built-in backup feature, and recovery can be performed to the point in time of the backup file.
- Add Data Node: If cluster expansion is required, 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 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.
Since the EOS and EoTS dates may change according to the supplier’s policy, please refer to the supplier’s license management policy page for details.
- Elasticsearch: https://www.elastic.co/kr/support/eol
Search Engine’s next version is scheduled to be provided after March 2026. The actual service provision schedule may change.
- OpenSearch 3.4.0 version
| Provided Version | EoS Date | EoTS Date |
|---|---|---|
| 8.15.0 | 2027-01 (planned) | 2027-07-15 |
| 8.19.7 | 2027-01 (scheduled) | 2027-07-15 |
- OpenSearch: https://opensearch.org/releases/
| Provided Version | EoS Date | EoTS Date |
|---|---|---|
| 2.19.3 | 2027-01 (planned) | 2027-07-15 |
| 3.4.0 | TBD | TBD |
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
| Category | Example | Detailed description |
|---|---|---|
| Server Type | Standard | Provided Server Types
|
| Server specifications | se1 | Provided server specifications
|
| Server specifications | v2 | Number of vCores
|
| Server specifications | m4 | Memory capacity
|
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.
| Service Category | Service | Detailed Description |
|---|---|---|
| Networking | VPC | A service that provides an independent virtual network in a cloud environment |
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
Classification | Example | Detailed Description |
|---|---|---|
| Server Type | Standard | Provided server type distinction
|
| Server Specification | db1 | Classification of provided server type and generation
|
| Server Specification | v2 | Number of vCores
|
| Server Specification | m4 | Memory Capacity
|
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
| Classification | Server Type | vCPU | Memory | Network Bandwidth |
|---|---|---|---|---|
| Standard | ses1v1m2 | 1 vCore | 2 GB | Up to 10 Gbps |
| Standard | ses1v2m8 | 2 vCore | 8 GB | Up to 10 Gbps |
| Standard | ses1v2m16 | 2 vCore | 16 GB | up to 10 Gbps |
| Standard | ses1v2m24 | 2 vCore | 24 GB | Up to 10 Gbps |
| Standard | ses1v2m32 | 2 vCore | 32 GB | Up to 10 Gbps |
| Standard | ses1v4m8 | 4 vCore | 8 GB | Up to 10 Gbps |
| Standard | ses1v4m16 | 4 vCore | 16 GB | Up to 10 Gbps |
| Standard | ses1v4m32 | 4 vCore | 32 GB | Up to 10 Gbps |
| Standard | ses1v4m48 | 4 vCore | 48 GB | Up to 10 Gbps |
| Standard | ses1v4m64 | 4 vCore | 64 GB | up to 10 Gbps |
| Standard | ses1v6m12 | 6 vCore | 12 GB | Up to 10 Gbps |
| Standard | ses1v6m24 | 6 vCore | 24 GB | Up to 10 Gbps |
| Standard | ses1v6m48 | 6 vCore | 48 GB | Up to 10 Gbps |
| Standard | ses1v6m72 | 6 vCore | 72 GB | Up to 10 Gbps |
| Standard | ses1v6m96 | 6 vCore | 96 GB | Up to 10 Gbps |
| Standard | ses1v8m16 | 8 vCore | 16 GB | Up to 10 Gbps |
| Standard | ses1v8m32 | 8 vCore | 32 GB | Up to 10 Gbps |
| Standard | ses1v8m64 | 8 vCore | 64 GB | Up to 10 Gbps |
| Standard | ses1v8m96 | 8 vCore | 96 GB | Up to 10 Gbps |
| Standard | ses1v8m128 | 8 vCore | 128 GB | Up to 10 Gbps |
| Standard | ses1v10m20 | 10 vCore | 20 GB | Up to 10 Gbps |
| Standard | ses1v10m40 | 10 vCore | 40 GB | Up to 10 Gbps |
| Standard | ses1v10m80 | 10 vCore | 80 GB | up to 10 Gbps |
| Standard | ses1v10m120 | 10 vCore | 120 GB | Up to 10 Gbps |
| Standard | ses1v10m160 | 10 vCore | 160 GB | up to 10 Gbps |
| Standard | ses1v12m24 | 12 vCore | 24 GB | Up to 12.5 Gbps |
| Standard | ses1v12m48 | 12 vCore | 48 GB | Up to 12.5 Gbps |
| Standard | ses1v12m96 | 12 vCore | 96 GB | up to 12.5 Gbps |
| Standard | ses1v12m144 | 12 vCore | 144 GB | Up to 12.5 Gbps |
| Standard | ses1v12m192 | 12 vCore | 192 GB | up to 12.5 Gbps |
| Standard | ses1v14m28 | 14 vCore | 28 GB | Up to 12.5 Gbps |
| Standard | ses1v14m56 | 14 vCore | 56 GB | Up to 12.5 Gbps |
| Standard | ses1v14m112 | 14 vCore | 112 GB | Up to 12.5 Gbps |
| Standard | ses1v14m168 | 14 vCore | 168 GB | up to 12.5 Gbps |
| Standard | ses1v14m224 | 14 vCore | 224 GB | Up to 12.5 Gbps |
| Standard | ses1v16m32 | 16 vCore | 32 GB | Up to 12.5 Gbps |
| Standard | ses1v16m64 | 16 vCore | 64 GB | up to 12.5 Gbps |
| Standard | ses1v16m128 | 16 vCore | 128 GB | up to 12.5 Gbps |
| Standard | ses1v16m192 | 16 vCore | 192 GB | up to 12.5 Gbps |
| Standard | ses1v16m256 | 16 vCore | 256 GB | up to 12.5 Gbps |
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
| Classification | Server Type | CPU vCore | Memory | Network Bandwidth(Gbps) |
|---|---|---|---|---|
| Standard | ses2v2m4 | 2 vCore | 4 GB | Up to 10 Gbps |
| Standard | ses2v2m8 | 2 vCore | 8 GB | Up to 10 Gbps |
| Standard | ses2v2m16 | 2 vCore | 16 GB | Up to 10 Gbps |
| Standard | ses2v2m24 | 2 vCore | 24 GB | Up to 10 Gbps |
| Standard | ses2v2m32 | 2 vCore | 32 GB | Up to 10 Gbps |
| Standard | ses2v4m8 | 4 vCore | 8 GB | Up to 10 Gbps |
| Standard | ses2v4m16 | 4 vCore | 16 GB | Up to 10 Gbps |
| Standard | ses2v4m32 | 4 vCore | 32 GB | Up to 10 Gbps |
| Standard | ses2v4m48 | 4 vCore | 48 GB | Up to 10 Gbps |
| Standard | ses2v4m64 | 4 vCore | 64 GB | Up to 10 Gbps |
| Standard | ses2v6m12 | 6 vCore | 12 GB | Up to 10 Gbps |
| Standard | ses2v6m24 | 6 vCore | 24 GB | Up to 10 Gbps |
| Standard | ses2v6m48 | 6 vCore | 48 GB | Up to 10 Gbps |
| Standard | ses2v6m72 | 6 vCore | 72 GB | Up to 10 Gbps |
| Standard | ses2v6m96 | 6 vCore | 96 GB | Up to 10 Gbps |
| Standard | ses2v8m16 | 8 vCore | 16 GB | Up to 10 Gbps |
| Standard | ses2v8m32 | 8 vCore | 32 GB | Up to 10 Gbps |
| Standard | ses2v8m64 | 8 vCore | 64 GB | up to 10 Gbps |
| Standard | ses2v8m96 | 8 vCore | 96 GB | Up to 10 Gbps |
| Standard | ses2v8m128 | 8 vCore | 128 GB | Up to 10 Gbps |
| Standard | ses2v10m20 | 10 vCore | 20 GB | Up to 10 Gbps |
| Standard | ses2v10m40 | 10 vCore | 40 GB | Up to 10 Gbps |
| Standard | ses2v10m80 | 10 vCore | 80 GB | Up to 10 Gbps |
| Standard | ses2v10m120 | 10 vCore | 120 GB | Up to 10 Gbps |
| Standard | ses2v10m160 | 10 vCore | 160 GB | Up to 10 Gbps |
| Standard | ses2v12m24 | 12 vCore | 24 GB | Up to 12.5 Gbps |
| Standard | ses2v12m48 | 12 vCore | 48 GB | Up to 12.5 Gbps |
| Standard | ses2v12m96 | 12 vCore | 96 GB | Up to 12.5 Gbps |
| Standard | ses2v12m144 | 12 vCore | 144 GB | Up to 12.5 Gbps |
| Standard | ses2v12m192 | 12 vCore | 192 GB | Up to 12.5 Gbps |
| Standard | ses2v14m28 | 14 vCore | 28 GB | Up to 12.5 Gbps |
| Standard | ses2v14m56 | 14 vCore | 56 GB | Up to 12.5 Gbps |
| Standard | ses2v14m112 | 14 vCore | 112 GB | Up to 12.5 Gbps |
| Standard | ses2v14m168 | 14 vCore | 168 GB | Up to 12.5 Gbps |
| Standard | ses2v14m224 | 14 vCore | 224 GB | up to 12.5 Gbps |
| Standard | ses2v16m32 | 16 vCore | 32 GB | Up to 12.5 Gbps |
| Standard | ses2v16m64 | 16 vCore | 64 GB | up to 12.5 Gbps |
| Standard | ses2v16m128 | 16 vCore | 128 GB | Up to 12.5 Gbps |
| Standard | ses2v16m192 | 16 vCore | 192 GB | Up to 12.5 Gbps |
| Standard | ses2v16m256 | 16 vCore | 256 GB | up to 12.5 Gbps |
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
| Classification | Server Type | vCPU | Memory | Network Bandwidth |
|---|---|---|---|---|
| High Capacity | seh2v24m48 | 24 vCore | 48 GB | Up to 25 Gbps |
| High Capacity | seh2v24m96 | 24 vCore | 96 GB | Up to 25 Gbps |
| High Capacity | seh2v24m192 | 24 vCore | 192 GB | Up to 25 Gbps |
| High Capacity | seh2v24m288 | 24 vCore | 288 GB | Up to 25 Gbps |
| High Capacity | seh2v32m64 | 32 vCore | 64 GB | Up to 25 Gbps |
| High Capacity | seh2v32m128 | 32 vCore | 128 GB | Up to 25 Gbps |
| High Capacity | seh2v32m256 | 32 vCore | 256 GB | Up to 25 Gbps |
| High Capacity | seh2v48m96 | 48 vCore | 96 GB | Up to 25 Gbps |
| High Capacity | seh2v48m192 | 48 vCore | 192 GB | Up to 25 Gbps |
| High Capacity | seh2v64m128 | 64 vCore | 128 GB | Up to 25 Gbps |
| High Capacity | seh2v64m256 | 64 vCore | 256 GB | Up to 25 Gbps |
| High Capacity | seh2v72m144 | 72 vCore | 144 GB | Up to 25 Gbps |
| High Capacity | seh2v72m288 | 72 vCore | 288 GB | Up to 25 Gbps |
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.
| Performance Item | Detailed Description | Unit |
|---|---|---|
| Disk Usage | datadir usage | MB |
| Documents [Deleted] | total number of deleted documents | cnt |
| Documents [Existing] | total number of existing documents | cnt |
| Filesystem Bytes [Available] | available filesystem | bytes |
| Filesystem Bytes [Free] | free filesystem | bytes |
| Filesystem Bytes [Total] | total filesystem | bytes |
| Instance Status [PID] | Elasticsearch process PID | PID |
| JVM Heap Used [Init] | JVM heap used init (bytes) | bytes |
| JVM Heap Used [MAX] | JVM heap used max (bytes) | bytes |
| JVM Non Heap Used [Init] | JVM non-heap used init (bytes) | bytes |
| JVM Non Heap Used [MAX] | JVM non-heap used max (bytes) | bytes |
| Kibana Connections | Kibana connections | cnt |
| Kibana Memory Heap Allocated [Limit] | maximum allocated Node.js process heap size (bytes) | bytes |
| Kibana Memory Heap Allocated [Total] | total allocated Node.js process heap size (bytes) | bytes |
| Kibana Memory Heap Used | used Node.js process heap size (bytes) | bytes |
| Kibana Process Uptime | Kibana process uptime | ms |
| Kibana Requests [Disconnected] | request count metric | cnt |
| Kibana Requests [Total] | request count metric | cnt |
| Kibana Response Time [Avg] | response time metric | ms |
| Kibana Response Time [MAX] | response time metric | ms |
| Kibana Status [PID] | Kibana process PID | PID |
| License Expiry Date [ms] | license expiry date [milliseconds] | ms |
| License Status | license status | status |
| License Type | license type | type |
| Queue Time | queue time | ms |
| Segments | total number of segments | cnt |
| Segments Bytes | total segment size (bytes) | bytes |
| Shards | cluster shard count | cnt |
| Store Bytes | total store size (bytes) | bytes |
2 - 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.
Before creating the service, make sure to configure the VPC Subnet type to General.
- If the Subnet type is Local, you cannot create the Database service.
Follow the procedure below to create a Search Engine.
Click All Services > Database > Search Engine menu. You will be moved to the Service Home page of Search Engine.
Click the Create Search Engine button on the Service Home page. You will be moved to the Create Search Engine page.
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 RequiredDescription 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 RequiredDescription 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
- Select storage type and enter capacity (for more details about each Block Storage type, refer to Create Block Storage)
- 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
- Select storage type and enter capacity (for more details about each Block Storage type, refer to Create Block Storage)
- 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 - Start with lowercase English letters, and enter 3 to 13 characters using lowercase letters, numbers, and special characters (
- Enter or select the required information in the Database Configuration Required Information Input area.
Division RequiredDescription 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 RequiredDescription 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
- Select the required information in the Image and Version Selection area.
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.
- Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
- Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
- 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
- Status information and additional feature information are displayed at the top of the Search Engine Details page.
Details
You can check the detailed information of the resource selected on the Search Engine List page and modify information if necessary.
| Division | Description |
|---|---|
| Server Information | Server information configured in the cluster
|
| Service | Service name |
| Resource Type | Resource type |
| SRN | Unique resource ID in Samsung Cloud Platform
|
| Resource Name | Resource name
|
| Resource ID | Unique resource ID in the service |
| Creator | User who created the service |
| Created At | Date and time when the service was created |
| Modifier | User who modified the service information |
| Modified At | Date and time when the service information was modified |
| Image/Version | Installed service image and version information |
| Cluster Name | Cluster name where servers are configured |
| Planned Compute | Resource status where Planned Compute is set
|
| Maintenance Window | Maintenance window status
|
| Backup | Backup setting status
|
| Time Zone | Standard time zone where the service is used |
| License | Elasticsearch license information
|
| Elastic Username | Elasticsearch username |
| Kibana Connection Information | Kibana connection information |
| Network | Installed network information (VPC, Subnet) |
| IP Access Control | Service access policy settings
|
| Master | Server type, basic OS, additional Disk information for Master node
|
| Data | Server type, basic OS, additional Disk information for Broker node
|
| Kibana | Server type, basic OS information for Kibana node
|
Tags
You can check the tag information of the resource selected on the Search Engine List page and add, change, or delete tags.
| Division | Description |
|---|---|
| Tag List | Tag list
|
Operation History
You can check the operation history of the resource selected on the Search Engine List page.
| Division | Description |
|---|---|
| Operation History List | Resource change history
|
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.
- Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
- Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
- 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.
- 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.
- Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
- Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
- 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.
- Click Synchronize Service Status button. It takes some time to check, and cluster changes to Synchronizing status during checking.
- 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.
- If server type is configured as Standard, it cannot be changed to High Capacity. If you want to change to High Capacity, create a new service.
- If server type is modified, server restart is required. Please check separately for SW license modification matters or SW settings and reflection according to specification change.
- Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
- Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
- 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.
- Click Modify button of the Server Type you want to change at the bottom of detailed information. Modify Server Type popup window opens.
- 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.
- If existing Block Storage has encryption setting, encryption is also applied to additional Disk.
- Disk size modification is only possible to expand more than 16GB than current disk size.
Follow the procedure below to expand storage capacity.
- Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
- Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
- 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.
- Click Modify button of the Additional Disk you want to expand at the bottom of detailed information. Modify Disk popup window opens.
- 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.
- If existing Block Storage has encryption setting, encryption is also applied to additional Disk.
Follow the procedure below to add storage capacity.
- Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
- Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
- 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.
- Click Add Disk button at the bottom of detailed information. Add Disk popup window opens.
- 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.
- If backup is set, backup is performed at the specified time after the set time, and additional charges occur depending on backup capacity.
- If backup setting is changed to Not Set, backup execution stops immediately, and stored backup data is deleted and can no longer be used.
- Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
- Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
- 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.
- Click Modify button in the backup item. Modify Backup popup window opens.
- 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.
- Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
- Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
- 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.
- Click Backup History button. Backup History popup window opens.
- 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.
- Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
- Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
- 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.
- Click Backup History button. Backup History popup window opens.
- 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.
- Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
- Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
- Click the resource you want to recover on the Search Engine Resource list page. You will be moved to the Search Engine Details page.
- Click Cluster Recovery button. You will be moved to the Cluster Recovery page.
- Enter the corresponding information in the Cluster Recovery Configuration area, and click Complete button.
Division RequiredDescription 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.
- You can use up to 10 nodes within a cluster. Note that additional charges occur for created nodes.
- During node addition, cluster performance may degrade.
Follow the procedure below to add nodes.
- Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
- Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
- Click the resource you want to recover on the Search Engine Resources list page. You will be moved to the Search Engine Details page.
- Click Add Broker Node button. You will be moved to the Add Broker Node page.
- Enter the corresponding information in the Required Information Input area, and click Complete button.
Division RequiredDescription 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.
- Click All Services > Data Analytics > Search Engine menu. You will be moved to the Service Home page of Search Engine.
- Click Search Engine menu on the Service Home page. You will be moved to the Search Engine List page.
- Select the resource to terminate on the Search Engine List page, and click Terminate Service button.
- When termination is completed, check if the resource is terminated on the Search Engine list page.
3 - API Reference
4 - CLI Reference
5 - Release Note
Search Engine
- OpenSearch 2.17.1 is newly provided.
- It provides Terraform.
- HDD, HDD_KMS disk types are also provided.
- A Search Engine service that can easily create and manage ElasticSearch Enterprise in a web environment has been released.