-
Notifications
You must be signed in to change notification settings - Fork 249
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update the docs with explanations and examples about the exclude-list feature. Signed-off-by: Talor Itzhak <[email protected]>
- Loading branch information
Showing
3 changed files
with
58 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
38 changes: 38 additions & 0 deletions
38
docs/reference/topology-updater-configuration-reference.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
title: "Topology-Updater config reference" | ||
layout: default | ||
sort: 3 | ||
--- | ||
|
||
# Configuration file reference of nfd-topology-updater | ||
{: .no_toc} | ||
|
||
## Table of contents | ||
{: .no_toc .text-delta} | ||
|
||
1. TOC | ||
{:toc} | ||
|
||
--- | ||
|
||
See the | ||
[sample configuration file](https://github.com/kubernetes-sigs/node-feature-discovery/blob/{{site.release}}/deployment/components/topology-updater-config/nfd-topology-updater.conf.example) | ||
for a full example configuration. | ||
|
||
## excludeList | ||
|
||
The `excludeList` specifies a key-value map of allocated resources that should not be examined by the topology-updater | ||
agent per node. | ||
Each key is a node name with a value as a list of resources | ||
that should not be examined by the agent for that specific node. | ||
|
||
### excludeList.* | ||
`excludeList.*` is a special value that use to specify all nodes. | ||
A resource that would be listed under this key, would be excluded from all nodes. | ||
|
||
Example: | ||
|
||
```yaml | ||
excludeList: | ||
*: [hugepages-2Mi] | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters