Тип бэкенда: COS

Сохраняет состояние в виде объекта с настраиваемым префиксом в указанном бакете в Tencent Cloud Object Storage (COS).

Этот бэкенд поддерживает блокировку состояния. Для хранения состояния в бакете COS требуются следующие разрешения:

• CreateTag, DeleteTag и DescribeTags для ключа тега tencentcloud-terraform-lock
• Put, Get и Delete для файлов с указанным префиксом бакета

Пример конфигурации​

terraform {
  backend "cos" {
    region = "ap-guangzhou"
    bucket = "bucket-for-tofu-state-1258798060"
    prefix = "tofu/state"
  }
}

Предполагается, что мы создали бакет COS с именем bucket-for-tofu-state-1258798060. Состояние OpenTofu будет записано в файл tofu/state/terraform.tfstate.

Конфигурация источника данных​

Чтобы использовать удалённое состояние COS в другой конфигурации, воспользуйтесь источником данных terraform_remote_state.

data "terraform_remote_state" "foo" {
  backend = "cos"

  config = {
    region = "ap-guangzhou"
    bucket = "bucket-for-tofu-state-1258798060"
    prefix = "tofu/state"
  }
}

Переменные конфигурации​

Поддерживаются следующие параметры конфигурации и переменные среды:

• secret_id — (Необязательно) Идентификатор секрета Tencent Cloud. Поддерживается переменная среды TENCENTCLOUD_SECRET_ID.
• secret_key — (Необязательно) Ключ секрета Tencent Cloud. Поддерживается переменная среды TENCENTCLOUD_SECRET_KEY.
• security_token — (Необязательно) Токен безопасности TencentCloud для временных учётных данных доступа. Поддерживается переменная среды TENCENTCLOUD_SECURITY_TOKEN.
• region — (Необязательно) Регион бакета COS. Поддерживается переменная среды TENCENTCLOUD_REGION.
• bucket — (Обязательно) Имя бакета COS. Сначала его необходимо создать вручную.
• prefix — (Необязательно) Каталог для сохранения файла состояния в бакете. По умолчанию — "env:".
• key — (Необязательно) Путь для сохранения файла состояния в бакете. По умолчанию — terraform.tfstate.
• encrypt — (Необязательно) Включает ли шифрование файла состояния на стороне сервера. Если значение равно true, COS будет шифровать файл состояния алгоритмом 'AES256'.
• acl — (Необязательно) ACL объекта, применяемый к файлу состояния; допускаются private и public-read. По умолчанию — private.
• accelerate — (Необязательно) Включает ли глобальное ускорение. По умолчанию — false.

Использование роли​

Если указана роль для принятия, OpenTofu попытается принять её, используя переданные учётные данные. Чтобы указать роль для принятия, добавьте блок assume_role в блок бэкенда cos.

• assume_role — (Необязательно) Блок assume_role. Если он указан, OpenTofu попытается принять эту роль, используя переданные учётные данные.

Описание блока assume_role:

• role_arn — (Обязательно) ARN принимаемой роли. Можно получить из TENCENTCLOUD_ASSUME_ROLE_ARN.
• session_name — (Обязательно) Имя сеанса, используемое при вызове AssumeRole. Можно получить из TENCENTCLOUD_ASSUME_ROLE_SESSION_NAME.
• session_duration — (Обязательно) Продолжительность сеанса при вызове AssumeRole. Значение может находиться в диапазоне от 0 до 43200 секунд; по умолчанию оно составляет 7200 секунд. Можно получить из TENCENTCLOUD_ASSUME_ROLE_SESSION_DURATION.
• policy — (Необязательно) Более ограничительная политика для вызова AssumeRole. Её содержимое не должно включать элементы principal. Примечание: дополнительные сведения о синтаксисе см. в разделе Логика синтаксиса политик.

Пример использования:

terraform {
  backend "cos" {
    region = "ap-guangzhou"
    bucket = "bucket-for-tofu-state-{appid}"
    prefix = "tofu/state"
    assume_role {
      role_arn = "qcs::cam::uin/xxx:roleName/yyy"
      session_name = "my-session-name"
      session_duration = 3600
    }
  }
}

Кроме того, эти параметры конфигурации assume_role можно также передать с помощью переменных среды.

Пример использования:

$ export TENCENTCLOUD_SECRET_ID="my-secret-id"
$ export TENCENTCLOUD_SECRET_KEY="my-secret-key"
$ export TENCENTCLOUD_REGION="ap-guangzhou"
$ export TENCENTCLOUD_ASSUME_ROLE_ARN="qcs::cam::uin/xxx:roleName/yyy"
$ export TENCENTCLOUD_ASSUME_ROLE_SESSION_NAME="my-session-name"
$ export TENCENTCLOUD_ASSUME_ROLE_SESSION_DURATION=3600
$ tofu plan