README.md

KubeRocketCI Portal

Central management tool in the the KubeRocketCI (aka EDP) ecosystem. Powered by Headlamp.

❗ Please refer to KubeRocketCI documentation to get the notion of the main concepts and guidelines.

Overview

KubeRocketCI Portal is built on the top of Headlamp. All the platform-specific functionality is written as Headlamp plugins.

overview.mp4

Installation

In order to install the KubeRocketCI Headlamp, follow the steps below:

1. To add the Helm EPAMEDP Charts for local client, run "helm repo add":

   helm repo add epamedp https://epam.github.io/edp-helm-charts/stable

2. Choose available Helm chart version:

   helm search repo epamedp/edp-headlamp -l

   Example response:

   NAME                             CHART VERSION APP VERSION     DESCRIPTION
   epamedp/edp-headlamp             0.15.0         0.15.0       A Helm chart for KubeRocketCI Headlamp

   NOTE: It is highly recommended to use the latest released version.

3. Full chart parameters available in deploy-templates/README.md.

4. Install edp-headlamp in the namespace with the helm command; find below the installation command example:

   helm install edp-headlamp epamedp/edp-headlamp --namespace <edp-project> --version <chart_version> --set name=edp-headlamp --set global.platform=<platform_type>

5. Check the namespace that should contain edp-headlamp deployment in a running status.

Local Development

Development versions are also available, please refer to the snapshot Helm Chart repository page.

Requirements

• NodeJS LTS v16.16.0 or higher.
• Headlamp Desktop App v0.10 or higher.
• KUBECONFIG environment variable is configured.

Start Local Development

• Run the npm run start command.
• Open the Headlamp desktop application.

Assets

For all assets please check the docs/assets folder.

Pipelines

Pipeline Overview

Pipeline Details

Pipeline Diagram

Marketplace

More content!

Components

Deployment Flows

Environment Monitoring

Headlamp Features

Application Create

Deployment Flow Create