Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2024-10-01 01:36:09 -04:00
Code Issues Packages Projects Releases Wiki Activity
2a59f2d464
constellation/docs/versioned_docs/version-2.8/reference/terraform.md
edgelessci f43366ed89
docs: add release v2.8.0 (#1884) 
* docs: add release v2.8.0
* docs: mention required AWS IAM permissions for upgrades

---------

Co-authored-by: malt3 <malt3@users.noreply.github.com>
Co-authored-by: Malte Poll <mp@edgeless.systems>
2023-06-07 10:34:07 +02:00

2.1 KiB
Raw Blame History

Terraform usage

Terraform is an Infrastructure as Code (IaC) framework to manage cloud resources. This page explains how Constellation uses it internally and how advanced users may manually use it to have more control over the resource creation.

:::info Information on this page is intended for users who are familiar with Terraform. It's not required for common usage of Constellation. See the Terraform documentation if you want to learn more about it. :::

Terraform state files

Constellation keeps Terraform state files in subdirectories of the workspace together with the corresponding Terraform configuration files and metadata. The subdirectories are created on the first Constellation CLI action that uses Terraform internally.

Currently, these subdirectories are:

  • constellation-terraform - Terraform state files for the resources of the Constellation cluster
  • constellation-iam-terraform - Terraform state files for IAM configuration

As with all commands, commands that work with these files (e.g., create, terminate, iam) have to be executed from the root of the cluster's workspace directory. You usually don't need and shouldn't manipulate or delete the subdirectories manually.

Interacting with Terraform manually

Manual interaction with Terraform state created by Constellation (i.e., via the Terraform CLI) should only be performed by experienced users. It may lead to unrecoverable loss of cloud resources. For the majority of users and use cases, the interaction done by the Constellation CLI is sufficient.

Terraform debugging

To debug Terraform issues, the Constellation CLI offers the tf-log flag. You can set it to any of Terraform's log levels:

  • JSON (JSON-formatted logs at TRACE level)
  • TRACE
  • DEBUG
  • INFO
  • WARN
  • ERROR

The log output is written to the terraform.log file in the workspace directory. The output is appended to the file on each run.