Updating Greenplum® 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 name and description of a Greenplum® cluster:

1. View the current name and description of the cluster:

   yc managed-greenplum cluster get <cluster_name_or_ID>
   

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

   yc managed-greenplum cluster update --help
   

3. Enter a new name and description for the cluster:

   yc managed-greenplum cluster update <cluster_name_or_ID> \
      --new-name <new_cluster_name> \
      --description <new_cluster_description>
   

To update the cluster description:

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 Greenplum® cluster configuration fields, see the Terraform provider documentation.

2. In the Managed Service for Greenplum® cluster description, change the description attribute value:

   resource "yandex_mdb_greenplum_cluster" "<cluster_name>" {
     name        = "<cluster_name>"
     description = "<new_cluster_description>"
     ...
   }
   

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.

   Warning

   The Terraform provider limits the amount of time for all Managed Service for Greenplum® 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 the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.Update method and make a 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-greenplum/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "name,description",
                 "name": "<new_cluster_name>",
                 "description": "<new_cluster_description>"
               }'
   

   Where updateMask is the list of parameters to update as a single string, separated by commas.

   You can get the cluster ID with a 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 make a 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/greenplum/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [ "name", "description" ]
             },
             "name": "<new_cluster_name>",
             "description": "<new_cluster_description>" 
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.greenplum.v1.ClusterService.Update
   

   Where update_mask is the list of parameters to update as an array of paths[] strings.

   You can get the cluster ID with a 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 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 public access setting Greenplum®:

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

   yc managed-greenplum cluster update --help
   

