From 809520809e2777d5f16cee68602fb37f06db6ab5 Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Mon, 29 Jan 2024 11:11:40 +0200 Subject: [PATCH] docs: document removal of hooks in v0.17 --- .../worker-configuration-reference.md | 14 ++++++-------- docs/usage/customization-guide.md | 19 +++++++++++-------- 2 files changed, 17 insertions(+), 16 deletions(-) diff --git a/docs/reference/worker-configuration-reference.md b/docs/reference/worker-configuration-reference.md index 59c0384ae1..6fc786132c 100644 --- a/docs/reference/worker-configuration-reference.md +++ b/docs/reference/worker-configuration-reference.md @@ -331,21 +331,19 @@ sources: ### 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 +**DEPRECATED**: Hooks are DEPRECATED since v0.12.0 release and support (and +this configuration option) will be removed in NFD v0.17. Use [feature files](../usage//customization-guide.md#feature-files) instead. +Configuration option to disable/enable hooks execution. Disabled by default. + > **NOTE:** The default NFD container image only supports statically linked > binaries. Use the [full](../deployment/image-variants.md#full) image variant > for a slightly more extensive environment that additionally supports bash and > perl runtimes. -Related tracking issues: - -1. Config option to disable hooks [#859](https://github.com/kubernetes-sigs/node-feature-discovery/issues/859). -1. Disable hook support by default [#855](https://github.com/kubernetes-sigs/node-feature-discovery/issues/855). -1. Drop support for hooks [#856](https://github.com/kubernetes-sigs/node-feature-discovery/issues/856). +GitHub tracking issue: +[Drop support for hooks (#856)](https://github.com/kubernetes-sigs/node-feature-discovery/issues/856). Default: false diff --git a/docs/usage/customization-guide.md b/docs/usage/customization-guide.md index 86be11269a..6fecdb8055 100644 --- a/docs/usage/customization-guide.md +++ b/docs/usage/customization-guide.md @@ -193,10 +193,10 @@ extensions, allowing the creation of new user-specific features and even overriding built-in labels. The `local` feature source has two methods for detecting features, feature -files and hooks (deprecated). The features discovered by the `local` source can -further be used in label rules specified in -[`NodeFeatureRule`](#nodefeaturerule-custom-resource) objects and the -[`custom`](#custom-feature-source) feature source. +files and hooks (hooks are deprecated and slated for removal in NFD v0.17). The +features discovered by the `local` source can further be used in label rules +specified in [`NodeFeatureRule`](#nodefeaturerule-custom-resource) objects and +the [`custom`](#custom-feature-source) feature source. > **NOTE:** Be careful when creating and/or updating hook or feature files > while NFD is running. To avoid race conditions you should write @@ -236,7 +236,10 @@ and translated into node labels, see the [input format below](#input-format). ### Hooks -**DEPRECATED** The `local` source executes hooks found in +**DEPRECATED** Hooks are deprecated and will be completely removed in NFD +v0.17. + +The `local` source executes hooks found in `/etc/kubernetes/node-feature-discovery/source.d/`. The hook files must be executable and they are supposed to print all discovered features in `stdout`. Since NFD v0.13 the default container image only supports statically linked ELF @@ -251,9 +254,9 @@ should be placed in a separate directory 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 a future release. -> Starting from release v0.14 hooks are disabled by default and can be enabled -> via `sources.local.hooksEnabled` field in the worker configuration. +> **NOTE:** Starting from release v0.14 hooks are disabled by default and can +> be enabled via `sources.local.hooksEnabled` field in the worker +> configuration. ```yaml sources: