The OpenShift Console, codenamed Bridge, is a web-based user interface that serves as a more accessible alternative to kubectl for managing OpenShift and Kubernetes clusters. Written primarily in TypeScript, it functions as a single-page web application that provides cluster administration capabilities through a graphical interface. The console integrates with multiple backend services including monitoring systems, chargeback services, and the Operator Lifecycle Manager, while also handling critical infrastructure tasks like proxying the Kubernetes API, managing user authentication, and serving frontend static assets.
The repository is classified across multiple domains reflecting its comprehensive scope: management, dashboard, cloud-native user interface, developer tools, web console, cluster administration, DevOps tools, and application deployment. It serves as both a management interface and an extension point for OpenShift functionality, supporting customization and operator integration alongside standard resource monitoring and application management capabilities.
Development of the console requires Node.js version 22 or higher with corepack enabled for Yarn Berry, Go 1.25 or later, and either the oc or kubectl command-line tools connected to an OpenShift or Kubernetes cluster. The project uses Go modules and maintains separate frontend and backend codebases, with frontend code located in the frontend directory using Node, Yarn, and Webpack to compile dependencies into dynamically loaded bundles. The backend binaries are output to a bin directory after compilation.
The console supports multiple deployment and development scenarios including local development without authentication using kubeadmin tokens, authenticated development environments with OAuth client registration, and integration with CodeReady Containers for local cluster testing. For native Kubernetes environments, the application can run with kubectl-based configuration. The development workflow includes comprehensive testing infrastructure with unit tests for both backend and frontend components, interactive development mode with hot reloading capabilities, and Cypress-based integration testing with support for both headless and UI-based test execution.
The project includes detailed developer documentation covering dependency installation, interactive development workflows, debugging procedures, and test execution across multiple testing frameworks. The console operator in OpenShift 4.x handles installation and management of the console as a cluster component. The repository maintains contribution guidelines in a CONTRIBUTING file and enforces coding standards through a STYLEGUIDE document, establishing clear expectations for developers working on the codebase.
