1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2024-12-14 11:57:51 +00:00
Commit graph

19 commits

Author SHA1 Message Date
Markus Lehtonen
7c9943e634 docs: align docs with the single-dash command line flags
After moving to the flags package for command line argument parsing NFD
accepts command line arguments (flags) starting with a single dash (e.g.
-no-publish in addition to --no-publish). Even if double-dash can be
used the single-dash version is printed e.g. in the usage string (from
-h, -help) so align documentation with that.
2021-02-24 21:31:07 +02:00
Markus Lehtonen
3fd61eacdb nfd-worker: switch to flag in command line parsing 2021-02-24 12:06:16 +02:00
Markus Lehtonen
47033db9c1 nfd-master: use flag for command line parsing 2021-02-24 12:06:16 +02:00
Markus Lehtonen
d761bc4fcd docs: update documentation regarding configuration
Publish an incomplete version of the NFD Worker Configuration File
Reference, currently covering only the newly added 'core' configuration
flags.
2021-02-17 21:42:52 +02:00
Markus Lehtonen
7e88f00e05 nfd-worker: add core.sources config option
Add a config file option for controlling the enabled feature sources,
aimed at replacing the --sources command line flag which is now marked
as deprecated. The command line flag takes precedence over the config
file option.
2021-02-17 21:36:20 +02:00
Markus Lehtonen
ed177350fc nfd-worker: add core.labelWhiteList config option
Add a config file option for label whitelisting. Deprecate the
--label-whitelist command line flag. Note that the command line flag has
higher priority than the config file option.
2021-02-17 21:35:44 +02:00
Markus Lehtonen
d1d8de944e nfd-worker: add core.sleepInterval config option
Add a new config file option for (dynamically) controlling the sleep
interval. At the same time, deprecate the --sleep-interval command line
flag. The command line flag takes precedence over the config file option.
2021-02-17 21:35:13 +02:00
Markus Lehtonen
e52ec3480f nfd-master: implement --instance flag
This can be used to help running multiple parallel NFD deployments in
the same cluster. The flag changes the node annotation namespace to
<instance>.nfd.node.kubernetes.io allowing different nfd-master intances
to store metadata in separate annotations.
2021-02-10 13:48:31 +02:00
Kubernetes Prow Robot
83e2a9defb
Merge pull request #356 from marquiz/devel/sources-flag
nfd-worker: add special handling for --sources=all
2020-11-22 01:53:33 -08:00
Markus Lehtonen
40be2c7e0c docs: specify container image in config 2020-11-20 17:00:19 +02:00
Markus Lehtonen
29cbb2429c nfd-worker: add special handling for --sources=all
A new special value 'all' is a shortcut for enabling all feature
sources. It should be the only name specified -- if any other names are
specified 'all' does not take effect, but, we only enable the listed
feature sources. E.g.
  --sources=all enables all sources, but
  --sources=all,cpu only enables the cpu source

Also, print a warning if unknown sources are specified.
2020-11-20 16:23:53 +02:00
Markus Lehtonen
f3db20bdcb docs: support versioned links to gihub blobs
Make the links point to the blob from the release corresponding the
documentation.
2020-11-02 17:05:39 +02:00
Markus Lehtonen
18ffd2a06d docs: fix broken refs 2020-11-02 13:51:09 +02:00
Markus Lehtonen
f6669e7d66 docs: add todo/placeholder pages under advanced
Placeholders for content that will be added in the future. Do not
publish these virtually empty pages.
2020-10-29 14:08:16 +02:00
Markus Lehtonen
409ad01a1c docs: describe deployment using templates
Use the existing content as a base but with heave editing. Move local
examples involving make to the developers guide.

Drop the really hackish label-nodes.sh. Just replace it with command
line examples in the documentation. If somebody really is dying for this
write it from scratch and put under scripts/hack.
2020-10-29 14:08:16 +02:00
Markus Lehtonen
0c276b6298 docs: add instructions for working on documentation 2020-10-29 14:08:16 +02:00
Markus Lehtonen
6c0d6c9003 docs: add commandline references for nfd-master and nfd-worker 2020-10-29 14:08:16 +02:00
Markus Lehtonen
2469db839f docs: markdown style fixes
Fix markdown syntax and style for content that was moved from README.md
to docs/:
- get-started/introduction
- examples-and-demos
- get-started/features
- contributing

Unify the spelling of master and worker in headings and beginning of
senctences.

Also, env variable for container name in developers-guide.
2020-10-29 14:08:16 +02:00
Markus Lehtonen
a9d45c80ac README: move content over to docs/
Move all content from README.md to the Jekyll site under docs/. Also
re-organize it into multiple sub-pages.

Populate README with fresh content turning it into virtually a big link
to the html-based documentation site. Spiced up with super-quick-start
instructions.
2020-10-29 14:07:08 +02:00