Skip to content

Commit

Permalink
chore: update README (#2)
Browse files Browse the repository at this point in the history
* chore: update README

* chore: empty changeset
  • Loading branch information
himeshladva authored Feb 16, 2024
1 parent 0e923aa commit b702dbb
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .changeset/beige-dryers-fetch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
12 changes: 11 additions & 1 deletion plugins/terraform-backend/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Terraform Backend Plugin for Backstage

This plugin is the backend api used by the terraform frontend plugin.

## Install

```shell
npm i @globallogicuki/plugin-terraform-backend
```

## Setup

To use the terraform backend, you will need to configure the following in your `app-config.yaml` file:

```yaml
Expand Down Expand Up @@ -42,4 +52,4 @@ After you start the backend (e.g. using yarn start-backend from the repo root),
curl localhost:7007/api/terraform/health
```

This should return {"status":"ok"}.
This should return `{"status":"ok"}`.
12 changes: 12 additions & 0 deletions plugins/terraform/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Terraform Frontend Plugin for Backstage

You can use this plugin to display a list of terraform runs for a specific workspace.

![](./docs/terraform-plugin-content.png)

## Install

```shell
npm i @globallogicuki/plugin-terraform
```

## Setup

This plugin is designed to work in its own tab within an entity. You will need to add the `<EntityTerraformContent />` component to the entity page in the frontend app.

There is a `isTerraformAvailable` helper function and a `<EntityTerraformCard />` component available should you wish to use this within an existing tab.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b702dbb

Please sign in to comment.