PostgreSQL cluster maintenance

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

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

To move a maintenance to a new date and time:

1. View the description of the CLI command to move maintenance:

   yc managed-postgresql cluster reschedule-maintenance --help
   

2. To move a maintenance to the nearest window, run the command by specifying the next-available-window reschedule type. To move to a specific date and time, specify the specific-time reschedule type:

   yc managed-postgresql cluster reschedule-maintenance <cluster_name_or_ID> \
      --reschedule-type <reschedule_type> \
      --delayed-until <timestamp>
   

   The timestamp must have one of the following formats:

   • RFC-3339
   • HH:MM:SS
   • Number of hours and minutes by which to move the maintenance.

   For example, 2006-01-02T15:04:05Z, 15:04:05, 2h, or 3h30m ago. When selecting the next-available-window reschedule type, you do not need to specify --delayed-until.

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

To move a maintenance to a new date and time:

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

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.rescheduleMaintenance method and run the following request, e.g., via cURL:

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

   Where rescheduleType is the reschedule type, which can take one of these two values:

   • NEXT_AVAILABLE_WINDOW: Move the maintenance to the nearest window.
   • SPECIFIC_TIME: Move the maintenance to a specific date and time.

   The timestamp must be in RFC-3339 format, e.g., 2006-01-02T15:04:05Z. When selecting the NEXT_AVAILABLE_WINDOW reschedule type, you do not need to specify delayedUntil.

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

3. View the server response to make sure the request was successful.

1. Get an IAM token for API authentication and put it into the 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 the repository contents are stored in the ~/cloudapi/ directory.

3. Use the ClusterService.RescheduleMaintenance call and run the following request, e.g., via gRPCurl:

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

   Where reschedule_type is the reschedule type, which can take one of these two values:

   • NEXT_AVAILABLE_WINDOW: Move the maintenance to the nearest window.
   • SPECIFIC_TIME: Move the maintenance to a specific date and time.

   The timestamp must be in RFC-3339 format, e.g., 2006-01-02T15:04:05Z. When selecting the NEXT_AVAILABLE_WINDOW reschedule type, you do not need to specify delayed_until.

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

4. View the server response to make sure the request was successful.

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

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

To perform a scheduled cluster maintenance immediately:

1. View the description of the CLI command to move maintenance:

   yc managed-postgresql cluster reschedule-maintenance --help
   

2. Run this command with immediate for reschedule type:

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

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

To perform a scheduled cluster maintenance immediately:

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

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.rescheduleMaintenance method and run the following request, e.g., via cURL:

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

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

3. View the server response to make sure the request was successful.

1. Get an IAM token for API authentication and put it into the 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 the repository contents are stored in the ~/cloudapi/ directory.

3. Use the ClusterService.RescheduleMaintenance call and run the following request, e.g., via gRPCurl:

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/postgresql/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.postgresql.v1.ClusterService.RescheduleMaintenance
   

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

4. View the server response to make sure the request was successful.

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

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

1. View the description of the CLI command for updating the maintenance window:

   yc managed-postgresql cluster reschedule-maintenance --help
   

2. Run this command:

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

   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.

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

1. Open the current Terraform configuration file that defines your infrastructure.

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

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

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

   resource "yandex_mdb_postgresql_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. 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.

   Time limits

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

   • Creating a cluster, including restoring 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_postgresql_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 the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.Update method and send the following request, e.g., via cURL:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

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

   Where:

   • updateMask: List of parameters to update as a single string, separated by commas.

     Only one parameter is provided in this case.

   • maintenanceWindow: Maintenance window settings (including for disabled clusters). In maintenanceWindow, provide one of the two parameters:

     • anytime: Maintenance can be scheduled to any time slot.

     • weeklyMaintenanceWindow: Maintenance can be scheduled to selected day of week and time only:

       • day: Day of week in DDD format: MON, TUE, WED, THU, FRI, SAT, or SUN.
       • hour: Hour of day (UTC) in HH format, from 1 to 24.

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

3. View the server response to make sure the request was successful.

1. Get an IAM token for API authentication and put it into the 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 the repository contents are stored in the ~/cloudapi/ directory.

3. Use the ClusterService.Update call and send the following request, e.g., via gRPCurl:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

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

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/postgresql/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.postgresql.v1.ClusterService.Update
   

   Where:

   • update_mask: List of parameters to update as an array of paths[] strings.

     Only one parameter is provided in this case.

   • maintenance_window: Maintenance window settings (including for disabled clusters). In maintenance_window, provide one of the two parameters:

     • anytime: Maintenance can be scheduled to any time slot.

     • weekly_maintenance_window: Maintenance can be scheduled to selected day of week and time only:

       • day: Day of week in DDD format: MON, TUE, WED, THU, FRI, SAT, or SUN.
       • hour: Hour of day (UTC) in HH format, from 1 to 24.

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

4. View the server response to make sure the request was successful.