Управление резервными копиями в Yandex StoreDoc

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

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.

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

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

   yc managed-mongodb cluster restore --help
   

2. Получите список доступных резервных копий кластеров Yandex StoreDoc:

   yc managed-mongodb backup list
   

   Результат:

   +--------------------------+---------------------+----------------------+---------------------+--------+-----------+
   |            ID            |     CREATED AT      |  SOURCE CLUSTER ID   |     STARTED AT      |  SIZE  |   TYPE    |
   +--------------------------+---------------------+----------------------+---------------------+--------+-----------+
   | c9qlk4v13uq7********:... | 2020-08-10 12:00:00 | c9qlk4v13uq7******** | 2020-08-10 11:55:17 | 3.3 KB | AUTOMATED |
   | ...                                                                                         |                    |
   +--------------------------+---------------------+----------------------+---------------------+--------+-----------+
   

   Время завершения создания резервной копии указано в столбце CREATED AT списка доступных резервных копий в формате yyyy-mm-dd hh:mm:ss (2020-08-10 12:00:00 в примере выше). Вы можете восстановить состояние кластера на любой момент времени, начиная от создания резервной копии.

3. Выполните команду создания нового кластера из резервной копии (в примерах приведены только некоторые параметры).

   Для нешардированного кластера:

   yc managed-mongodb cluster restore \
      --backup-id <идентификатор_резервной_копии> \
      --recovery-target-timestamp <момент_времени> \
      --mongodb-version <версия_Yandex_StoreDoc> \
      --name <имя_нового_кластера> \
      --environment <окружение> \
      --network-name <имя_сети> \
      --host zone-id=<зона_доступности>,`
            `subnet-id=<идентификатор_подсети> \
      --mongod-resource-preset <класс_хоста> \
      --mongod-disk-size <размер_хранилища_ГБ> \
      --mongod-disk-type <тип_диска> \
      --performance-diagnostics=<включить_диагностику>
   

   Для шардированного кластера:

   yc managed-mongodb cluster restore \
      --backup-id <идентификатор_резервной_копии> \
      --recovery-target-timestamp <момент_времени> \
      --mongodb-version <версия_Yandex_StoreDoc> \
      --name <имя_нового_кластера> \
      --environment <окружение> \
      --network-name <имя_сети> \
      --host zone-id=<зона_доступности>,`
            `subnet-id=<идентификатор_подсети>,`
            `type=mongod,`
            `shard-name=<имя_шарда> \
      --mongod-resource-preset <класс_хоста> \
      --mongod-disk-size <размер_хранилища_ГБ> \
      --mongod-disk-type <тип_диска> \
      --host zone-id=<зона_доступности>,`
            `subnet-id=<идентификатор_подсети>,`
            `type=<тип_хоста> \
      ...
      --host zone-id=<зона_доступности>,`
            `subnet-id=<идентификатор_подсети>,`
            `type=<тип_хоста> \
      --<тип_хоста>-resource-preset <класс_хоста> \
      --<тип_хоста>-disk-size <размер_хранилища_ГБ> \
      --<тип_хоста>-disk-type <тип_диска> \
      --performance-diagnostics=<включить_диагностику>
   

   Где:

   • --backup-id — идентификатор резервной копии. Чтобы восстановить шардированный кластер, укажите идентификатор шардированной резервной копии. Такие копии имеют больший размер. Чтобы узнать идентификатор, получите список резервных копий в каталоге.

   • --recovery-target-timestamp — момент времени, на который нужно восстановить состояние кластера Yandex StoreDoc, в формате UNIX time. Если параметр не задан, восстановится состояние кластера на момент завершения создания резервной копии.

   • --environment — окружение: PRESTABLE или PRODUCTION.

   • --mongod-disk-type — тип диска: network-hdd, network-ssd или network-ssd-io-m3.

   • --<тип_хоста>-resource-preset, --<тип_хоста>-disk-size, --<тип_хоста>-disk-type — параметры хостов, которые управляют шардированием в кластере. <тип_хоста> может принимать значения: mongoinfra, mongocfg, mongos.

   • --performance-diagnostics — включить диагностику производительности кластера: true или false.

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

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

