Skip to content

Commit 00b16a3

Browse files
committed
📃 Add documentation for cloud credentials
1 parent 77ceba7 commit 00b16a3

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

prepare-labs/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,27 @@ You don't **have to** install the CLI tools of the cloud provider(s) that you wa
5959

6060
If you want to provide your cloud credentials through other means, you will have to adjust the Terraform configuration files in `terraform/provider-config` accordingly.
6161

62+
Here is where we look for credentials for each provider:
63+
64+
- AWS: Terraform defaults; see [AWS provider documentation][creds-aws] (for instance, you can use the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables, or AWS config and profile files)
65+
- Azure: Terraform defaults; see [AzureRM provider documentation][creds-azure] (typically, you can authenticate with the `az` CLI and Terraform will pick it up automatically)
66+
- Civo: CLI configuration file (`~/.civo.json`)
67+
- Digital Ocean: CLI configuration file (`~/.config/doctl/config.yaml`)
68+
- Exoscale: CLI configuration file (`~/.config/exoscale/exoscale.toml`)
69+
- Google Cloud: FIXME, note that the project name is currently hard-coded to `prepare-tf`
70+
- Hetzner: CLI configuration file (`~/.config/hcloud/cli.toml`)
71+
- Linode: CLI configuration file (`~/.config/linode-cli`)
72+
- OpenStack: you will need to write a tfvars file (check [that exemple](terraform/virtual-machines/tfvars.example))
73+
- Oracle: Terraform defaults; see [OCI provider documentation][creds-oci] (for instance, you can set up API keys; or you can use a short-lived token generated by the OCI CLI with `oci session authenticate`)
74+
- OVH: Terraform defaults; see [OVH provider documentation][creds-ovh] (this typically involves setting up 5 `OVH_...` environment variables)
75+
- Scaleway: Terraform defaults; see [Scaleway provider documentation][creds-scw] (for instance, you can set environment variables, but it will also automatically pick up CLI authentication from `~/.config/scw/config.yaml`)
76+
77+
[creds-aws]: https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication-and-configuration
78+
[creds-azure]: https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs#authenticating-to-azure
79+
[creds-oci]: https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/terraformproviderconfiguration.htm#authentication
80+
[creds-ovh]: https://registry.terraform.io/providers/ovh/ovh/latest/docs#provider-configuration
81+
[creds-scw]: https://registry.terraform.io/providers/scaleway/scaleway/latest/docs#authentication
82+
6283
## General Workflow
6384

6485
- fork/clone repo

0 commit comments

Comments
 (0)