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.

Notice
  • 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.

Information

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 VersionEoS DateEoTS Date
8.15.02027-01 (planned)2027-07-15
8.19.72027-01 (scheduled)2027-07-15
Table. Search Engine's Elasticsearch engine version
Provided VersionEoS DateEoTS Date
2.19.32027-01 (planned)2027-07-15
3.4.0TBDTBD
Table. Search Engine's OpenSearch engine version

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
CategoryExampleDetailed description
Server TypeStandardProvided Server Types
  • Standard: Standard specifications (vCPU, Memory) configuration commonly used
  • High Capacity: High-capacity server specifications of 24 vCore or more
Server specificationsse1Provided server specifications
  • se1: Standard specifications (vCPU, Memory) configuration commonly used
  • seh2: Large-capacity server specifications
    • Provides servers with 24 vCore or more
Server specificationsv2Number of vCores
  • v2: 2 virtual cores
Server specificationsm4Memory capacity
  • m4: 4GB Memory
Table. Search Engine Server Type Components

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 CategoryServiceDetailed Description
NetworkingVPCA service that provides an independent virtual network in a cloud environment
Table. Search Engine Pre-service

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
ExampleDetailed Description
Server TypeStandardProvided server type distinction
  • Standard: Composed of standard specifications (vCPU, Memory) commonly used
  • High Capacity: Server specifications with higher capacity than Standard
Server Specificationdb1Classification of provided server type and generation
  • ses1: s means general specification, and 1 means generation
  • seh2: h means large-capacity server specification, and 2 means generation
Server Specificationv2Number of vCores
  • v2: 2 virtual cores
Server Specificationm4Memory Capacity
  • m4: 4GB Memory
