Skip to content

Latest commit

 

History

History
130 lines (81 loc) · 6.76 KB

README.md

File metadata and controls

130 lines (81 loc) · 6.76 KB
Raw

OpenShift Monitoring Plugin

This plugin runs in one of two modes, with and without feature flags. When deployed without any feature flags enabled, it will add the monitoring UI to the OpenShift web console. This is most commonly seen in the CMO deployment of it, which is shipped by default with every OpenShift cluster. Documentation for this mode is located under the monitoring-plugin heading.

When started with feature flag(s), it will instead only add functionality to the OpenShift web console related to the features. Documentation for this mode is located under the monitoring-console-plugin heading.

monitoring-plugin

This section describes knowledge helpful to development of the default monitoring-plugin.

Docker image

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

  1. Build the image:

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

  2. Run the image:

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

  3. 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 cluster

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 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 monitoring-plugin charts/openshift-console-plugin -n my-plugin-namespace --create-namespace --set plugin.image=my-plugin-image-location

Redux Store

The monitoring-plugin is currently in a transitionary state as the remaining pages are moved from the openshift/console repo to this one. One such instance of this is the redux store definition, which lives within the openshift/console codebase.

Changes to the store must be completed in the openshift/console codebase and are not backwards compatible unless cherry-picked with purpose.

Local Development

Dependencies

  1. Node.js and npm are required
  2. oc
  3. podman 3.2.0+ or Docker
  4. An OpenShift cluster

Running Locally

# Login to an OpenShift cluster
$ oc login <clusterAddress> -u <username> -p <password>

# Start podman (or Docker)
$ podman machine init
$ podman machine start

# Install dependencies
$ make install

# Run the application
$ make start-frontend
# In a separate terminal
$ make start-console

The application will be running at localhost:9000.

Local Development Troubleshooting

  1. Disable cache. Select 'disable cache' in your browser's DevTools > Network > 'disable cache'. Or use private/incognito mode in your browser.
  2. Enable higher log verbosity by setting -log-level=trace when starting the plugin backend. For more options to set log level see logrus documentation.

monitoring-console-plugin (mcp)

Dependencies

  1. Local Development Dependencies
  2. yq for acm deployment
  3. sed (gnu-sed for mac, with sed being aliased to that gnu-sed)

Building an image

Images for the mcp can be built by running the following command. Due to the limitation of linux/amd64 image builds on Apple Silicon Macs's, some of the changes are run locally and not just in the Dockerfiles. If you are on a Mac, it is not suggested to cancel the exection of this scipt part way through

make build-mcp-image

Feature Flags

Feature flags are used by the mcp mode to dictate the specific features which are enabled when the server starts up. Feature flags should be added to the Feature enum here and to the useFeature hook here. When any feature flag is enabled the default extension points are overridden, including a new monitoring-console-plugin exclusive redux store and all extension points for the flags. These feature extension points are created through the use of json-patches, such as the acm-alerting patch here. The server looks for a patch in the format of {feature-flag-name}.patch.json to apply.

Feature OCP Version
acm-alerting 4.14+
incidents

ACM

Due to the extensive number of items which would need to be run to locally run the ACM perspective, the suggested development pattern is instead repeat installations with helm. A small number of scripts have been put together to help you deploy the monitoring-plugin in its acm-alerting configuration. REGISTRY_ORG and TAG variables are available to adjust the quay image generated and used for deployment. Certain build time changes to the codebase are created when running these scripts.

make deploy-acm

Once the code has been updated, make sure to update the helm chart and variables (variable example, chart example) for ease of deployment of your feature.

Redux Store

Since the store for the monitoring-plugin is stored in the openshift/console codebase and updates to the store that are aren't tied directly to the OCP are needed, when the default extension points are removed due to the presense of a feature flag a duplicate store is created at the .state.plugins.monitoring path. A combination of the useFeatures hook and the getObserveState (which is dependant on the perspective) can be used to retrieve the state from the redux store based on the mode the plugin was deployed in.