Skip to content

Commit 856b174

Browse files
authored
Merge pull request #1573 from marquiz/devel/docs-hooks
docs: document removal of hooks in v0.17
2 parents e3d5b92 + 8095208 commit 856b174

File tree

2 files changed

+17
-16
lines changed

2 files changed

+17
-16
lines changed

docs/reference/worker-configuration-reference.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -331,21 +331,19 @@ sources:
331331

332332
### sources.local.hooksEnabled
333333

334-
Configuration option to disable/enable hooks execution. Enabled by default.
335-
Hooks are DEPRECATED since v0.12.0 release and support will be removed in a
336-
future release. Use
334+
**DEPRECATED**: Hooks are DEPRECATED since v0.12.0 release and support (and
335+
this configuration option) will be removed in NFD v0.17. Use
337336
[feature files](../usage//customization-guide.md#feature-files) instead.
338337

338+
Configuration option to disable/enable hooks execution. Disabled by default.
339+
339340
> **NOTE:** The default NFD container image only supports statically linked
340341
> binaries. Use the [full](../deployment/image-variants.md#full) image variant
341342
> for a slightly more extensive environment that additionally supports bash and
342343
> perl runtimes.
343344

344-
Related tracking issues:
345-
346-
1. Config option to disable hooks [#859](https://github.com/kubernetes-sigs/node-feature-discovery/issues/859).
347-
1. Disable hook support by default [#855](https://github.com/kubernetes-sigs/node-feature-discovery/issues/855).
348-
1. Drop support for hooks [#856](https://github.com/kubernetes-sigs/node-feature-discovery/issues/856).
345+
GitHub tracking issue:
346+
[Drop support for hooks (#856)](https://github.com/kubernetes-sigs/node-feature-discovery/issues/856).
349347

350348
Default: false
351349

docs/usage/customization-guide.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -193,10 +193,10 @@ extensions, allowing the creation of new user-specific features and even
193193
overriding built-in labels.
194194

195195
The `local` feature source has two methods for detecting features, feature
196-
files and hooks (deprecated). The features discovered by the `local` source can
197-
further be used in label rules specified in
198-
[`NodeFeatureRule`](#nodefeaturerule-custom-resource) objects and the
199-
[`custom`](#custom-feature-source) feature source.
196+
files and hooks (hooks are deprecated and slated for removal in NFD v0.17). The
197+
features discovered by the `local` source can further be used in label rules
198+
specified in [`NodeFeatureRule`](#nodefeaturerule-custom-resource) objects and
199+
the [`custom`](#custom-feature-source) feature source.
200200

201201
> **NOTE:** Be careful when creating and/or updating hook or feature files
202202
> 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).
236236

237237
### Hooks
238238

239-
**DEPRECATED** The `local` source executes hooks found in
239+
**DEPRECATED** Hooks are deprecated and will be completely removed in NFD
240+
v0.17.
241+
242+
The `local` source executes hooks found in
240243
`/etc/kubernetes/node-feature-discovery/source.d/`. The hook files must be
241244
executable and they are supposed to print all discovered features in `stdout`.
242245
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
251254
trying to execute them. A subdirectory under the hooks directory can be used,
252255
for example `/etc/kubernetes/node-feature-discovery/source.d/conf/`.
253256

254-
> **NOTE:** Hooks are being DEPRECATED and will be removed in a future release.
255-
> Starting from release v0.14 hooks are disabled by default and can be enabled
256-
> via `sources.local.hooksEnabled` field in the worker configuration.
257+
> **NOTE:** Starting from release v0.14 hooks are disabled by default and can
258+
> be enabled via `sources.local.hooksEnabled` field in the worker
259+
> configuration.
257260

258261
```yaml
259262
sources:

0 commit comments

Comments
 (0)