Skip to content

Commit

Permalink
docs(backend): update remote state backend for terraform v1.6.3 (Flex…
Browse files Browse the repository at this point in the history
  • Loading branch information
ShiChangkuo authored Dec 24, 2023
1 parent 64629d1 commit b84ee84
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 4 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@ Terraform FlexibleEngine Provider

<!-- markdownlint-disable-next-line MD034 -->
- Website: https://www.terraform.io
- [![Documentation](https://img.shields.io/badge/documentation-blue)](https://registry.terraform.io/providers/FlexibleEngineCloud/flexibleengine/latest/docs)
- [![Gitter chat](https://badges.gitter.im/hashicorp-terraform/Lobby.png)](https://gitter.im/hashicorp-terraform/Lobby)
- Mailing list: [Google Groups](http://groups.google.com/group/terraform-tool)

<!-- markdownlint-disable-next-line MD033 -->
<img src="https://cdn.rawgit.com/hashicorp/terraform-website/master/content/source/assets/images/logo-hashicorp.svg" width="600px">

Quick Start
-----------

Expand Down
37 changes: 36 additions & 1 deletion docs/guides/remote-state-backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ export AWS_SECRET_ACCESS_KEY="your secretkey"

The backend configuration as follows:

* The following example should be applied when using Terraform version before **v1.6.0**:

```hcl
terraform {
backend "s3" {
Expand All @@ -62,6 +64,27 @@ terraform {
}
```

* The following example should be applied when using Terraform version after **v1.6.3**:

```hcl
terraform {
backend "s3" {
bucket = "terraformbucket"
key = "terraform.tfstate"
region = "eu-west-0"
endpoints = {
s3 = "https://oss.eu-west-0.prod-cloud-ocb.orange-business.com"
}
skip_region_validation = true
skip_credentials_validation = true
skip_metadata_api_check = true
skip_requesting_account_id = true
skip_s3_checksum = true
}
}
```

### Argument Reference

The following arguments are supported:
Expand All @@ -83,16 +106,28 @@ The following arguments are supported:
* `region` - (Required) Specifies the region where the bucket is located. This can also be sourced from the
*AWS_DEFAULT_REGION* and *AWS_REGION* environment variables.

* `endpoint` - (Required) Specifies the endpoint for FlexibleEngine OSS.
* `endpoint` - (**Required before v1.6.0**) Specifies the endpoint for FlexibleEngine OSS.
The value is `https://oss.{{region}}.prod-cloud-ocb.orange-business.com`.
This can also be sourced from the *AWS_S3_ENDPOINT* environment variable.
Use `endpoints.s3` instead when using Terraform version after **v1.6.3**.

* `endpoints.s3` - (**Required after v1.6.3**) Specifies the endpoint for FlexibleEngine OSS.
The value is `https://oss.{{region}}.prod-cloud-ocb.orange-business.com`.
This can also be sourced from the environment variable *AWS_ENDPOINT_URL_S3* or the deprecated environment variable
*AWS_S3_ENDPOINT*.

* `skip_credentials_validation` - (Required) Skip credentials validation via the STS API. It's mandatory for FlexibleEngine.

* `skip_region_validation` - (Required) Skip validation of provided region name. It's mandatory for FlexibleEngine.

* `skip_metadata_api_check` - (Required) Skip usage of EC2 Metadata API. It's mandatory for FlexibleEngine.

* `skip_requesting_account_id` - (Optional) Skip requesting the account ID. It's mandatory for FlexibleEngine and
**only available** when using Terraform version after **v1.6.3**.

* `skip_s3_checksum` - (Optional) Do not include checksum when uploading S3 Objects. It's mandatory for FlexibleEngine and
**only available** when using Terraform version after **v1.6.3**.

* `workspace_key_prefix` - (Optional) Specifies the prefix applied to the state path inside the bucket.
This is only relevant when using a non-default workspace.

Expand Down

0 comments on commit b84ee84

Please sign in to comment.