Update documentation about hooks depreciation

Signed-off-by: Feruzjon Muyassarov <[email protected]>
kubernetes-sigs · Aug 24, 2022 · 1fa9ee3 · 1fa9ee3
1 parent 0379d07
commit 1fa9ee3
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/docs/advanced/customization-guide.md b/docs/advanced/customization-guide.md
@@ -153,6 +153,16 @@ should be placed in a separate directory in order to avoid NFD unnecessarily
 trying to execute them. A subdirectory under the hooks directory can be used,
 for example `/etc/kubernetes/node-feature-discovery/source.d/conf/`.
 
+**NOTE:** Hooks are being DEPRECATED and will be removed in the future releases.
+For backward compatibility, currently hooks are enabled by default and can be
+disabled via `sources.local.hooksEnabled` field in the worker configuration.
+
+```yaml
+sources:
+  local:
+    hooksEnabled: true  # true by default at this point
+```
+
 **NOTE:** NFD will blindly run any executables placed/mounted in the hooks
 directory. It is the user's responsibility to review the hooks for e.g.
 possible security implications.

diff --git a/docs/advanced/worker-configuration-reference.md b/docs/advanced/worker-configuration-reference.md
@@ -329,6 +329,23 @@ sources:
     configOpts: [NO_HZ, X86, DMI]
 ```
 
+### sources.local
+
+### sources.local.hooksEnabled
+
+Configuration option to disable/enable hooks execution. Enabled by default.
+Hooks are DEPRECATED since v0.12.0 release and support will be removed in a
+future release. Use [feature files](./customization-guide.md#feature-files)
+instead.
+
+Example:
+
+```yaml
+sources:
+  local:
+    hooksEnabled: true  # true by default
+```
+
 ### soures.pci
 
 #### soures.pci.deviceClassWhitelist