mirror of
https://github.com/kubernetes-sigs/node-feature-discovery.git
synced 2025-03-06 16:57:10 +00:00
11 lines
No EOL
20 KiB
HTML
11 lines
No EOL
20 KiB
HTML
<!DOCTYPE html> <html lang="en" dir="auto"> <head><meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no"> <meta name="description" content="NFD-Worker Configuration File Reference Table of contents WORK IN PROGRESS. NFD-Worker Configuration File Reference core core.sleepInterval core.so..."> <meta name="revised" content=""> <meta name="author" content="Kubernetes SIGs"> <meta name="generator" content="jekyll-rtd-theme v2.0.9"> <meta property="og:title" content="Worker Config Reference · Node Feature Discovery"> <meta property="og:description" content="NFD-Worker Configuration File Reference Table of contents WORK IN PROGRESS. NFD-Worker Configuration File Reference core core.sleepInterval core.so..."> <meta property="og:locale" content="en"> <meta property="og:url" content="https://kubernetes-sigs.github.com/node-feature-discovery/master/advanced/worker-configuration-reference.html"> <meta property="og:type" content="article"> <meta property="article:author" content="Kubernetes SIGs"> <meta property="article:published_time" content="2016-07-23T00:07:52-05:00"> <meta property="article:modified_time" content="2021-03-01T10:19:51-06:00"> <meta name="twitter:title" content="Worker Config Reference · Node Feature Discovery"> <meta name="twitter:description" content="NFD-Worker Configuration File Reference Table of contents WORK IN PROGRESS. NFD-Worker Configuration File Reference core core.sleepInterval core.so..."> <meta name="twitter:card" content="summary"> <meta name="twitter:site" content="@Kubernetes SIGs"> <meta name="twitter:url" content="https://kubernetes-sigs.github.com/node-feature-discovery/master/advanced/worker-configuration-reference.html"> <meta name="twitter:creator" content="@jekyll-rtd-theme v2.0.9"> <title>Worker Config Reference · Node Feature Discovery</title> <link rel="dns-prefetch" href="https://rundocs-analytics.glitch.me"> <link rel="dns-prefetch" href="https://cdn.jsdelivr.net"> <link rel="canonical" href="https://kubernetes-sigs.github.com/node-feature-discovery/master/advanced/worker-configuration-reference.html"><link rel="prev" href="https://kubernetes-sigs.github.com/node-feature-discovery/master/advanced/worker-commandline-reference.html"> <link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme@2.0.9/assets/css/theme.min.css"> <link rel="icon" type="image/svg+xml" href="/node-feature-discovery/master/assets/images/favicon.svg"> <link rel="icon" type="image/png" href="/node-feature-discovery/master/assets/images/favicon-16x16.png" sizes="16x16"> <link rel="icon" type="image/png" href="/node-feature-discovery/master/assets/images/favicon-32x32.png" sizes="32x32"> <link rel="icon" type="image/png" href="/node-feature-discovery/master/assets/images/favicon-96x96.png" sizes="96x96"> <link rel="mask-icon" href="/node-feature-discovery/master/assets/images/favicon.svg" color="#2980b9"> <link rel="apple-touch-icon" href="/node-feature-discovery/master/assets/images/apple-touch-icon-300x300.jpg"> <script type="application/ld+json"> { "@context": "https://schema.org", "@type": "Article", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://kubernetes-sigs.github.com/node-feature-discovery/master/advanced/worker-configuration-reference.html" }, "headline": "Worker Config Reference · Node Feature Discovery", "image": [], "author": { "@type": "Person", "name": "Kubernetes SIGs" }, "datePublished": "2016-07-23T00:07:52-05:00", "dateModified": "2021-03-01T10:19:51-06:00", "publisher": { "@type": "Organization", "name": "Kubernetes SIGs", "logo": { "@type": "ImageObject", "url": "https://avatars.githubusercontent.com/u/36015203?v=4" } }, "description": "NFD-Worker Configuration File Reference Table of contents WORK IN PROGRESS. NFD-Worker Configuration File Reference core core.sleepInterval core.so..." } </script> </head> <body class="container"><div class="sidebar-wrap overflow-hidden"> <div class="sidebar height-full overflow-y-scroll overflow-x-hidden"> <div class="header d-flex flex-column p-3 text-center"> <div class="title pb-1"> <a class="h4 no-underline py-1 px-2 rounded-1" href="/node-feature-discovery/master/" title="Documentation of Node Feature Discovery - a Kubernetes add-on for discovering and advertising hardware features and system configuration in the cluster."> <i class="fa fa-home"></i> Node Feature Discovery </a> </div> <span class="version">master</span> <form class="search pt-2" action="/node-feature-discovery/master/search.html" method="get" autocomplete="off"> <input class="form-control input-block input-sm" type="text" name="q" placeholder="Search docs..."> </form> </div> <div class="toctree py-2" data-spy="affix" role="navigation" aria-label="main navigation"> <ul> </ul> <a class="caption d-block text-uppercase no-wrap px-2 py-0" href="/node-feature-discovery/master/get-started/"> Get started </a><ul> <li class="toc level-1 " data-sort="1" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/master/get-started/introduction.html">1. Introduction</a> </li> <li class="toc level-1 " data-sort="2" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/master/get-started/quick-start.html">2. Quick Start</a> </li> <li class="toc level-1 " data-sort="3" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/master/get-started/deployment-and-usage.html">3. Deployment and Usage</a> </li> <li class="toc level-1 " data-sort="4" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/master/get-started/features.html">4. Feature Discovery</a> </li> <li class="toc level-1 " data-sort="5" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/master/get-started/examples-and-demos.html">5. Examples and Demos</a> </li></ul> <a class="caption d-block text-uppercase no-wrap px-2 py-0" href="/node-feature-discovery/master/advanced/"> Advanced </a><ul> <li class="toc level-1 " data-sort="1" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/master/advanced/developer-guide.html">1. Developer Guide</a> </li> <li class="toc level-1 " data-sort="2" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/master/advanced/master-commandline-reference.html">2. Master Cmdline Reference</a> </li> <li class="toc level-1 " data-sort="3" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/master/advanced/worker-commandline-reference.html">3. Worker Cmdline Reference</a> </li> <li class="toc level-1 current" data-sort="4" data-level="1"> <a class="d-flex flex-items-baseline current" href="/node-feature-discovery/master/advanced/worker-configuration-reference.html">4. Worker Config Reference</a> </li></ul> <a class="caption d-block text-uppercase no-wrap px-2 py-0" href="/node-feature-discovery/master/contributing/"> Contributing </a><ul> </ul> </div> </div> </div> <div class="content-wrap"> <div class="header d-flex flex-justify-between p-2 hide-lg hide-xl" aria-label="top navigation"> <button id="toggle" class="btn-octicon p-2 m-0 text-white" type="button"> <i class="fa fa-bars"></i> </button> <div class="title flex-1 d-flex flex-justify-center"> <a class="h4 no-underline py-1 px-2 rounded-1" href="/node-feature-discovery/master/">Node Feature Discovery</a> </div> </div> <div class="content p-3 p-sm-5"> <div class="navigation-top d-flex flex-justify-between"> <ul class="breadcrumb" role="navigation" aria-label="breadcrumbs navigation"> <li class="breadcrumb-item"> <a class="no-underline" href="/node-feature-discovery/master/" title="/"> <i class="fa fa-home"></i> </a> </li><li class="breadcrumb-item" ><a href="/node-feature-discovery/master/advanced/">advanced</a></li><li class="breadcrumb-item" aria-current="page">worker-configuration-reference.md</li></ul> <a class="edit" href="https://github.com/kubernetes-sigs/node-feature-discovery/edit/gh-pages/advanced/worker-configuration-reference.md" title="Edit on GitHub" rel="noreferrer" target="_blank"> <i class="fa fa-edit"></i> </a> </div> <hr> <div role="main" itemscope="itemscope" itemtype="http://schema.org/Article"> <div class="markdown-body" itemprop="articleBody"> <h1 id="nfd-worker-configuration-file-reference">NFD-Worker Configuration File Reference</h1> <h2 class="no_toc" id="table-of-contents">Table of contents</h2> <p class="no_toc text-delta"><strong><em>WORK IN PROGRESS.</em></strong></p> <ol id="markdown-toc"> <li><a href="#nfd-worker-configuration-file-reference" id="markdown-toc-nfd-worker-configuration-file-reference">NFD-Worker Configuration File Reference</a> <ol> <li><a href="#core" id="markdown-toc-core">core</a> <ol> <li><a href="#coresleepinterval" id="markdown-toc-coresleepinterval">core.sleepInterval</a></li> <li><a href="#coresources" id="markdown-toc-coresources">core.sources</a></li> <li><a href="#corelabelwhitelist" id="markdown-toc-corelabelwhitelist">core.labelWhiteList</a></li> <li><a href="#corenopublish" id="markdown-toc-corenopublish">core.noPublish</a></li> <li><a href="#coreklog" id="markdown-toc-coreklog">core.klog</a></li> </ol> </li> <li><a href="#sources" id="markdown-toc-sources">sources</a> <ol> <li><a href="#sourcescpu" id="markdown-toc-sourcescpu">sources.cpu</a></li> <li><a href="#sourceskernel" id="markdown-toc-sourceskernel">sources.kernel</a></li> <li><a href="#sourespci" id="markdown-toc-sourespci">soures.pci</a></li> <li><a href="#sourcesusb" id="markdown-toc-sourcesusb">sources.usb</a></li> <li><a href="#sourcescustom" id="markdown-toc-sourcescustom">sources.custom</a></li> </ol> </li> </ol> </li> </ol> <hr /> <p>See the <a href="https://github.com/kubernetes-sigs/node-feature-discovery/blob/master/nfd-worker.conf.example">sample configuration file</a> for a full example configuration.</p> <h2 id="core">core</h2> <p>The <code class="language-plaintext highlighter-rouge notranslate">core</code> section contains common configuration settings that are not specific to any particular feature source.</p> <h3 id="coresleepinterval">core.sleepInterval</h3> <p><code class="language-plaintext highlighter-rouge notranslate">core.sleepInterval</code> 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.</p> <p>Note: Overridden by the deprecated <code class="language-plaintext highlighter-rouge notranslate">--sleep-interval</code> command line flag (if specified).</p> <p>Default: <code class="language-plaintext highlighter-rouge notranslate">60s</code></p> <p>Example:</p> <div class="language-yaml highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code><span class="na">core</span><span class="pi">:</span>
|
||
<span class="na">sleepInterval</span><span class="pi">:</span> <span class="s">60s</span>
|
||
</code></pre> </div></div> <h3 id="coresources">core.sources</h3> <p><code class="language-plaintext highlighter-rouge notranslate">core.sources</code> specifies the list of enabled feature sources. A special value <code class="language-plaintext highlighter-rouge notranslate">all</code> enables all feature sources.</p> <p>Note: Overridden by the deprecated <code class="language-plaintext highlighter-rouge notranslate">--sources</code> command line flag (if specified).</p> <p>Default: <code class="language-plaintext highlighter-rouge notranslate">[all]</code></p> <p>Example:</p> <div class="language-yaml highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code><span class="na">core</span><span class="pi">:</span>
|
||
<span class="na">sources</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">system</span>
|
||
<span class="pi">-</span> <span class="s">custom</span>
|
||
</code></pre> </div></div> <h3 id="corelabelwhitelist">core.labelWhiteList</h3> <p><code class="language-plaintext highlighter-rouge notranslate">core.labelWhiteList</code> specifies a regular expression for filtering feature labels based on the label name. Non-matching labels are not 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 prefix (or namespace) is omitted.</p> <p>Note: Overridden by the deprecated <code class="language-plaintext highlighter-rouge notranslate">--label-whitelist</code> command line flag (if specified).</p> <p>Default: <code class="language-plaintext highlighter-rouge notranslate">null</code></p> <p>Example:</p> <div class="language-yaml highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code><span class="na">core</span><span class="pi">:</span>
|
||
<span class="na">labelWhiteList</span><span class="pi">:</span> <span class="s1">'</span><span class="s">^cpu-cpuid'</span>
|
||
</code></pre> </div></div> <h3 id="corenopublish">core.noPublish</h3> <p>Setting <code class="language-plaintext highlighter-rouge notranslate">core.noPublish</code> to <code class="language-plaintext highlighter-rouge notranslate">true</code> 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.</p> <p>Note: Overridden by the <code class="language-plaintext highlighter-rouge notranslate">--no-publish</code> command line flag (if specified).</p> <p>Default: <code class="language-plaintext highlighter-rouge notranslate">false</code></p> <p>Example:</p> <div class="language-yaml highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code><span class="na">core</span><span class="pi">:</span>
|
||
<span class="na">noPublish</span><span class="pi">:</span> <span class="no">true</span>
|
||
</code></pre> </div></div> <h3 id="coreklog">core.klog</h3> <p>The following options specify the logger configuration. Most of which can be dynamically adjusted at run-time.</p> <p>Note: The logger options can also be specified via command line flags which take precedence over any corresponding config file options.</p> <h4 id="coreklogadddirheader">core.klog.addDirHeader</h4> <p>If true, adds the file directory to the header of the log messages.</p> <p>Default: false</p> <p>Run-time configurable: yes</p> <h4 id="coreklogalsologtostderr">core.klog.alsologtostderr</h4> <p>Log to standard error as well as files.</p> <p>Default: false</p> <p>Run-time configurable: yes</p> <h4 id="corekloglogbacktraceat">core.klog.logBacktraceAt</h4> <p>When logging hits line file:N, emit a stack trace.</p> <p>Default: <em>empty</em></p> <p>Run-time configurable: yes</p> <h4 id="corekloglogdir">core.klog.logDir</h4> <p>If non-empty, write log files in this directory.</p> <p>Default: <em>empty</em></p> <p>Run-time configurable: no</p> <h4 id="corekloglogfile">core.klog.logFile</h4> <p>If non-empty, use this log file.</p> <p>Default: <em>empty</em></p> <p>Run-time configurable: no</p> <h4 id="corekloglogfilemaxsize">core.klog.logFileMaxSize</h4> <p>Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited.</p> <p>Default: 1800</p> <p>Run-time configurable: no</p> <h4 id="corekloglogtostderr">core.klog.logtostderr</h4> <p>Log to standard error instead of files</p> <p>Default: true</p> <p>Run-time configurable: yes</p> <h4 id="coreklogskipheaders">core.klog.skipHeaders</h4> <p>If true, avoid header prefixes in the log messages.</p> <p>Default: false</p> <p>Run-time configurable: yes</p> <h4 id="coreklogskiplogheaders">core.klog.skipLogHeaders</h4> <p>If true, avoid headers when opening log files.</p> <p>Default: false</p> <p>Run-time configurable: no</p> <h4 id="coreklogstderrthreshold">core.klog.stderrthreshold</h4> <p>Logs at or above this threshold go to stderr (default 2)</p> <p>Run-time configurable: yes</p> <h4 id="coreklogv">core.klog.v</h4> <p>Number for the log level verbosity.</p> <p>Default: 0</p> <p>Run-time configurable: yes</p> <h4 id="coreklogvmodule">core.klog.vmodule</h4> <p>Comma-separated list of <code class="language-plaintext highlighter-rouge notranslate">pattern=N</code> settings for file-filtered logging.</p> <p>Default: <em>empty</em></p> <p>Run-time configurable: yes</p> <h2 id="sources">sources</h2> <p>The <code class="language-plaintext highlighter-rouge notranslate">sources</code> section contains feature source specific configuration parameters.</p> <h3 id="sourcescpu">sources.cpu</h3> <h3 id="sourceskernel">sources.kernel</h3> <h3 id="sourespci">soures.pci</h3> <h3 id="sourcesusb">sources.usb</h3> <h3 id="sourcescustom">sources.custom</h3> </div> </div> <div class="navigation-bottom d-flex flex-justify-between py-3" role="navigation" aria-label="footer navigation"> <div class="prev"><a href="/node-feature-discovery/master/advanced/worker-commandline-reference.html" class="btn" title="Worker Cmdline Reference" accesskey="p" rel="prev"> <i class="fa fa-arrow-circle-left"></i> Previous </a></div> <div class="next"></div> </div><hr> <div class="copyright text-center text-gray" role="contentinfo"> <i class="fa fa-copyright"></i> <span class="time">2016-2021,</span> <a class="text-gray" href="https://github.com/kubernetes-sigs" rel="noreferrer" target="_blank">Kubernetes SIGs</a> Revision <a class="text-gray" href="https://github.com/kubernetes-sigs/node-feature-discovery/commit/" title="" rel="noreferrer" target="_blank"></a> <br> <div class="generator"> Built with <a href="https://jekyllrb.com" rel="noreferrer" target="_blank">Jekyll</a> using a <a href="https://github.com/rundocs/jekyll-rtd-theme" rel="noreferrer" target="_blank" title="remote theme: jekyll-rtd-theme v2.0.9">theme</a> provided by <a href="https://rundocs.io" rel="noreferrer" target="_blank">RunDocs</a>. </div> </div> </div> </div> <div class="addons-wrap d-flex flex-column overflow-y-auto"> <div class="status d-flex flex-justify-between p-2"> <div class="title p-1"> <i class="fa fa-book"></i> Node Feature Discovery </div> <div class="branch p-1"> <span class="name"> master </span> <i class="fa fa-caret-down"></i> </div> </div> <div class="addons d-flex flex-column height-full p-2 d-none"> <dl id="versions"> <dt>Versions</dt> <script src="/node-feature-discovery/versions.js"></script> <script> var dt = document.getElementById('versions'); var items = getVersionListItems(); for (var i=0; i < items.length; i++) { var dd = document.createElement('dd'); var a = 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> <a href="https://github.com/kubernetes-sigs/node-feature-discovery" title="Stars: 258"> <i class="fa fa-github"></i> Homepage </a> </dd> <dd> <a href="https://github.com/kubernetes-sigs/node-feature-discovery/issues" title="Open issues: 16"> <i class="fa fa-question-circle-o"></i> Issues </a> </dd> <dd> <a href="https://github.com/kubernetes-sigs/node-feature-discovery/zipball/gh-pages" title="Size: 78985 Kb"> <i class="fa fa-download"></i> Download </a> </dd> </dl> <hr> <div class="license f6 pb-2"> The <a href="/node-feature-discovery/master/">software</a> is under the terms of <a href="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> <script src="https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme@2.0.9/assets/js/jquery.min.js"></script><script src="https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme@2.0.9/assets/js/theme.min.js"></script> </body> </html> |