OpenShift Console Customizations Plugin

This project is a simple plugin that adds a Customization nav item to the Administrator perspective in OpenShift console. It requires OpenShift 4.10 to use.

Local development

In one terminal window, run:

1. yarn install
2. yarn run start

In another terminal window, run:

1. oc login
2. yarn run start-console (requires Docker or podman)

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

Deployment on cluster

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

oc apply -f manifest.yaml

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

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

Docker image

1. Build the image:

   docker build -t quay.io/$USER/console-customization-plugin:latest .

2. Run the image:

   docker run -it --rm -d -p 9001:80 quay.io/$USER/console-customization-plugin:latest

3. Push the image to image registry:

   docker push quay.io/$USER/console-customization-plugin:latest

Update and apply manifest.yaml to use a custom plugin image.