Skip to main content
Redhat Developers  Logo
  • Products

    Platforms

    • Red Hat Enterprise Linux
      Red Hat Enterprise Linux Icon
    • Red Hat AI
      Red Hat AI
    • Red Hat OpenShift
      Openshift icon
    • Red Hat Ansible Automation Platform
      Ansible icon
    • View All Red Hat Products

    Featured

    • Red Hat build of OpenJDK
    • Red Hat Developer Hub
    • Red Hat JBoss Enterprise Application Platform
    • Red Hat OpenShift Dev Spaces
    • Red Hat OpenShift Local
    • Red Hat Developer Sandbox

      Try Red Hat products and technologies without setup or configuration fees for 30 days with this shared Openshift and Kubernetes cluster.
    • Try at no cost
  • Technologies

    Featured

    • AI/ML
      AI/ML Icon
    • Linux
      Linux Icon
    • Kubernetes
      Cloud icon
    • Automation
      Automation Icon showing arrows moving in a circle around a gear
    • View All Technologies
    • Programming Languages & Frameworks

      • Java
      • Python
      • JavaScript
    • System Design & Architecture

      • Red Hat architecture and design patterns
      • Microservices
      • Event-Driven Architecture
      • Databases
    • Developer Productivity

      • Developer productivity
      • Developer Tools
      • GitOps
    • Automated Data Processing

      • AI/ML
      • Data Science
      • Apache Kafka on Kubernetes
    • Platform Engineering

      • DevOps
      • DevSecOps
      • Ansible automation for applications and services
    • Secure Development & Architectures

      • Security
      • Secure coding
  • Learn

    Featured

    • Kubernetes & Cloud Native
      Openshift icon
    • Linux
      Rhel icon
    • Automation
      Ansible cloud icon
    • AI/ML
      AI/ML Icon
    • View All Learning Resources

    E-Books

    • GitOps Cookbook
    • Podman in Action
    • Kubernetes Operators
    • The Path to GitOps
    • View All E-books

    Cheat Sheets

    • Linux Commands
    • Bash Commands
    • Git
    • systemd Commands
    • View All Cheat Sheets

    Documentation

    • Product Documentation
    • API Catalog
    • Legacy Documentation
  • Developer Sandbox

    Developer Sandbox

    • Access Red Hat’s products and technologies without setup or configuration, and start developing quicker than ever before with our new, no-cost sandbox environments.
    • Explore Developer Sandbox

    Featured Developer Sandbox activities

    • Get started with your Developer Sandbox
    • OpenShift virtualization and application modernization using the Developer Sandbox
    • Explore all Developer Sandbox activities

    Ready to start developing apps?

    • Try at no cost
  • Blog
  • Events
  • Videos

How to develop and deploy OpenShift console dynamic plugin

June 29, 2023
Ajay Pratap
Related topics:
ContainersHelmKubernetes
Related products:
Red Hat QuayRed Hat OpenShift

