</code></pre></div></div><h3id="-h-help">-h, –help</h3><p>Print usage and exit.</p><h3id="version">–version</h3><p>Print version and exit.</p><h3id="config">–config</h3><p>The <codeclass="language-plaintext highlighter-rouge notranslate">--config</code> flag specifies the path of the nfd-worker configuration file to use.</p><p>Default: /etc/kubernetes/node-feature-discovery/nfd-worker.conf</p><p>Example:</p><divclass="language-bash highlighter-rouge notranslate"><divclass="highlight"><preclass="highlight"><code>nfd-worker <spanclass="nt">--config</span><spanclass="o">=</span>/opt/nfd/worker.conf
</code></pre></div></div><h3id="options">–options</h3><p>The <codeclass="language-plaintext highlighter-rouge notranslate">--options</code> flag may be used to specify and override configuration file options directly from the command line. The required format is the same as in the config file i.e. JSON or YAML. Configuration options specified via this flag will override those from the configuration file:</p><p>Default: <em>empty</em></p><p>Example:</p><divclass="language-bash highlighter-rouge notranslate"><divclass="highlight"><preclass="highlight"><code>nfd-worker <spanclass="nt">--options</span><spanclass="o">=</span><spanclass="s1">'{"sources":{"cpu":{"cpuid":{"attributeWhitelist":["AVX","AVX2"]}}}}'</span>
</code></pre></div></div><h3id="server">–server</h3><p>The <codeclass="language-plaintext highlighter-rouge notranslate">--server</code> flag specifies the address of the nfd-master endpoint where to connect to.</p><p>Default: localhost:8080</p><p>Example:</p><divclass="language-bash highlighter-rouge notranslate"><divclass="highlight"><preclass="highlight"><code>nfd-worker <spanclass="nt">--server</span><spanclass="o">=</span>nfd-master.nfd.svc.cluster.local:443
</code></pre></div></div><h3id="ca-file">–ca-file</h3><p>The <codeclass="language-plaintext highlighter-rouge notranslate">--ca-file</code> is one of the three flags (together with <codeclass="language-plaintext highlighter-rouge notranslate">--cert-file</code> and <codeclass="language-plaintext highlighter-rouge notranslate">--key-file</code>) controlling the mutual TLS authentication on the worker side. This flag specifies the TLS root certificate that is used for verifying the authenticity of nfd-master.</p><p>Default: <em>empty</em></p><p>Note: Must be specified together with <codeclass="language-plaintext highlighter-rouge notranslate">--cert-file</code> and <codeclass="language-plaintext highlighter-rouge notranslate">--key-file</code></p><p>Example:</p><divclass="language-bash highlighter-rouge notranslate"><divclass="highlight"><preclass="highlight"><code>nfd-worker <spanclass="nt">--ca-file</span><spanclass="o">=</span>/opt/nfd/ca.crt <spanclass="nt">--cert-file</span><spanclass="o">=</span>/opt/nfd/worker.crt <spanclass="nt">--key-file</span><spanclass="o">=</span>/opt/nfd/worker.key
</code></pre></div></div><h3id="cert-file">–cert-file</h3><p>The <codeclass="language-plaintext highlighter-rouge notranslate">--cert-file</code> is one of the three flags (together with <codeclass="language-plaintext highlighter-rouge notranslate">--ca-file</code> and <codeclass="language-plaintext highlighter-rouge notranslate">--key-file</code>) controlling mutual TLS authentication on the worker side. This flag specifies the TLS certificate presented for authenticating outgoing requests.</p><p>Default: <em>empty</em></p><p>Note: Must be specified together with <codeclass="language-plaintext highlighter-rouge notranslate">--ca-file</code> and <codeclass="language-plaintext highlighter-rouge notranslate">--key-file</code></p><p>Example:</p><divclass="language-bash highlighter-rouge notranslate"><divclass="highlight"><preclass="highlight"><code>nfd-workerr <spanclass="nt">--cert-file</span><spanclass="o">=</span>/opt/nfd/worker.crt <spanclass="nt">--key-file</span><spanclass="o">=</span>/opt/nfd/worker.key <spanclass="nt">--ca-file</span><spanclass="o">=</span>/opt/nfd/ca.crt
</code></pre></div></div><h3id="key-file">–key-file</h3><p>The <codeclass="language-plaintext highlighter-rouge notranslate">--key-file</code> is one of the three flags (together with <codeclass="language-plaintext highlighter-rouge notranslate">--ca-file</code> and <codeclass="language-plaintext highlighter-rouge notranslate">--cert-file</code>) controlling the mutual TLS authentication on the worker side. This flag specifies the private key corresponding the given certificate file (<codeclass="language-plaintext highlighter-rouge notranslate">--cert-file</code>) that is used for authenticating outgoing requests.</p><p>Default: <em>empty</em></p><p>Note: Must be specified together with <codeclass="language-plaintext highlighter-rouge notranslate">--cert-file</code> and <codeclass="language-plaintext highlighter-rouge notranslate">--ca-file</code></p><p>Example:</p><divclass="language-bash highlighter-rouge notranslate"><divclass="highlight"><preclass="highlight"><code>nfd-worker <spanclass="nt">--key-file</span><spanclass="o">=</span>/opt/nfd/worker.key <spanclass="nt">--cert-file</span><spanclass="o">=</span>/opt/nfd/worker.crt <spanclass="nt">--ca-file</span><spanclass="o">=</span>/opt/nfd/ca.crt
</code></pre></div></div><h3id="server-name-override">–server-name-override</h3><p>The <codeclass="language-plaintext highlighter-rouge notranslate">--server-name-override</code> flag specifies the common name (CN) which to expect from the nfd-master TLS certificate. This flag is mostly intended for development and debugging purposes.</p><p>Default: <em>empty</em></p><p>Example:</p><divclass="language-bash highlighter-rouge notranslate"><divclass="highlight"><preclass="highlight"><code>nfd-worker <spanclass="nt">--server-name-override</span><spanclass="o">=</span>localhost
</code></pre></div></div><h3id="sources">–sources</h3><p>The <codeclass="language-plaintext highlighter-rouge notranslate">--sources</code> flag specifies a comma-separated list of enabled feature sources. A special value <codeclass="language-plaintext highlighter-rouge notranslate">all</code> enables all feature sources.</p><p>Note: This flag takes precedence over the <codeclass="language-plaintext highlighter-rouge notranslate">core.sources</code> configuration file option.</p><p>Default: all</p><p>Example:</p><divclass="language-bash highlighter-rouge notranslate"><divclass="highlight"><preclass="highlight"><code>nfd-worker <spanclass="nt">--sources</span><spanclass="o">=</span>kernel,system,local
</code></pre></div></div><p><strong>DEPRECATED</strong>: you should use the <codeclass="language-plaintext highlighter-rouge notranslate">core.sources</code> option in the configuration file, instead.</p><h3id="no-publish">–no-publish</h3><p>The <codeclass="language-plaintext highlighter-rouge notranslate">--no-publish</code> flag disables all communication with the nfd-master, making it a "dry-run" flag for nfd-worker. NFD-Worker runs feature detection normally, but no labeling requests are sent to nfd-master.</p><p>Default: <em>false</em></p><p>Example:</p><divclass="language-bash highlighter-rouge notranslate"><divclass="highlight"><preclass="highlight"><code>nfd-worker <spanclass="nt">--no-publish</span>
</code></pre></div></div><h3id="label-whitelist">–label-whitelist</h3><p>The <codeclass="language-plaintext highlighter-rouge notranslate">--label-whitelist</code> specifies a regular expression for filtering feature labels based on their name. Each label must match against the given reqular expression in order to be published.</p><p>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 namespace is omitted.</p><p>Note: This flag takes precedence over the <codeclass="language-plaintext highlighter-rouge notranslate">core.labelWhiteList</code> configuration file option.</p><p>Default: <em>empty</em></p><p>Example:</p><divclass="language-bash highlighter-rouge notranslate"><divclass="highlight"><preclass="highlight"><code>nfd-worker <spanclass="nt">--label-whitelist</span><spanclass="o">=</span><spanclass="s1">'.*cpuid\.'</span>
</code></pre></div></div><p><strong>DEPRECATED</strong>: you should use the <codeclass="language-plaintext highlighter-rouge notranslate">core.labelWhiteList</code> option in the configuration file, instead.</p><h3id="oneshot">–oneshot</h3><p>The <codeclass="language-plaintext highlighter-rouge notranslate">--oneshot</code> flag causes nfd-worker to exit after one pass of feature detection.</p><p>Default: <em>false</em></p><p>Example:</p><divclass="language-bash highlighter-rouge notranslate"><divclass="highlight"><preclass="highlight"><code>nfd-worker <spanclass="nt">--oneshot</span><spanclass="nt">--no-publish</span>
</code></pre></div></div><h3id="sleep-interval">–sleep-interval</h3><p>The <codeclass="language-plaintext highlighter-rouge notranslate">--sleep-interval</code> specifies the interval between feature re-detection (and node re-labeling). A non-positive value implies infinite sleep interval, i.e. no re-detection or re-labeling is done.</p><p>Note: This flag takes precedence over the <codeclass="language-plaintext highlighter-rouge notranslate">core.sleepInterval</code> configuration file option.</p><p>Default: 60s</p><p>Example:</p><divclass="language-bash highlighter-rouge notranslate"><divclass="highlight"><preclass="highlight"><code>nfd-worker <spanclass="nt">--sleep-interval</span><spanclass="o">=</span>1h
</code></pre></div></div><p><strong>DEPRECATED</strong>: you should use the <codeclass="language-plaintext highlighter-rouge notranslate">core.sleepInterval</code> option in the configuration file, instead.</p></div></div><divclass="navigation-bottom d-flex flex-justify-between py-3"role="navigation"aria-label="footer navigation"><divclass="prev"><ahref="/node-feature-discovery/master/advanced/master-commandline-reference.html"class="btn"title="Master Cmdline Reference"accesskey="p"rel="prev"><iclass="fa fa-arrow-circle-left"></i> Previous </a></div><divclass="next"><ahref="/node-feature-discovery/master/advanced/worker-configuration-reference.html"class="btn"title="Worker Config Reference"accesskey="n"rel="next"> Next <iclass="fa fa-arrow-circle-right"></i></a></div></div><hr><divclass="copyright text-center text-gray"role="contentinfo"><iclass="fa fa-copyright"></i><spanclass="time">2016-2021,</span><aclass="text-gray"href="https://github.com/kubernetes-sigs"rel="noreferrer"target="_blank">Kubernetes SIGs</a> Revision <aclass="text-gray"href="https://github.com/kubernetes-sigs/node-feature-discovery/commit/"title=""rel="noreferrer"target="_blank"></a><br><divclass="generator"> Built with <ahref="https://jekyllrb.com"rel="noreferrer"target="_blank">Jekyll</a> using a <ahref="https://github.com/rundocs/jekyll-rtd-theme"rel="noreferrer"target="_blank"title="remote theme: jekyll-rtd-theme v2.0.9">theme</a> provided by <ahref="https://rundocs.io"rel="noreferrer"target="_blank">RunDocs</a>. </div></div></div></div><divclass="addons-wrap d-flex flex-column overflow-y-auto"><divclass="status d-flex flex-justify-between p-2"><divclass="title p-1"><iclass="fa fa-book"></i> Node Feature Discovery </div><divclass="branch p-1"><spanclass="name"> master </span><iclass="fa fa-caret-down"></i></div></div><divclass="addons d-flex flex-column height-full p-2 d-none"><dlid="versions"><dt>Versions</dt><scriptsrc="/node-feature-discovery/versions.js"></script><script>vardt=document.getElementById('versions');varitems=getVersionListItems();for(vari=0;i<items.length;i++){vardd=document.createElement('dd');vara=dd.appendChild(document.createElement('a'));a.appendChild(document.createTextNode(items[i].name));a.href=items[i].url;dt.appendChild(dd);}</script></dl><dl><dt>GitHub</dt><dd><ahref="https://github.com/kubernetes-sigs/node-feature-discovery"title="Stars: 257"><iclass="fa fa-github"></i> Homepage </a></dd><dd><ahref="https://github.com/kubernetes-sigs/node-feature-discovery/issues"title="Open issues: 15"><iclass="fa fa-question-circle-o"></i> Issues </a></dd><dd><ahref="https://github.com/kubernetes-sigs/node-feature-discovery/zipball/gh-pages"title="Size: 78876 Kb"><iclass="fa fa-download"></i> Download </a></dd></dl><hr><divclass="license f6 pb-2"> The <ahref="/node-feature-discovery/master/">software</a> is under the terms of <ahref="https://github.com/kubernetes-sigs/node-feature-discovery">Apache License 2.0</a>. </div></div></div><script>window.ui={title:"Node Feature Discovery",baseurl:"/node-feature-discovery/master",i18n:{search_results:"Search Results",search_results_found:"Search finished, found # page(s) matching the search query.",search_results_not_found:"Your search did not match any documents, please make sure that all characters are spelled correctly!"}};</script><scriptsrc="https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme@2.0.9/assets/js/jquery.min.js"></script><scriptsrc="https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme@2.0.9/assets/js/theme.min.js"></script></body></html>
