Apache Kafka® cluster maintenance

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 reschedule maintenance for a new date and time:

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

   yc managed-kafka cluster reschedule-maintenance --help
   

2. Run this command:

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

   Where:

   • reschedule-type: Reschedule type:

     • next-available-window: Next available window.
     • specific-time: Specific date and time.

   • delayed-until: Timestamp (do not use with the next-available-window reschedule type).

     The timestamp must be in one of the following 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, or 3h30m ago.

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

To reschedule maintenance for a new date and time:

1. Get an IAM token for API authentication.

2. Save the token to an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

3. 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-kafka/v1/clusters/<cluster_ID>:rescheduleMaintenance' \
     --data '{
       "rescheduleType": <reschedule_type>,
       "delayedUntil": <timestamp>
     }'
   

   Where:

   • rescheduleType: Reschedule type:

     • NEXT_AVAILABLE_WINDOW: Next available window.
     • SPECIFIC_TIME: Specific date and time.

   • delayedUntil: Timestamp in RFC-3339 format, such as 2006-01-02T15:04:05Z.

     Do not use this option with the NEXT_AVAILABLE_WINDOW reschedule type.

   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.

To reschedule maintenance for a new date and time:

1. Get an IAM token for API authentication.

2. Save the token to an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

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

4. 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/kafka/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.kafka.v1.ClusterService.RescheduleMaintenance
   

   Where:

   • reschedule_type: Reschedule type:

     • NEXT_AVAILABLE_WINDOW: Next available window.
     • SPECIFIC_TIME: Specific date and time.

   • delayedUntil: Timestamp in RFC-3339 format, such as 2006-01-02T15:04:05Z.

     Do not use this option with the NEXT_AVAILABLE_WINDOW reschedule type.

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

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

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 start scheduled maintenance immediately, do the following:

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

   yc managed-kafka cluster reschedule-maintenance --help
   

2. Run this command using the immediate reschedule type:

   yc managed-kafka 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.

To start scheduled maintenance immediately, do the following:

1. Get an IAM token for API authentication.

2. Save the token to an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

3. 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-kafka/v1/clusters/<cluster_ID>:rescheduleMaintenance' \
     --data '{
       "rescheduleType": "IMMEDIATE"
     }'
   

   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.

To start scheduled maintenance immediately, do the following:

1. Get an IAM token for API authentication.

2. Save the token to an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

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

4. 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/kafka/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.kafka.v1.ClusterService.RescheduleMaintenance
   

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

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

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.

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

   yc managed-kafka cluster update --help
   

2. Run this command:

   yc managed-kafka 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.

   Learn how to create this file in Creating a cluster.

   For a complete list of Managed Service for Apache Kafka® cluster configuration fields you can update, see this Terraform provider guide.

2. To set up the maintenance window that will also apply to stopped clusters, add the maintenance_window section to the cluster description:

   resource "yandex_mdb_kafka_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: On a schedule
   • day: Day of week for the WEEKLY type, i.e., MON, TUE, WED, THU, FRI, SAT, or SUN.
   • hour: UTC hour for the WEEKLY type, from 1 to 24.

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.

   Timeouts

   The Terraform provider limits the time for all operations with the Managed Service for Apache Kafka® cluster to 60 minutes.

   Operations exceeding the timeout are aborted.

   How do I change these limits?

   Add the timeouts section to your cluster description, such as the following:

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

2. Save the token to an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

3. Call the Cluster.Update method, e.g., via the following cURL request:

   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-kafka/v1/clusters/<cluster_ID>' \
     --data '{
       "updateMask": "maintenanceWindow",
       "maintenanceWindow": {
         "weeklyMaintenanceWindow": {
           "day": "<day_of_week>",
           "hour": "<hour>"
         }
       }
     }'
   

   Where:

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

     Here, we provide only one setting.

   • maintenanceWindow: Maintenance window settings, including for stopped clusters. The possible values are:

     • anytime: Maintenance can run at any time.

     • weeklyMaintenanceWindow: Maintenance runs once a week on the specified day and 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) in HH format, 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.

1. Get an IAM token for API authentication.

2. Save the token to an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

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

4. Call the ClusterService.Update method, e.g., via the following gRPCurl request:

   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/kafka/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.kafka.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of strings (paths[]).

     Here, we provide only one setting.

   • maintenance_window: Maintenance window settings, including for stopped clusters. The possible values are:

     • anytime: Maintenance can run at any time.

     • weekly_maintenance_window: Maintenance runs once a week on the specified day and 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) in HH format, from 1 to 24.

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

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