{"id":19057478,"url":"https://github.com/litmuschaos/backstage-plugin","last_synced_at":"2026-03-03T14:32:29.524Z","repository":{"id":186943733,"uuid":"675530777","full_name":"litmuschaos/backstage-plugin","owner":"litmuschaos","description":"Backstage plugin where you can find all the information you need to run chaos engineering on Litmus in one place","archived":false,"fork":false,"pushed_at":"2024-03-04T17:57:33.000Z","size":2372,"stargazers_count":3,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-13T22:20:37.925Z","etag":null,"topics":["backstage","backstage-plugin","chaos-engineering","litmus","litmuschaos"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/litmuschaos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-08-07T06:21:04.000Z","updated_at":"2024-05-14T17:50:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"5d905ee5-e24f-455a-b9ab-fbc1a4805f94","html_url":"https://github.com/litmuschaos/backstage-plugin","commit_stats":null,"previous_names":["litmuschaos/backstage-plugin"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/litmuschaos%2Fbackstage-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/litmuschaos%2Fbackstage-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/litmuschaos%2Fbackstage-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/litmuschaos%2Fbackstage-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/litmuschaos","download_url":"https://codeload.github.com/litmuschaos/backstage-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250567900,"owners_count":21451518,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backstage","backstage-plugin","chaos-engineering","litmus","litmuschaos"],"created_at":"2024-11-08T23:57:34.949Z","updated_at":"2026-03-03T14:32:24.500Z","avatar_url":"https://github.com/litmuschaos.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# backstage-plugin\n\n[![npm version](https://badge.fury.io/js/backstage-plugin-litmus.svg)](https://badge.fury.io/js/backstage-plugin-litmus)\n\n## Features\n\n### EntityLitmusCard\n\n![EntityLitmusCard](./docs/EntityLitmusCard.png)\n\n### EntityLitmusContent\n\n![EntityLitmusContent](./docs/EntityLitmusContent.png)\n\n## Before you begin\n\n- Compatible only with Litmus version [3.0.0](https://github.com/litmuschaos/litmus/releases/tag/3.0.0) or later.\n- Please visit our [documentation site](https://docs.litmuschaos.io/docs/integrations/backstage) to get a detailed guide.\n\n## Getting started\n\n1. In the `./packages/app` project add the plugin.\n\n   ```yaml\n   yarn add backstage-plugin-litmus\n   ```\n\n2. Get Litmus API Token through the Litmus UI\n\n   1. Click \"SETTINGS\" in the sidebar.\n   2. Click \"+ New Token\" Button in the 'API Tokens' section.\n      ![settings_tab](./docs/settings_tab.png)\n   3. Enter your information and click \"Confirm\".\n      ![create_dialog](./docs/create_dialog.png)\n   4. Get the token in the \"VALUE\" column.\n\n3. In the `app-config.yaml` file root directory, add litmus proxy and info like below\n   ```yaml\n   proxy:\n     '/litmus':\n       target: 'your-own-litmus-ui-url'\n       changeOrigin: true\n       headers:\n         Authorization: 'Bearer ${LITMUS_AUTH_TOKEN}'\n   litmus:\n     baseUrl: 'your-own-litmus-ui-url'\n     apiToken: ${LITMUS_AUTH_TOKEN}\n   ```\n4. Add your auth key to the environmental variables\n   ```shell\n   export LITMUS_AUTH_TOKEN=\"your-own-token\"\n   ```\n5. Adding annotations and values to your component file.\n   ```yaml\n   apiVersion: backstage.io/v1alpha1\n   kind: Component\n   metadata:\n     name: component-name\n     description: 'description'\n     annotations:\n       litmuschaos.io/project-id: 'your-own-project-id'\n   ```\n6. Enabling frontend\n\n   ```ts\n   // packages/app/src/components/catalog/EntityPage.tsx\n   import {\n     isLitmusAvailable,\n     EntityLitmusCard,\n     EntityLitmusContent,\n   } from 'backstage-plugin-litmus';\n   // ...\n   const overviewContent = (\n     \u003cGrid container spacing={6} alignItems=\"stretch\"\u003e\n       // ...\n       \u003cEntitySwitch\u003e\n         \u003cEntitySwitch.Case if={isLitmusAvailable}\u003e\n           \u003cGrid item md={4} xs={12}\u003e\n             \u003cEntityLitmusCard /\u003e\n           \u003c/Grid\u003e\n         \u003c/EntitySwitch.Case\u003e\n       \u003c/EntitySwitch\u003e\n       // ...\n     \u003c/Grid\u003e\n   );\n   // ...\n   const serviceEntityPage = (\n     \u003cEntityLayout\u003e\n       // ...\n       \u003cEntityLayout.Route path=\"/litmus\" title=\"Litmus\"\u003e\n         \u003cEntityLitmusContent /\u003e\n       \u003c/EntityLayout.Route\u003e\n       // ...\n     \u003c/EntityLayout\u003e\n   );\n   ```\n\n---\n\n\u003e This plugin is based on [proposal documentation](https://docs.google.com/document/d/1_ePJ36DwFrhFPhcxhxXX__yiNzW1KDL83L2lfF8oIcA/edit?usp=sharing)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flitmuschaos%2Fbackstage-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flitmuschaos%2Fbackstage-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flitmuschaos%2Fbackstage-plugin/lists"}