Share:

    Dynamic plugins allow you to extend the Red Hat OpenShift UI at runtime, adding custom pages and other extensions. They are based on the webpack module federation. Plugins are registered with the console using the ConsolePlugin custom resource and enabled in the console operator config by a cluster administrator.

    Prerequisites

    • Node.js
    • yarn
    • Docker or podman 3.2.0+
    • oc

    Getting started

    To clone console plugin template repo, you should update the plugin metadata, such as the plugin name in the ConsolePlugin declaration of package.json.

    "consolePlugin": {
      "name": "plugin-name",
      "version": "0.0.1",
      "displayName": "Dynamic Plugin",
      "description": "OpenShift console dynamic plugin",
      "exposedModules": {
        "ExamplePage": "./components/ExamplePage"
      },
      "dependencies": {
        "@console/pluginAPI": "*"
      }
    }

    The template adds a single example page in the home navigation section. The extension is in the console-extensions.json file and the react component is declared in: src/components/ExamplePage.tsx.

    You can run the plugin using a local development environment or build an image to deploy it to a cluster.

    There are two ways for development.

    Development option 1: Local

    In the terminal window, run the following commands:

    • yarn install
    • yarn run start

    In another terminal window, run these commands:

    • oc login (requires oc and an OpenShift cluster)
    • yarn run start-console (requires Docker or Podman 3.2.0+)

    This will run the OpenShift console in a container connected to the cluster you logged into. The plugin HTTP server runs on port 9001 with CORS enabled. Navigate to http://localhost:9000/example to see the running plugin.

    Running start-console with Apple silicon and Podman

    If you are using podman on a Mac with Apple silicon, yarn run start-console might fail since it runs an amd64 image. You can workaround the problem with qemu-user-static by running these commands:

    podman machine ssh
    sudo -i
    rpm-ostree install qemu-user-static
    systemctl reboot

    Note: If you are facing issues related to tls while oc loggedIn, skip tls by adding below flag --insecure-skip-tls-verify=true with oc loggedIn command.

    oc login -u kubeadmin -p <password> --insecure-skip-tls-verify=true

    Development option 2: Docker and VSCode remote containers

    Make sure the remote containers extension is installed. This method uses Docker Compose where one container is the OpenShift console and the second container is the plugin. It requires that you have access to an existing OpenShift cluster. After the initial build, the cached containers will help you start developing in seconds.

    • Create a dev.env file inside the .devcontainer folder with the correct values for your cluster:
    OC_PLUGIN_NAME=my-plugin
    OC_URL=https://api.example.com:6443
    OC_USER=kubeadmin
    OC_PASS=<password>
    • (Ctrl+Shift+P) => Remote Containers: Open Folder in Container...
    • yarn run start
    • Navigate to: http://localhost:9000/example

    Build the docker image

    You can deploy your plugin on a cluster. You must build an image and push it to an image registry. Create an account for Red Hat Quay.io.

    • Build the image:

    docker build -t quay.io/my-repositroy/my-plugin:latest.

    • Run the image:

    docker run -it --rm -d -p 9001:80 quay.io/my-repository/my-plugin:latest

    • Push the image:

    docker push quay.io/my-repository/my-plugin:latest

    Note: If you have a Mac with Apple silicon, you will need to add the flag --platform=linux/amd64 when building the image to target the correct platform to run in-cluster.

    Deployment on the cluster

    Download the yaml template file and update plugin name PLUGIN_NAME , namespace NAMESPACE, docker image IMAGE etc.

    You can deploy the plugin to a cluster by applying template.yaml.

    oc apply -f template.yaml

    Once deployed, patch the console operator config to enable the plugin.

    oc patch consoles.operator.openshift.io cluster --patch '{ "spec": { "plugins": ["plugin-name"] } }' --type=merge

    Deployment by Helm chart

    A Helm chart is available to deploy the plugin to an OpenShift environment.

    The following Helm parameters are required:

    plugin.image: The location of the image containing the plugin that was previously pushed.

    Additional parameters can be specified if desired. Consult the chart values file for the full set of supported parameters.

    Installing the Helm chart

    Install the chart using the name of the plugin as the Helm release name into a new namespace or an existing namespace as specified by the my-plugin-namespace parameter and providing the location of the image within the plugin.image parameter by using the following command:

    helm upgrade -i  my-plugin charts/openshift-console-plugin -n my-plugin-namespace --create-namespace --set plugin.image=my-plugin-image-location

    Note: When deploying on OpenShift 4.10, it is recommended to add the parameter --set plugin.securityContext.enabled=false which will omit configurations related to pod security.

    Learn more about the OpenShift console plugin

    This article guided you through getting started in the dynamic plugin for Red Hat OpenShift. For more information, refer to the Console Plugin SDK README and ActiveMQ Artemis Self Provisioning Plugin.

    Last updated: September 19, 2023

    Related Posts

    • CDK 3: Build your first application using the OpenShift Console

    • What's new in Red Hat OpenShift 4.13

    • How to use the new OpenShift quick starts to deploy JBoss EAP

    • Advanced Helm support in the OpenShift 4.5 web console

    • OpenShift 4.13: Create serverless functions and more

    Recent Posts

    • What qualifies for Red Hat Developer Subscription for Teams?

    • How to run OpenAI's gpt-oss models locally with RamaLama

    • Using DNS over TLS in OpenShift to secure communications

    • Scaling DeepSeek and Sparse MoE models in vLLM with llm-d

    • Multicluster authentication with Ansible Automation Platform

    What’s up next?

    OpenShift For Developers Tile Card

    Creating and packaging your applications for deployment on modern distributed systems can be daunting. OpenShift for Developers is a practical guide that shows how to build, deploy, and manage a multitiered application on Red Hat OpenShift.

    Get the e-book
    Red Hat Developers logo LinkedIn YouTube Twitter Facebook

    Products

    • Red Hat Enterprise Linux
    • Red Hat OpenShift
    • Red Hat Ansible Automation Platform

    Build

    • Developer Sandbox
    • Developer Tools
    • Interactive Tutorials
    • API Catalog

    Quicklinks

    • Learning Resources
    • E-books
    • Cheat Sheets
    • Blog
    • Events
    • Newsletter

    Communicate

    • About us
    • Contact sales
    • Find a partner
    • Report a website issue
    • Site Status Dashboard
    • Report a security problem

    RED HAT DEVELOPER

    Build here. Go anywhere.

    We serve the builders. The problem solvers who create careers with code.

    Join us if you’re a developer, software engineer, web designer, front-end designer, UX designer, computer scientist, architect, tester, product manager, project manager or team lead.

    Sign me up

    Red Hat legal and privacy links

    • About Red Hat
    • Jobs
    • Events
    • Locations
    • Contact Red Hat
    • Red Hat Blog
    • Inclusion at Red Hat
    • Cool Stuff Store
    • Red Hat Summit
    © 2025 Red Hat

    Red Hat legal and privacy links

    • Privacy statement
    • Terms of use
    • All policies and guidelines
    • Digital accessibility

    Report a website issue