docs: include Helm as an option in quick-start instructions

With OCI-based Helm chart available, deployment became a simple
one-liner.

Author: marquiz

README.md

@@ -7,31 +7,27 @@
 Welcome to Node Feature Discovery – a Kubernetes add-on for detecting hardware
 features and system configuration!
 
-### See our [Documentation][documentation] for detailed instructions and reference
+## See our [Documentation][documentation] for detailed instructions and reference
 
-#### Quick-start – the short-short version
+### Quick-start – the short-short version
+
+#### Helm
+
+```bash
+helm install -n node-feature-discovery --create-namespace nfd oci://registry.k8s.io/nfd/charts/node-feature-discovery --version 0.18.0
+```
+
+#### Kustomize
+
+Alternatively, you can deploy using kubectl and kustomize:
 
 ```bash
-$ kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref=v0.18.0"
-  namespace/node-feature-discovery created
-  customresourcedefinition.apiextensions.k8s.io/nodefeaturegroups.nfd.k8s-sigs.io created
-  customresourcedefinition.apiextensions.k8s.io/nodefeaturerules.nfd.k8s-sigs.io created
-  customresourcedefinition.apiextensions.k8s.io/nodefeatures.nfd.k8s-sigs.io created
-  serviceaccount/nfd-gc created
-  serviceaccount/nfd-master created
-  serviceaccount/nfd-worker created
-  role.rbac.authorization.k8s.io/nfd-worker created
-  clusterrole.rbac.authorization.k8s.io/nfd-gc created
-  clusterrole.rbac.authorization.k8s.io/nfd-master created
-  rolebinding.rbac.authorization.k8s.io/nfd-worker created
-  clusterrolebinding.rbac.authorization.k8s.io/nfd-gc created
-  clusterrolebinding.rbac.authorization.k8s.io/nfd-master created
-  configmap/nfd-master-conf-9mfc26f2tc created
-  configmap/nfd-worker-conf-c2mbm9t788 created
-  deployment.apps/nfd-gc created
-  deployment.apps/nfd-master created
-  daemonset.apps/nfd-worker created
+kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref=v0.18.0"
+```
+
+#### Verify the deployment
 
+```bash
 $ kubectl -n node-feature-discovery get all
   NAME                              READY   STATUS    RESTARTS   AGE
   pod/nfd-gc-565fc85d9b-94jpj       1/1     Running   0          18s
@@ -46,7 +42,6 @@ $ kubectl get no -o json | jq ".items[].metadata.labels"
     "feature.node.kubernetes.io/cpu-cpuid.ADX": "true",
     "feature.node.kubernetes.io/cpu-cpuid.AESNI": "true",
 ...
-
 ```
 
 [documentation]: https://kubernetes-sigs.github.io/node-feature-discovery

docs/get-started/index.md

@@ -19,28 +19,35 @@ Continue to:
 
 ## Quick-start -- the short-short version
 
+### Helm
+
+```bash
+helm install -n node-feature-discovery --create-namespace nfd {{ site.helm_oci_repo }} --version {{ site.helm_chart_version }}
+```
+
+### Kustomize
+
+Alternatively, you can deploy using kubectl and kustomize:
+
 ```bash
-$ kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref={{ site.release }}
-  namespace/node-feature-discovery created
-  serviceaccount/nfd-master created
-  clusterrole.rbac.authorization.k8s.io/nfd-master created
-  clusterrolebinding.rbac.authorization.k8s.io/nfd-master created
-  configmap/nfd-worker-conf created
-  deployment.apps/nfd-master created
-  daemonset.apps/nfd-worker created
+kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref={{ site.release }}
+```
+
+### Verify the deployment
 
