https://github.com/containers/nri-plugins-operator
https://github.com/containers/nri-plugins-operator
containerd cri-o helm kubernetes nri nri-plugins
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/containers/nri-plugins-operator
- Owner: containers
- License: apache-2.0
- Created: 2023-11-03T23:48:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-13T13:47:13.000Z (over 1 year ago)
- Last Synced: 2025-03-29T13:05:08.725Z (2 months ago)
- Topics: containerd, cri-o, helm, kubernetes, nri, nri-plugins
- Language: Makefile
- Homepage:
- Size: 36.1 KB
- Stars: 3
- Watchers: 10
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nri-plugins-operator
The nri-plugins-operator is an Ansible-based operator created with operator-sdk to manage the life cycle of the
nri-plugins. The operator deploys community maintained [nri-plugins](https://github.com/containers/nri-plugins) in
Kubernetes cluster. When operator is installed, it doesn't do anything apart from watching for custom resources called
NriPluginDeployment. When NriPluginDeployment object is created, reconciliation loops kicks off and installs the
nri-plugin specified in the NriPluginDeployment.
## nriPluginDeployment object
```YAML
apiVersion: config.nri/v1alpha1
kind: NriPluginDeployment
metadata:
name: nriplugindeployment-sample
namespace: kube-system
spec:
pluginName: topology-aware
pluginVersion: "v0.2.3"
state: present
values:
nri:
patchRuntimeConfig: true
tolerations:
- key: "node-role.kubernetes.io/control-plane"
operator: "Exists"
effect: "NoSchedule"
affinity:
nodeAffinity:
requiredDuringSchedulingIgnoredDuringExecution:
nodeSelectorTerms:
- matchExpressions:
- key: topology.kubernetes.io/disk
operator: In
values:
- ssd
```
- `metadata.namespace`: the same namespace is used to install the nri-plugin Helm chart.
- `spec.pluginName`: This field specifies the desired plugin to be installed, with currently accepted values including
topology-aware, balloons, memtierd, memory-qos, or sgx-epc. The list of allowed nri-plugins is expected to grow as
new plugins are introduced. The field is immutable and to deploy a different plugin you need to re-create the object
or create a new one with different name and namespace.
- `spec.pluginVersion`: specifies the version of the plugin. If not indicated, it defaults to the latest version. The
plugin version is mutable, and updating it will uninstall the current version before installing the updated one.
- `spec.state`: Determines whether to install (`present`) or uninstall (`absent`) the plugin.
- `spec.values`: Allows users to provide custom values for manipulating Helm chart values. This field is immutable,
requiring users to recreate the object to pass new values.
- `spec.status`: Tracks the basic state of the resource and includes basic messages in case the operator encounters
issues while reconciling the object.
## Operator installation
Build the operator image and push it to some registry
```shell
make docker-build docker-push IMG="my-registry.com/nri-plugins-operator:unstable"
```
Deploy the operator in your cluster
```shell
make deploy
```
Uninstall the operator
```shell
make undeploy
```
# License
Licensed under [Apache 2.0](https://github.com/containers/nri-plugins-operator/blob/main/LICENSE).