Updating Elasticsearch cluster settings

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To change the settings of the service account used to work with the cluster:

1. View the description of the update cluster CLI command:

   yc managed-elasticsearch cluster update --help
   

2. Specify the service account ID in the update cluster command:

   yc managed-elasticsearch cluster update <cluster_name_or_ID> \
     --service-account-id <service_account_ID>
   

   You can request the cluster name and ID with a list of clusters in the folder.

Managed Service for Elasticsearch will run the service account update for the cluster.

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about creating this file, see Creating clusters.

2. In the service_account_id field, enter the service account ID:

   resource "yandex_mdb_elasticsearch_cluster" "<cluster_name>" {
     ...
     service_account_id = <service_account_ID>
   }
   

3. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

4. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

   Time limits

   A Terraform provider sets the timeout for Managed Service for Elasticsearch cluster operations:

   • Creating a cluster, including by restoring one from a backup: 30 minutes.
   • Editing a cluster: 60 minutes.
   • Deleting a cluster: 15 minutes.

   Operations exceeding the set timeout are interrupted.

   How do I change these limits?

   Add the timeouts block to the cluster description, for example:

   resource "yandex_mdb_elasticsearch_cluster" "<cluster_name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

To change service account settings, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:

• Cluster ID in the clusterId parameter.

  You can get the cluster ID with a list of clusters in the folder.

• ID of the service account used for cluster operations in the serviceAccountId parameter.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To change the host class for the cluster:

1. View the description of the update cluster CLI command:

   yc managed-elasticsearch cluster update --help
   

2. Specify the host class you need with the Data node and Master node roles in the update cluster command:

   yc managed-elasticsearch cluster update <cluster_name_or_ID> \
     --datanode-resource-preset <class_of_hosts_with_the_Data_node_role> \
     --masternode-resource-preset <class_of_hosts_with_the_Master_node_role>
   

You can request the cluster name and ID with a list of clusters in the folder.

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about creating this file, see Creating clusters.

   For a complete list of available Managed Service for Elasticsearch cluster configuration fields, see the Terraform provider documentation.

2. In the Managed Service for Elasticsearch cluster description, change the resource_preset_id attribute value under config.data_node.resources or config.master_node.resources:

   resource "yandex_mdb_elasticsearch_cluster" "<cluster_name>" {
     ...
     config {
       data_node {
         resources {
           resource_preset_id = "<host_class>"
           ...
         }
       }
   
       master_node {
         resources {
           resource_preset_id = "<host_class>"
           ...
         }
       }
     }
   }
   

3. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

4. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

   Time limits

   A Terraform provider sets the timeout for Managed Service for Elasticsearch cluster operations:

   • Creating a cluster, including by restoring one from a backup: 30 minutes.
   • Editing a cluster: 60 minutes.
   • Deleting a cluster: 15 minutes.

   Operations exceeding the set timeout are interrupted.

   How do I change these limits?

   Add the timeouts block to the cluster description, for example:

   resource "yandex_mdb_elasticsearch_cluster" "<cluster_name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

To change the host class, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:

• Cluster ID in the clusterId parameter.

  You can get the cluster ID with a list of clusters in the folder.

• Host class in the following parameters:

  • configSpec.elasticsearchSpec.dataNode.resources.resourcePresetId: For hosts with the Data node role.
  • configSpec.elasticsearchSpec.masterNode.resources.resourcePresetId: For hosts with the Master node role.

  To request a list of supported values, use the list method for the ResourcePreset resources.

• List of settings to update in the updateMask parameter.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To increase the cluster storage size:

1. View a description of the CLI update configuration command:

   yc managed-elasticsearch cluster update --help
   

2. Specify new storage settings for hosts with the Data node and Master node roles in the update cluster command:

   yc managed-elasticsearch cluster update <cluster_name_or_ID> \
     --datanode-disk-size <Data_node_storage_size_in_GB> \
     --masternode-disk-size <Master_node_storage_size_in_GB>
   

   Where:

   • --datanode-disk-size: Storage size in GB for hosts with the Data node role.
   • --masternode-disk-size: Storage size in GB for hosts with the Master node role.