+```bash
 $ kubectl -n node-feature-discovery get all
   NAME                              READY   STATUS    RESTARTS   AGE
-  pod/nfd-master-555458dbbc-sxg6w   1/1     Running   0          56s
-  pod/nfd-worker-mjg9f              1/1     Running   0          17s
+  pod/nfd-gc-565fc85d9b-94jpj       1/1     Running   0          18s
+  pod/nfd-master-6796d89d7b-qccrq   1/1     Running   0          18s
+  pod/nfd-worker-nwdp6              1/1     Running   0          18s
 ...
 
-$ kubectl get nodes -o json | jq '.items[].metadata.labels'
+$ kubectl get no -o json | jq ".items[].metadata.labels"
   {
     "kubernetes.io/arch": "amd64",
     "kubernetes.io/os": "linux",
     "feature.node.kubernetes.io/cpu-cpuid.ADX": "true",
     "feature.node.kubernetes.io/cpu-cpuid.AESNI": "true",
 ...
-
 ```

docs/get-started/quick-start.md

@@ -10,24 +10,35 @@ Minimal steps to deploy latest released version of NFD in your cluster.
 
 ## Installation
 
-Deploy with kustomize -- creates a new namespace, service and required RBAC
-rules and deploys nfd-master and nfd-worker daemons.
+NFD installation consists of CRDs, RBAC rules, Deployments of the nfd-master
+and nfd-gc daemons and DaemonSet of the nfd-worker daemon.
+
+### Helm
+
+```bash
+helm install -n node-feature-discovery --create-namespace nfd {{ site.helm_oci_repo }} --version {{ site.helm_chart_version }}
+```
+
+### Kustomize
+
+Alternatively, NFD can be deploy with kubectl/kustomize.
 
 ```bash
 kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref={{ site.release }}"
 ```
 
 ## Verify
 
-Wait until NFD master and NFD worker are running.
+Wait until NFD pods are running.
 
 ```bash
 $ kubectl -n node-feature-discovery get ds,deploy
-NAME                         DESIRED   CURRENT   READY   UP-TO-DATE   AVAILABLE   NODE SELECTOR   AGE
-daemonset.apps/nfd-worker    2         2         2       2            2           <none>          10s
+NAME                                               DESIRED   CURRENT   READY   UP-TO-DATE   AVAILABLE   NODE SELECTOR   AGE
+daemonset.apps/nfd-node-feature-discovery-worker   2         2         2       2            2           <none>          20s
 
-NAME                         READY   UP-TO-DATE   AVAILABLE   AGE
-deployment.apps/nfd-master   1/1     1            1           17s
+NAME                                                READY   UP-TO-DATE   AVAILABLE   AGE
+deployment.apps/nfd-node-feature-discovery-gc       1/1     1            1           20s
+deployment.apps/nfd-node-feature-discovery-master   1/1     1            1           20s
 
 ```
 
@@ -78,8 +89,16 @@ feature-dependent-pod   1/1     Running   0          23s   10.36.0.4   node-2
 
 ### Deploy nfd-topology-updater
 
-To deploy nfd-topology-updater use the `topologyupdater` kustomize
-overlay.
+#### Deploy nfd-topology-updater with Helm
+
+```bash
+helm upgrade --install -n node-feature-discovery --create-namespace nfd {{ site.helm_oci_repo }} --version {{ site.helm_chart_version }} --set topologyUpdater.enable=true
+```
+
+#### Deploy nfd-topology-updater with Kustomize
+
+There's a separate overlay that deploys nfd-topology-updater in addition to the
+default NFD components.
 
 ```bash
 kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref={{ site.release }}"
@@ -91,9 +110,9 @@ Wait until nfd-topology-updater is running.
 
 ```bash
 $ kubectl -n node-feature-discovery get ds
-NAME                                  DESIRED   CURRENT   READY   UP-TO-DATE   AVAILABLE   NODE SELECTOR   AGE
-daemonset.apps/nfd-topology-updater   2         2         2       2            2           <none>          5s
-
+NAME                                                         DESIRED   CURRENT   READY   UP-TO-DATE   AVAILABLE   NODE SELECTOR   AGE
+daemonset.apps/nfd-node-feature-discovery-topology-updater   2         2         2       2            2           <none>          20s
+...
 ```
 
 Check that the NodeResourceTopology objects are created