Skip to content

Latest commit

 

History

History
114 lines (76 loc) · 4.3 KB

PLUGIN.md

File metadata and controls

114 lines (76 loc) · 4.3 KB
Raw

Dynamic Plugins

React can lazy load components. This means the bundled javascript for a component is not loaded until it is needed.

Webpack 5 added module federation. The idea being that instead of lazy loading a component from the same server/container, you can load a component from a remote server/container. Think microservices for the frontend.

OCP Console dynamic plugins build upon this issue by adding a resource that registers the federated module, and has extensions indicating how and where that "dynamic plugin" will be loaded into the OCP console.

In addition the OCP console provides dynamic [proxies]((https://github.com/openshift/console/tree/master/frontend/packages/console-dynamic-plugin-sdk) that allow those loaded conponents to communicate with the backends even in other namespaces.

ACM Dynamic Plugins

ACM will run stand-alone as it needs to support back to OCP 4.6 and dynamic plugins are only available in OCP 4.10+.

ACM will not only serve up the stand alone but also plugins for each of the main navigation pages in ACM.

Install Changes

ACM console will need to know what version of OCP it is being installed on. In the case of 4.10+ we will install addition resources to register the plugins with the OCP console.

Development

Prerequisites

  • python
  • jq
  • oc
  • podman or docker

Running console as OCP dynamic plugins

From the root of the console repository make sure your kubecontext is set to a hub cluster, then run:

npm run setup
npm run plugins

This will concurrently start the backend server, frontend webpack development server and OCP console.

The console will be running at localhost:9000.

Running against local development build of OCP console

npm run setup
npm run plugins-dev

This will concurrently start the backend server and frontend webpack development server

OCP Console Git Repo

Ensure that OCP Console's dependencies are met in your local environment.

git clone [email protected]:openshift/console.git

Running OCP Console in development mode

Note: With recent post-4.10 builds, you need to run OpenShift console with authentication for authorization to work with the proxied services. Follow these instructions. Alternatively, you can revert a commit that regressed the ability to use proxies that require authorization when running without authentication and continue with these instructions.

git revert 1230920afbcd7cbc1d2f0c6b1e48744c72eb60be -m 1 -n

Build OCP Console

./build.sh

Start ocp console bridge with plugin and proxy

source ./contrib/oc-environment.sh

./bin/bridge -plugins mce=http://localhost:3001 -plugins acm=http://localhost:3002 --plugin-proxy='{"services":[{"consoleAPIPath":"/api/proxy/plugin/mce/console/","endpoint":"https://localhost:4000","authorize":true},{"consoleAPIPath":"/api/proxy/plugin/acm/console/","endpoint":"https://localhost:4000","authorize":true}]}'

The console will be running at localhost:9000.

Bridge variables can also be passed in as environment variables

BRIDGE_PLUGIN_PROXY='{"services":[{"consoleAPIPath":"/api/proxy/plugin/mce/console/","endpoint":"https://localhost:4000","authorize":true},{"consoleAPIPath":"/api/proxy/plugin/acm/console/","endpoint":"https://localhost:4000","authorize":true}]}'

Dynamic Plugin support for getting resources

Q: What support does OCP have for realtime data with websockets?

useWatchK8sResource and useWatchK8sResources are the utilities we have right now for that

const [data, loaded, error] = useK8sWatchResource<CustomizationResource[]>({
    groupVersionKind: {
        group: 'console.openshift.io',
        version: 'v1',
        kind: 'ConsoleLink',
    },
    isList: true,
    namespaced: false,
});