You can request the cluster name and ID with a list of clusters in the folder.

To increase the cluster storage size:

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about creating this file, see Creating clusters.

   For a complete list of available Managed Service for Elasticsearch cluster configuration fields, see the Terraform provider documentation.

2. In the Managed Service for Elasticsearch cluster description, change the disk_size attribute value under config.data_node.resources or config.master_node.resources:

   resource "yandex_mdb_elasticsearch_cluster" "<cluster_name>" {
     ...
     config {
       data_node {
         resources {
           disk_size = <storage_size_in_GB>
           ...
         }
       }
   
       master_node {
         resources {
           disk_size = <storage_size_in_GB>
           ...
         }
       }
     }
   }
   

3. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

4. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

   Time limits

   A Terraform provider sets the timeout for Managed Service for Elasticsearch cluster operations:

   • Creating a cluster, including by restoring one from a backup: 30 minutes.
   • Editing a cluster: 60 minutes.
   • Deleting a cluster: 15 minutes.

   Operations exceeding the set timeout are interrupted.

   How do I change these limits?

   Add the timeouts block to the cluster description, for example:

   resource "yandex_mdb_elasticsearch_cluster" "<cluster_name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

To increase the cluster storage size, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:

• Cluster ID in the clusterId parameter.

  You can get the cluster ID with a list of clusters in the folder.

• Required storage size (in bytes) in the following parameters:

  • configSpec.elasticsearchSpec.dataNode.resources.diskSize: For hosts with the Data node role.
  • configSpec.elasticsearchSpec.masterNode.resources.diskSize: For hosts with the Master node role.

• List of settings to update in the updateMask parameter.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To change Elasticsearch server settings:

1. View the full list of settings specified for the cluster:

   yc managed-elasticsearch cluster get <cluster_name_or_ID> --full
   

2. View a description of the update cluster configuration CLI command:

   yc managed-elasticsearch cluster update-config --help
   

3. Set the required parameter values:

   yc managed-elasticsearch cluster update-config <cluster_name_or_ID> \
      --set <parameter_1_name>=<value_1>,<parameter_2_name>=<value_2>,...
   

   All the supported parameters are listed in Elasticsearch settings.

To change Elasticsearch settings, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:

• Cluster ID in the clusterId parameter.

  You can get the cluster ID with a list of clusters in the folder.

• Required DBMS values in the configSpec.elasticsearchSpec.dataNode.elastcsearchConfig_7 parameter.

• List of settings to update in the updateMask parameter. If you skip this parameter, the API method will reset any cluster settings that are not explicitly specified in the request to their default values.

All supported settings are described in the Elasticsearch settings section and the API reference.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To change the admin user's cluster password:

1. View the description of the update cluster CLI command:

   yc managed-elasticsearch cluster update --help
   

2. Specify a new password in the cluster update command using one of the available methods:

   • Entering a password in interactive mode.

     yc managed-elasticsearch cluster update <cluster_name> \
       --read-admin-password
     

   • Entering a password as plain text (less secure method).

     yc managed-elasticsearch cluster update <cluster_name> \
       --admin-password <new_password>
     

   • Generating a password automatically. The generated password will be output to the console.

     yc managed-elasticsearch cluster update <cluster_name> \
       --generate-admin-password
     

Managed Service for Elasticsearch will run the admin password update command for the cluster.

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about creating this file, see Creating clusters.

   For a complete list of available Managed Service for Elasticsearch cluster configuration fields, see the Terraform provider documentation.

2. In the Managed Service for Elasticsearch cluster description, change the admin_password attribute value under config:

   resource "yandex_mdb_elasticsearch_cluster" "<cluster_name>" {
     ...
     config {
       admin_password = "<new_admin_user_password>"
       ...
     }
   }
   

3. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

4. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

   Time limits

   A Terraform provider sets the timeout for Managed Service for Elasticsearch cluster operations:

   • Creating a cluster, including by restoring one from a backup: 30 minutes.
   • Editing a cluster: 60 minutes.
   • Deleting a cluster: 15 minutes.

   Operations exceeding the set timeout are interrupted.

   How do I change these limits?

   Add the timeouts block to the cluster description, for example:

   resource "yandex_mdb_elasticsearch_cluster" "<cluster_name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

