@stolostron/console
What is console?
The console provides the user interface for Red Hat Advanced Cluster Management (ACM) for Kubernetes and Red Hat MultiCluster Engine (MCE).
Go to the Contributing guide to learn how to get involved.
Prerequisites
- Node.js 14
- NPM 6
Running
-
Clone repository
-
Install dependencies
npm ci
-
Setup environment
You need:
- to be connected to a OpenShift 4.x.x cluster
- to have Advanced Cluster Management installed on the cluster
npm run setup
This will create a
.env
file in the backend directory containing environment variables. -
Start the development services
npm start
This will start the frontend and the backend in parallel. (It may take up to 30 seconds for the UI to appear)
Running as an OpenShift console plugin-in
See Dynamic Plugins - Development
Architecture
See ARCHITECTURE.md
Chrome
To develop with self signed certificates goto chrome://flags/
and enable
- Allow invalid certificates for resources loaded from localhost.
- Insecure origins treated as secure.
Authentication
Frontend has a cookie acm-access-token-cookie
that contains the user's token.
If the backend responds with a 401 Unauthorized
the frontend starts an OAuth flow to authorize with the cluster.
- Frontend redirects to the backend
/login
endpoint. - Backend redirects to the cluster
/authorize
endpoint. - Cluster OAuth redirects back to the backend
/login/callback
endpoint. - Backend redirects to the frontend and sets the
acm-access-token-cookie
.
Optional Features
In some cases there are development preview (Dev Preview) features or technical preview (Tech Preview) features that can optionally be enabled and used in the product. These features are enabled by updating the console-config
configmap in the installation namepsace (default: open-cluster-management
). The following features are available:
Single node OpenShift
Enabling this feature will allow the user to create a cluster that only contains a single control plane node. This option is only available for providers AWS, Azure, GCP, OpenStack and VMware when the OpenShift release image is version 4.8 or higher.
References
console
is an add-on for the open-cluster-management community. For more information, visit: open-cluster-management.io