Skip to content

Commit

Permalink
Updating ReadMe documentation for Backstage Terraform Integrations (#…
Browse files Browse the repository at this point in the history
…220)

Signed-off-by: Elamaran Shanmugam <[email protected]>
Co-authored-by: Nima Kaviani <[email protected]>
  • Loading branch information
elamaran11 and nimakaviani authored Apr 25, 2024
1 parent f5f3bd9 commit f883470
Showing 1 changed file with 9 additions and 8 deletions.
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.

0 comments on commit f883470

Please sign in to comment.