generated from kubernetes/kubernetes-template-project
-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
- Loading branch information
1 parent
2bdb963
commit 4189fb3
Showing
4 changed files
with
117 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,36 @@ | ||
--- | ||
title: "Image variants" | ||
layout: default | ||
sort: 1 | ||
sort: 2 | ||
--- | ||
|
||
# Image variants | ||
|
||
{: .no_toc} | ||
|
||
## Table of contents | ||
|
||
{: .no_toc .text-delta} | ||
|
||
1. TOC | ||
{:toc} | ||
|
||
--- | ||
|
||
NFD-Operator currently offers two variants of the container image. The "minimal" variant is | ||
currently deployed by default. Released container images are available for | ||
x86_64 and Arm64 architectures. | ||
NFD-Operator currently offers two variants of the container image. | ||
The "minimal" variant is currently deployed by default. Released container | ||
images are available for x86_64 and Arm64 architectures. | ||
|
||
## Minimal | ||
## Default | ||
|
||
This is a minimal image based on | ||
[gcr.io/distroless/base](https://github.com/GoogleContainerTools/distroless/blob/master/base/README.md) | ||
and only supports running statically linked binaries. | ||
|
||
For backwards compatibility a container image tag with suffix `-minimal` | ||
(e.g. `{{ site.container_image }}-minimal`) is provided. | ||
|
||
## Full | ||
|
||
This image is based on [debian:bullseye-slim](https://hub.docker.com/_/debian) | ||
and contains a full Linux system for running shell-based nfd-worker hooks and | ||
doing live debugging and diagnosis of the NFD-Operator images. | ||
|
||
The container image tag has suffix `-full` | ||
(e.g. `{{ site.container_image }}-full`). | ||
(e.g. `{{ site.container_image }}-full`). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
--- | ||
title: "Deployment" | ||
layout: default | ||
sort: 1 | ||
--- | ||
|
||
# Deployment | ||
|
||
See [Image variants](image-variants) for description of the different NFD-Operator | ||
container images available. | ||
|
||
[Using Helm](helm) provides easy management of NFD deployments with nice | ||
configuration management and easy upgrades. | ||
|
||
[Uninstallation](uninstallation) provides deployment and configuration management via | ||
CRDs. | ||
|
||
# Quick start | ||
|
||
Get the source code | ||
|
||
```bash | ||
git clone -b {{ site.release }} https://github.com/kubernetes-sigs/node-feature-discovery-operator | ||
``` | ||
|
||
Deploy the operator | ||
|
||
> By default it will deploy using the minimal tag image, is | ||
> desired you can simply modify the IMAGE_TAG env var to point to the image | ||
> tag to use. | ||
```bash | ||
IMAGE_TAG={{ site.container_image }} | ||
make deploy | ||
``` | ||
|
||
By default the operator will watch `NodeFeatureDiscovery` objects | ||
only in the namespace where the operator is deployed in. This is | ||
specified by the `WATCH_NAMESPACE` env variable in the operator | ||
deployment manifest. If unset the operator will watch ALL | ||
namespaces. | ||
|
||
Create a NodeFeatureDiscovery instance | ||
|
||
```bash | ||
kubectl apply -f config/samples/nfd.kubernetes.io_v1_nodefeaturediscovery.yaml | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
title: "Uninstallation" | ||
layout: default | ||
sort: 4 | ||
--- | ||
|
||
# Uninstallation | ||
|
||
{: .no_toc} | ||
|
||
## Table of contents | ||
|
||
{: .no_toc .text-delta} | ||
|
||
1. TOC | ||
{:toc} | ||
|
||
--- | ||
|
||
If you followed the deployment instructions from the [Quick start](index) you | ||
can simply do: | ||
|
||
```bash | ||
kubectl -n nfd-operator delete NodeFeatureDiscovery my-nfd-deployment | ||
``` | ||
|
||
Optionally, you can also remove the namespace: | ||
|
||
```bash | ||
kubectl delete ns nfd-operator | ||
``` | ||
|
||
See the [node-feature-discovery-operator][nfd-operator] and [OLM][OLM] project | ||
documentation for instructions for uninstalling the operator and operator | ||
lifecycle manager, respectively. | ||
|
||
## Removing feature labels | ||
|
||
From the [Operand repository][nfd] NFD-Master has a special `-prune` command | ||
line flag for removing all nfd-related node labels, annotations and extended | ||
resources from the cluster. | ||
|
||
```bash | ||
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref={{ site.release }} | ||
kubectl -n node-feature-discovery wait job.batch/nfd-master --for=condition=complete && \ | ||
kubectl delete -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref={{ site.release }} | ||
``` | ||
|
||
**NOTE:** You must run prune before removing the RBAC rules (serviceaccount, | ||
clusterrole and clusterrolebinding). | ||
|
||
<!-- Links --> | ||
[nfd-operator]: https://github.com/kubernetes-sigs/node-feature-discovery-operator | ||
[nfd]: https://github.com/kubernetes-sigs/node-feature-discovery | ||
[OLM]: https://github.com/operator-framework/operator-lifecycle-manager |