Komodor Backstage Plugin

A Backstage app with the Komodor plugin pre-installed for Kubernetes workload monitoring and insights.

This repository contains both the Komodor plugin and a working Backstage app instance for local development and testing.

Getting Started

To start the app:

yarn install
yarn start

Required Environment Variables

To successfully run the app, you’ll need to set the following environment variables:

Name	Description
K8S_CLUSTER_TOKEN	Kubernetes cluster service account token (Docs)
KOMODOR_API_KEY	Komodor API key for fetching workload data (Docs)

The variables are mostly used in the app-config.yaml file. Make sure their names matches between the environment and the file.

💡 Note: These values are required to connect to your Kubernetes cluster and fetch data from Komodor.

Komodor Frontend Plugin

The Komodor Frontend Plugin is located in the /plugins/komodor-frontend directory. This plugin integrates Komodor's data (workloads and health risks) into the Backstage instance, providing insights and visualizations directly within your Backstage environment.

How it Works

The plugin connects to your Kubernetes cluster and the Komodor API to fetch and display data related to the services (workloads) running in your Kubernetes environment. The integration allows users to view:

• Service health status
• Risk assessments
• Availability issues and more

You can find the full plugin code in the /plugins/komodor-frontend directory and make modifications if needed.

For more details, refer to the plugin’s source code and documentation within the Backstage instance.

Troubleshooting the Kubernetes Plugin

If you need to restore a working Kubernetes plugin environment:

1. Remove faulty plugin references, including:

   • Imports
   • Actual code
   • Entries in package.json

2. Then run the following commands:

# Clean reinstall
rm -rf node_modules
rm yarn.lock
yarn install

# Rebuild and restart
yarn build --no-cache
yarn start

About Komodor

Komodor provides continuous visibility and troubleshooting tools for Kubernetes workloads. This plugin integrates Komodor insights directly into Backstage, helping teams monitor workload health, risks, and investigations.

For more information, visit the Komodor website.