Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add more cross-references to NodeFeatureGroup API #1718

Merged
merged 1 commit into from
May 27, 2024
Merged

docs: add more cross-references to NodeFeatureGroup API #1718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/usage/custom-resources.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions docs/usage/customization-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`,
Expand Down