Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Iwona Langer <[email protected]>
  • Loading branch information
dbadura and IwonaLanger authored Sep 17, 2024
1 parent 42c4451 commit 246d10b
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 21 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Busola project contains additional sub-projects:

- [`Backend`](./backend) - A kind of a proxy between Busola and the Kubernetes cluster
- [`Tests`](./tests) - Acceptance, regression and integration tests
- [`Kyma`](./kyma) - Kyma specific configuration for busola
- [`Kyma`](./kyma) - Kyma specific configuration for Busola

## Prerequisites

Expand Down Expand Up @@ -86,10 +86,10 @@ Features comprise the following elements:

See the available Busola [feature flags](docs/features.md) for more information.

#### Environment specific settings
#### Environment-Specific Settings

You can provide override to the default configuration with your own environment specific settings.
Custom environment directory structure should look and be placed in **public/environments**.
You can provide an override to the default configuration with your own environment-specific settings.
Follow this pattern to structure your custom environment directory and place it in `public/environments`.

```
custom-env/
Expand All @@ -100,17 +100,18 @@ custom-env/
└── wizards.yaml
```

> **Important:** Files `extensions.yaml`, `statics.yaml`, `wizards.yaml` and `config.yaml` are required to make busola work properly.
> [!WARNING]
> The `extensions.yaml`, `statics.yaml`, `wizards.yaml`, and `config.yaml` files are necessary for Busola to work properly.
To activate environment configuration you have to create or edit `active.env` file located in [public](./public).
The `active.env` file should look like that:
To activate your environment configuration, create or edit the `active.env` file in the [public directory](./public).
Follow this example of the `active.env` file:

```dotenv
ENVIRONMENT=your-environment-name
```

When the `ENVIRONMENT` is set to `my-env`, the busola looks for custom configuration in **public/environemnt/my-env**
If the `ENVIRONMENT` is not set busola fetch default configuration which has the same structure as custom configuration located in [public](./public)
When **ENVIRONMENT** is set to `my-env`, Busola looks for your custom configuration in `public/environemnt/my-env`.
If **ENVIRONMENT** is not set, Busola fetches the default configuration with the same structure as the custom configuration located in the [public directory](./public).

In case of docker image, the file `active.env` is created from `ENVIRONMENT` env at the startup to image.

Expand Down
22 changes: 11 additions & 11 deletions kyma/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Kyma dashboard
# Kyma Dashboard

## Overview
The directory contains configuration of kyma extensibility for busola and tools to prepare configuration to build Kyma-dashboard using busola.
The directory contains the configuration of Kyma extensibility for Busola and tools to prepare the configuration for building Kyma dashboard using Busola.

Files structure:
```
Expand All @@ -27,17 +27,17 @@ Files structure:
3 directories, 12 files
```

The **environments** directory contains configuration per environment.
The environment configuration contains **config.yaml** for busola and **extensions.json**, **statics.json**, **wizards.json** with list of extensibility configuration.
The entries for extensibility can be **relative path to kyma** directory or **URL to extension yaml**.
The `environments` directory contains configuration per environment.
The environment configuration contains `config.yaml` for Busola and `extensions.json`, `statics.json`, and `wizards.json` with a list of extensibility configurations.
The entries for extensibility can be `relative path to Kyma directory` or `URL to extension yaml`.

The **extensions** directory contains general extensibility configuration to avoid duplication in each environment configuration dir.
The `extensions` directory contains a general extensibility configuration to avoid duplication in each environment configuration directory.

## Prerequisites

- [`npm`](https://www.npmjs.com/) in version 10.x
- [`node`](https://nodejs.org/en/) in version 20.x
- [`make`](https://www.gnu.org/software/make/)
- [Node.js](https://nodejs.org/en/) in version 20.x
- [Make](https://www.gnu.org/software/make/)

## Installation

Expand All @@ -47,10 +47,10 @@ npm clean-install

## Usage

To prepare final configuration for busola run:
To prepare the final configuration for Busola, run:
```bash
make prepare-all-configuration
```

This target fetches and copies configuration file to **temp** directory.
Then all the files are merged and moved to final **build** directory.
This target fetches and copies the configuration file to the `temp` directory.
Then, all the files are merged and moved to the final `build` directory.
2 changes: 1 addition & 1 deletion tests/kyma/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This project contains integration and smoke UI tests for Kyma-Dashboard.

Before testing, you need to copy your cluster's kubeconfig file to `fixtures/kubeconfig.yaml`.

You need to have run Kyma-Dashboard using docker, PR number and desired environment (can be empty):
First, run Kyma-Dashboard using Docker, PR number, and - optionally - your desired environment:

```bash
PR_NUMBER={YOUR_PR_NUMBER} ENV={DESIRED_ENV} npm run run-docker
Expand Down

0 comments on commit 246d10b

Please sign in to comment.