Developer guide

Developer guide

Building the operator

Download the source code

git clone https://github.com/kubernetes-sigs/node-feature-discovery-operator

Build the operator image

IMAGE_REGISTRY=<my registry>
make image
  

Or for the debug variant

IMAGE_REGISTRY=<my registry>
make image-debug
  

Push the container image

IMAGE_REGISTRY=<my registry>
make push
  

Or for the debug variant

IMAGE_REGISTRY=<my registry>
make push-debug
  

Alternatively, instead of specifying variables on the command line, you can edit the Makefile to permanently change parameter defaults like name of the image or namespace where the operator is deployed.

Manual deployment of the operator

After building the image you can simply run

IMAGE_REGISTRY=<my registry>
make deploy
  

Then create a NodeFeatureDiscovery CR by running

kubectl apply -f config/samples/nfd.kubernetes.io_v1_nodefeaturediscovery.yaml

Undeploy the operator

The operator will use the operand node-feature-discovery image built from: https://github.com/kubernetes-sigs/node-feature-discovery

To uninstall the operator run

make undeploy

Clean up labels

In case you need to remove the labels created by NFD, the source Makefile comes with a built in target

make clean-labels

This will clean all labels referencing to feature.node.kubernetes.io and nfd.node.kubernetes.io

Using skipper utility

Skipper is a tool that allows executing any target defined in the Makefile in the container enviroment, without any need to install project dependencies on the host. Skipper is used besides the Makefile, meaning: if somebody does not want to use skipper, he can run makefile commands as usual In order to use skipper, it must be installed once on the host, along with docker. You can use skipper installation guide

using Makefile commands without skipper:

make image
make build
make deploy
  

using Makefile commands with skipper

skipper make image
skipper make build
skipper make deploy
  