Dynamic plugin for Red Hat OpenShift Container Platform (OCP) Console. This provides Cryostat Web functionality directly within the OCP Console so that users do not need to visit individual Cryostat instances' UIs. Usage of this plugin requires the Cryostat Operator or Cryostat Helm Chart to create Cryostat instances for the plugin to interact with.

SEE ALSO

• cryostat.io : upstream documentation website with user guides, tutorials, blog posts, and other user-facing content. Start here if what you've read so far sounds interesting and you want to know more as a user, rather than as a developer. Here you will find instructions on how to install Cryostat using the Cryostat Operator, how to configure your applications to enable connectivity, and how to use the Cryostat application.

• cryostat-operator : an Operator for deploying Cryostat in your OpenShift or Kubernetes cluster.

• cryostat-helm: a Helm Chart for deploying Cryostat in your OpenShift or Kubernetes cluster

Requirements

• OpenShift Container Platform 4.15+
• Cryostat Operator installed on the cluster and at least one Cryostat CR created, or Cryostat Helm Chart

The Cryostat project follows semantic versioning. To ensure compatibility, please keep your Cryostat component versions matching. If you use the Operator to install Cryostat then this will be done automatically.

Development

Initialize the project:

$ git submodule init
$ git submodule update --remote
$ pushd src/cryostat-web
$ yarn install
$ yarn yarn:frzinstall
$ popd
$ yarn install
$ pushd backend
$ npm ci
$ popd

Deploying the plugin:

Build the image locally and push it to a registry that the cluster can pull from:

$ export IMAGE_NAMESPACE=quay.io/$myusername # replace $myusername with your quay.io username, or else set this to a different repository
$ PLATFORMS=linux/amd64 PUSH_MANIFEST=true ./plugin.bash build
$ ./plugin.bash install

Deploying the plugin from local sources, without an external registry:

cluster-build uploads the working tree to the cluster that the oc client is currently logged in to and builds the same Dockerfile there, pushing the result to the cluster's internal registry in the plugin's own install namespace. No registry login or pull secret is required, and nothing is published outside the cluster.

$ ./plugin.bash cluster-build
$ ./plugin.bash cluster-install

Re-run cluster-build to pick up further source changes. A rebuild overwrites the existing image tag rather than creating a new one, so when the build replaces an image that is already deployed the script restarts the plugin Deployment and waits for the rollout to finish. Set $ROLLOUT_TIMEOUT to change how long it waits (defaults to 5m).

Run ./plugin.bash --help for the full list of subcommands and environment variables.

Development using local backend (Cryostat or Prism):

Terminal 1: Run the plugin locally

yarn run start

Plugin assets will be accessible at http://localhost:9001

Terminal 2: Run a local backend, either a Prism mock server or local Cryostat

npm run mock-server

OR

(in a Cryostat repo)
CRYOSTAT_HTTP_PORT=8181 bash smoketest.bash -tkp

Cryostat is accessible at http://localhost:8181, and for simplicity Prism has been configured to use the same port.

Terminal 3: Run a local OpenShift Console with plugin-proxy

yarn run start-console

The OpenShift Console running the plugin will be available at http://localhost:9000

References

• Console Plugin SDK README
• Customization Plugin Example
• Dynamic Plugin Enhancement Proposal