4 KiB
| title | layout | sort |
|---|---|---|
| Worker config reference | default | 4 |
Configuration file reference of nfd-worker
{: .no_toc }
Table of contents
{: .no_toc .text-delta }
WORK IN PROGRESS.
- TOC {:toc}
See the sample configuration file for a full example configuration.
core
The core section contains common configuration settings that are not specific
to any particular feature source.
core.sleepInterval
core.sleepInterval specifies the interval between consecutive passes of
feature (re-)detection, and thus also the interval between node re-labeling. A
non-positive value implies infinite sleep interval, i.e. no re-detection or
re-labeling is done.
Note: Overridden by the deprecated --sleep-interval command line flag (if
specified).
Default: 60s
Example:
core:
sleepInterval: 60s
core.sources
core.sources specifies the list of enabled feature sources. A special value
all enables all feature sources.
Note: Overridden by the deprecated --sources command line flag (if
specified).
Default: [all]
Example:
core:
sources:
- system
- custom
core.labelWhiteList
core.labelWhiteList specifies a regular expression for filtering feature
labels based on the label name. Non-matching labels are not published.
Note: The regular expression is only matches against the "basename" part of the label, i.e. to the part of the name after '/'. The label prefix (or namespace) is omitted.
Note: Overridden by the deprecated --label-whitelist command line flag (if
specified).
Default: null
Example:
core:
labelWhiteList: '^cpu-cpuid'
core.noPublish
Setting core.noPublish to true disables all communication with the
nfd-master. It is effectively a "dry-run" flag: nfd-worker runs feature
detection normally, but no labeling requests are sent to nfd-master.
Note: Overridden by the --no-publish command line flag (if specified).
Default: false
Example:
core:
noPublish: true
core.klog
The following options specify the logger configuration. Most of which can be dynamically adjusted at run-time.
Note: The logger options can also be specified via command line flags which take precedence over any corresponding config file options.
core.klog.addDirHeader
If true, adds the file directory to the header of the log messages.
Default: false
Run-time configurable: yes
core.klog.alsologtostderr
Log to standard error as well as files.
Default: false
Run-time configurable: yes
core.klog.logBacktraceAt
When logging hits line file:N, emit a stack trace.
Default: empty
Run-time configurable: yes
core.klog.logDir
If non-empty, write log files in this directory.
Default: empty
Run-time configurable: no
core.klog.logFile
If non-empty, use this log file.
Default: empty
Run-time configurable: no
core.klog.logFileMaxSize
Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited.
Default: 1800
Run-time configurable: no
core.klog.logtostderr
Log to standard error instead of files
Default: true
Run-time configurable: yes
core.klog.skipHeaders
If true, avoid header prefixes in the log messages.
Default: false
Run-time configurable: yes
core.klog.skipLogHeaders
If true, avoid headers when opening log files.
Default: false
Run-time configurable: no
core.klog.stderrthreshold
Logs at or above this threshold go to stderr (default 2)
Run-time configurable: yes
core.klog.v
Number for the log level verbosity.
Default: 0
Run-time configurable: yes
core.klog.vmodule
Comma-separated list of pattern=N settings for file-filtered logging.
Default: empty
Run-time configurable: yes
sources
The sources section contains feature source specific configuration parameters.