Warning: This plugin is not actively maintained or supported. Use at your own risk.
A dynamic plugin for the OpenShift console that adds GPU monitoring dashboards and visualizations using metrics from the NVIDIA GPU Operator.
Multi-architecture images (amd64, arm64) are available starting from version 0.2.6.
| Plugin version | OpenShift version |
|---|---|
| 0.3.0 | 4.19+ |
| 0.2.6 | 4.12-4.18 |
# add Helm repo
$ helm repo add rh-ecosystem-edge https://rh-ecosystem-edge.github.io/console-plugin-nvidia-gpu
$ helm repo update
# install Helm chart in the default NVIDIA GPU operator namespace
$ helm install -n nvidia-gpu-operator console-plugin-nvidia-gpu rh-ecosystem-edge/console-plugin-nvidia-gpu
# view deployed resources
$ oc -n nvidia-gpu-operator get all -l app.kubernetes.io/name=console-plugin-nvidia-gpu
# check if a plugins field is specified
$ oc get consoles.operator.openshift.io cluster --output=jsonpath="{.spec.plugins}"
# if not, then run the following to enable the plugin
$ oc patch consoles.operator.openshift.io cluster --patch '{ "spec": { "plugins": ["console-plugin-nvidia-gpu"] } }' --type=merge
# if yes, then run the following to enable the plugin
$ oc patch consoles.operator.openshift.io cluster --patch '[{"op": "add", "path": "/spec/plugins/-", "value": "console-plugin-nvidia-gpu" }]' --type=json
# add the required DCGM Exporter metrics ConfigMap to the existing NVIDIA operator ClusterPolicy CR
$ oc patch clusterpolicies.nvidia.com gpu-cluster-policy --patch '{ "spec": { "dcgmExporter": { "config": { "name": "console-plugin-nvidia-gpu" } } } }' --type=merge
Important: Configuring the plugin’s metrics ConfigMap will override any default or custom DCGM metrics. To collect additional metrics beyond those required by the plugin, merge the plugin’s required metrics with your custom list into a new ConfigMap before applying it to the ClusterPolicy.
The Helm chart includes tests to verify successful deployment. To run them:
$ helm test -n nvidia-gpu-operator console-plugin-nvidia-gpu --timeout 2m
See DEVELOPMENT.md for local development setup and contributing guidelines.