README.md

Busola

Overview

Busola is a web-based UI for managing resources within a Kubernetes cluster. It's based on the ReactJS library.

Subcomponents

The Busola project contains additional sub-projects:

• Backend - A proxy between Busola and the Kubernetes cluster
• Tests - Acceptance, regression, and integration tests
• Kyma - Kyma-specific configuration for Busola

Prerequisites

• npm in version 11.5.x

• node in version 22.x

Installation

To install dependencies for the root and backend projects, and to prepare symlinks for local libraries within this repository, run the following command:

npm install

To learn how to install the dashboard with Istio Ingress and install it in a Kyma cluster, see Deploying and Accessing Busola in the Kubernetes Cluster.

Usage

Run the npm start command.

Related Information

• For more information on the Busola configuration, see Configuration.
• For more information on using Busola for development, see Development.
• To learn how to run Busola in Docker, see Busola in Docker.
• To learn how to deploy and access Busola in the Kubernetes cluster, see Deploying and Accessing Busola in the Kubernetes Cluster.
• To learn how to deploy and access Busola in the k3d cluster, see Deploying and Accessing Busola in k3d.
• For more information on troubleshooting Busola, see Troubleshooting.

Contributing

See the Contributing Rules.

Code of Conduct

See the Code of Conduct document.

Licensing

See the license file.