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

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

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

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

   yc managed-mongodb backup-retention-policy create --help
   

2. Создайте политику:

   yc managed-mongodb backup-retention-policy create \
      --cluster-id <идентификатор_кластера> \
      --policy-name <название_политики> \
      --day-of-month <день_месяца> \
      --month <месяц> \
      --day-of-week <день_недели> \
      --retain-for-days <срок_хранения_копии_в_днях> \
      --description <описание_политики>
   

   Где:

   • --cluster-id — идентификатор кластера. Его можно получить со списком кластеров.
   • --day-of-month — день месяца. Возможные значения: 1–31.
   • --month — месяц. Возможные значения: 1–12 или JAN–DEC.
   • --day-of-week — день недели. Возможные значения: 0–6 или SUN–SAT.
   • --retain-for-days — срок хранения копии в днях. Возможные значения: 7–1095 (до трех лет).

   Параметры --day-of-month, --month и --day-of-week составляют расписание, по которому создаются резервные копии. Расписание задается в виде cron-выражения, но часы и минуты не указываются.

   Cron-выражение также поддерживает специальные символы:

   • * — выбор всех возможных значений. Копия будет создаваться каждый раз (день или месяц), когда это возможно и не противоречит остальным параметрам. Используется по умолчанию, если значение параметра не указано.
   • , — перечисление нескольких значений.
   • – — указание диапазона значений.
   • / — указание шага диапазона. Например, */3 для параметра --day-of-month означает, что копия будет создаваться раз в три дня.

   Если ни один параметр расписания не задан, резервные копии создаются по cron-выражению * * *, то есть каждый день.

   Примеры cron-выражений:

   • 1 */6 * — копия создается в первый день месяца раз в полгода.
   • 31 jan SUN — копия создается в январе по воскресеньям и тридцать первого января.
   • * * WED — копия создается каждую среду.

   Вы можете протестировать cron-выражение в редакторе.

   Результат выполнения команды:

   policy_id: mdbt553glp51********
   cluster_id: c9q5le6h1a4k********
   policy_name: test-policy
   created_at: "2025-03-25T15:55:50.393000450Z"
   cron:
     day_of_month: "25"
     month: mar
     day_of_week: TUE
   retain_for_days: "300"
   

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

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

2. Добавьте описание ресурса:

   resource "yandex_mdb_mongodb_backup_retention_policy" "<имя_политики>" {
     cluster_id      = "<идентификатор_кластера>"
     policy_name     = "<имя_политики>"
     description     = "<описание_политики>"
     retain_for_days = <срок_хранения_копии_в_днях>
   
     cron = {
       day_of_month = "<день_месяца>"
       day_of_week  = "<день_недели>"
       month        = "<месяц>"
     }
   }
   

   Где:

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

   • retain_for_days — срок хранения копии в днях. Возможные значения: 7–1095 (до трех лет).

   • cron — настройки расписания, по которому создаются резервные копии:

     • day_of_month — день месяца. Возможные значения: 1–31.
     • day_of_week — день недели. Возможные значения: 0–6 или SUN–SAT.
     • month — месяц. Возможные значения: 1–12 или JAN–DEC.

     Расписание задается в виде cron-выражения, но часы и минуты не указываются.

     Cron-выражение также поддерживает специальные символы:

     • * — выбор всех возможных значений. Копия будет создаваться каждый раз (день или месяц), когда это возможно и не противоречит остальным параметрам. Используется по умолчанию, если значение параметра не указано.
     • , — перечисление нескольких значений.
     • – — указание диапазона значений.
     • / — указание шага диапазона. Например, */3 для параметра day_of_month означает, что копия будет создаваться раз в три дня.

     Если ни один параметр расписания не задан, резервные копии создаются по cron-выражению * * *, то есть каждый день.

     Примеры cron-выражений:

     • 1 */6 * — копия создается в первый день месяца раз в полгода.
     • 31 jan SUN — копия создается в январе по воскресеньям и тридцать первого января.
     • * * WED — копия создается каждую среду.

     Вы можете протестировать cron-выражение в редакторе.

3. Проверьте корректность конфигурационных файлов.

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

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

      terraform validate
      

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

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

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

      terraform plan
      

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

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

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

         terraform apply
         

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

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

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

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

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

2. Воспользуйтесь методом BackupRetentionPolicy.Create и выполните запрос, например, с помощью 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/<идентификатор_кластера>/retention_policies' \
     --data '{
                "cron": {
                  "dayOfMonth": "<день_месяца>",
                  "month": "<месяц>",
                  "dayOfWeek": "<день_недели>"
                },
                "retainForDays": "<срок_хранения_в_днях>",
                "description": "<описание_политики>",
                "policyName": "<название_политики>"
            }'
   

   Где:

   • <идентификатор_кластера> — идентификатор кластера, который можно получить со списком кластеров.
   • dayOfMonth — день месяца. Возможные значения: 1-31.
   • month — месяц. Возможные значения: 1-12 или JAN-DEC.
   • dayOfWeek — день недели. Возможные значения: 0-6 или SUN-SAT.
   • retainForDays — срок хранения копии в днях. Возможные значения: 7–1095 (до трех лет).

   Параметры dayOfMonth, month и dayOfWeek составляют расписание, по которому создаются резервные копии. Расписание задается в виде cron-выражения, но часы и минуты не указываются.

   Cron-выражение также поддерживает специальные символы:

   • * — выбор всех возможных значений. Копия будет создаваться каждый раз (день или месяц), когда это возможно и не противоречит остальным параметрам. Используется по умолчанию, если значение параметра не указано.
   • , — перечисление нескольких значений.
   • – — указание диапазона значений.
   • / — указание шага диапазона. Например, */3 для параметра dayOfMonth означает, что копия будет создаваться раз в три дня.

   Если ни один параметр расписания не задан, резервные копии создаются по cron-выражению * * *, то есть каждый день.

   Примеры cron-выражений:

   • 1 */6 * — копия создается в первый день месяца раз в полгода.
   • 31 jan SUN — копия создается в январе по воскресеньям и тридцать первого января.
   • * * WED — копия создается каждую среду.

   Вы можете протестировать cron-выражение в редакторе.

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

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

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

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

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

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

