Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Creating and Managing OpenSearch Index Policies

Updated on 2024-10-26 GMT+08:00

This topic describes how to create and manage index lifecycle policies for OpenSearch clusters.

Context

Index State Management (ISM) of OpenSearch is a plugin that allows you to automate periodic, administrative operations on indexes by triggering them based on changes in the index age, index size, or number of documents. With ISM, you can define custom policies to automate index rollovers and deletion, thus optimizing cluster search performance or cutting storage costs. The procedure for using ISM is as follows:

  1. Creating an Index Lifecycle Policy: Create an index lifecycle policy on OpenSearch Dashboards.
  2. Associating Indexes with a Lifecycle Policy: Associate indexes with a lifecycle policy.
  3. Managing Index Policies: Modify, retry, and change index lifecycle policies.

For more information about ISM, see Index State Management.

Automating Index Rollover in an OpenSearch Cluster Through Index Lifecycle Management describes a common use case for index lifecycle policies.

Creating an Index Lifecycle Policy

  1. Log in to the CSS management console.
  2. Choose Clusters > OpenSearch, find the cluster that you want to log in to, and click Access Kibana in the Operation column.
  3. Log in to OpenSearch Dashboards, and choose Index Management on the left. The index management page is displayed.
  4. Click Create policy to create an index policy. In the Configuration method dialog box, select JSON editor and click Continue. The page for creating an index policy is displayed.
    • Policy ID: use a custom policy name.
    • Define policy: define a custom policy based on the reference example provided.
      Figure 1 Configuring a policy
  5. Click Create.

Associating Indexes with a Lifecycle Policy

You can bind a policy to one or more indexes, or associate a policy with an index template, so that the policy will be applied to all indexes created using this index template.

  • Method 1: OpenSearch Dashboards CLI

    On the Dev Tools page of the OpenSearch Dashboards, run the following command to associate a policy ID with an index template:

    PUT _template/<template_name> 
    {
        "index_patterns": ["index_name-*"],
        "settings": {
            "opendistro.index_state_management.policy_id": "policy_id"
        }
    }
    • <template_name>: Replace it with the name of a created index template.
    • policy_id: Replace it with a custom policy ID.

    For details about how to create an index template, see Index Templates.

  • Method 2: OpenSearch Dashboards Console
    1. On the Index Management page of the OpenSearch Dashboards, choose Indices.
      Figure 2 Choosing Indices
    2. In the Indices list, select one or more indexes to which you want to bind a policy.
    3. Click Apply policy in the upper right corner. In the displayed dialog box, select a policy ID.
      Figure 3 Apply policy
      Figure 4 Selecting a policy
    4. Click Apply.

      After you bind a policy to an index, ISM creates a job that runs every 5 minutes by default to execute the policy, check criteria, and change index states.

Managing Index Policies

  1. On the Index Management page of the OpenSearch Dashboards, choose Managed Indices.

    The displayed page shows index policies configured for the current cluster.

  2. Manage policies in the index policy list.
    • For a policy whose status is abnormal, click Retry policy.
    • To update a policy for an index, select the associated index, and click Change policy. After the policy is updated, click Change to apply the new policy.
    • To remove a policy from an index, select the index, and click Remove policy. In the displayed dialog box, click Remove.

For details, see Index State Management.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback