Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating ReadMe documentation for Backstage Terraform Integrations #220

Merged
merged 4 commits into from
Apr 25, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions examples/terraform-integrations/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# Terraform Integrations for Backstage

This is an experimental effort allowing the users of the idpBuilder to run terraform modules using the tooling in place.
`idpBuilder` is now experimentally extensible to launch custom terraform patterns using package extensions. This is an experimental effort allowing the users of the `idpBuilder` to run terraform modules using the tooling in place.

This stack add-on goes together with the work done under [backstage-terraform-integrations](https://github.com/cnoe-io/backstage-terraform-integrations/).
Once the add-on is enabled, the user will need to follow the setup discussed in the [backstage-terraform-integrations](https://github.com/cnoe-io/backstage-terraform-integrations/) repo for the remainder of the configuration, and terraform integrations should work.
Please use the below command to deploy an IDP reference implementation with an Argo application for terraform integrations with few sample patterns we have built:

This add-on has a dependency to the [reference implementation][../ref-implementation/]. In order to enable the add-on with
idpBuilder run the following:

```
./idpbuilder create --use-path-routing --package-dir examples/ref-implementation --package-dir examples/terraform-integrations
```bash
idpbuilder create \
--use-path-routing \
--package-dir examples/ref-implementation \
--package-dir examples/terraform-integrations
```

As you see above, this add-on to `idpbuilder` has a dependency to the [reference implementation](../ref-implementation/). This stack add-on goes together with the work done under [backstage-terraform-integrations](https://github.com/cnoe-io/backstage-terraform-integrations/). Once the add-on is enabled, the user will need to follow the setup discussed in the [backstage-terraform-integrations](https://github.com/cnoe-io/backstage-terraform-integrations/) repo for the remainder of the configuration, and terraform integrations should work.
Loading