2. Создайте файл body.json и добавьте в него следующее содержимое:

   {
     "folderId": "<идентификатор_каталога>",
     "backupId": "<идентификатор_резервной_копии>",
     "name": "<имя_нового_кластера>",
     "environment": "<окружение>",
     "networkId": "<идентификатор_сети>",
     "recoveryTargetSpec": {
       "timestamp": "<время>"
     },
     "configSpec": {
       "version": "<версия_Yandex_StoreDoc>",
       "mongodb": {
         "<тип_хоста_Yandex_StoreDoc>": {
           "resources": {
             "resourcePresetId": "<класс_хостов>",
             "diskSize": "<размер_хранилища_в_байтах>",
             "diskTypeId": "<тип_диска>"
           }
         },
         ...
         "<тип_хоста_Yandex_StoreDoc>": {
           "resources": {
             "resourcePresetId": "<класс_хостов>",
             "diskSize": "<размер_хранилища_в_байтах>",
             "diskTypeId": "<тип_диска>"
           }
         }
       }
     },
     "hostSpecs": [
       {
         "zoneId": "<зона_доступности>",
         "subnetId": "<идентификатор_подсети>",
         "assignPublicIp": <разрешить_публичный_доступ_к_хосту>,
         "type": "<тип_хоста>",
         "shardName": "<имя_шарда>",
         "hidden": <скрыть_хост>,
         "secondaryDelaySecs": "<задержка_в_секундах>",
         "priority": "<приоритет_назначения_хоста_мастером>",
         "tags": "<метки_хоста>"
       }
     ]
   }
   

   Где:

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

   • backupId — идентификатор резервной копии. Чтобы восстановить шардированный кластер, укажите идентификатор шардированной резервной копии. Такие копии имеют больший размер. Чтобы узнать идентификатор, получите список резервных копий в каталоге.

   • name — имя нового кластера.

   • environment — окружение кластера: PRODUCTION или PRESTABLE.

   • networkId — идентификатор сети, в которой будет размещен кластер.

   • recoveryTargetSpec.timestamp — момент времени, на который нужно восстановить состояние кластера Yandex StoreDoc, в формате UNIX time. Если параметр не задан, восстановится состояние кластера на момент завершения создания резервной копии.

   • configSpec — настройки кластера:

     • version — версия Yandex StoreDoc: 5.0, 6.0 или 7.0.

     • Тип хоста Yandex StoreDoc — зависит от типа шардирования. Доступные значения: mongod, mongocfg, mongos, mongoinfra. Если кластер нешардированный, укажите mongod.

       • resources — ресурсы кластера:

         • resourcePresetId — класс хостов.
         • diskSize — размер диска в байтах.
         • diskTypeId — тип диска.

   • hostSpecs — настройки хостов кластера в виде массива элементов. Каждый элемент соответствует отдельному хосту и имеет следующую структуру:

     • zoneId — зона доступности.
     • subnetId — идентификатор подсети.
     • assignPublicIp — доступность хоста из интернета по публичному IP-адресу: true или false.
     • type— тип хоста в шардированном кластере: MONGOD, MONGOINFRA, MONGOS или MONGOCFG. Если кластер нешардированный, укажите MONGOD.
     • shardName — имя шарда в шардированном кластере.
     • hidden— будет ли хост виден (false) или скрыт (true).
     • secondaryDelaySecs — время отставания хоста от мастера.
     • priority — приоритет назначения хоста мастером при выходе из строя основного мастера.
     • tags— метки хоста.

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

   curl \
       --request POST \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters:restore' \
       --data "@body.json"
   

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

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

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

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

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

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

