Açıklama Yok

Samuel Padgett baf20639d1 build: fully qualify images in Dockerfile		4 yıl önce
.devcontainer	d4e799fb32 add vscode remote container infra	4 yıl önce
src	1b15c2c262 doc: update example page help text	4 yıl önce
.eslintrc.yml	e9fb978540 initial commit	4 yıl önce
.gitignore	d4e799fb32 add vscode remote container infra	4 yıl önce
.prettierrc.yml	e9fb978540 initial commit	4 yıl önce
Dockerfile	baf20639d1 build: fully qualify images in Dockerfile	4 yıl önce
LICENSE	e9fb978540 initial commit	4 yıl önce
README.md	be8077f520 doc: replace OpenShift links	4 yıl önce
console-extensions.json	e9fb978540 initial commit	4 yıl önce
package.json	2714eac24e build: update to dynamic-plugin-sdk-webpack 0.0.6	4 yıl önce
start-console.sh	053bbf4a97 fix(start-console): use host networking on Linux	4 yıl önce
template.yaml	3d0c7471e2 manifest: use OpenShift templates	4 yıl önce
tsconfig.json	e9fb978540 initial commit	4 yıl önce
webpack.config.ts	6ed8de9958 feat: allow users to run console in a container	4 yıl önce
yarn.lock	2714eac24e build: update to dynamic-plugin-sdk-webpack 0.0.6	4 yıl önce

OpenShift Console Plugin Template

This project is a minimal template for writing a new OpenShift Console dynamic plugin. It requires OpenShift 4.10.

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

Node.js and yarn are required to build and run the example. To run OpenShift console in a container, either Docker or podman 3.2.0+ and oc are required.

Getting started

After cloning this repo, you should update the plugin metadata such as the plugin name in the consolePlugin declaration of package.json.

"consolePlugin": {
  "name": "my-plugin",
  "version": "0.0.1",
  "displayName": "My Plugin",
  "description": "Enjoy this shiny, new console plugin!",
  "exposedModules": {
    "ExamplePage": "./components/ExamplePage"
  },
  "dependencies": {
    "@console/pluginAPI": "*"
  }
}

The template adds a single example page in the Home navigation section. The extension is declared 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.

Development

Option 1: Local

In one terminal window, run:

yarn install
yarn run start

In another terminal window, run:

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've logged into. The plugin HTTP server runs on port 9001 with CORS enabled. Navigate to http://localhost:9000/example to see the running plugin.

Option 2: Docker + VSCode Remote Container

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

Docker image

Before you can deploy your plugin on a cluster, you must build an image and push it to an image registry.

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

Deployment on cluster

After pushing an image with your changes to a registry, you can deploy the plugin to a cluster by instantiating the provided OpenShift template. It will run a light-weight nginx HTTP server to serve your plugin's assets.

oc process -f template.yaml \
  -p PLUGIN_NAME=my-plugin \
  -p NAMESPACE=my-plugin-namespace \
  -p IMAGE=quay.io/my-repository/my-plugin:latest \
  | oc create -f -

PLUGIN_NAME must match the plugin name you used in the consolePlugin declaration of package.json.

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

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

README.md