To update the admin user's password, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:

• Cluster ID in the clusterId parameter.

  You can get the cluster ID with a list of clusters in the folder.

• New password in the configSpec.adminPassword parameter. The maximum password length is 128 characters.

• List of settings to update (in this case, configSpec.adminPassword), in the updateMask parameter.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

1. View the description of the update cluster CLI command:

   yc managed-elasticsearch cluster update --help
   

2. Run the following command with a list of settings to update:

   yc managed-elasticsearch cluster update <cluster_name_or_ID> \
      --plugins <plugin_1_name>,...,<plugin_N_name> \
      --maintenance-window type=<maintenance_type>,`
                          `day=<day_of_week>,`
                          `hour=<hour> \
      --deletion-protection=<deletion_protection>
   

You can change the following settings:

• --plugins: List of Elasticsearch plugins available in the cluster. Plugins that are not on the list will be disabled.

• --maintenance-window: Maintenance window settings (including for disabled clusters), where type is the maintenance type:

  • anytime (default): Any time.
  • weekly: On a schedule. If setting this value, specify the day of week and the hour:
    • day: Day of week in DDD format: MON, TUE, WED, THU, FRI, SAT, or SUN.
    • hour: Hour (UTC) in HH format: 1 to 24.

• --deletion-protection: Protection of the cluster, its databases, and users against accidental deletion.

  Cluster deletion protection will not prevent a manual connection to a cluster to delete data.

You can get the cluster ID and name with a list of clusters in the folder.

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about creating this file, see Creating clusters.

   For a complete list of available Managed Service for Elasticsearch cluster configuration fields, see the Terraform provider documentation.

2. To set up the maintenance window (for disabled clusters as well), add the maintenance_window block to the cluster description:

   resource "yandex_mdb_elasticsearch_cluster" "<cluster_name>" {
     ...
     maintenance_window {
       type = <maintenance_type>
       day  = <day_of_week>
       hour = <hour>
     }
     ...
   }
   

   Where:

   • type: Maintenance type. The possible values include:
     • anytime: Anytime.
     • weekly: By schedule.
   • day: Day of the week for the weekly type in DDD format, e.g., MON.
   • hour: Hour of the day for the weekly type in the HH format, e.g., 21.

3. To change the list of Elasticsearch plugins, change the value of the plugins parameter under config in the cluster description:

   resource "yandex_mdb_elasticsearch_cluster" "<cluster_name>" {
     ...
     config {
       plugins = [ "<list_of_plugin_names>" ]
     }
   }
   

   Plugins that are not on the list will be disabled.

4. To enable cluster protection against accidental deletion by a user of your cloud, add the deletion_protection field set to true to your cluster description:

   resource "yandex_mdb_elasticsearch_cluster" "<cluster_name>" {
     ...
     deletion_protection = <deletion_protection>
   }
   

   Where deletion_protection is the cluster deletion protection, true or false.

   Enabled deletion protection will not prevent a manual connection with the purpose to delete database contents.

5. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

6. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

   Time limits

   A Terraform provider sets the timeout for Managed Service for Elasticsearch cluster operations:

   • Creating a cluster, including by restoring one from a backup: 30 minutes.
   • Editing a cluster: 60 minutes.
   • Deleting a cluster: 15 minutes.

   Operations exceeding the set timeout are interrupted.

   How do I change these limits?

   Add the timeouts block to the cluster description, for example:

   resource "yandex_mdb_elasticsearch_cluster" "<cluster_name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

To change additional cluster settings, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:

• Cluster ID in the clusterId parameter.

  You can get the cluster ID with a list of clusters in the folder.

• List of Elasticsearch plugins in the plugins parameter.

• Maintenance window settings (including for disabled clusters) in the maintenanceWindow parameter.

• Cluster deletion protection settings in the deletionProtection parameter.

  Cluster deletion protection will not prevent a manual connection to a cluster to delete data.

• Settings for access from Yandex Data Transfer in the configSpec.access.dataTransfer parameter.