2. Configure public access in the --assign-public-ip parameter:

   yc managed-greenplum cluster update <cluster_name_or_ID> \
      --assign-public-ip=<public_access_to_cluster>
   

   Where assign-public-ip is public access to the cluster, true or false.

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 make a 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-greenplum/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "config.assignPublicIp",
                 "config": {
                   "assignPublicIp": <public_access_to_cluster_hosts>
                 }
               }'
   

   Where:

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

     Only one parameter is provided in this case.

   • assignPublicIp: Public access to cluster hosts, true or false.

   You can get the cluster ID with a 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 make a 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/greenplum/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [ "config.assign_public_ip" ]
             },
             "config": {
               "assign_public_ip": <public_access_to_cluster_hosts> 
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.greenplum.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.

   • assign_public_ip: Public access to cluster hosts, true or false.

   You can get the cluster ID with a 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 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 additional cluster settings:

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

   yc managed-greenplum cluster update --help
   

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

   yc managed-greenplum cluster update <cluster_name_or_ID> \
       --backup-window-start <backup_start_time> \
       --datalens-access=<access_from_DataLens> \
       --yandexquery-access=<access_from_Yandex_Query> \
       --maintenance-window type=<maintenance_type>,`
                           `day=<day_of_week>,`
                           `hour=<hour> \
       --deletion-protection
   

You can change the following settings:

• --backup-window-start: The cluster backup start time, set in UTC format HH:MM:SS. If the time is not set, the backup will start at 22:00 UTC.

• --datalens-access: Access to the cluster from Yandex DataLens, true or false.

• --yandexquery-access: Access to the cluster from Yandex Query, true or false.

• --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.

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

You can get the cluster 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 Greenplum® cluster configuration fields, see the Terraform provider documentation.

2. In the Managed Service for Greenplum® cluster description, change the values of the required additional settings:

   resource "yandex_mdb_greenplum_cluster" "<cluster_name>" {
     ...
     backup_window_start {
       hours = <backup_period_start>
     }
   
     maintenance_window {
       type = <maintenance_type>
       day  = <day_of_week>
       hour = <hour>
     }
   
     access {
       data_lens    = <access_from_DataLens>
       yandex_query = <access_from_Yandex_Query>
     }
   
     deletion_protection = <deletion_protection>
   
     cloud_storage {
       enable = <hybrid_storage_use>
     }
   
     pooler_config {
       pooling_mode             = <operation_mode>
       pool_size                = <size>
       pool_client_idle_timeout = <client_timeout>
     }
   }
   

   You can change the following settings:

   • backup_window_start.hours: Start of the period for initiating cluster backup. It is set in UTC in HH format: from 0 to 23.

   • maintenance_window: Maintenance window settings (including for disabled clusters):

     • type: Maintenance type. The possible values include:
       • ANYTIME: Anytime.
       • WEEKLY: On a schedule.
     • day: Day of the week in DDD format for the WEEKLY type, e.g., MON.
     • hour: Hour UTC in HH format for the WEEKLY type, e.g., 21.

   • access.data_lens: Access to the cluster from Yandex DataLens, true or false.

   • access.yandex_query: Access to the cluster from Yandex Query, true or false.

   • deletion_protection: Protection of the cluster, its databases, and users against deletion, true or false value.

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

   • cloud_storage.enable: Use of hybrid storage in clusters with Greenplum® 6.25 or higher. Set it to true to enable the Yandex Cloud Yezzey extension in a cluster. This extension is used to export AO and AOCO tables from disks within the Managed Service for Greenplum® cluster to a cold storage in Yandex Object Storage. This way, the data will be stored in a service bucket in a compressed and encrypted form. This is a more cost-efficient storage method.

     You cannot disable hybrid storage after you save your cluster settings.

     Note

     This feature is at the Preview stage and is free of charge.

   • pooler_config: Connection pooler settings:

     • pooling_mode: Operation mode, SESSION or TRANSACTION.
     • pool_size: Maximum number of client connections.
     • pool_client_idle_timeout: Idle timeout for a client connection (in ms).

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.

   Warning

   The Terraform provider limits the amount of time for all Managed Service for Greenplum® 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 the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Create a file named body.json and add the following contents to it:

   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.

   {
     "updateMask": "config.backupWindowStart,config.access.dataLens,config.access.yandexQuery,maintenanceWindow,deletionProtection,configSpec.pool.mode,configSpec.pool.size,configSpec.pool.clientIdleTimeout,cloudStorage",
     "config": {
       "backupWindowStart": {
         "hours": "<hours>",
         "minutes": "<minutes>",
         "seconds": "<seconds>",
         "nanos": "<nanoseconds>"
       },
       "access": {
         "dataLens": <access_from_DataLens>,
         "yandexQuery": <access_from_Yandex_Query>
       }
     },
     "maintenanceWindow": {
       "weeklyMaintenanceWindow": {
         "day": "<day_of_week>",
         "hour": "<hour>"
       }
     },
     "deletionProtection": <cluster_deletion_protection>,
     "configSpec": {
       "pool": {
         "mode": "<operation_mode>",
         "size": "<number_of_client_connections>",
         "clientIdleTimeout": "<client_timeout>"
       }
     },
     "cloudStorage": {
       "enable": <hybrid_storage_use>
     }
   }
   

   Where:

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

   • config: Cluster settings:

     • backupWindowStart: Backup window settings.

       In this parameter, specify the backup start time:

       • hours: Between 0 and 23 hours.
       • minutes: Between 0 and 59 minutes.
       • seconds: Between 0 and 59 seconds.
       • nanos: Between 0 and 999999999 nanoseconds.

     • access: Cluster settings for access to the following Yandex Cloud services:

       • dataLens: Yandex DataLens, true or false.
       • yandexQuery: Yandex Query, true or false.

   • maintenanceWindow: Maintenance window settings (including for disabled clusters). Provide one of the 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: MON, TUE, WED, THU, FRI, SAT, or SUN.
       • hour: Hour of day (UTC), from 1 to 24.

   • deletionProtection: Cluster deletion protection, true or false.

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

   • configSpec.pool: Connection pooler settings:

     • mode: Operation mode, SESSION or TRANSACTION.
     • size: Maximum number of client connections.
     • clientIdleTimeout: Idle timeout for a client connection (in ms).

   • cloudStorage.enable: Use of hybrid storage in clusters with Greenplum® 6.25 or higher. Set it to true to enable the Yandex Cloud Yezzey extension in a cluster. This extension is used to export AO and AOCO tables from disks within the Managed Service for Greenplum® cluster to a cold storage in Yandex Object Storage. This way, the data will be stored in a service bucket in a compressed and encrypted form. This is a more cost-efficient storage method.

     You cannot disable hybrid storage after you save your cluster settings.

     Note

     This feature is at the Preview stage and is free of charge.

3. Use the Cluster.Update method and make a request, e.g., via cURL:

   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 "@body.json"
   

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

4. 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. Create a file named body.json and add the following contents to it:

   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>"
       ]
   }
   

   {
     "cluster_id": "<cluster_ID>"
     "update_mask": {
       "paths": [
         "config.backup_window_start",
         "config.access.data_lens",
         "config.access.yandex_query",
         "maintenance_window",
         "deletion_protection",
         "config_spec.pool.mode",
         "config_spec.pool.size",
         "config_spec.pool.client_idle_timeout",
         "cloud_storage"
       ]
     },
     "config": {
       "backup_window_start": {
         "hours": "<hours>",
         "minutes": "<minutes>",
         "seconds": "<seconds>",
         "nanos": "<nanoseconds>"
       },
       "access": {
         "data_lens": <access_from_DataLens>,
         "yandex_query": <access_from_Yandex_Query>
       }
     },
     "maintenance_window": {
       "weekly_maintenance_window": {
         "day": "<day_of_week>",
         "hour": "<hour>"
       }
     },
     "deletion_protection": <cluster_deletion_protection>,
     "config_spec": {
       "pool": {
         "mode": "<operation_mode>",
         "size": "<number_of_client_connections>",
         "client_idle_timeout": "<client_timeout>"
       }
     },
     "cloud_storage": {
       "enable": <hybrid_storage_use>
     }
   }
   

   Where:

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

   • config: Cluster settings:

     • backup_window_start: Backup window settings.

       In this parameter, specify the backup start time:

       • hours: Between 0 and 23 hours.
       • minutes: Between 0 and 59 minutes.
       • seconds: Between 0 and 59 seconds.
       • nanos: Between 0 and 999999999 nanoseconds.

     • access: Cluster settings for access to the following Yandex Cloud services:

       • data_lens: Yandex DataLens, true or false.
       • yandex_query: Yandex Query, true or false.

   • maintenance_window: Maintenance window settings (including for disabled clusters). Provide one of the 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: MON, TUE, WED, THU, FRI, SAT, or SUN.
       • hour: Hour of day (UTC), from 1 to 24.

   • deletion_protection: Cluster deletion protection, true or false.

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

   • config_spec.pool: Connection pooler settings:

     • mode: Operation mode, SESSION or TRANSACTION.
     • size: Maximum number of client connections.
     • client_idle_timeout: Idle timeout for a client connection (in ms).

   • cloud_storage.enable: Use of hybrid storage in clusters with Greenplum® 6.25 or higher. Set it to true to enable the Yandex Cloud Yezzey extension in a cluster. This extension is used to export AO and AOCO tables from disks within the Managed Service for Greenplum® cluster to a cold storage in Yandex Object Storage. This way, the data will be stored in a service bucket in a compressed and encrypted form. This is a more cost-efficient storage method.

     You cannot disable hybrid storage after you save your cluster settings.

     Note

     This feature is at the Preview stage and is free of charge.

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

