Тип бэкенда: 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