Skip to main content

Key concepts

Advanced Managed Search from KakaoCloud is a managed search service that provides OpenSearch-based indexes and data as a fully managed platform. It allows users to integrate, search, and analyze large-scale data without managing complex cluster infrastructure.

Cluster​

A cluster is an OpenSearch execution unit composed of multiple nodes (Data Node and Cluster Manager Node) that perform indexing and analysis tasks. A cluster provides an integrated search and analytics environment including high-performance search processing, data durability, scalability, and security configuration. It enables reliable exploration of data generated from various applications and systems.
The following describes the lifecycle and status of an OpenSearch cluster in the Advanced Managed Search service.

Cluster lifecycle and status​

이미지
Cluster lifecycle

StatusDescription
PendingWaiting state for resource allocation and initialization required to create the cluster
ProvisioningDeploying infrastructure resources for cluster configuration (OpenSearch nodes, Dashboards, nginx, etc.)
InitializingConfiguring the OpenSearch engine, plugins, and runtime environment on the deployed infrastructure and establishing communication between data nodes
RunningAll nodes in the cluster are operating normally and search engine services and dashboard access are available
Scaling OutExpanding the number of data nodes to respond to changing workloads
- If a Provisioning Error occurs during data node scaling, the cluster remains in the Scaling Out state
Volume ResizingExpanding the volume size of each data node to secure additional storage capacity
ErrorSearch service is unavailable due to system failure or health check failure
- Only cluster deletion is available in this state
DeletingDeleting the cluster and all associated infrastructure resources

Network configuration​

All nodes of Advanced Managed Search are created inside the user-specified VPC.
For the cluster to operate correctly, a security group must be configured, and the necessary inbound rules must allow node-to-node communication and management traffic.
Through network design, you can block external access or control cluster access paths using specific subnets and security policies.
For more information about network and security settings, refer to Security groups.

Data node​

Data nodes are core components in OpenSearch that store and index actual data.
When creating a cluster, the same number of data nodes are automatically distributed across availability zones. Balanced distribution between nodes contributes to stable search performance and improved fault recovery capability. The instance type and volume size specified by the user are applied equally to each data node.

Data nodes perform the following tasks.

  • Index and store documents
  • Manage shard allocation and maintain replicas
  • Process search queries and return results
  • Distribute cluster load and support scaling

When workload increases, cluster performance can be improved easily by adding data nodes or expanding volumes.

Data node lifecycle and status​

이미지
Data node lifecycle

StatusDescription
PendingInitial state waiting for resource allocation for data node creation
ProvisioningDeploying resources for the data node (VM, network, port, volume, etc.)
Provisioning ErrorInfrastructure provisioning failed due to insufficient resources or storage allocation errors
InitializingInstalling and running files required for data processing, such as the OpenSearch engine and monitoring agents
RunningData node operating normally and capable of handling indexing and search requests
Volume ResizingExpanding the allocated volume size to resolve storage shortages or improve performance
ErrorData input/output unavailable due to health check failure or hardware failure
- Only cluster deletion is available in this state
DeletingDeleting the data node and stored data

Volume​

The volume size specified when creating the cluster is applied equally to all data nodes, and each node stores data using the assigned volume. OpenSearch distributes and replicates data by shard, so node volume size directly affects the cluster’s total storage capacity and performance. Volume size can be expanded during cluster operation without service interruption, providing flexible scalability for workloads that store large volumes of logs or analytics data.
For more information about volumes, refer to Create and manage volumes.

Cluster manager node​

Cluster manager nodes maintain cluster state and manage metadata. In Advanced Managed Search, three cluster manager nodes are always automatically created and distributed across availability zones to ensure stable operation even during failures.

Cluster manager nodes perform the following functions.

  • Manage cluster metadata
  • Determine shard allocation and movement
  • Monitor node status and detect failures
  • Manage the master election process

Users do not need to manage or modify manager nodes directly. KakaoCloud maintains three nodes at all times to ensure stable operation.