4. Use the ClusterService.Update call and make a request, e.g., via gRPCurl:

   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 @ \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.greenplum.v1.ClusterService.Update \
       < body.json
   

5. 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. Use the Cluster.Update method and make a 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-greenplum/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "configSpec.backgroundActivities.analyzeAndVacuum.start,configSpec.backgroundActivities.analyzeAndVacuum.analyzeTimeout,configSpec.backgroundActivities.analyzeAndVacuum.vacuumTimeout",
                 "configSpec": {
                   "backgroundActivities": {
                     "analyzeAndVacuum": {
                       "start": {
                         "hours": "<operation_start_hour>",
                         "minutes": "<operation_start_minute>"
                       },
                       "analyzeTimeout": "<ANALYZE_operation_duration>",
                       "vacuumTimeout": "<VACUUM_operation_duration>"
                     }
                   }
                 }
               }'
   

   Where:

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

   • configSpec.backgroundActivities.analyzeAndVacuum: Background process management settings:

     • start.hours: Start hour of the VACUUM operation in UTC. The values range from 0 to 23, the default one is 19.
     • start.minutes: Start minute of the VACUUM operation in UTC. The values range from 0 to 59, the default one is 0.
     • analyzeTimeout: Maximum duration of the ANALYZE operation, in seconds. The values range from 7200 to 86399, the default one is 36000. As soon as this period expires, the ANALYZE operation will be forced to terminate.
     • vacuumTimeout: Maximum duration of the VACUUM operation, in seconds. The values range from 7200 to 86399, the default one is 36000. As soon as this period expires, the VACUUM operation will be forced to terminate.

   You can get the cluster ID with a 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 make a 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/greenplum/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [ 
                 "config_spec.background_activities.analyze_and_vacuum.start",
                 "config_spec.background_activities.analyze_and_vacuum.analyze_timeout",
                 "config_spec.background_activities.analyze_and_vacuum.vacuumTimeout"
               ]
             },
             "config_spec": {
               "background_activities": {
                 "analyze_and_vacuum": {
                   "start": {
                     "hours": "<operation_start_hour>",
                     "minutes": "<operation_start_minute>"
                   },
                   "analyze_timeout": "<ANALYZE_operation_duration>",
                   "vacuum_timeout": "<VACUUM_operation_duration>"
                 }
               }
             } 
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.greenplum.v1.ClusterService.Update
   

   Where:

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

   • config_spec.background_activities.analyze_and_vacuum: Background process management settings:

     • start.hours: Start hour of the VACUUM operation in UTC. The values range from 0 to 23, the default one is 19.
     • start.minutes: Start minute of the VACUUM operation in UTC. The values range from 0 to 59, the default one is 0.
     • analyze_timeout: Maximum duration of the ANALYZE operation, in seconds. The values range from 7200 to 86399, the default one is 36000. As soon as this period expires, the ANALYZE operation will be forced to terminate.
     • vacuum_timeout: Maximum duration of the VACUUM operation, in seconds. The values range from 7200 to 86399, the default one is 36000. As soon as this period expires, the VACUUM operation will be forced to terminate.

   You can get the cluster ID with a 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 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 Greenplum® DBMS settings:

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

   yc managed-greenplum cluster get <cluster_name_or_ID>
   

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

   yc managed-greenplum cluster update-config --help
   

