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.

• Node.js 18
• NPM 8

The same codebase is used to build images for Red Hat Advanced Cluster Management for Kubernetes (from release-* branches) and multicluster engine for Kubernetes (from backplane-* branches). The build system fast-forwards between branches to keep the content in sync. Pull requests should only be opened against the first branch in each line listed below. The arrow represents an automatic fast-forwarding of commits from one branch to the next.

main → release-2.8 → backplane-2.3
release-2.7 → backplane-2.2
release-2.6 → backplane-2.1
release-2.5
backplane-2.0 // cherry-pick from PRs against release-2.5
release-2.4

A number of the core NPM package dependencies are published from other repositories. To allow development of new features in these projects, branches are created each time a new release is started.

1. Clone repository

2. Install dependencies

   npm ci
   

3. 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.

4. 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)

See Dynamic Plugins - Development

See ARCHITECTURE.md

To develop with self signed certificates goto chrome://flags/and enable

• Allow invalid certificates for resources loaded from localhost.
• Insecure origins treated as secure.
  • http://localhost

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.

1. Frontend redirects to the backend /login endpoint.
2. Backend redirects to the cluster /authorize endpoint.
3. Cluster OAuth redirects back to the backend /login/callback endpoint.
4. Backend redirects to the frontend and sets the acm-access-token-cookie.

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:

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.

console is an add-on for the open-cluster-management community. For more information, visit: open-cluster-management.io