Apache Hive™ Metastore cluster maintenance

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id. If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

To configure a maintenance window:

1. See the description of the CLI command for updating cluster settings:

   yc managed-metastore cluster update --help
   

2. Configure the maintenance window:

   yc managed-metastore cluster update <cluster_name_or_ID> \
     --maintenance-window type=<maintenance_type>,`
                         `day=<day_of_week>,`
                         `hour=<sequence_number_of_hour_interval>
   

   Where:

   • <cluster_name_or_ID>: Cluster name or ID which you can get with the list of clusters in the folder.

   • --maintenance-window: Maintenance window settings that apply to both running and stopped clusters. The type setting defines the maintenance type:

     • anytime: Any time (default).
     • weekly: On a schedule. For this value, also specify the following:

       • day: Day of week, i.e., MON, TUE, WED, THU, FRI, SAT, or SUN.

       • hour: Sequence number of UTC hour interval, from 1 to 24.

         For example, 1 stands for the interval from 00:00 to 01:00, and 5, from 04:00 to 05:00.

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

   To learn how to create this file, see Creating a cluster.

   For the complete list of configurable Apache Hive™ Metastore cluster fields, see this Terraform provider guide.

2. To set up a maintenance window, add the maintenance_window section to the cluster description:

   resource "yandex_metastore_cluster" "<local_cluster_name>" {
     ...
     maintenance_window = {
       type = "<maintenance_type>"
       day  = "<day_of_week>"
       hour = <sequence_number_of_hour_interval>
     }
     ...
   }
   

   Where:

   • type: Maintenance type. The possible values include:

     • ANYTIME: Any time.
     • WEEKLY: On a schedule.

   • day: Day of week for the WEEKLY type, i.e., MON, TUE, WED, THU, FRI, SAT, or SUN.

   • hour: UTC hour interval for the WEEKLY type, from 1 to 24.

     For example, 1 stands for the interval from 00:00 to 01:00, and 5, from 04:00 to 05:00.

3. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.Update method, e.g., via the following cURL request:

   curl \
     --request PATCH \
     --header "Authorization: Bearer $IAM_TOKEN" \
     --header "Content-Type: application/json" \
     --url 'https://metastore.api.cloud.yandex.net/managed-metastore/v1/clusters/<cluster_ID>' \
     --data '{
              "updateMask": "maintenanceWindow",
              "maintenanceWindow": {
                "weeklyMaintenanceWindow": {
                  "day": "<day_of_week>",
                  "hour": "<sequence_number_of_hour_interval>"
                }
              }
            }'
   

   Where:

   • <cluster_ID>: Cluster ID which you can get with the list of clusters in the folder.

   • updateMask: Comma-separated string of settings to update.

     In this example, only the maintenanceWindow setting is provided.

     Warning

     All settings of the cluster object you are modifying will be reset to their defaults unless explicitly provided in the request. To avoid this, list the settings you want to change in the updateMask parameter.

   • maintenanceWindow: Maintenance window settings, applying to both running and stopped clusters. In maintenanceWindow, provide one of these two parameters:

     • anytime: Maintenance can take place at any time.

     • weeklyMaintenanceWindow: Maintenance takes place once a week at the specified time:

       • day: Day of week in DDD format, i.e., MON, TUE, WED, THU, FRI, SAT, or SUN.

       • hour: UTC hour interval, from 1 to 24.

         For example, 1 stands for the interval from 00:00 to 01:00, and 5, from 04:00 to 05:00.

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

3. Call the ClusterService.Update method, e.g., via the following gRPCurl request:

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/metastore/v1/cluster_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d '{
          "cluster_id": "<cluster_ID>",
          "update_mask": {
            "paths": [
              "maintenance_window"
            ]
          },
          "maintenance_window": {
            "weekly_maintenance_window": {
              "day": "<day_of_week>",
              "hour": "<sequence_number_of_hour_interval>"
            }
          }
        }' \
     metastore.api.cloud.yandex.net:443 \
     yandex.cloud.metastore.v1.ClusterService.Update \
   

   Where:

   • cluster_id: Cluster ID which you can get with the list of clusters in the folder.

   • update_mask: List of settings to update as an array of strings (paths[]).

     Format for listing settings

     "update_mask": {
       "paths": [
         "<setting_1>",
         "<setting_2>",
         ...
         "<setting_N>"
       ]
     }
     

     In this example, only the maintenance_window setting is provided.

     Warning

     All settings of the cluster object you are modifying will be reset to their defaults unless explicitly provided in the request. To avoid this, list the settings you want to change in the update_mask parameter.

   • maintenance_window: Maintenance window settings, applying to both running and stopped clusters. In maintenance_window, provide one of these two parameters:

     • anytime: Maintenance can take place at any time.

     • weekly_maintenance_window: Maintenance takes place once a week at the specified time:

       • day: Day of week in DDD format, i.e., MON, TUE, WED, THU, FRI, SAT, or SUN.

       • hour: UTC hour interval, from 1 to 24.

         For example, 1 stands for the interval from 00:00 to 01:00, and 5, from 04:00 to 05:00.

4. Check the server response to make sure your request was successful.