https://github.com/tomarv2/tfremote
Terraform wrapper to manage state across multiple cloud providers(AWS, GCP, and Azure)
https://github.com/tomarv2/tfremote
aws azure gcloud python python3 terraform terraform-scripts
Last synced: 9 months ago
JSON representation
Terraform wrapper to manage state across multiple cloud providers(AWS, GCP, and Azure)
- Host: GitHub
- URL: https://github.com/tomarv2/tfremote
- Owner: tomarv2
- License: apache-2.0
- Created: 2020-05-01T20:49:55.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T21:32:30.000Z (over 1 year ago)
- Last Synced: 2025-03-03T22:09:39.444Z (10 months ago)
- Topics: aws, azure, gcloud, python, python3, terraform, terraform-scripts
- Language: Python
- Homepage:
- Size: 1.97 MB
- Stars: 5
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Terraform Remote State Manager([tfremote](https://pypi.org/project/tfremote/))
**tf** is a python package for managing terraform remote state for: Google(Gcloud), AWS, and Azure.
It sets a defined structure for all cloud providers by removing the overheard of configuring and managing the path in storage buckets.
It works with:
:point_right: Google Storage Bucket
:point_right: AWS S3
:point_right: Azure Storage
> ❗️ **Note** Best practice is to make sure buckets are versioned.
## Install package
```
pip install tfremote --upgrade
```
## Environment setup
- Install Python 3.6+
- Using virtualenv is strongly recommended:
```
python3 -m venv
```
- Terraform 0.14.0 and above (download: https://www.terraform.io/downloads.html)
Default log level is `WARNING`, to change:
`export TF_LOG_LEVEL` to any of these: `'CRITICAL', 'ERROR', 'WARNING', 'INFO', 'DEBUG'`
> ❗️ **Important** - Two variables are required for using `tf` package (used set creat path in remote storage):
>
> - teamid
> - prjid
>
> Required variables can be defined using:
>
> - As `inline variables` e.g.: `-var='teamid=demo-team' -var='prjid=demo-project'`
> - Inside `.tfvars` file e.g.: `-var-file= `
>
> Two optional variables:
>
> `workspace` and `state_key` can be defined using:
>
> - `-w=`. If no workspace is provided `default` workspace is used.
>
> - `s=`. If no key is provided `terraform` is used.
>
> Path created in S3 backend: `////.tfstate`
>
> For more information refer to [Terraform documentation](https://www.terraform.io/docs/language/values/variables.html)
## Setup environment variables
### Workspace list file location `TF_WORKSPACE_FILE_LOCATION`
```
export TF_WORKSPACE_FILE_LOCATION=
```
Reference file: [link](scripts/workspaces.yml)
### AWS
> ❗️ **Important** - s3 bucket for remote state should reside in `us-west-2`
Set these env variables:
```
export TF_AWS_BUCKET=
export TF_AWS_BUCKET_REGION=us-west-2
```
One of below environment variable is required:
```
export TF_AWS_PROFILE=
```
or
```
export AWS_ACCESS_KEY_ID=
export AWS_SECRET_ACCESS_KEY=
```
### Azure
To create storage for remote state there is handy script.
Run `scripts/remote_state.sh` (fill in the required information)
Set below env variables:
```
export TF_AZURE_STORAGE_ACCOUNT=
export TF_AZURE_CONTAINER=
export ARM_ACCESS_KEY=
```
### GCP(gcloud)
https://cloud.google.com/community/tutorials/managing-gcp-projects-with-terraform
Set below env variables:
```
export TF_GCLOUD_BUCKET=
export TF_GCLOUD_CREDENTIALS=json credentials file path>
```
## Usage
### For GCP(gcloud):
```
tf plan -c=gcloud -var=teamid=demo-team -var=prjid=demo-app -w=demo-workspace
```
The structure in Google Storage Bucket:
### For AWS:
```
tf plan -c=aws -var=teamid=demo-team -var=prjid=demo-app -w=demo-workspace
```
The structure in AWS S3:
If you need to specify `state_key` in S3, specify `-s=tryme-key`
### For Azure:
```
tf plan -c=azure -var=teamid=demo-team -var=prjid=demo-app -w=demo-workspace
```
The structure in Azure Storage:
### For more available options:
```
tf --help
usage: tf [-h] [-var] [-var-file] [-c] [-w] [-wp] [-s] [-no-color] [-json] [-out] [-f] [-nf] [-v]
Terraform remote state wrapper package
--------------------------------------
Usage: Set below env variables to begin (more information: https://github.com/tomarv2/tfremote):
TF_WORKSPACE_FILE_LOCATION
aws: TF_AWS_BUCKET, TF_AWS_BUCKET_REGION=us-west-2, TF_AWS_PROFILE or AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
azure: TF_AZURE_STORAGE_ACCOUNT, TF_AZURE_CONTAINER, ARM_ACCESS_KEY
gcloud: TF_GCLOUD_BUCKET, TF_GCLOUD_CREDENTIALS
optional arguments:
-h, --help show this help message and exit
-var Set Terraform configuration variable. This flag can be set multiple times
-var-file Set Terraform configuration variables from a file. This flag can be set multiple times
-c Specify cloud provider (default: 'aws'). Supported values: gcloud, aws, or azure
-w Specify existing workspace name(default: 'default')
-wp Overwrite workspace directory path structure
-s File name in remote state (default: 'terraform.tfstate')
-no-color Disables terminal formatting sequences in the output
-json Enables the machine readable JSON UI output
-out Writes the generated plan to the given filename in an opaque file format
-f Enable FIPS endpoints (default: True)
-nf Disable FIPS endpoints
-v show program's version number and exit
```