Updating a Managed Service for Kubernetes cluster

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

By default, the CLI uses the folder specified when creating the 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 parameter.

To update a Managed Service for Kubernetes cluster:

1. View the description of the CLI command for updating a Managed Service for Kubernetes cluster:

   yc managed-kubernetes cluster update --help
   

2. Run the following command providing a list of settings you want to change (not all settings are listed in the example below):

   yc managed-kubernetes cluster update <Managed_Service_for_Kubernetes_cluster_name> \
     --new-name <new_name_for_Managed_Service_for_Kubernetes_cluster> \
     --description <Managed_Service_for_Kubernetes_cluster_description> \
     --service-account-id <ID_of_service_account_for_resources> \
     --service-account-name <name_of_service_account_for_resources> \
     --node-service-account-id <ID_of_service_account_for_Kubernetes_nodes> \
     --security-group-ids <list_of_security_group_IDs> \
     --master-logging enabled=<send_logs>,`
         `log-group-id=<log_group_ID>,`
         `folder-id=<folder_ID>,`
         `kube-apiserver-enabled=<send_kube-apiserver_logs>,`
         `cluster-autoscaler-enabled=<send_cluster-autoscaler_logs>,`
         `events-enabled=<send_Kubernetes_events>`
         `audit-enabled=<send_audit_events>
   

   Where:

   • --new-name: Managed Service for Kubernetes cluster name.

   • --description: Managed Service for Kubernetes cluster description.

   • --service-account-id, --service-account-name: Service account for managing the Managed Service for Kubernetes cluster.

   • --node-service-account-id, --node-service-account-name: Service account for managing the Managed Service for Kubernetes nodes.

   • --security-group-ids: Managed Service for Kubernetes cluster security groups.

     Warning

     The configuration of security groups determines performance and availability of the cluster and services running in it.

   • --master-logging: Sending logs to Cloud Logging:

     • enabled: Flag that enables sending logs, true or false.
     • log-group-id: ID of the log group to send logs to.
     • folder-id: ID of the folder to send logs to. Logs will be sent to the log group of the default folder.
     • kube-apiserver-enabled: Flag that enables sending kube-apiserver logs, true or false.
     • cluster-autoscaler-enabled: Flag that enables sending cluster-autoscaler logs, true or false.
     • events-enabled: Flag that enables sending Kubernetes events, true or false.
     • audit-enabled: Flag that enables sending audit events, true or false.

     If log sending is enabled but neither log-group-id nor folder-id is specified, logs will be sent to the default log group in the Managed Service for Kubernetes cluster folder. You cannot specify both log-group-id and folder-id at the same time.

   • --version: Kubernetes version.

   • --latest-revision: Get all available updates for the current Managed Service for Kubernetes master version.

   • --auto-upgrade: Manage automatic Managed Service for Kubernetes cluster updates.

   • Managing the maintenance window:

     • --anytime-maintenance-window: Update at any time.
     • --daily-maintenance-window: Update daily at the selected time.
     • --weekly-maintenance-window: Update on selected days.

To update a Managed Service for Kubernetes cluster:

1. Open the current configuration file with the Managed Service for Kubernetes cluster description.

   For more information about creating this file, see Creating a Managed Service for Kubernetes cluster.

2. Edit the required parameters in the Managed Service for Kubernetes cluster description.

   To edit the settings for sending logs to Cloud Logging, update the master_logging section parameters. If there is no such section, create one.

   resource "yandex_kubernetes_cluster" "<cluster_name>" {
    ...
    master {
      ...
      master_logging {
        enabled                    = <send_logs>
        log_group_id               = "<log_group_ID>"
        folder_id                  = "<folder_ID>"
        kube_apiserver_enabled     = <send_kube-apiserver_logs>
        cluster_autoscaler_enabled = <send_cluster-autoscaler_logs>
        events_enabled             = <send_Kubernetes_events>
        audit_enabled              = <send_audit_events>
      }
    }
   }
   

   Where:

   • enabled: Flag that enables sending logs, true or false.
   • log_group_id: ID of the log group to send logs to.
   • folder_id: ID of the folder to send logs to. Logs will be sent to the log group of the default folder.
   • kube_apiserver_enabled: Flag that enables sending kube-apiserver logs, true or false.
   • cluster_autoscaler_enabled: Flag that enables sending cluster-autoscaler logs, true or false.
   • events_enabled: Flag that enables sending Kubernetes events, true or false.
   • audit_enabled: Flag that enables sending audit events, true or false.

   If log sending is enabled but neither log_group_id nor folder_id is specified, logs will be sent to the default log group in the Managed Service for Kubernetes cluster folder. You cannot specify both log_group_id and folder_id at the same time.