3. Создайте файл body.json и добавьте в него следующее содержимое:

   {
     "folder_id": "<идентификатор_каталога>",
     "backup_id": "<идентификатор_резервной_копии>",
     "name": "<имя_нового_кластера>",
     "environment": "<окружение>",
     "network_id": "<идентификатор_сети>",
     "recovery_target_spec": {
       "timestamp": "<время>"
     },
     "config_spec": {
       "version": "<версия_Yandex_StoreDoc>",
       "mongodb": {
         "<тип_хоста_Yandex_StoreDoc>": {
           "resources": {
             "resource_preset_id": "<класс_хостов>",
             "disk_size": "<размер_хранилища_в_байтах>",
             "disk_type_id": "<тип_диска>"
           }
         },
         ...
         "<тип_хоста_Yandex_StoreDoc>": {
           "resources": {
             "resource_preset_id": "<класс_хостов>",
             "disk_size": "<размер_хранилища_в_байтах>",
             "disk_type_id": "<тип_диска>"
           }
         }
       }
     },
     "host_specs": [
       {
         "zone_id": "<зона_доступности>",
         "subnet_id": "<идентификатор_подсети>",
         "assign_public_ip": <разрешить_публичный_доступ_к_хосту>,
         "type": "<тип_хоста>",
         "shard_name": "<имя_шарда>",
         "hidden": <скрыть_хост>,
         "secondary_delay_secs": "<задержка_в_секундах>",
         "priority": "<приоритет_назначения_хоста_мастером>",
         "tags": "<метки_хоста>"
       }
     ]
   }
   

   Где:

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

   • backup_id — идентификатор резервной копии. Чтобы восстановить шардированный кластер, укажите идентификатор шардированной резервной копии. Такие копии имеют больший размер. Чтобы узнать идентификатор, получите список резервных копий в каталоге.

   • name — имя нового кластера.

   • environment — окружение кластера: PRODUCTION или PRESTABLE.

   • network_id — идентификатор сети, в которой будет размещен кластер.

   • recovery_target_spec.timestamp — момент времени, на который нужно восстановить состояние кластера Yandex StoreDoc, в формате UNIX time. Если параметр не задан, восстановится состояние кластера на момент завершения создания резервной копии.

   • config_spec — настройки кластера:

     • version — версия Yandex StoreDoc: 5.0, 6.0 или 7.0.

     • Тип хоста Yandex StoreDoc — зависит от типа шардирования. Доступные значения: mongod, mongocfg, mongos, mongoinfra. Если кластер нешардированный, укажите mongod.

       • resources — ресурсы кластера:

         • resource_preset_id — класс хостов.
         • disk_size — размер диска в байтах.
         • disk_type_id — тип диска.

   • host_specs — настройки хостов кластера в виде массива элементов. Каждый элемент соответствует отдельному хосту и имеет следующую структуру:

     • zone_id — зона доступности.
     • subnet_id — идентификатор подсети.
     • assign_public_ip — доступность хоста из интернета по публичному IP-адресу: true или false.
     • type— тип хоста в шардированном кластере: MONGOD, MONGOINFRA, MONGOS или MONGOCFG. Если кластер нешардированный, укажите MONGOD.
     • shard_name — имя шарда в шардированном кластере.
     • hidden— будет ли хост виден (false) или скрыт (true).
     • secondary_delay_secs — время отставания хоста от мастера.
     • priority — приоритет назначения хоста мастером при выходе из строя основного мастера.
     • tags— метки хоста.

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

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/mongodb/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d @ \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mongodb.v1.ClusterService.Restore \
       < body.json
   

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

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

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.

Чтобы создать резервную копию кластера:

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

   yc managed-mongodb cluster backup --help
   

2. Запросите создание резервной копии, указав идентификатор или имя кластера:

   yc managed-mongodb cluster backup <имя_или_идентификатор_кластера>
   

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.

Чтобы получить список резервных копий кластеров Yandex StoreDoc, доступных в каталоге по умолчанию, выполните команду:

yc managed-mongodb backup list

Результат:

+--------------------------+---------------------+----------------------+---------------------+--------+-----------+
|            ID            |     CREATED AT      |  SOURCE CLUSTER ID   |     STARTED AT      |  SIZE  |   TYPE    |
+--------------------------+---------------------+----------------------+---------------------+--------+-----------+
| c9qlk4v13uq7********:... | 2020-08-10 12:00:00 | c9qlk4v13uq7******** | 2020-08-10 11:55:17 | 3.3 KB | AUTOMATED |
| c9qpm90p3pcg********:... | 2020-08-09 22:01:04 | c9qpm90p3pcg******** | 2020-08-09 21:30:00 | 30 KB  | MANUAL    |
+--------------------------+---------------------+----------------------+---------------------+--------+-----------+

В выведенной таблице содержится следующая информация:

• Идентификатор резервной копии.
• Время окончания создания резервной копии по UTC (Coordinated Universal Time).
• Идентификатор кластера, для которого создавалась эта резервная копия.
• Время начала создания резервной копии по UTC.
• Размер резервной копии.
• Тип резервной копии: автоматическая (AUTOMATED) или ручная (MANUAL).

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

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

2. Чтобы получить список резервных копий кластера:

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

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

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

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

