docs: better document differences between deployment methods

kubernetes-sigs · Dec 20, 2022 · 27c47bd · 27c47bd
1 parent c551a9a
commit 27c47bd
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 3 deletions.
diff --git a/docs/deployment/helm.md b/docs/deployment/helm.md
@@ -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.

diff --git a/docs/deployment/index.md b/docs/deployment/index.md
@@ -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.
diff --git a/docs/deployment/kustomize.md b/docs/deployment/kustomize.md
@@ -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 }}

diff --git a/docs/deployment/operator.md b/docs/deployment/operator.md
@@ -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