3. Make sure the configuration files 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.

   Timeouts

   The Terraform provider limits the time for creating and updating a Managed Service for Kubernetes cluster to 30 minutes.

   Operations in excess of this time will be interrupted.

   How do I modify these limits?

   Add a timeouts block to the cluster description, e.g.:

   resource "yandex_kubernetes_cluster" "<cluster_name>" {
     ...
     timeouts {
       create = "60m"
       update = "60m"
     }
   }
   

   For more information, see this Terraform provider guide.

To update Managed Service for Kubernetes cluster parameters, use the Update method for the Cluster resource.

To edit the settings for sending logs to Cloud Logging, update their values in the masterSpec.masterLogging parameter.

Run this command:

yc managed-kubernetes cluster add-labels k8s-demo --labels new_label=test_label

Result:

done (1s)
id: abcd123ef4gh********
folder_id: l1m01nopqr1s********
...
description: My test Kubernetes cluster
labels:
  new_label: test_label
...

Run this command:

yc managed-kubernetes cluster update k8s-demo --labels test_label=my_k8s_label

Result:

done (1s)
id: abcd123ef4gh********
folder_id: l1m01nopqr1s********
...
description: My test Kubernetes cluster
labels:
  test_label: my_k8s_label
...

Run this command:

yc managed-kubernetes cluster remove-labels k8s-demo --labels test_label

Result:

done (1s)
id: cati493bu7ia********
folder_id: b1g88tflru0e********
created_at: "2019-11-20T11:26:36Z"
name: k8s-demo
...

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

By default, the CLI uses the folder specified when creating the 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 parameter.

Specify the required master resource configuration in the cluster modification command:

yc managed-kubernetes cluster update <Managed_Service_for_Kubernetes_cluster_name> \
  --master-scale-policy policy=auto,min-resource-preset-id=<master_host_class>

The selected configuration allocates minimum resources to the master. Depending on the load, the amount of RAM and number of vCPUs will increase automatically.

Result:

done (1s)
id: abcd123ef4gh********
folder_id: l1m01nopqr1s********
...
description: My test Kubernetes cluster
master:
  scale_policy:
    auto_scale:
      min_resource_preset_id: <master_host_class>
...

1. Open the current configuration file with the Managed Service for Kubernetes cluster description.

   For more information about creating this file, see Creating a Managed Service for Kubernetes cluster.

2. Add or update the master computing resource configuration in the Managed Service for Kubernetes cluster description in the scale_policy section:

   resource "yandex_kubernetes_cluster" "<cluster_name>" {
    ...
    master {
      ...
      scale_policy {
        auto_scale  {
          min_resource_preset_id = "<master_host_class>"
        }
      }
    }
   }
   

   The selected configuration allocates minimum resources to the master. Depending on the load, the amount of RAM and number of vCPUs will increase automatically.

3. Make sure the configuration files 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.

   Timeouts

   The Terraform provider limits the time for creating and updating a Managed Service for Kubernetes cluster to 30 minutes.

   Operations in excess of this time will be interrupted.

   How do I modify these limits?

   Add a timeouts block to the cluster description, e.g.:

   resource "yandex_kubernetes_cluster" "<cluster_name>" {
     ...
     timeouts {
       create = "60m"
       update = "60m"
     }
   }
   

   For more information, see this Terraform provider guide.

To update the master resource configuration, use the Update method for the Cluster resource and provide the masterSpec.scalePolicy.autoScale.minResourcePresetId parameter in the request.

The selected configuration allocates minimum resources to the master. Depending on the load, the amount of RAM and number of vCPUs will increase automatically.