Yandex MPP Analytics for PostgreSQL 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 set a different folder for any specific command using the --folder-name or --folder-id options.

To postpone scheduled maintenance:

1. View the description of the CLI command for rescheduling maintenance:

   yc managed-greenplum cluster reschedule-maintenance --help
   

2. Reschedule the maintenance:

   yc managed-greenplum cluster reschedule-maintenance <cluster_name_or_ID> \
     --reschedule-type <reschedule_type>
   

   Where reschedule_type is reschedule type:

   • next-available-window: Next available maintenance window.

   • specific-time: Specific date and time, UTC.

     For this value, also use the --delayed-until parameter to provide a timestamp in one of these formats:

     • RFC 3339.
     • HH:MM:SS.
     • Relative time to postpone maintenance for.

     Here are some examples: 2006-01-02T15:04:05Z, 15:04:05, 2h, 3h30m ago.

     Maintenance can be postponed for a maximum of two weeks from the original scheduled date.

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

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

   export IAM_TOKEN="<IAM_token>"
   

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

   curl \
     --request POST \
     --header "Authorization: Bearer $IAM_TOKEN" \
     --header "Content-Type: application/json" \
     --url 'https://mdb.api.cloud.yandex.net/managed-greenplum/v1/clusters/<cluster_ID>:rescheduleMaintenance' \
     --data '{
              "rescheduleType": "<reschedule_type>"
            }'
   

   Where reschedule_type is reschedule type:

   • NEXT_AVAILABLE_WINDOW: Next available maintenance window.

   • SPECIFIC_TIME: Specific date and time, UTC.

     For this value, also use the delayedUntil parameter to provide a timestamp in RFC 3339 format. Here is an example:

     2006-01-02T15:04:05Z

     Maintenance can be postponed for a maximum of two weeks from the original scheduled date.

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

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.RescheduleMaintenance method, e.g., via the following gRPCurl request:

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/greenplum/v1/cluster_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d '{
          "cluster_id": "<cluster_ID>",
          "reschedule_type": "<reschedule_type>"
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.greenplum.v1.ClusterService.RescheduleMaintenance
   

   Where reschedule_type is reschedule type:

   • NEXT_AVAILABLE_WINDOW: Next available maintenance window.

   • SPECIFIC_TIME: Specific date and time, UTC.

     For this value, also use the delayed_until parameter to provide a timestamp in RFC 3339 format. Here is an example:

     2006-01-02T15:04:05Z

     Maintenance can be postponed for a maximum of two weeks from the original scheduled date.

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

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

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 set a different folder for any specific command using the --folder-name or --folder-id options.

To start scheduled maintenance immediately, do the following:

1. View the description of the CLI command for rescheduling maintenance:

   yc managed-greenplum cluster reschedule-maintenance --help
   

2. Start scheduled maintenance immediately:

   yc managed-greenplum cluster reschedule-maintenance <cluster_name_or_ID> \
     --reschedule-type immediate
   

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

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

   export IAM_TOKEN="<IAM_token>"
   

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

   curl \
     --request POST \
     --header "Authorization: Bearer $IAM_TOKEN" \
     --header "Content-Type: application/json" \
     --url 'https://mdb.api.cloud.yandex.net/managed-greenplum/v1/clusters/<cluster_ID>:rescheduleMaintenance' \
     --data '{
              "rescheduleType": "IMMEDIATE"
            }'
   

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

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.RescheduleMaintenance method, e.g., via the following gRPCurl request:

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/greenplum/v1/cluster_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d '{
          "cluster_id": "<cluster_ID>",
          "reschedule_type": "IMMEDIATE"
        }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.greenplum.v1.ClusterService.RescheduleMaintenance
   

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

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

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 set a different folder for any specific command using the --folder-name or --folder-id options.

To set a maintenance window:

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

   yc managed-greenplum cluster update --help
   

2. Set up a maintenance window:

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

   Where type is the maintenance type:

   • anytime: At 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: Hour of day (UTC), from 1 to 24.

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

1. Open the current Terraform configuration file describing your infrastructure.

   For more on how to create this file, see Creating a cluster.

   For a complete list of configurable Greenplum® 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_mdb_greenplum_cluster" "<local_cluster_name>" {
     ...
     maintenance_window {
       type = "<maintenance_type>"
     }
     ...
   }
   

   Where type is 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: Hour of day (UTC), from 1 to 24.

3. Validate your configuration.

   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.

   Warning

   The Terraform provider limits the amount of time for all Yandex MPP Analytics for PostgreSQL cluster operations to complete to 120 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_greenplum_cluster" "<cluster name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

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://mdb.api.cloud.yandex.net/managed-greenplum/v1/clusters/<cluster_ID>' \
     --data '{
              "updateMask": "maintenanceWindow",
              "maintenanceWindow": {
                "weeklyMaintenanceWindow": {
                  "day": "<day_of_week>",
                  "hour": "<hour>"
                }
              }
            }'
   

   Where:

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

     In this example, only the maintenanceWindow setting is provided.

     Warning

     When you update a cluster, all parameters of the object you are modifying will take 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. Provide one of the values:

     • anytime: Allows performing maintenance at any time; default option.

       This parameter is provided as an empty object: "anytime": {}.

     • 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: Time of day (UTC), from 1 to 24.

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

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/mdb/greenplum/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": "<hour>"
            }
          }
        }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.greenplum.v1.ClusterService.Update
   

   Where:

   • 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

     When you update a cluster, all parameters of the object you are modifying will take 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. Provide one of the values:

     • anytime: Allows performing maintenance at any time; default option.

       This parameter is provided as an empty object: "anytime": {}.

     • 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: Time of day (UTC), from 1 to 24.

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

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