mirror of
https://github.com/edgelesssys/constellation.git
synced 2025-05-02 06:16:08 -04:00
Add package design goals to CLI package documentation
Signed-off-by: Daniel Weiße <dw@edgeless.systems>
This commit is contained in:
parent
946942ba68
commit
99c579b45a
10 changed files with 56 additions and 135 deletions
|
@ -5,12 +5,15 @@ SPDX-License-Identifier: AGPL-3.0-only
|
|||
*/
|
||||
|
||||
/*
|
||||
Package terraform handles creation/destruction of a Constellation cluster using Terraform.
|
||||
Package terraform handles creation/destruction of cloud and IAM resources required by Constellation using Terraform.
|
||||
|
||||
Since Terraform does not provide a stable Go API, we use the `terraform-exec` package to interact with Terraform.
|
||||
|
||||
The Terraform templates are located in the "terraform" subdirectory. The templates are embedded into the CLI binary using `go:embed`.
|
||||
On use the relevant template is extracted to the working directory and the user customized variables are written to a `terraform.tfvars` file.
|
||||
|
||||
Functions in this package should be kept CSP agnostic (there should be no "CreateAzureCluster" function),
|
||||
as loading the correct values and calling the correct functions for a given CSP is handled by the `cloudcmd` package.
|
||||
*/
|
||||
package terraform
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue