mirror of
https://github.com/edgelesssys/constellation.git
synced 2024-12-13 18:04:20 -05:00
34bf3ad296
* terraform-provider: init Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * terraform-provider: add basic docgen Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * terraform-provider: fix build steps Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * terraform-provider: extend build process and docgen Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * dev-docs: document provider usage Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * bazel: upload aspect lib mirror Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * terraform-provider: don't try to create lockfiles Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * bazel: fix shellcheck issues * bazel: separate paths to check * terraform-provider: clean up old files * terraform-provider: update provider resource * terraform-provider: add image data source * dev-docs: remove unnecessary init * bazel: adhere to Terraform naming expectations * terraform-provider: fix expected data type * terraform-provider: generate docs * terraform-provider: improve errors * terraform-provider: add acceptance tests for data source * terraform-provider: fix dependencies * bazel: quote var reference * terraform-provider: make region optional * terraform-provider: bind imagefetcher to data source * bazel: tidy * terraform-provider: remove unused parameter * terraform-provider: remove unused parameter * terraform-provider: extend acceptance tests * terraform-provider: allow tests to be ran without Bazel * dev-docs: document testing * terraform-provider: set binary path accordingly * dev-docs: document docgen process for the provider * bazel: run acceptance test in writable environment * bazel: try to write to `$TMPDIR` * terraform-provider: style nits * terraform-provider: leave TODO * bazel: tidy * terraform-provider: regenerate docs * terraform-provider: fix comment --------- Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com>
50 lines
2.2 KiB
Markdown
50 lines
2.2 KiB
Markdown
# Constellation Terraform Provider
|
|
|
|
This document explains the basic ways of working with the [Constellation Terraform Provider](../../terraform-provider-constellation/).
|
|
|
|
## Building the Terraform Provider
|
|
|
|
The Constellation Terraform provider can be built through Bazel, either via the [`devbuild` target](./build-develop-deploy.md) (recommended), which will create a `terraform` directory
|
|
with the provider binary and some utility files in the current working directory, or explicitly via this command:
|
|
|
|
```bash
|
|
bazel build //terraform-provider-constellation:tf_provider
|
|
```
|
|
|
|
Documentation for the provider can be generated with:
|
|
|
|
```bash
|
|
bazel run //:generate
|
|
# or
|
|
bazel run //bazel/ci:terraform_docgen
|
|
```
|
|
|
|
## Using the Terraform Provider
|
|
|
|
The Terraform provider binary can be used with the normal Terraform CLI, 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. If using the [`devbuild` target](./build-develop-deploy.md), a `config.tfrc` file with the override set to the path
|
|
of the built binary is placed automatically in the `terraform` directory in the current working directory. Otherwise, the file can be also built and copied to the current working directory explicitly via this command:
|
|
|
|
```bash
|
|
bazel build //terraform-provider-constellation:terraform_rc
|
|
cp bazel-bin/terraform-provider-constellation/config.tfrc .
|
|
sed -i "s|@@TERRAFORM_PROVIDER_PATH@@|$(realpath bazel-bin/terraform-provider-constellation/tf_provider_/tf_provider)|g" config.tfrc
|
|
```
|
|
|
|
Afterwards, all Terraform commands that should use the local provider build should be prefixed with `TF_CLI_CONFIG_FILE=config.tfrc` like so:
|
|
|
|
```bash
|
|
TF_CLI_CONFIG_FILE=config.tfrc terraform apply
|
|
...
|
|
```
|
|
|
|
## Testing the Terraform Provider
|
|
|
|
Terraform acceptance tests can be run hermetically through Bazel (recommended):
|
|
|
|
```bash
|
|
bazel test //terraform-provider-constellation/internal/provider:provider_acc_test
|
|
```
|
|
|
|
The tests can also be run through Go, but the `TF_ACC` environment variable needs to be set to `1`, and the host's Terraform binary is used, which may produce inaccurate test results.
|