quickstarts,examples: expose cluster_region and clarify #231
Conversation
The AWS quickstart shows how to configure the `AWS_DEFAULT_REGION` environment variable without explaining that this only applies to the lokoctl S3 backend. Also, the current examples don't expose the cluster region so a user might expect `AWS_DEFAULT_REGION` to change the region where the cluster is deployed. This clarifies what `AWS_DEFAULT_REGION` configures in the quickstart and exposes a new `cluster_region` parameter in the example AWS configurations.
Does having the region be picked up as an env variable make sense? I'd think this should be a cluster configuration (hopefully in git) and not an env variable. |
For me, it seems confusing, that environment variable is only used for S3 storage and not for the cluster. Either we should ask for it explicitly, or pick the default value consistently to avoid "surprising" behavior. |
|
aws Terraform provider does pick up |
| @@ -70,7 +70,7 @@ or | |||
| ```console | |||
| export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE | |||
| export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY | |||
| export AWS_DEFAULT_REGION=us-east-1 | |||
| export AWS_DEFAULT_REGION=us-east-1 # This region will be used by the lokoctl S3 backend only | |||
There was a problem hiding this comment.
Could we please avoid the future tense here?
"This region is used by..."
| @@ -13,6 +13,10 @@ variable "cluster_name" { | |||
| default = "lokomotive-cluster" | |||
| } | |||
|
|
|||
| variable "cluster_region" { | |||
There was a problem hiding this comment.
this variable is only used for S3 bucket location?
There was a problem hiding this comment.
This variable configures the region where the cluster is deployed.
The AWS_DEFAULT_REGION env variable is only used for the S3 bucket location in current Lokomotive.
The AWS quickstart shows how to configure the
AWS_DEFAULT_REGIONenvironment variable without explaining that this only applies to the
lokoctl S3 backend.
Also, the current examples don't expose the cluster region so a user
might expect
AWS_DEFAULT_REGIONto change the region where the clusteris deployed.
This clarifies what
AWS_DEFAULT_REGIONconfigures in the quickstartand exposes a new
cluster_regionparameter in the example AWSconfigurations.