OpenShift Console Plugin For NMstate

nmstate-console-plugin is an open source project providing Openshift web console plugin for kubernetes-nmstate. The plugin adds a web based user interface for NMState inside Openshift web console.

NMState is a tool to perform state driven network configuration on cluster nodes and to report back their current state.

Prerequisites

• NMState Operator
• OpenShift Console 4.12+

Quick start

Development

# inside the develpment environment
cd nmstate-console-plugin

# add your git remote
# edit the code

# start a develoment server on port 9443
yarn dev --port 9443 \
  --server-type https \
  --server-options-key /var/serving-cert/tls.key \
  --server-options-cert /var/serving-cert/tls.crt

Development on local PC

Requirements

nmstate-console-plugin development require web development tools, and a kubernetes or Openshift cluster. You can use any available Openshift cluster, or deploy your own small development cluster on your local PC, using OpenShift Local or KinD.

requirements
nodejs	JavaScript runtime environment
yarn	package manager for nodejs
kubernetes	An Openshift or kubernetes cluster for development
kubectl	The Kubernetes command-line tool

Spin your own small kubernetes

It is posible to create a small Openshift environment using OpenShift Local or KinD. Openshift local will install all the neccary services. When installing a cluster using KinD, you may want to setup a custom development enviormnet manually.

This example script is using KinD to deploy a minimal kubernetes cluster with storage, registry and admin user.

# deploy small local kubernetes cluster using kind command line utility
bash scripts/deploy-cluster.sh

# delete the cluster and local registry, this script will remove any
# workload or data currenly in the local cluster or the local registry
# this script may be usufull for development when starting a new session
bash scripts/clean-cluster.sh

Note: Running virtualized workloads (e.g. virtual machines) on this cluster requires starting the cluster using the root user (e.g. sudo bash scripts/deploy-cluster.sh)

See cli docs for more information about Openshift local and Kind.

Running development server on local PC using mock data

In one terminal window, run:

1. yarn install
2. yarn run start-console

This will run the OpenShift console in a container connected to the cluster you are currently logged into. The plugin HTTP server runs on port 9001 with CORS enabled, the development server will be available at http://localhost:9000

start-console script uses this environment varialbles:

Environment varialbles	Description
CONSOLE_IMAGE	The console image to run ( default quay.io/openshift/origin-console:latest )
CONSOLE_PORT	Expose the console web application on port ( default 9000 )
INVENTORY_SERVER_HOST	URL of nmstate inventory server ( default http://localhost:30088 )
BRIDGE_K8S_AUTH_BEARER_TOKEN	Bearer token of user account ( on openshift token default to $(oc whoami -t) )
BRIDGE_K8S_MODE_OFF_CLUSTER_ENDPOINT	Kubernetes API servere URL (default, guess useing kubeconfig file)

Note: when running the plugin on a cluster with no nmstate install, you can install only the missing CRDs using this command:

kubectl apply -f scripts/yaml/crds

Running development server on local PC using remote nmstate API server

When running OpenShift Local you can install nmstate and kubevirt using the OperatorHub, on KinD you can use the CI scripts.

Before starting the development server, set the inventory and must-gather hosts to match the nmstate API servers, for example:

# example of using nmstate API running inside our Openshift cluster (using the oc command line utility)
export BRIDGE_K8S_MODE_OFF_CLUSTER_ENDPOINT:=$(oc whoami --show-server)
export BRIDGE_K8S_AUTH_BEARER_TOKEN=$(oc whoami --show-token)
export INVENTORY_SERVER_HOST=https://$(oc get routes -o custom-columns=HOST:.spec.host -A | grep 'nmstate-inventory' | head -n 1)

# start the nmstate console plugin
yarn dev

Deployment on cluster with Openshift templates

After pushing an image with your changes to an image registry, you can deploy the plugin to a cluster by instantiating the template:

oc process -f oc-manifest.yaml \
  -p PLUGIN_NAME=nmstate-console-plugin \
  -p NAMESPACE=openshift-nmstate \
  -p IMAGE=quay.io/nmstate/nmstate-console-plugin:latest \
  | oc create -f -

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

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

Deployment on cluster with Helm

A Helm chart is available to deploy the plugin to an OpenShift environment.

Install the chart using the name of the plugin as the Helm release name into a new or existing namespace (openshift-nmstate by default) parameter and providing the location of the image within the image parameter by using the following command:

helm upgrade -i  nmstate-console-plugin deployment/nmstate-console-plugin -n openshift-nmstate --create-namespace

By default helm will use quay.io/nmstate/nmstate-console-plugin:latest as the console plugin image. If you desire, you can change the image with the --set image=IMAGE_NAME parameter

Consult the chart values file for the full set of supported parameters.

If you don't have other console plugins installed

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

If you have other console plugins

oc patch consoles.operator.openshift.io cluster \
  --patch '[{ "op": "add", "path": "/spec/plugins/-", "value": "nmstate-console-plugin" }]'  --type="json"

NOTE: When deploying on OpenShift 4.10, it is recommended to add the parameter --set plugin.securityContext.enabled=false which will omit configurations related to Pod Security.

Learn more

Reference
NMState
Openshift web console	Openshift web console is a web based user interface for Openshift.
OpenShift Dynamic Plugin SDK	Dynamic plugin SDK for Openshift user interfaces.
NMState documentation	Usage documentation for nmstate configuration
Patternfly	Open source design system used for Openshift user interfaces development.

Credit

Inspired by: forklift console plugin