From bec9297fe7253e3086b13cdf2940b6cdb025e721 Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Mon, 27 May 2024 13:41:15 +0300 Subject: [PATCH] docs: add more cross-references to NodeFeatureGroup API --- docs/usage/custom-resources.md | 4 ++++ docs/usage/customization-guide.md | 5 +++++ 2 files changed, 9 insertions(+) diff --git a/docs/usage/custom-resources.md b/docs/usage/custom-resources.md index 09b730ab6b..5508d79798 100644 --- a/docs/usage/custom-resources.md +++ b/docs/usage/custom-resources.md @@ -73,6 +73,10 @@ spec: major: {op: Exists} ``` +NodeFeatureGroup API is an alpha feature and disabled by default in NFD version +{{ site.version }}. For more details and examples see the +[customization guide](customization-guide.md#nodefeaturegroup-custom-resource). + ## NodeFeatureRule NodeFeatureRule is an NFD-specific custom resource that is designed for diff --git a/docs/usage/customization-guide.md b/docs/usage/customization-guide.md index f4be9a7012..f8379bc057 100644 --- a/docs/usage/customization-guide.md +++ b/docs/usage/customization-guide.md @@ -189,6 +189,11 @@ to specify taints in the NodeFeatureRule object. ## NodeFeatureGroup custom resource +NodeFeatureGroup API is an alpha feature and disabled by default in NFD version +{{ site.version }}. Use the +[NodeFeatureAPI](../reference/feature-gates.md#nodefeaturegroupapi) feature +gate to enable it. + `NodeFeatureGroup` objects provide a way to create node groups that share the same set of features. The `NodeFeatureGroup` object spec consists of a list of `NodeFeatureRule` that follow the same format as the `NodeFeatureRule`,