From e284ae5d9e05db6a140215ad02638527182d0f80 Mon Sep 17 00:00:00 2001 From: Patrick Decat Date: Mon, 9 Oct 2023 12:20:32 +0200 Subject: [PATCH] Clarify that tfwrapper does not create backend resources --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cd53e65f7..3c2ed10bc 100644 --- a/README.md +++ b/README.md @@ -407,10 +407,15 @@ Also, an isolation context is set to the local `.run/aure_` directo ### States centralization configuration -The `conf/state.yml` configuration file defines the configurations used to connect to state backend account. -It can be an AWS (S3) or Azure (Storage Account) backend type. +The `conf/state.yml` configuration file defines the configuration used to connect to state backends. -You can use other backends (e.g. Google GCS or Hashicorp Consul) not specifically supported by the wrapper if you them manage yourself and omit the `conf/state.yml` file or make it empty: +These backends can be of [AWS S3](https://developer.hashicorp.com/terraform/language/settings/backends/s3) and/or AzureRM types. + +The resources for these backends are not created by tfwrapper, and thus must exist beforehand: +* AWS: an S3 bucket (and optionally but highly recommended a DynamoDB table for locking). It is also recommended to enable versioning on the S3 bucket. +* Azure: a Blob storage account + +You can use other backends (e.g. Google GCS or Hashicorp Consul) not specifically supported by the wrapper, if you manage authentication yourself and omit the `conf/state.yml` file or make it empty: ```yaml ---