From fe7423625b7c21d8c07bbdcc21e3e496c860886b Mon Sep 17 00:00:00 2001 From: Carlos Eduardo Arango Gutierrez Date: Mon, 13 Mar 2023 14:57:18 +0100 Subject: [PATCH] DOCS: Add deployment/uninstallation Signed-off-by: Carlos Eduardo Arango Gutierrez --- docs/deployment/helm.md | 2 +- docs/deployment/image-variants.md | 8 ++--- docs/deployment/uninstallation.md | 54 +++++++++++++++++++++++++++++++ 3 files changed, 57 insertions(+), 7 deletions(-) create mode 100644 docs/deployment/uninstallation.md diff --git a/docs/deployment/helm.md b/docs/deployment/helm.md index da3db05c..0a1bbc48 100644 --- a/docs/deployment/helm.md +++ b/docs/deployment/helm.md @@ -1,7 +1,7 @@ --- title: "Helm" layout: default -sort: 2 +sort: 3 --- # Deployment with Helm diff --git a/docs/deployment/image-variants.md b/docs/deployment/image-variants.md index 0442a09a..0816c439 100644 --- a/docs/deployment/image-variants.md +++ b/docs/deployment/image-variants.md @@ -1,7 +1,7 @@ --- title: "Image variants" layout: default -sort: 1 +sort: 2 --- # Image variants @@ -19,11 +19,10 @@ NFD-Operator currently offers two variants of the container image. The "minimal" 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. @@ -31,8 +30,5 @@ For backwards compatibility a container image tag with suffix `-minimal` ## 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`). \ No newline at end of file diff --git a/docs/deployment/uninstallation.md b/docs/deployment/uninstallation.md new file mode 100644 index 00000000..840d6779 --- /dev/null +++ b/docs/deployment/uninstallation.md @@ -0,0 +1,54 @@ +--- +title: "Uninstallation" +layout: default +sort: 4 +--- + +# Uninstallation +{: .no_toc} + +## Table of contents +{: .no_toc .text-delta} + +1. TOC +{:toc} + +--- + +## Uninstallation + +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). + + +[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