3. Чтобы получить список резервных копий всех кластеров в каталоге:

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

      curl \
         --request GET \
         --header "Authorization: Bearer $IAM_TOKEN" \
         --url 'https://mdb.api.cloud.yandex.net/managed-mongodb/v1/backups'
         --url-query folderId=<идентификатор_каталога>
      

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

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

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

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

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

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

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

3. Чтобы получить список резервных копий кластера:

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

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

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

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

4. Чтобы получить список резервных копий всех кластеров в каталоге:

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

      grpcurl \
          -format json \
          -import-path ~/cloudapi/ \
          -import-path ~/cloudapi/third_party/googleapis/ \
          -proto ~/cloudapi/yandex/cloud/mdb/mongodb/v1/backup_service.proto \
          -rpc-header "Authorization: Bearer $IAM_TOKEN" \
          -d '{
                "folder_id": "<идентификатор_каталога>"
              }' \
          mdb.api.cloud.yandex.net:443 \
          yandex.cloud.mdb.mongodb.v1.BackupService.List
      

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

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

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

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.

Чтобы получить данные о резервной копии кластера Yandex StoreDoc, выполните команду:

yc managed-mongodb backup get <идентификатор_резервной_копии>

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

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

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

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

   curl \
      --request GET \
      --header "Authorization: Bearer $IAM_TOKEN" \
      --url 'https://mdb.api.cloud.yandex.net/managed-mongodb/v1/backups/<идентификатор_резервной_копии>'
   

   Идентификатор резервной копии можно запросить со списком резервных копий.

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

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

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

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

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

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

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

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/mongodb/v1/backup_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d '{
           "backup_id": "<идентификатор_резервной_копии>"
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.mongodb.v1.BackupService.Get
   

   Идентификатор резервной копии можно запросить со списком резервных копий.

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

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

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.

Чтобы задать срок хранения автоматических резервных копий, передайте нужное значение в аргументе --backup-retain-period-days команды изменения кластера:

yc managed-mongodb cluster update <имя_или_идентификатор_кластера> \
   --backup-retain-period-days=<срок_хранения_в_днях>

Допустимые значения: от 7 до 35. Значение по умолчанию — 7.

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

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

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

   Полный список доступных для изменения полей конфигурации кластера Yandex StoreDoc см. в документации провайдера Terraform.

2. Добавьте к описанию кластера Yandex StoreDoc блок backup_retain_period_days в секции cluster_config:

     resource "yandex_mdb_mongodb_cluster" "<имя_кластера>" {
       ...
       cluster_config {
         ...
         backup_retain_period_days = <срок_хранения_в_днях>
         }
         ...
       }
       ...
   

   Где backup_retain_period_days — срок хранения автоматических резервных копий.

   Допустимые значения: от 7 до 35. Значение по умолчанию — 7.

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

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

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

      terraform validate
      

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

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

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

      terraform plan
      

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

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

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

         terraform apply
         

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

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

   Ограничения по времени

   Провайдер Terraform ограничивает время на выполнение операций с кластером Yandex StoreDoc:

   • создание, в т. ч. путем восстановления из резервной копии, — 30 минут;
   • изменение — 60 минут.

   Операции, длящиеся дольше указанного времени, прерываются.

   Как изменить эти ограничения?

   Добавьте к описанию кластера блок timeouts, например:

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

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-mongodb/v1/clusters/<идентификатор_кластера>' \
       --data '{
                 "updateMask": "configSpec.backupRetainPeriodDays",
                 "configSpec": {
                   "backupRetainPeriodDays": <время_хранения_резервных_копий_в_днях>
                 }
               }'
   

   Где:

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

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

   • configSpec.backupRetainPeriodDays — срок хранения автоматических резервных копий в днях.

     Допустимые значения — от 7 до 35. Значение по умолчанию — 7.

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

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/mongodb/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<идентификатор_кластера>",
             "update_mask": {
               "paths": [
                 "config_spec.backup_retain_period_days"
               ]
             },
             "config_spec": {
               "backup_retain_period_days": <время_хранения_резервных_копий_в_днях>
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mongodb.v1.ClusterService.Update
   

   Где:

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

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

   • config_spec.backup_retain_period_days — срок хранения автоматических резервных копий в днях.

     Допустимые значения — от 7 до 35. Значение по умолчанию — 7.

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

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