Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
Update the docs with explanations and examples
about the exclude-list feature.

Signed-off-by: Talor Itzhak <[email protected]>
  • Loading branch information
Tal-or committed Nov 15, 2022
1 parent 152035a commit c5d2c0b
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 2 deletions.
16 changes: 15 additions & 1 deletion docs/reference/topology-updater-commandline-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ To quickly view available command line flags execute `nfd-topology-updater -help
In a docker container:

```bash
docker run gcr.io/k8s-staging-nfd/node-feature-discovery:master nfd-topology-updater -help
docker run gcr.io/k8s-staging-nfd/node-feature-discovery:master \
nfd-topology-updater -help
```

### -h, -help
Expand All @@ -32,6 +33,19 @@ Print usage and exit.

Print version and exit.

### -config

The `-config` flag specifies the path of the nfd-topology-updater
configuration file to use.

Default: /etc/kubernetes/node-feature-discovery/nfd-topology-updater.conf

Example:

```bash
nfd-topology-updater -config=/opt/nfd/nfd-topology-updater.conf
```

### -server

The `-server` flag specifies the address of the nfd-master endpoint where to
Expand Down
38 changes: 38 additions & 0 deletions docs/reference/topology-updater-configuration-reference.md
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]
```
6 changes: 5 additions & 1 deletion docs/usage/nfd-topology-updater.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,9 @@ When run as a daemonset, nodes are re-examined for the allocated resources
(to determine the information of the allocatable resources on a per zone basis
where a zone can be a NUMA node) at an interval specified using the
[`-sleep-interval`](../reference/topology-updater-commandline-reference.html#-sleep-interval)
option. The default sleep interval is set to 60s which is the the value when no
option. The default sleep interval is set to 60s which is the value when no
-sleep-interval is specified.
In addition, it can avoid examined specific allocated resources
given a configuration of resources to exclude via [`-config`](../reference/topology-updater-commandline-reference.html#-config)


0 comments on commit c5d2c0b

Please sign in to comment.