Изменение настроек кластера Valkey™

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

Чтобы изменить имя и описание кластера:

1. Посмотрите описание команды CLI для изменения кластера:

   yc managed-redis cluster update --help
   

2. Укажите новые имя и описание в команде изменения кластера:

   yc managed-redis cluster update <имя_или_идентификатор_кластера> \
     --new-name <новое_имя_кластера> \
     --description <новое_описание_кластера>
   

Чтобы изменить описание кластера:

1. Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.

   О том, как создать такой файл, см. в разделе Создание кластера.

2. Измените в описании кластера Yandex Managed Service for Valkey™ значение параметра description:

   resource "yandex_mdb_redis_cluster" "<имя_кластера>" {
     name        = "<имя_кластера>"
     description = "<новое_описание_кластера>"
     ...
   }
   

3. Проверьте корректность настроек.

   1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.

   2. Выполните команду:

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

4. Подтвердите изменение ресурсов.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

      1. Выполните команду:

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

Подробнее см. в документации провайдера Terraform.

resource "yandex_mdb_redis_cluster" "<имя_кластера>" {
  ...
  timeouts {
    create = "1h30m" # Полтора часа
    update = "2h"    # 2 часа
    delete = "30m"   # 30 минут
  }
}

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом Cluster.Update и выполните запрос, например, с помощью cURL:

   Важно

   Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре updateMask (одной строкой через запятую).

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/<идентификатор_кластера>' \
       --data '{
                 "updateMask": "name,description",
                 "name": "<новое_имя_кластера>",
                 "description": "<новое_описание_кластера>"
               }'
   

   Где updateMask — перечень изменяемых параметров в одну строку через запятую.

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом ClusterService.Update и выполните запрос, например, с помощью gRPCurl:

   Важно

   Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре update_mask (в виде массива строк paths[]).

   Формат перечисления настроек

   "update_mask": {
       "paths": [
           "<настройка_1>",
           "<настройка_2>",
           ...
           "<настройка_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/redis/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<идентификатор_кластера>",
             "update_mask": {
               "paths": [ "name", "description" ]
             },
             "name": "<новое_имя_кластера>",
             "description": "<новое_описание_кластера>" 
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.redis.v1.ClusterService.Update
   

   Где update_mask — перечень изменяемых параметров в виде массива строк paths[].

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

Чтобы включить или выключить использование FQDN вместо IP-адресов:

1. Посмотрите описание команды CLI для изменения кластера:

   yc managed-redis cluster update --help
   

2. Укажите нужное значение настройки в команде изменения кластера:

   yc managed-redis cluster update <имя_или_идентификатор_кластера> \
     --announce-hostnames <использование_FQDN_вместо_IP-адресов>
   

   Где --announce-hostnames — настройка, определяющая, использовать ли FQDN вместо IP-адресов: true или false.

   Имя и идентификатор кластера можно получить со списком кластеров в каталоге.

Чтобы включить или выключить использование FQDN вместо IP-адресов:

1. Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.

   О том, как создать такой файл, см. в разделе Создание кластера.

2. Измените в описании кластера Yandex Managed Service for Valkey™ значение параметра announce_hostnames:

   resource "yandex_mdb_redis_cluster" "<имя_кластера>" {
     name        = "<имя_кластера>"
     ...
     announce_hostnames    = <использование_FQDN_вместо_IP-адресов>
     ...
   }
   

   Где announce_hostnames — настройка, определяющая, использовать ли FQDN вместо IP-адресов: true или false.

3. Проверьте корректность настроек.

   1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.

   2. Выполните команду:

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

4. Подтвердите изменение ресурсов.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

      1. Выполните команду:

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

Подробнее см. в документации провайдера Terraform.

resource "yandex_mdb_redis_cluster" "<имя_кластера>" {
  ...
  timeouts {
    create = "1h30m" # Полтора часа
    update = "2h"    # 2 часа
    delete = "30m"   # 30 минут
  }
}

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом Cluster.Update и выполните запрос, например, с помощью cURL:

   Важно

   Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре updateMask (одной строкой через запятую).

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/<идентификатор_кластера>' \
       --data '{
                 "updateMask": "announceHostnames",
                 "announceHostnames": <использование_FQDN_вместо_IP-адресов>
               }'
   

   Где:

   • updateMask — перечень изменяемых параметров в одну строку через запятую.

     В данном случае передается только один параметр.

   • announceHostnames — использование FQDN вместо IP-адресов: true или false.

     Примечание

     Некоторые клиенты несовместимы с этой настройкой и не смогут подключиться к хостам кластера. Такие клиенты ожидают именно IP-адрес и некорректно обрабатывают ситуацию, когда IP-адрес подменяется на FQDN.

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом ClusterService.Update и выполните запрос, например, с помощью gRPCurl:

   Важно

   Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре update_mask (в виде массива строк paths[]).

   Формат перечисления настроек

   "update_mask": {
       "paths": [
           "<настройка_1>",
           "<настройка_2>",
           ...
           "<настройка_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/redis/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<идентификатор_кластера>",
             "update_mask": {
               "paths": [ "announce_hostnames" ]
             },
             "announce_hostnames": <использование_FQDN_вместо_IP-адресов>
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.redis.v1.ClusterService.Update
   

   Где:

   • update_mask — перечень изменяемых параметров в виде массива строк paths[].

     В данном случае передается только один параметр.

   • announce_hostnames — использование FQDN вместо IP-адресов: true или false.

     {% include fqdn-option-compatibility-note %}.

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

Чтобы изменить класс хостов для кластера:

1. Посмотрите описание команды CLI для изменения кластера:

   yc managed-redis cluster update --help
   

2. Запросите список доступных классов хостов (в колонке ZONE IDS указаны зоны доступности, в которых можно выбрать соответствующий класс):

   yc managed-redis resource-preset list
   

   Результат:

   +-------------+--------------------------------+----------+
   |     ID      |            ZONE IDS            |  MEMORY  |
   +-------------+--------------------------------+----------+
   | b1.nano     | ru-central1-a, ru-central1-b,  | 2.0 GB   |
   |             | ru-central1-d                  |          |
   | b1.small    | ru-central1-a, ru-central1-b,  | 4.0 GB   |
   |             | ru-central1-d                  |          |
   | hm1.nano    | ru-central1-a, ru-central1-b,  | 8.0 GB   |
   |             | ru-central1-d                  |          |
   | hm1.micro   | ru-central1-a, ru-central1-b,  | 12.0 GB  |
   | ...                                                     |
   +-----------+----------------------------------+----------+
   

3. Укажите нужный класс в команде изменения кластера:

   yc managed-redis cluster update <имя_или_идентификатор_кластера> \
     --resource-preset <идентификатор_класса_хостов>
   

   Yandex Managed Service for Valkey™ запустит операцию изменения класса хостов для кластера.

1. Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.

   О том, как создать такой файл, см. в разделе Создание кластера.

2. Измените в описании кластера Yandex Managed Service for Valkey™ значение параметра resource_preset_id в блоке resources:

   resource "yandex_mdb_redis_cluster" "<имя_кластера>" {
     ...
     resources {
       resource_preset_id = "<класс_хоста>"
       ...
       }
   }
   

3. Проверьте корректность настроек.

   1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.

   2. Выполните команду:

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

4. Подтвердите изменение ресурсов.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

      1. Выполните команду:

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

Подробнее см. в документации провайдера Terraform.

resource "yandex_mdb_redis_cluster" "<имя_кластера>" {
  ...
  timeouts {
    create = "1h30m" # Полтора часа
    update = "2h"    # 2 часа
    delete = "30m"   # 30 минут
  }
}

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом Cluster.Update и выполните запрос, например, с помощью cURL:

   Важно

   Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре updateMask (одной строкой через запятую).

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/<идентификатор_кластера>' \
       --data '{
                 "updateMask": "configSpec.resources.resourcePresetId",
                 "configSpec": {
                   "resources": {
                     "resourcePresetId": "<класс_хостов>"
                   }
                 }
               }'
   

   Где:

   • updateMask — перечень изменяемых параметров в одну строку через запятую.

     В данном случае передается только один параметр.

   • configSpec.resources.resourcePresetId — новый класс хостов. Чтобы получить список поддерживаемых значений, воспользуйтесь методом ResourcePreset.List.

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом ClusterService.Update и выполните запрос, например, с помощью gRPCurl:

   Важно

   Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре update_mask (в виде массива строк paths[]).

   Формат перечисления настроек

   "update_mask": {
       "paths": [
           "<настройка_1>",
           "<настройка_2>",
           ...
           "<настройка_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/redis/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<идентификатор_кластера>",
             "update_mask": {
               "paths": [ "config_spec.resources.resource_preset_id" ]
             },
             "config_spec": {
               "resources": {
                 "resource_preset_id": "<класс_хостов>"
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.redis.v1.ClusterService.Update
   

   Где:

   • update_mask — перечень изменяемых параметров в виде массива строк paths[].

     В данном случае передается только один параметр.

   • config_spec.resources.resource_preset_id — новый класс хостов. Чтобы получить список поддерживаемых значений, воспользуйтесь методом ResourcePreset.List.

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

Чтобы увеличить размер хранилища хостов Valkey™:

1. Посмотрите описание команды CLI для изменения кластера:

   yc managed-redis cluster update --help
   

2. Укажите нужный размер хранилища в команде изменения кластера. Новый размер должен быть не меньше, чем текущее значение disk_size в свойствах кластера.

   yc managed-redis cluster update <имя_или_идентификатор_кластера> \
     --disk-size <размер_хранилища_ГБ>
   

   Если все условия выполнены, Yandex Managed Service for Valkey™ запустит операцию по увеличению размера дисков хостов Valkey™.

Чтобы увеличить размер хранилища для кластера:

1. Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.

   О том, как создать такой файл, см. в разделе Создание кластера.

2. Измените в описании кластера Yandex Managed Service for Valkey™ значение параметра disk_size в блоке resources:

   resource "yandex_mdb_redis_cluster" "<имя_кластера>" {
     ...
     resources {
       disk_size = <размер_хранилища_ГБ>
       ...
       }
   }
   

3. Проверьте корректность настроек.

   1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.

   2. Выполните команду:

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

4. Подтвердите изменение ресурсов.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

      1. Выполните команду:

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

Подробнее см. в документации провайдера Terraform.

resource "yandex_mdb_redis_cluster" "<имя_кластера>" {
  ...
  timeouts {
    create = "1h30m" # Полтора часа
    update = "2h"    # 2 часа
    delete = "30m"   # 30 минут
  }
}

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом Cluster.Update и выполните запрос, например, с помощью cURL:

   Важно

   Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре updateMask (одной строкой через запятую).

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/<идентификатор_кластера>' \
       --data '{
                 "updateMask": "configSpec.resources.diskSize",
                 "configSpec": {
                   "resources": {
                     "diskSize": "<размер_хранилища_в_байтах>"
                   }
                 }
               }'
   

   Где:

   • updateMask — перечень изменяемых параметров в одну строку через запятую.

     В данном случае передается только один параметр.

   • configSpec.resources.diskSize — новый размер диска в байтах.

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом ClusterService.Update и выполните запрос, например, с помощью gRPCurl:

   Важно

   Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре update_mask (в виде массива строк paths[]).

   Формат перечисления настроек

   "update_mask": {
       "paths": [
           "<настройка_1>",
           "<настройка_2>",
           ...
           "<настройка_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/redis/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<идентификатор_кластера>",
             "update_mask": {
               "paths": [ "config_spec.resources.disk_size" ]
             },
             "config_spec": {
               "resources": {
                 "disk_size": "<размер_хранилища_в_байтах>"
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.redis.v1.ClusterService.Update
   

   Где:

   • update_mask — перечень изменяемых параметров в виде массива строк paths[].

     В данном случае передается только один параметр.

   • config_spec.resources.disk_size — новый размер диска в байтах.

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Чтобы изменить настройки СУБД для кластера:

1. Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.

   О том, как создать такой файл, см. в разделе Создание кластера.

2. Измените в описании кластера Yandex Managed Service for Valkey™ значения параметров в блоке config:

   resource "yandex_mdb_redis_cluster" "<имя_кластера>" {
     ...
     config {
       password         = "<пароль>"
       timeout          = <время>
       maxmemory_policy = "<политика>"
       ...
     }
   }
   

   Где:

   • timeout — время в секундах перед отключением неактивных клиентов.
   • maxmemory_policy — политика управления памятью при ее дефиците.

   Допустимая длина пароля — от 8 до 128 символов. Пароль должен удовлетворять регулярному выражению [a-zA-Z0-9@=+?*.,!&#$^<>_-]*.

3. Проверьте корректность настроек.

   1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.

   2. Выполните команду:

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

4. Подтвердите изменение ресурсов.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

      1. Выполните команду:

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

Подробнее см. в документации провайдера Terraform.

resource "yandex_mdb_redis_cluster" "<имя_кластера>" {
  ...
  timeouts {
    create = "1h30m" # Полтора часа
    update = "2h"    # 2 часа
    delete = "30m"   # 30 минут
  }
}

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом Cluster.Update и выполните запрос, например, с помощью cURL:

   Важно

   Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре updateMask (одной строкой через запятую).

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/<идентификатор_кластера>' \
       --data '{
                 "updateMask": "configSpec.redisConfig_<версия_Valkey™>.<настройка_1>,configSpec.redisConfig_<версия_Valkey™>.<настройка_2>,...,configSpec.redisConfig_<версия_Valkey™>.<настройка_N>",
                 "configSpec": {
                   "redisConfig_<версия_Valkey™>": {
                     "<настройка_1>": "<значение_1>",
                     "<настройка_2>": "<значение_2>",
                     ...
                     "<настройка_N>": "<значение_N>"
                   }
                 }
               }'
   

   Где:

   • updateMask — перечень изменяемых параметров в одну строку через запятую.

   • configSpec.redisConfig_<версия_Valkey™> — набор настроек Valkey™. Укажите каждую настройку на отдельной строке через запятую.

     Список версий Valkey™, доступных для параметра, см. в описании метода. Описание и возможные значения настроек см. в разделе Настройки Valkey™.

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом ClusterService.Update и выполните запрос, например, с помощью gRPCurl:

   Важно

   Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре update_mask (в виде массива строк paths[]).

   Формат перечисления настроек

   "update_mask": {
       "paths": [
           "<настройка_1>",
           "<настройка_2>",
           ...
           "<настройка_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/redis/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<идентификатор_кластера>",
             "update_mask": {
               "paths": [ 
                 "config_spec.redis_config_<версия_Valkey™>.<настройка_1>",
                 "config_spec.redis_config_<версия_Valkey™>.<настройка_2>",
                 ...
                 "config_spec.redis_config_<версия_Valkey™>.<настройка_N>"
               ]
             },
             "config_spec": {
               "redis_config_<версия_Valkey™>": {
                 "<настройка_1>": "<значение_1>",
                 "<настройка_2>": "<значение_2>",
                 ...
                 "<настройка_N>": "<значение_N>"
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.redis.v1.ClusterService.Update
   

   Где:

   • update_mask — перечень изменяемых параметров в виде массива строк paths[].

   • config_spec.redis_config_<версия_Valkey™> — набор настроек Valkey™. Укажите каждую настройку на отдельной строке через запятую.

     Список версий Valkey™, доступных для параметра, см. в описании метода. Описание и возможные значения настроек см. в разделе Настройки Valkey™.

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

Чтобы изменить дополнительные настройки кластера:

1. Посмотрите описание команды CLI для изменения кластера:

   yc managed-redis cluster update --help
   

2. Выполните команду, передав список настроек, которые хотите изменить:

   yc managed-redis cluster update <имя_или_идентификатор_кластера> \
       --backup-window-start <время> \
       --maintenance-window type=<тип_технического_обслуживания>,`
                           `day=<день_недели>,`
                           `hour=<час_дня> \
       --websql-access=<true_или_false> \
       --deletion-protection
   

Вы можете изменить следующие настройки:

• --backup-window-start — время начала резервного копирования кластера, задается по UTC в формате HH:MM:SS. Если время не задано, резервное копирование начнется в 22:00 UTC.

• --maintenance-window — настройки времени технического обслуживания (в т. ч. для выключенных кластеров), где type — тип технического обслуживания:

  • anytime (по умолчанию) — в любое время.
  • weekly — по расписанию. При задании этого значения укажите день недели и час дня:
    • day — день недели в формате DDD: MON, TUE, WED, THU, FRI, SAT или SUN.
    • hour — час дня по UTC в формате HH: от 1 до 24.

• --websql-access — разрешает выполнять SQL-запросы к базам данных кластера из консоли управления Yandex Cloud с помощью сервиса Yandex WebSQL. Значение по умолчанию — false.

• --deletion-protection — защита кластера, его баз данных и пользователей от непреднамеренного удаления.

  Включенная защита от удаления не помешает подключиться вручную и удалить содержимое базы данных.

Имя кластера можно получить со списком кластеров в каталоге.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом Cluster.Update и выполните запрос, например, с помощью cURL:

   Важно

   Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре updateMask (одной строкой через запятую).

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/<идентификатор_кластера>' \
       --data '{
                 "updateMask": "configSpec.backupWindowStart,maintenanceWindow,deletionProtection",
                 "configSpec": {
                   "backupWindowStart": {
                     "hours": "<часы>",
                     "minutes": "<минуты>",
                     "seconds": "<секунды>",
                     "nanos": "<наносекунды>"
                   }
                 },
                 "maintenanceWindow": {
                   "weeklyMaintenanceWindow": {
                     "day": "<день_недели>",
                     "hour": "<час>"
                   }
                 },
                 "deletionProtection": <защита_от_удаления_кластера>
               }'
   

   Где:

   • updateMask — перечень изменяемых параметров в одну строку через запятую.

   • configSpec.backupWindowStart — настройки окна резервного копирования.

     В параметре укажите время, когда начинать резервное копирование:

     • hours — от 0 до 23 часов;
     • minutes — от 0 до 59 минут;
     • seconds — от 0 до 59 секунд;
     • nanos — от 0 до 999999999 наносекунд.

   • maintenanceWindow — настройки времени технического обслуживания (в т. ч. для выключенных кластеров). Передайте один из двух параметров:

     • anytime — техническое обслуживание происходит в любое время.

     • weeklyMaintenanceWindow — техническое обслуживание происходит раз в неделю, в указанное время:

       • day — день недели в формате DDD: MON, TUE, WED, THU, FRI, SAT или SUN.
       • hour — час дня по UTC в формате HH: от 1 до 24.

   • deletionProtection — защита от удаления кластера: true или false.

     Включенная защита от удаления не помешает подключиться вручную и удалить содержимое базы данных.

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом ClusterService.Update и выполните запрос, например, с помощью gRPCurl:

   Важно

   Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре update_mask (в виде массива строк paths[]).

   Формат перечисления настроек

   "update_mask": {
       "paths": [
           "<настройка_1>",
           "<настройка_2>",
           ...
           "<настройка_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/redis/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<идентификатор_кластера>",
             "update_mask": {
               "paths": [ 
                 "config_spec.backup_window_start",
                  "maintenance_window",
                  "deletion_protection"
               ]
             },
             "config_spec": {
               "backup_window_start": {
                 "hours": "<часы>",
                 "minutes": "<минуты>",
                 "seconds": "<секунды>",
                 "nanos": "<наносекунды>"
               }
             },
             "maintenance_window": {
               "weekly_maintenance_window": {
                 "day": "<день_недели>",
                 "hour": "<час>"
               }
             },
             "deletion_protection": <защита_от_удаления_кластера>
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.redis.v1.ClusterService.Update
   

   Где:

   • update_mask — перечень изменяемых параметров в виде массива строк paths[].

   • config_spec.backup_window_start — настройки окна резервного копирования.

     В параметре укажите время, когда начинать резервное копирование:

     • hours — от 0 до 23 часов;
     • minutes — от 0 до 59 минут;
     • seconds — от 0 до 59 секунд;
     • nanos — от 0 до 999999999 наносекунд.

   • maintenance_window — настройки времени технического обслуживания (в т. ч. для выключенных кластеров). Передайте один из двух параметров:

     • anytime — техническое обслуживание происходит в любое время.

     • weekly_maintenance_window — техническое обслуживание происходит раз в неделю, в указанное время:

       • day — день недели в формате DDD: MON, TUE, WED, THU, FRI, SAT или SUN.
       • hour — час дня по UTC в формате HH: от 1 до 24.

   • deletion_protection — защита от удаления кластера: true или false.

     Включенная защита от удаления не помешает подключиться вручную и удалить содержимое базы данных.

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом Cluster.EnableSharding и выполните запрос, например, с помощью cURL:

   curl \
       --request POST \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --url 'https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/<идентификатор_кластера>:enable_sharding'
   

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

   После включения шардирования все существующие хосты кластера будут добавлены в единственный шард shard1.

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом ClusterService.EnableSharding и выполните запрос, например, с помощью gRPCurl:

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/redis/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<идентификатор_кластера>"
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.redis.v1.ClusterService.EnableSharding
   

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

   После включения шардирования все существующие хосты кластера будут добавлены в единственный шард shard1.

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

Чтобы переместить кластер:

1. Посмотрите описание команды CLI для перемещения кластера:

   yc managed-redis cluster move --help
   

2. Укажите каталог назначения в команде перемещения кластера:

   yc managed-redis cluster move <идентификатор_кластера> \
      --destination-folder-name=<имя_каталога_назначения>
   

   Идентификатор кластера можно получить со списком кластеров в каталоге.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом Cluster.Move и выполните запрос, например, с помощью cURL:

   curl \
       --request POST \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/<идентификатор_кластера>:move' \
       --data '{
                 "destinationFolderId": "<идентификатор_каталога>"
               }'
   

   Где destinationFolderId — идентификатор каталога, в который нужно переместить кластер.

   Идентификатор кластера можно запросить со списком кластеров в каталоге, идентификатор каталога — со списком каталогов в облаке.

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом ClusterService.Move и выполните запрос, например, с помощью gRPCurl:

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/redis/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<идентификатор_кластера>",
             "destination_folder_id": "<идентификатор_каталога>"
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.redis.v1.ClusterService.Move
   

   Где destination_folder_id — идентификатор каталога, в который нужно переместить кластер.

   Идентификатор кластера можно запросить со списком кластеров в каталоге, идентификатор каталога — со списком каталогов в облаке.

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

Чтобы изменить список групп безопасности для кластера:

1. Посмотрите описание команды CLI для изменения кластера:

   yc managed-redis cluster update --help
   

2. Укажите нужные группы безопасности в команде изменения кластера:

   yc managed-redis cluster update <имя_или_идентификатор_кластера> \
     --security-group-ids <список_идентификаторов_групп_безопасности>
   

1. Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.

   О том, как создать такой файл, см. в разделе Создание кластера.

2. Измените в описании кластера Yandex Managed Service for Valkey™ значение параметра security_group_ids:

   resource "yandex_mdb_redis_cluster" "<имя_кластера>" {
     ...
     security_group_ids = [<список_идентификаторов_групп_безопасности>]
   }
   

3. Проверьте корректность настроек.

   1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.

   2. Выполните команду:

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

4. Подтвердите изменение ресурсов.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

      1. Выполните команду:

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

Подробнее см. в документации провайдера Terraform.

resource "yandex_mdb_redis_cluster" "<имя_кластера>" {
  ...
  timeouts {
    create = "1h30m" # Полтора часа
    update = "2h"    # 2 часа
    delete = "30m"   # 30 минут
  }
}

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом Cluster.Update и выполните запрос, например, с помощью cURL:

   Важно

   Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре updateMask (одной строкой через запятую).

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/<идентификатор_кластера>' \
       --data '{
                 "updateMask": "securityGroupIds",
                 "securityGroupIds": [
                   "<идентификатор_группы_безопасности_1>",
                   "<идентификатор_группы_безопасности_2>",
                   ...
                   "<идентификатор_группы_безопасности_N>"
                 ]
               }'
   

   Где:

   • updateMask — перечень изменяемых параметров в одну строку через запятую.

     В данном случае передается только один параметр.

   • securityGroupIds — идентификаторы групп безопасности.

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом ClusterService.Update и выполните запрос, например, с помощью gRPCurl:

   Важно

   Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре update_mask (в виде массива строк paths[]).

   Формат перечисления настроек

   "update_mask": {
       "paths": [
           "<настройка_1>",
           "<настройка_2>",
           ...
           "<настройка_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/redis/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<идентификатор_кластера>",
             "update_mask": {
               "paths": [ "security_group_ids" ]
             },
             "security_group_ids": [
               "<идентификатор_группы_безопасности_1>",
               "<идентификатор_группы_безопасности_2>",
               ...
               "<идентификатор_группы_безопасности_N>"
             ] 
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.redis.v1.ClusterService.Update
   

   Где:

   • update_mask — перечень изменяемых параметров в виде массива строк paths[].

     В данном случае передается только один параметр.

   • security_group_ids — идентификаторы групп безопасности.

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.