Table. Search Engine server type format

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
ClassificationServer TypevCPUMemoryNetwork Bandwidth
Standardses1v1m21 vCore2 GBUp to 10 Gbps
Standardses1v2m82 vCore8 GBUp to 10 Gbps
Standardses1v2m162 vCore16 GBup to 10 Gbps
Standardses1v2m242 vCore24 GBUp to 10 Gbps
Standardses1v2m322 vCore32 GBUp to 10 Gbps
Standardses1v4m84 vCore8 GBUp to 10 Gbps
Standardses1v4m164 vCore16 GBUp to 10 Gbps
Standardses1v4m324 vCore32 GBUp to 10 Gbps
Standardses1v4m484 vCore48 GBUp to 10 Gbps
Standardses1v4m644 vCore64 GBup to 10 Gbps
Standardses1v6m126 vCore12 GBUp to 10 Gbps
Standardses1v6m246 vCore24 GBUp to 10 Gbps
Standardses1v6m486 vCore48 GBUp to 10 Gbps
Standardses1v6m726 vCore72 GBUp to 10 Gbps
Standardses1v6m966 vCore96 GBUp to 10 Gbps
Standardses1v8m168 vCore16 GBUp to 10 Gbps
Standardses1v8m328 vCore32 GBUp to 10 Gbps
Standardses1v8m648 vCore64 GBUp to 10 Gbps
Standardses1v8m968 vCore96 GBUp to 10 Gbps
Standardses1v8m1288 vCore128 GBUp to 10 Gbps
Standardses1v10m2010 vCore20 GBUp to 10 Gbps
Standardses1v10m4010 vCore40 GBUp to 10 Gbps
Standardses1v10m8010 vCore80 GBup to 10 Gbps
Standardses1v10m12010 vCore120 GBUp to 10 Gbps
Standardses1v10m16010 vCore160 GBup to 10 Gbps
Standardses1v12m2412 vCore24 GBUp to 12.5 Gbps
Standardses1v12m4812 vCore48 GBUp to 12.5 Gbps
Standardses1v12m9612 vCore96 GBup to 12.5 Gbps
Standardses1v12m14412 vCore144 GBUp to 12.5 Gbps
Standardses1v12m19212 vCore192 GBup to 12.5 Gbps
Standardses1v14m2814 vCore28 GBUp to 12.5 Gbps
Standardses1v14m5614 vCore56 GBUp to 12.5 Gbps
Standardses1v14m11214 vCore112 GBUp to 12.5 Gbps
Standardses1v14m16814 vCore168 GBup to 12.5 Gbps
Standardses1v14m22414 vCore224 GBUp to 12.5 Gbps
Standardses1v16m3216 vCore32 GBUp to 12.5 Gbps
Standardses1v16m6416 vCore64 GBup to 12.5 Gbps
Standardses1v16m12816 vCore128 GBup to 12.5 Gbps
Standardses1v16m19216 vCore192 GBup to 12.5 Gbps
Standardses1v16m25616 vCore256 GBup to 12.5 Gbps
Table. Search Engine server type specification - ses1 server type

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
ClassificationServer TypeCPU vCoreMemoryNetwork Bandwidth(Gbps)
Standardses2v2m42 vCore4 GBUp to 10 Gbps
Standardses2v2m82 vCore8 GBUp to 10 Gbps
Standardses2v2m162 vCore16 GBUp to 10 Gbps
Standardses2v2m242 vCore24 GBUp to 10 Gbps
Standardses2v2m322 vCore32 GBUp to 10 Gbps
Standardses2v4m84 vCore8 GBUp to 10 Gbps
Standardses2v4m164 vCore16 GBUp to 10 Gbps
Standardses2v4m324 vCore32 GBUp to 10 Gbps
Standardses2v4m484 vCore48 GBUp to 10 Gbps
Standardses2v4m644 vCore64 GBUp to 10 Gbps
Standardses2v6m126 vCore12 GBUp to 10 Gbps
Standardses2v6m246 vCore24 GBUp to 10 Gbps
Standardses2v6m486 vCore48 GBUp to 10 Gbps
Standardses2v6m726 vCore72 GBUp to 10 Gbps
Standardses2v6m966 vCore96 GBUp to 10 Gbps
Standardses2v8m168 vCore16 GBUp to 10 Gbps
Standardses2v8m328 vCore32 GBUp to 10 Gbps
Standardses2v8m648 vCore64 GBup to 10 Gbps
Standardses2v8m968 vCore96 GBUp to 10 Gbps
Standardses2v8m1288 vCore128 GBUp to 10 Gbps
Standardses2v10m2010 vCore20 GBUp to 10 Gbps
Standardses2v10m4010 vCore40 GBUp to 10 Gbps
Standardses2v10m8010 vCore80 GBUp to 10 Gbps
Standardses2v10m12010 vCore120 GBUp to 10 Gbps
Standardses2v10m16010 vCore160 GBUp to 10 Gbps
Standardses2v12m2412 vCore24 GBUp to 12.5 Gbps
Standardses2v12m4812 vCore48 GBUp to 12.5 Gbps
Standardses2v12m9612 vCore96 GBUp to 12.5 Gbps
Standardses2v12m14412 vCore144 GBUp to 12.5 Gbps
Standardses2v12m19212 vCore192 GBUp to 12.5 Gbps
Standardses2v14m2814 vCore28 GBUp to 12.5 Gbps
Standardses2v14m5614 vCore56 GBUp to 12.5 Gbps
Standardses2v14m11214 vCore112 GBUp to 12.5 Gbps
Standardses2v14m16814 vCore168 GBUp to 12.5 Gbps
Standardses2v14m22414 vCore224 GBup to 12.5 Gbps
Standardses2v16m3216 vCore32 GBUp to 12.5 Gbps
Standardses2v16m6416 vCore64 GBup to 12.5 Gbps
Standardses2v16m12816 vCore128 GBUp to 12.5 Gbps
Standardses2v16m19216 vCore192 GBUp to 12.5 Gbps
Standardses2v16m25616 vCore256 GBup to 12.5 Gbps
Table. Search Engine server type specification - ses2 server type

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
ClassificationServer TypevCPUMemoryNetwork Bandwidth
High Capacityseh2v24m4824 vCore48 GBUp to 25 Gbps
High Capacityseh2v24m9624 vCore96 GBUp to 25 Gbps
High Capacityseh2v24m19224 vCore192 GBUp to 25 Gbps
High Capacityseh2v24m28824 vCore288 GBUp to 25 Gbps
High Capacityseh2v32m6432 vCore64 GBUp to 25 Gbps
High Capacityseh2v32m12832 vCore128 GBUp to 25 Gbps
High Capacityseh2v32m25632 vCore256 GBUp to 25 Gbps
High Capacityseh2v48m9648 vCore96 GBUp to 25 Gbps
High Capacityseh2v48m19248 vCore192 GBUp to 25 Gbps
High Capacityseh2v64m12864 vCore128 GBUp to 25 Gbps
High Capacityseh2v64m25664 vCore256 GBUp to 25 Gbps
High Capacityseh2v72m14472 vCore144 GBUp to 25 Gbps
High Capacityseh2v72m28872 vCore288 GBUp to 25 Gbps
Table. Search Engine server type specification - seh2 server type

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 ItemDetailed DescriptionUnit
Disk Usagedatadir usageMB
Documents [Deleted]total number of deleted documentscnt
Documents [Existing]total number of existing documentscnt
Filesystem Bytes [Available]available filesystembytes
Filesystem Bytes [Free]free filesystembytes
Filesystem Bytes [Total]total filesystembytes
Instance Status [PID]Elasticsearch process PIDPID
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 ConnectionsKibana connectionscnt
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 Usedused Node.js process heap size (bytes)bytes
Kibana Process UptimeKibana process uptimems
Kibana Requests [Disconnected]request count metriccnt
Kibana Requests [Total]request count metriccnt
Kibana Response Time [Avg]response time metricms
Kibana Response Time [MAX]response time metricms
Kibana Status [PID]Kibana process PIDPID
License Expiry Date [ms]license expiry date [milliseconds]ms
License Statuslicense statusstatus
License Typelicense typetype
Queue Timequeue timems
Segmentstotal number of segmentscnt
Segments Bytestotal segment size (bytes)bytes
Shardscluster shard countcnt
Store Bytestotal store size (bytes)bytes
Table. Search Engine Monitoring Metrics

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.

