Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nmstate/nmstate-console-plugin
Nmstate Console Plugin for kubernetes-nmstate operator
https://github.com/nmstate/nmstate-console-plugin
Last synced: 2 months ago
JSON representation
Nmstate Console Plugin for kubernetes-nmstate operator
- Host: GitHub
- URL: https://github.com/nmstate/nmstate-console-plugin
- Owner: nmstate
- License: apache-2.0
- Created: 2022-12-14T09:06:34.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-11T10:33:44.000Z (4 months ago)
- Last Synced: 2024-09-11T15:32:05.165Z (4 months ago)
- Language: TypeScript
- Homepage:
- Size: 838 KB
- Stars: 3
- Watchers: 5
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenShift Console Plugin For NMstate
nmstate-console-plugin is an open source project providing [Openshift web console](https://github.com/openshift/console) plugin for [kubernetes-nmstate](https://github.com/nmstate/kubernetes-nmstate). The plugin adds a web based user interface for [NMState](https://github.com/nmstate/kubernetes-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**](https://github.com/nmstate/kubernetes-nmstate)
- [**OpenShift Console 4.12+**](https://www.openshift.com/)
## Quick start
## Development
```bash
# 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](https://www.openshift.com/) cluster, or deploy your own small development cluster on your local PC, using [OpenShift Local](https://developers.redhat.com/products/openshift-local) or [KinD](https://sigs.k8s.io/kind).
| requirements | |
| -------------------------------------------------- | ------------------------------------------------------------------------------------ |
| [nodejs](https://nodejs.org/) | JavaScript runtime environment |
| [yarn](https://yarnpkg.com/) | package manager for nodejs |
| [kubernetes]() | An [Openshift](<(https://www.openshift.com/)>) or kubernetes cluster for development |
| [kubectl](https://kubernetes.io/docs/tasks/tools/) | The Kubernetes command-line tool |
### Spin your own small kubernetes
It is posible to create a small Openshift environment using [OpenShift Local](https://developers.redhat.com/products/openshift-local) or [KinD](https://sigs.k8s.io/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](https://sigs.k8s.io/kind) to deploy a minimal kubernetes cluster with storage, registry and admin user.
```bash
# 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](https://github.com/kubev2v/forklift-console-plugin/blob/main/docs/cli-tools.md) 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`
1. `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:
```bash
kubectl apply -f scripts/yaml/crds
```
### Running development server on local PC using remote nmstate API server
When running [OpenShift Local](https://developers.redhat.com/products/openshift-local) you can install nmstate and kubevirt using
the OperatorHub, on [KinD](https://sigs.k8s.io/kind) you can use the [CI scripts](https://github.com/upalatucci/nmstate-console-plugin/tree/main/scripts).
Before starting the development server, set the inventory and must-gather hosts to match the nmstate API servers, for example:
```bash
# 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:
```sh
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](https://github.com/openshift/console-operator)
config to enable the plugin.
```sh
oc patch consoles.operator.openshift.io cluster \
--patch '{ "spec": { "plugins": ["nmstate-console-plugin"] } }' --type=merge
```
## Deployment on cluster with Helm
A [Helm](https://helm.sh) 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:
```shell
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](deployment/nmstate-console-plugin/values.yaml) file for the full set of supported parameters.
### If you don't have other console plugins installed
```sh
oc patch consoles.operator.openshift.io cluster \
--patch '{ "spec": { "plugins": ["nmstate-console-plugin"] } }' --type=merge
```
### If you have other console plugins
```sh
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](https://github.com/nmstate/nmstate/) | |
| [Openshift web console](https://github.com/openshift/console) | Openshift web console is a web based user interface for Openshift. |
| [OpenShift Dynamic Plugin SDK](https://github.com/openshift/dynamic-plugin-sdk) | Dynamic plugin SDK for Openshift user interfaces. |
| [NMState documentation](https://nmstate.io/) | Usage documentation for nmstate configuration |
| [Patternfly](https://www.patternfly.org/) | Open source design system used for Openshift user interfaces development. |
## Credit
Inspired by: [forklift console plugin](https://github.com/kubev2v/forklift-console-plugin)