3. Set the required parameter values:

   All supported parameters are listed in the request format for the update method, in the greenplumConfig_<Greenplum_version> field. To specify a parameter name in the CLI call, convert its name from lowerCamelCase to snake_case. For example, convert the maxConnections parameter from an API request to max_connections for the CLI command:

   yc managed-greenplum cluster update-config <cluster_name_or_ID> \
      --set <parameter1_name>=<value1>,<parameter2_name>=<value2>,...
   

   Managed Service for Greenplum® runs the update cluster settings operation.

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 Greenplum® cluster configuration fields, see the Terraform provider documentation.

2. In the cluster description, edit the Greenplum® settings under greenplum_config:

   resource "yandex_mdb_greenplum_cluster" "<cluster_name>" {
     ...
     greenplum_config = {
       max_connections         = <maximum_number_of_connections>
       gp_workfile_compression = <true_or_false>
       ...
     }
   }
   

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.

   Warning

   The Terraform provider limits the amount of time for all Managed Service for Greenplum® 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 the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.Update method and make a 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-greenplum/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "configSpec.greenplumConfig_<Greenplum®_version>.<setting_1>,...,configSpec.greenplumConfig_<Greenplum®_version>.<setting_N>",
                 "configSpec": {
                   "greenplumConfig_<Greenplum®_version>": {
                     "<setting_1>": "<value_1>",
                     "<setting_2>": "<value_2>",
                     ...
                     "<setting_N>": "<value_N>"
                   }
                 }
               }'
   

   Where:

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

     In this case, list all the Greenplum® settings to update.

   • configSpec.greenplumConfig_<PostgreSQL>_version: Greenplum® settings. Use a separate line for each setting; separate them by commas.

     See the method description for the list of Greenplum® versions available for the parameter. See Cluster-level DBMS settings for a description and possible values for each setting.

   You can get the cluster ID with a 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 make a 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/greenplum/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [ 
                 "config_spec.greenplum_config_<Greenplum®_version>.<setting_1>",
                 "config_spec.greenplum_config_<Greenplum®_version>.<setting_2>",
                 ...
                 "config_spec.greenplum_config_<Greenplum®_version>.<setting_N>"
               ]
             },
             "config_spec": {
               "greenplum_config_<Greenplum®_version>": {
                 "<setting_1>": "<value_1>",
                 "<setting_2>": "<value_2>",
                 ...
                 "<setting_N>": "<value_N>"
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.greenplum.v1.ClusterService.Update
   

   Where:

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

     In this case, list all the Greenplum® settings to update.

   • config_spec.greenplum_config_<Greenplum®>_version: Greenplum® settings. Use a separate line for each setting; separate them by commas.

     See the method description for the list of Greenplum® versions available for the parameter. See Greenplum® settings for a description and possible values for each setting.

   You can get the cluster ID with a 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 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-greenplum cluster update --help
   

2. Request a list of available classes (the ZONE IDS column lists the availability zones where you can select the appropriate class):

   • For master hosts:

     yc managed-greenplum resource-preset list master
     

   • For segment hosts:

     yc managed-greenplum resource-preset list segment
     

   +-------------+--------------------------------+--------------------------------+-------+----------+--------------------+---------------------+
   |     ID      |            ZONE IDS            |           DISK TYPES           | CORES |  MEMORY  | HOST COUNT DIVIDER | MAX SEGMENT IN HOST |
   +-------------+--------------------------------+--------------------------------+-------+----------+--------------------+---------------------+
   | i2.2xlarge  | ru-central1-a, ru-central1-b   | local-ssd,                     |    16 | 128.0 GB |                  1 |                   0 |
   |             |                                | network-ssd-nonreplicated      |       |          |                    |                     |
   | ...                                                                                                                                         |
   +-------------+--------------------------------+--------------------------------+-------+----------+--------------------+---------------------+
   

3. Specify the required classes in the cluster update command:

   yc managed-greenplum cluster update <cluster_name_or_ID> \
       --master-config resource-id=<master_host_class_ID> \
       --segment-config resource-id=<segment_host_class_ID>
   

   Managed Service for Greenplum® will run the update host class 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 Greenplum® cluster configuration fields, see the Terraform provider documentation.

2. In the Managed Service for Greenplum® cluster description, change the resource_preset_id attribute value under master_subcluster.resources or segment_subcluster.resources:

   resource "yandex_mdb_greenplum_cluster" "<cluster_name>" {
     ...
     master_subcluster {
       resources {
         resource_preset_id = "<host_class>"
         ...
       }
     }
     segment_subcluster {
       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.

   Warning

   The Terraform provider limits the amount of time for all Managed Service for Greenplum® 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 the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.Update method and make a 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-greenplum/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "masterConfig.resources.resourcePresetId,segmentConfig.resources.resourcePresetId",
                 "masterConfig": {
                   "resources": {
                     "resourcePresetId": "<host_class>"
                   }
                 },
                 "segmentConfig": {
                   "resources": {
                     "resourcePresetId": "<host_class>"
                   }
                 }
               }'
   

   Where:

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

   • masterConfig.resources.resourcePresetId and segmentConfig.resources.resourcePresetId: New host class for master and segment hosts.

   You can get the cluster ID with a 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 make a 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/greenplum/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [ 
                 "master_config.resources.resource_preset_id",
                 "segment_config.resources.resource_preset_id"
               ]
             },
             "master_config": {
               "resources": {
                 "resource_preset_id": "<host_class>"
               }
             },
             "segment_config": {
               "resources": {
                 "resource_preset_id": "<host_class>"
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.greenplum.v1.ClusterService.Update
   

   Where:

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

   • master_config.resources.resource_preset_id and segment_config.resources.resource_preset_id: New host class for master and segment hosts.

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

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

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 Greenplum® cluster configuration fields, see the Terraform provider documentation.

2. In the Managed Service for Greenplum® cluster description, change the disk_size attribute value under master_subcluster.resources or segment_subcluster.resources:

   resource "yandex_mdb_greenplum_cluster" "<cluster_name>" {
     ...
     master_subcluster {
       resources {
         disk_size = <storage_size_in_GB>
         ...
       }
     }
     segment_subcluster {
       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.

   Warning

   The Terraform provider limits the amount of time for all Managed Service for Greenplum® 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 the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.Update method and make a 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-greenplum/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "masterConfig.resources.diskSize,segmentConfig.resources.diskSize",
                 "masterConfig": {
                   "resources": {
                     "diskSize": "<storage_size_in_bytes>"
                   }
                 },
                 "segmentConfig": {
                   "resources": {
                     "diskSize": "<storage_size_in_bytes>"
                   }
                 }
               }'
   

   Where:

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

   • masterConfig.resources.diskSize and segmentConfig.resources.diskSize: New disk size in bytes for master and segment hosts.

   You can get the cluster ID with a 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 make a 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/greenplum/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [ 
                 "master_config.resources.disk_size",
                 "segment_config.resources.disk_size"
               ]
             },
             "master_config": {
               "resources": {
                 "disk_size": "<storage_size_in_bytes>"
               }
             },
             "segment_config": {
               "resources": {
                 "disk_size": "<storage_size_in_bytes>"
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.greenplum.v1.ClusterService.Update
   

   Where:

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

   • master_config.resources.disk_size and segment_config.resources.disk_size: New disk size in bytes for master and segment hosts.

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

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