Backstage Plugin: Terraform Environments

A Backstage plugin for managing ephemeral Terraform environments using GitHub Issues as metadata and GitHub Actions for lifecycle automation.

Features

• List, view, and destroy ephemeral environments managed by Terraform
• Integrates with GitHub Issues and Actions for environment metadata and automation
• Designed for use with Backstage

Installation

yarn add @your-org/backstage-plugin-terraform-environments
# or
npm install @your-org/backstage-plugin-terraform-environments

After installation, the plugin will automatically add the necessary export to your Backstage app's packages/app/src/plugins.ts file.

Configuration

1. Add a route in your app:

   In packages/app/src/App.tsx:

   import { TerraformEnvironmentsPage } from '@your-org/backstage-plugin-terraform-environments';
   
   // Inside your routes:
   <Route path="/terraform-environments" element={<TerraformEnvironmentsPage />} />

2. Configure GitHub Token:

   In your Backstage app-config.yaml:

   github:
     token: ${GITHUB_TOKEN}

   The token must have repo and workflow permissions for the target repository.

Usage

• Navigate to /terraform-environments in your Backstage app.
• View, manage, and destroy ephemeral environments.

Development

• Clone the repo and run:

  yarn install
  yarn build

Contributing

Contributions are welcome! Please open issues or pull requests.

License

Apache-2.0