Notice

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.

Notice
The following explanation is for the case where Elasticsearch Enterprise image is selected.
  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
      ImageRequiredSelect the type of image provided
      • Elasticsearch Enterprise, OpenSearch
      Image VersionRequiredSelect 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 PrefixRequiredServer 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 NameRequiredCluster name where servers are configured
      • Enter 3 to 20 characters using English letters
      • Cluster is a unit that bundles multiple servers
      Install MasterNode Separately > UseRequiredWhether 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 CountRequiredNumber of Master nodes
      • Master nodes are installed with fixed 3 units for recovery (Fail-over)
      Install MasterNode Separately > Server TypeRequiredMaster node server type
      • Standard: Standard specifications commonly used
      • High Capacity: Large capacity servers with 24vCore or more
      Install MasterNode Separately > Planned ComputeOptionalResource 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
      Install MasterNode Separately > Block StorageRequiredBlock 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 CountRequiredNumber of data nodes
      • If Master node is installed separately, select 2 or more; otherwise, select 1 or more
      Service Type > Server TypeRequiredData node server type
      • Standard: Standard specifications commonly used
      • High Capacity: Large capacity servers with 24vCore or more
      Service Type > Planned ComputeOptionalResource 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
      Service Type > Block StorageRequiredBlock 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 TypeRequiredServer type where Kibana is installed
      • Standard: Standard specifications commonly used
      Kibana > Planned ComputeOptionalResource 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
      Kibana > Block StorageRequiredBlock Storage type to be used for server where Kibana is installed
      • Basic OS: Area where engine is installed
      Network > Common SettingsRequiredNetwork 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 SettingsRequiredNetwork 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 ControlOptionalService 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 WindowOptionalSearch 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 > UseOptionalWhether to use node backup
      • If node backup is selected, select retention period and backup start time
      Backup > Retention PeriodOptionalBackup 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 TimeOptionalBackup start time
      • Select backup start time
      • Backup execution minutes are set randomly, and backup end time cannot be set
      Cluster Port NumberRequiredElasticsearch 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 UsernameRequiredElasticsearch 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 PasswordRequiredElasticsearch connection password
      • Enter 8 to 30 characters including English letters, numbers, and special characters (excluding ", , \)
      Elastic Password ConfirmationRequiredElasticsearch connection password confirmation
      • Re-enter the Elasticsearch connection password identically
      License KeyRequiredElasticsearch 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 ZoneOptionalStandard 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
      TagsOptionalAdd 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.
      DivisionDescription
      Cluster StatusCluster 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 ControlButtons to change cluster status
      • Start: Starts the stopped cluster
      • Stop: Stops the running cluster
      • Restart: Restarts the running cluster
      Additional Features MoreCluster-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 TerminationButton 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.

DivisionDescription
Server InformationServer information configured in the cluster
  • Category: Server type (Master&Data, Master, Data, Kibana)
  • Server Name: Server name
  • IP:Port: Server IP and port
  • NAT IP: NAT IP
  • Status: Server status
ServiceService name
Resource TypeResource type
SRNUnique resource ID in Samsung Cloud Platform
  • Means cluster SRN
Resource NameResource name
  • Means cluster name
Resource IDUnique resource ID in the service
CreatorUser who created the service
Created AtDate and time when the service was created
ModifierUser who modified the service information
Modified AtDate and time when the service information was modified
Image/VersionInstalled service image and version information
Cluster NameCluster name where servers are configured
Planned ComputeResource status where Planned Compute is set
Maintenance WindowMaintenance window status
  • If maintenance window setting is needed, click Modify button to set
BackupBackup setting status
  • If backup setting is needed, click Modify button to set
Time ZoneStandard time zone where the service is used
LicenseElasticsearch license information
  • License update is possible in Kibana > Stack Management > License management
  • If License expires, service cannot be used
Elastic UsernameElasticsearch username
Kibana Connection InformationKibana connection information
NetworkInstalled network information (VPC, Subnet)
IP Access ControlService access policy settings
  • If IP addition or deletion is needed, click Modify button to set
MasterServer type, basic OS, additional Disk information for Master node
  • If server type modification is needed, click Modify button next to server type to set
    • If server type is modified, server restart is required
  • If storage expansion is needed, click Modify button next to storage capacity to expand
  • If storage addition is needed, click Add Disk button next to additional Disk to add
DataServer type, basic OS, additional Disk information for Broker node
  • If server type modification is needed, click Modify button next to server type to set
    • If server type is modified, server restart is required
  • If storage addition is needed, click Add Disk button next to additional Disk to add
KibanaServer type, basic OS information for Kibana node
  • If server type modification is needed, click Modify button next to server type to set
    • If server type is modified, server restart is required
Table. Search Engine Details Information Items

Tags

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

DivisionDescription
Tag ListTag list
  • Can check tag Key, Value information
  • Can add up to 50 tags per resource
  • When entering tags, search and select from previously created Key and Value lists
Table. Search Engine Tags Tab Items

Operation History

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

DivisionDescription
Operation History ListResource change history
  • Check operation details, operation date and time, resource type, resource ID, resource name, event topic, operation result, operator information
Table. Search Engine Operation History Tab Detailed Information Items

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.

Caution
  • 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.
  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.

Notice
  • 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.

  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.

Notice
  • If existing Block Storage has encryption setting, encryption is also applied to additional Disk.

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.

Caution
  • 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.
  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

Notice
To set notifications for backup success and failure, you can set through Notification Manager product. For detailed usage guide for notification policy setting, refer to Create Notification Policy.

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.

Caution
Deleted backup files cannot be restored, so please make sure to check if it is unnecessary data before deleting.
  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.

Caution
For recovery execution, capacity at least equal to data type Disk capacity is required. If Disk capacity is insufficient, recovery may fail.

Notice
Cluster recovery is restored to the same configuration as the original. For example, if configured with 3 Master nodes and 2 Data nodes, it is restored to the same configuration

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 PointRequiredSet the time point user wants to recover
    • Select from the list of time points of backup files displayed in the list
    Server Name PrefixRequiredRecovery 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 NameRequiredRecovery server cluster name
    • Enter 3 to 20 characters using English letters
    • Cluster is a unit that bundles multiple servers
    Node CountRequiredNumber of data nodes
    • Set to the same as the number of nodes set in the original cluster
    Service Type > Server TypeRequiredData node server type
    • Set to the same as the number of nodes set in the original cluster
    Service Type > Planned ComputeOptionalResource 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
    Service Type > Block StorageRequiredBlock 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 > UseRequiredWhether to install Master node separately
    • Applied identically to the installation status of the original cluster
    Install MasterNode Separately > MasterNode CountRequiredNumber of Master nodes
    Install MasterNode Separately > Server TypeRequiredMaster node server type
    • Set to the same as the number of nodes set in the original cluster
    Install MasterNode Separately > Planned ComputeOptionalResource 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
    Install MasterNode Separately > Block StorageRequiredBlock 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 TypeRequiredKibana node server type
    • Set to the same as the number of nodes set in the original cluster
    Kibana > Planned ComputeOptionalResource 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
    Kibana > Block StorageRequiredBlock Storage to be used for Kibana node
    • Basic OS: Area where engine is installed
    Cluster Port NumberRequiredElasticsearch connection port number
    • Set identically to the port number set in the original cluster
    License KeyRequiredElasticsearch 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 ControlOptionalService 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 WindowOptionalMaintenance 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.

Notice
  • 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.

  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 PrefixRequiredData node server name
    • Set to the server name set in the original cluster
    Cluster NameRequiredCluster name
    • Set to the cluster name set in the original cluster
    Additional Node CountRequiredNumber of Nodes to add
    • Use up to 10 nodes in one cluster
    Service Type > Server TypeRequiredData node server type
    • Set identically to the server type set in the original cluster
    Service Type > Planned ComputeOptionalResource 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
    Service Type > Block StorageRequiredBlock Storage settings to be used for data nodes
    • Storage type and capacity set in the original cluster are applied identically
    NetworkRequiredNetwork 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.

3 - API Reference

API Reference

4 - CLI Reference

CLI Reference

5 - Release Note

Search Engine

2025.07.01
FEATURE New feature, Terraform and disk type added
  • OpenSearch 2.17.1 is newly provided.
  • It provides Terraform.
  • HDD, HDD_KMS disk types are also provided.
2025.02.27
NEW Search Engine Service Official Version Release
  • A Search Engine service that can easily create and manage ElasticSearch Enterprise in a web environment has been released.