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 change a cluster's name and description, 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. To find out the cluster ID, get a list of clusters in the folder.
• New name in the name parameter.
• New description in the description parameter.
• List of updatable cluster configuration fields in the updateMask parameter (in this case, name, description).

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 the public access to the cluster, true or false.

Use the update API method and include the following in the request:

• Cluster ID in the clusterId parameter. To find out the cluster ID, get a list of clusters in the folder.
• Public access settings in the config.assignPublicIp parameter.
• List of updatable cluster configuration fields in the updateMask parameter (in this case, name, description).

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> \
       --assign-public-ip=<public_access_to_cluster> \
       --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.

• --assign-public-ip: Cluster accessibility from the internet.

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

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. To find out the cluster ID, get a list of clusters in the folder.

• Public access in the config.assignPublicIp parameter.

• Backup window in the config.backupWindowStart parameter.

• Cluster access from Yandex DataLens in the config.access.dataLens parameter.

• Cluster access from Yandex Query in the config.access.yandexQuery parameter.

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

• Cluster deletion protection in the deletionProtection parameter.

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

• List of cluster configuration fields to update in the updateMask parameter.

To edit your cluster's scheduled maintenance operations settings, use the REST API update 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. To find out the cluster ID, get a list of clusters in the folder.

• New parameter values for the configSpec.backgroundActivities.analyzeAndVacuum object:

  • start.hours: Start hour of the VACUUM operation in UTC. Values range from 0 to 23, the default one is 19.
  • start.minutes: Start minute of the VACUUM operation in UTC. Values range from 0 to 59, the default one is 0.
  • vacuumTimeout: Maximum duration of the VACUUM operation, in seconds. 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.
  • analyzeTimeout: Maximum duration of the ANALYZE operation, in seconds. 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.

• List of cluster configuration fields 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 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 <parameter_1_name>=<value1>,<parameter_2_name>=<value2>,...
   

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

To change Greenplum® 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:

• New values ​​in the configSpec.greenplumConfig_<version> parameter.

• List of cluster configuration fields to update, in the updateMask parameter.

  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.

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 specifies 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
     }
   }
   

To change the class of cluster hosts, 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. To find out the cluster ID, get a list of clusters in the folder.
• Master host class ID in the masterConfig.resources.resourcePresetId parameter or segment host class ID in the segmentConfig.resources.resourcePresetId parameter. You can get a list of supported values by using the list method for the ResourcePreset.
• List of settings to update (in this case, masterConfig.resources.resourcePresetId or segmentConfig.resources.resourcePresetId), in the updateMask parameter.

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. To find out the cluster ID, get a list of clusters in the folder.
• New master and segment host storage size in the masterConfig.resources.diskSize and segmentConfig.resources.diskSize parameters.
• List of cluster configuration fields to update in the updateMask parameter.