Strimzi UI

This repository contains the Strimzi UI and its implementation. Strimzi UI provides a way for managing Strimzi and Kafka clusters (+ other components) deployed by it using a graphical user interface.

This UI is currently not in a state where it can be used. Is it still early on in it's development but we hope to have something usable very soon! If you're interested in what we're working on, please view our project board. If you're interested in contributing, please view our contribution guidelines.

Getting started

This UI uses npm to provide dependency management. If you wish to develop the UI, you will need:

• npm version 6.14.8 or later
• node 14.15.0 or later

Once these prerequisites are met, all required dependencies to build and run the UI can be downloaded by running the following command:

npm install

The Strimzi-UI can be developed while making use of TLS certificates between server and client, as would be the case in a typical production deployment. The openssl tool and configuration (used via the npm run addDevCerts command) can generate representative development time certificates for this purpose, given openssl is installed for your operating system. This is not required however to develop the UI.

If you run into any issues while working in this repo, please check out the troubleshooting guide.

Helpful commands

npm scripts are provided for common tasks. These include:

• npm run test - runs all tests for the client and server
• npm run start - runs the UI client and server in development mode
  • npm run addDevCerts - requires openssl, will generate certificates for development purposes for UI development
• npm run build - builds the UI
• npm run clean - deletes the build/generated content directories
• npm run lint - lints the codebase. See Linting for the individual linting steps
• npm run storybook - runs Storybook for the UI components.

Implementation documentation

Further details around how this UI is implemented can be found below:

• Architecture
• Build
• Linting
• Test
• Contribution
• Coding Standards

Troubleshooting

Currently there are no known issues.