Skip to content

Commit cdf94eb

Browse files
authored
Merge pull request #1718 from marquiz/devel/nfg-docs
docs: add more cross-references to NodeFeatureGroup API
2 parents dc52c50 + bec9297 commit cdf94eb

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

docs/usage/custom-resources.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,10 @@ spec:
7373
major: {op: Exists}
7474
```
7575
76+
NodeFeatureGroup API is an alpha feature and disabled by default in NFD version
77+
{{ site.version }}. For more details and examples see the
78+
[customization guide](customization-guide.md#nodefeaturegroup-custom-resource).
79+
7680
## NodeFeatureRule
7781
7882
NodeFeatureRule is an NFD-specific custom resource that is designed for

docs/usage/customization-guide.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,11 @@ to specify taints in the NodeFeatureRule object.
189189

190190
## NodeFeatureGroup custom resource
191191

192+
NodeFeatureGroup API is an alpha feature and disabled by default in NFD version
193+
{{ site.version }}. Use the
194+
[NodeFeatureAPI](../reference/feature-gates.md#nodefeaturegroupapi) feature
195+
gate to enable it.
196+
192197
`NodeFeatureGroup` objects provide a way to create node groups that share the
193198
same set of features. The `NodeFeatureGroup` object spec consists of a list of
194199
`NodeFeatureRule` that follow the same format as the `NodeFeatureRule`,

0 commit comments

Comments
 (0)