3. Чтобы создать политику:

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

      grpcurl \
          -format json \
          -import-path ~/cloudapi/ \
          -import-path ~/cloudapi/third_party/googleapis/ \
          -proto ~/cloudapi/yandex/cloud/mdb/mongodb/v1/backup_retention_policy_service.proto \
          -rpc-header "Authorization: Bearer $IAM_TOKEN" \
          -d '{
                "cluster_id": "<идентификатор_кластера>",
                "cron": {
                   "day_of_month": "<день_месяца>",
                   "month": "<месяц>",
                   "day_of_week": "<день_недели>"
                },
                "retain_for_days": "<срок_хранения_копии_в_днях>",
                "description": "<описание_политики>",
                "policy_name": "<название_политики>"
              }' \
          mdb.api.cloud.yandex.net:443 \
          yandex.cloud.mdb.mongodb.v1.BackupRetentionPolicyService.Create
      

      Где:

      • cluster_id — идентификатор кластера. Его можно получить со списком кластеров.
      • day_of_month — день месяца. Возможные значения: 1–31.
      • month — месяц. Возможные значения: 1–12 или JAN–DEC.
      • day_of_week — день недели. Возможные значения: 0–6 или SUN–SAT.
      • retain_for_days — срок хранения копии в днях. Возможные значения: 7–1095 (до трех лет).

      Параметры day_of_month, month и day_of_week составляют расписание, по которому создаются резервные копии. Расписание задается в виде cron-выражения, но часы и минуты не указываются.

      Cron-выражение также поддерживает специальные символы:

      • * — выбор всех возможных значений. Копия будет создаваться каждый раз (день или месяц), когда это возможно и не противоречит остальным параметрам. Используется по умолчанию, если значение параметра не указано.
      • , — перечисление нескольких значений.
      • – — указание диапазона значений.
      • / — указание шага диапазона. Например, */3 для параметра day_of_month означает, что копия будет создаваться раз в три дня.

      Если ни один параметр расписания не задан, резервные копии создаются по cron-выражению * * *, то есть каждый день.

      Примеры cron-выражений:

      • 1 */6 * — копия создается в первый день месяца раз в полгода.
      • 31 jan SUN — копия создается в январе по воскресеньям и тридцать первого января.
      • * * WED — копия создается каждую среду.

      Вы можете протестировать cron-выражение в редакторе.

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

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

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

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

   yc managed-mongodb backup-retention-policy list --help
   

2. Получите список политик для кластера Yandex StoreDoc:

   yc managed-mongodb backup-retention-policy list \
      --cluster-id <идентификатор_кластера>
   

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

   Результат выполнения команды:

   +----------------------+-------------+--------------------+------------+-------------------+
   |          ID          |     NAME    |     CLUSTER ID     |  CRONTAB   |  RETENTION PERIOD |
   +----------------------+-------------+--------------------+------------+-------------------+
   | mdbt553glp51******** | test-policy | c9q5le6h1a4******* | 31 JAN SUN |                50 |
   +----------------------+-------------+--------------------+------------+-------------------+
   

   Порядок параметров в столбце CRONTAB: --day-of-month (день месяца), --month (месяц), --day-of-week (день недели).

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

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

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

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

   Где:

   • <идентификатор_кластера> — идентификатор кластера, который можно получить со списком кластеров.
   • pageSize — количество результатов запроса, которые возвращаются на одной странице. Укажите число больше нуля.

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

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

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

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

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

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

3. Чтобы получить список политик для кластера:

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

      grpcurl \
        -format json \
        -import-path ~/cloudapi/ \
        -import-path ~/cloudapi/third_party/googleapis/ \
        -proto ~/cloudapi/yandex/cloud/mdb/mongodb/v1/backup_retention_policy_service.proto \
        -rpc-header "Authorization: Bearer $IAM_TOKEN" \
        -d '{
              "cluster_id": "<идентификатор_кластера>",
              "page_size": "<количество_результатов>"
            }' \
        mdb.api.cloud.yandex.net:443 \
        yandex.cloud.mdb.mongodb.v1.BackupRetentionPolicyService.List
      

      Где:

      • cluster_id — идентификатор кластера. Его можно получить со списком кластеров.
      • page_size — количество результатов запроса, которые возвращаются на одной странице. Укажите число больше нуля.

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

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

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

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

   yc managed-mongodb backup-retention-policy delete --help
   

2. Удалите политику:

   yc managed-mongodb backup-retention-policy delete <идентификатор_политики> \
      --cluster-id <идентификатор_кластера>
   

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

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

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

2. Удалите ресурс yandex_mdb_mongodb_backup_retention_policy с именем удаляемой политики.

3. Проверьте корректность конфигурационных файлов.

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

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

      terraform validate
      

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

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

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

      terraform plan
      

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

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

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

         terraform apply
         

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

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

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

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

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

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

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

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

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

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

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

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

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

3. Чтобы удалить политику:

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

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

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

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