https://github.com/litmuschaos/backstage-plugin

Backstage plugin where you can find all the information you need to run chaos engineering on Litmus in one place
https://github.com/litmuschaos/backstage-plugin

backstage backstage-plugin chaos-engineering litmus litmuschaos

Last synced: about 1 month ago
JSON representation

Backstage plugin where you can find all the information you need to run chaos engineering on Litmus in one place

• Host: GitHub
• URL: https://github.com/litmuschaos/backstage-plugin
• Owner: litmuschaos
• License: apache-2.0
• Created: 2023-08-07T06:21:04.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-03-04T17:57:33.000Z (10 months ago)
• Last Synced: 2024-10-07T19:08:19.807Z (3 months ago)
• Topics: backstage, backstage-plugin, chaos-engineering, litmus, litmuschaos
• Language: TypeScript
• Homepage:
• Size: 2.26 MB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# backstage-plugin

[![npm version](https://badge.fury.io/js/backstage-plugin-litmus.svg)](https://badge.fury.io/js/backstage-plugin-litmus)

## Features

### EntityLitmusCard

![EntityLitmusCard](./docs/EntityLitmusCard.png)

### EntityLitmusContent

![EntityLitmusContent](./docs/EntityLitmusContent.png)

## Before you begin

- Compatible only with Litmus version [3.0.0](https://github.com/litmuschaos/litmus/releases/tag/3.0.0) or later.

- Please visit our [documentation site](https://docs.litmuschaos.io/docs/integrations/backstage) to get a detailed guide.

## Getting started

1. In the `./packages/app` project add the plugin.

   ```yaml

   yarn add backstage-plugin-litmus

   ```

2. Get Litmus API Token through the Litmus UI

   1. Click "SETTINGS" in the sidebar.

   2. Click "+ New Token" Button in the 'API Tokens' section.

      ![settings_tab](./docs/settings_tab.png)

   3. Enter your information and click "Confirm".

      ![create_dialog](./docs/create_dialog.png)

   4. Get the token in the "VALUE" column.

3. In the `app-config.yaml` file root directory, add litmus proxy and info like below

   ```yaml

   proxy:

     '/litmus':

       target: 'your-own-litmus-ui-url'

       changeOrigin: true

       headers:

         Authorization: 'Bearer ${LITMUS_AUTH_TOKEN}'

   litmus:

     baseUrl: 'your-own-litmus-ui-url'

     apiToken: ${LITMUS_AUTH_TOKEN}

   ```

4. Add your auth key to the environmental variables

   ```shell

   export LITMUS_AUTH_TOKEN="your-own-token"

   ```

5. Adding annotations and values to your component file.

   ```yaml

   apiVersion: backstage.io/v1alpha1

   kind: Component

   metadata:

     name: component-name

     description: 'description'

     annotations:

       litmuschaos.io/project-id: 'your-own-project-id'

   ```

6. Enabling frontend

   ```ts

   // packages/app/src/components/catalog/EntityPage.tsx

   import {

     isLitmusAvailable,

     EntityLitmusCard,

     EntityLitmusContent,

   } from 'backstage-plugin-litmus';

   // ...

   const overviewContent = (

     

       // ...

       

         

           

             

           

         

       

       // ...

     

   );

   // ...

   const serviceEntityPage = (

     

       // ...

       

         

       

       // ...

     

   );

   ```

---

> This plugin is based on [proposal documentation](https://docs.google.com/document/d/1_ePJ36DwFrhFPhcxhxXX__yiNzW1KDL83L2lfF8oIcA/edit?usp=sharing)