From aa01ebc0770fe5ce49f5cb0dd23756db3f667c5a Mon Sep 17 00:00:00 2001 From: Adrian Stobbe Date: Fri, 15 Dec 2023 13:22:51 +0100 Subject: [PATCH] doc nits tf provider --- dev-docs/workflows/terraform-provider.md | 6 ++++++ docs/docs/workflows/terraform-provider.md | 16 ++++++++++++---- internal/constellation/helm/actionfactory.go | 4 ++-- 3 files changed, 20 insertions(+), 6 deletions(-) diff --git a/dev-docs/workflows/terraform-provider.md b/dev-docs/workflows/terraform-provider.md index b27d509c5..920a73184 100644 --- a/dev-docs/workflows/terraform-provider.md +++ b/dev-docs/workflows/terraform-provider.md @@ -36,6 +36,12 @@ terraform { } ``` +Make sure to add the devbuild version number (without v prefix) as ``. Alternatively, check the available versions here: + +```bash +ls ~/.terraform.d/plugins/registry.terraform.io/edgelesssys/constellation +``` + Alternatively, you can configure Terraform to use your binary by setting a [development override](https://developer.hashicorp.com/terraform/cli/config/config-file#development-overrides-for-provider-developers), so that the registry path to the provider is replaced with the path to the locally built provider. A `config.tfrc` file containing the necessary configuration can be created with the following commands: diff --git a/docs/docs/workflows/terraform-provider.md b/docs/docs/workflows/terraform-provider.md index 9019c436b..5c3c02376 100644 --- a/docs/docs/workflows/terraform-provider.md +++ b/docs/docs/workflows/terraform-provider.md @@ -99,7 +99,15 @@ The steps for applying the upgrade are as follows: - For [local paths as module sources](https://developer.hashicorp.com/terraform/language/modules/sources#local-paths) or when [providing your own infrastructure](#bringing-your-own-infrastructure), see the changes made in the reference modules since the upgrade's origin version and adjust your infrastructure / IAM configuration accordingly. 4. Upgrade the Terraform module and provider dependencies and apply the targeted configuration. -```bash - terraform init -upgrade - terraform apply -``` + ```bash + terraform init -upgrade + TF_LOG=INFO terraform apply + ``` + + While verbose when creating all resources together, we recommend to enable logging to get output during the cluster resource creation. + +5. Connect to the cluster + + ```bash + terraform output -raw kubeconfig > "$(pwd)/constellation-admin.conf" + ``` diff --git a/internal/constellation/helm/actionfactory.go b/internal/constellation/helm/actionfactory.go index 1ad3366b7..74bd551e7 100644 --- a/internal/constellation/helm/actionfactory.go +++ b/internal/constellation/helm/actionfactory.go @@ -86,7 +86,7 @@ func (a actionFactory) appendNewAction( return compatibility.NewInvalidUpgradeError( currentVersion.String(), configTargetVersion.String(), - fmt.Errorf("this CLI only supports installing microservice version %s", newVersion), + fmt.Errorf("this Constellation version only supports installing microservice version %s", newVersion), ) } @@ -114,7 +114,7 @@ func (a actionFactory) appendNewAction( return compatibility.NewInvalidUpgradeError( currentVersion.String(), configTargetVersion.String(), - fmt.Errorf("this CLI only supports upgrading to microservice version %s", newVersion), + fmt.Errorf("this Constellation version only supports upgrading to microservice version %s", newVersion), ) } } else {