Terraform module to deploy a remote backend storage for Alibaba Cloud
terraform-alicloud-remote-backend
A terraform module to set up remote state management with OSS backend for your account. It creates an encrypted OSS bucket to store state files and a OTS table for state locking and consistency checking.
- Create a OSS bucket to store remote state files.
- Encrypt state files with AES256.
- Create a OTS Instance and table for state locking.
- Export the final oss-backend template named
terraform.tf.
You can use this in your terraform template with the following steps.
module "remote_state" {
source = "terraform-alicloud-modules/remote-backend/alicloud"
create_backend_bucket = true
create_ots_lock_instance = true
create_ots_lock_table = true
region = "cn-hangzhou"
state_name = "prod/terraform.tfstate"
encrypt_state = true
}Once the module has been created, you will get a OSS backend in the file terraform.tf as follows.
terraform {
backend "oss" {
bucket = "THE_NAME_OF_THE_STATE_BUCKET"
prefix = "env:"
key = "prod/terraform.tfstate"
acl = "private"
region = "cn-hangzhou"
encrypt = "true"
tablestore_endpoint = "https://tf-oss-backend.cn-hangzhou.ots.aliyuncs.com"
tablestore_table = "THE_NAME_OF_THE_LOCK_TABLE"
}
}
THE_NAME_OF_THE_STATE_BUCKET and THE_NAME_OF_THE_LOCK_TABLE prefix with terraform-remote-backend.
See the official document for more detail.
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| region | The region used to launch this module resources. | string | null |
no |
| create_ots_lock_instance | Boolean: If you have a ots table already, use that one, else make this true and one will be created. | bool | false |
no |
| backend_ots_lock_instance | The name of OTS instance to which table belongs. | string | "tf-oss-backend" |
no |
| create_ots_lock_table | Boolean: If you have a ots table already, use that one, else make this true and one will be created. | bool | false |
no |
| backend_ots_lock_table | OTS table to hold state lock when updating. If not set, the module will craete one with prefix terraform-remote-backend. |
string | "" | no |
| create_backend_bucket | Boolean. If you have a OSS bucket already, use that one, else make this true and one will be created. | bool | false |
no |
| backend_oss_bucket | Name of OSS bucket prepared to hold your terraform state(s). If not set, the module will craete one with prefix terraform-remote-backend. |
string | "" | no |
| state_acl | Canned ACL applied to bucket. | string | "private" |
no |
| encrypt_state | Boolean. Whether to encrypt terraform state. | object | true |
no |
| state_path | The path directory of the state file will be stored. Examples: dev/frontend, prod/db, etc.. | string | "env:" |
no |
| state_name | The name of the state file. Examples: dev/tf.state, dev/frontend/tf.tfstate, etc.. | string | "terraform.tfstate" |
no |
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent