mirrors/node-feature-discovery
mirrors/node-feature-discovery
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2025-03-28 10:47:23 +00:00
Code Activity

docs: document removal of hooks in v0.17

Browse source
This commit is contained in:
Markus Lehtonen 2024-01-29 11:11:40 +02:00
parent 5c99ae8343
commit 809520809e
2 changed files with 17 additions and 16 deletions

14
docs/reference/worker-configuration-reference.md
View file

@ -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

19
docs/usage/customization-guide.md
View file

@ -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: