Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: better document differences between deployment methods #1006

Merged
merged 1 commit into from
Dec 20, 2022
+28 −3
Merged

docs: better document differences between deployment methods #1006

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/deployment/helm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ sort: 3

Node Feature Discovery Helm chart allow to easily deploy and manage NFD.

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

## Prerequisites

[Helm package manager](https://helm.sh/) should be installed.
Expand Down
12 changes: 11 additions & 1 deletion docs/deployment/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,14 @@ sort: 2

# Deployment

Deployment instructions.
See [Image variants](image-variants) for description of the different NFD
container images available.

[Using Kustomize](kustomize) provides straightforward deployment with
`kubectl` integration and declarative customization.

[Using Helm](helm) provides easy management of NFD deployments with nice
configuration management and easy upgrades.

[Using Operator](operator) provides deployment and configuration management via
CRDs.
10 changes: 8 additions & 2 deletions docs/deployment/kustomize.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,15 @@ sort: 2

---

This deployment method requires
[Kustomize](https://github.com/kubernetes-sigs/kustomize) provides easy
deployment of NFD. Customization of the deployment is done by maintaining
declarative overlays on top of the base overlays in NFD.

To follow the deployment instructions here,
[kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl) v1.21 or
later. The kustomize overlays provided in the repo can be used directly:
later is required.

The kustomize overlays provided in the repo can be used directly:

```bash
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref={{ site.release }}
Expand Down
5 changes: 5 additions & 0 deletions docs/deployment/operator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ sort: 4

---

The [Node Feature Discovery Operator][nfd-operator] automates installation,
configuration and updates of NFD using a specific NodeFeatureDiscovery custom
resource. This also provides good support for managing NFD as a dependency of
other operators.

## Deployment

Deployment using the
Expand Down