Skip to content

Commit

Permalink
DOCS: Add deployment/uninstallation
Browse files Browse the repository at this point in the history
Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
  • Loading branch information
ArangoGutierrez committed Mar 14, 2023
1 parent 2bdb963 commit d297273
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 15 deletions.
12 changes: 7 additions & 5 deletions docs/deployment/helm.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
---
title: "Helm"
layout: default
sort: 2
sort: 3
---

# Deployment with Helm

{: .no_toc}

## Table of contents

{: .no_toc .text-delta}

1. TOC
Expand All @@ -17,9 +19,9 @@ sort: 2

Helm chart allow to easily deploy and manage the NFD-operator.

> NOTE: NFD-operator is not ideal for other Helm charts to depend on as that may result
> in multiple parallel NFD-operator deployments in the same cluster which is not fully
> supported by the NFD-operator Helm chart.
> NOTE: NFD-operator is not ideal for other Helm charts to depend on as that
> may result in multiple parallel NFD-operator deployments in the same cluster
> which is not fully supported by the NFD-operator Helm chart.
## Prerequisites

Expand Down Expand Up @@ -107,4 +109,4 @@ We have introduced the following Chart parameters.
| `controller.image.repository` | string | `{{ site.container_image | split: ":" | first }}` | NFD-Operator image repository |
| `controller.image.tag` | string | `{{ site.release }}` | NFD-Operator image tag |

[rbac]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/
[rbac]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/
18 changes: 8 additions & 10 deletions docs/deployment/image-variants.md
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`).
55 changes: 55 additions & 0 deletions docs/deployment/uninstallation.md
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

0 comments on commit d297273

Please sign in to comment.