StatusDescription
PendingInitial state waiting for resource allocation for cluster manager node creation
ProvisioningDeploying resources for the cluster manager node (VM, network, port, volume, etc.)
Provisioning ErrorInfrastructure provisioning failed due to insufficient resources or network configuration errors
InitializingInstalling and running essential software such as OpenSearch processes and cluster management agents
RunningCluster manager node operating normally and capable of managing cluster metadata and monitoring
ErrorNode control functions unavailable due to health check failure or master election process errors
- Only cluster deletion is available in this state
DeletingDeleting the cluster manager node and related resources

Cluster manager node lifecycle and status​

이미지
Cluster manager node lifecycle

Master user​

The master user is a privileged account used to perform administrative operations on the OpenSearch cluster.
When creating the cluster, the username and password are configured. After creation, the account can perform the following operations through OpenSearch Dashboards or APIs.

  • Create and delete indexes
  • Manage user and role-based access control
  • Configure templates and ISM (Index State Management) policies
  • Grant permissions for search and analytics tasks
  • Check cluster status and modify configurations

Because the master user account has critical permissions for cluster operations, secure password configuration and access management are important.

OpenSearch version​

Advanced Managed Search currently provides the following version.

OpenSearch versionSupport start dateSupport end date
2.19.22026-02-26-

Custom API​

S3 snapshot​

This custom API allows KakaoCloud Object Storage to be used as long-term storage for OpenSearch. You can create snapshots of indexes to store data safely and restore them to a specific point in time when needed.

1. Register snapshot repository​

Before creating a snapshot, you must configure a repository where snapshots will be stored. Register the repository using KakaoCloud Object Storage information.

Request
PUT _snapshot/my_s3_repository
{
  "type": "s3",
  "settings": {
    "endpoint": "https://objectstorage.kr-central-2.kakaocloud.com",
    "path_style_access": true,
    "bucket": "test-s3",
    "region": "kr-central-2",
    "access_key": "YOUR_ACCESS_KEY",
    "secret_key": "YOUR_SECRET_KEY",
    "base_path": "snapshots"
  }
}
  • endpoint: Object Storage connection address
  • base_path: Directory path within the bucket where snapshots will be stored
info

To obtain the IAM access key ID and secret access key required for API calls, refer to Prepare for API usage.

2. Create snapshot (backup)​

Create a snapshot for a specific index or the entire dataset.

Request
POST _snapshot/my_s3_repository/my-first-snapshot
{
  "indices": "test-index*",
  "ignore_unavailable": true,
  "include_global_state": false,
  "partial": false
}
  • indices: Index pattern to back up (for example, test-index*)
  • partial: When set to false, snapshot creation stops if any shard fails, ensuring data integrity
3. Check snapshot status​

Check the information and status (SUCCESS, IN_PROGRESS, etc.) of the created snapshot.

Request
GET /_snapshot/my_s3_repository/my-first-snapshot
주요 응답 필드​
FieldDescription
stateSnapshot result (completed when SUCCESS)
indicesList of indexes included in the snapshot
duration_in_millisTime required to create the snapshot
4. Restore snapshot​

Restore data using a stored snapshot. It is recommended to rename the restored index to avoid conflicts with existing indexes.

Request
POST /_snapshot/my_s3_repository/my-first-snapshot/_restore
{
  "indices": "test-index*",
  "ignore_unavailable": true,
  "include_global_state": false,
  "rename_pattern": "(.+)",
  "rename_replacement": "$1_restored",
  "include_aliases": false
}
  • rename_pattern / replacement: Adds _restored to the restored index name to distinguish it from existing data
5. Verify restore result​

Confirm that the restored index was created successfully and that its status is open.

Request
GET /_cat/indices/test-index2_restored
  • Response example: yellow open test-index2_restored KlLBNIBcReazgKnutWZbXw 1 1 0 0 208b 208b