mirrors/node-feature-discovery
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2024-12-15 17:50:49 +00:00
Code Activity
node-feature-discovery/v0.14/reference/worker-configuration-reference.html
Github Actions 50483de249 Update documentation for v0.14 
Auto-generated from v0.14.2 by 'update-gh-pages.sh'
2023-10-10 07:17:22 +00:00

71 lines
No EOL
40 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html> <html lang="en" dir="auto"> <head><meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=5, user-scalable=no"> <meta name="description" content="Configuration file reference of nfd-worker Table of contents core core.sleepInterval core.featureSources core.labelSources core.sources core.labelW..."> <meta name="revised" content=""> <meta name="author" content="Kubernetes SIGs"> <meta name="generator" content="rundocs/jekyll-rtd-theme v2.0.10"><meta name="theme-color" content="#2980b9"> <title>Worker config reference · Node Feature Discovery</title> <meta name="twitter:title" content="Worker config reference · Node Feature Discovery"> <meta name="twitter:description" content="Configuration file reference of nfd-worker Table of contents core core.sleepInterval core.featureSources core.labelSources core.sources core.labelW..."> <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/v0.14/reference/worker-configuration-reference.html"> <meta name="twitter:creator" content="@rundocs/jekyll-rtd-theme v2.0.10"> <meta property="og:title" content="Worker config reference · Node Feature Discovery"> <meta property="og:description" content="Configuration file reference of nfd-worker Table of contents core core.sleepInterval core.featureSources core.labelSources core.sources core.labelW..."> <meta property="og:locale" content="en"> <meta property="og:url" content="https://kubernetes-sigs.github.com/node-feature-discovery/v0.14/reference/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-23T05:07:52+00:00"> <meta property="article:modified_time" content="2023-10-10T07:17:12+00:00"> <script type="application/ld+json"> { "@context": "https://schema.org", "@type": "Article", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://kubernetes-sigs.github.com/node-feature-discovery/v0.14/reference/worker-configuration-reference.html" }, "headline": "Worker config reference · Node Feature Discovery", "image": [], "author": { "@type": "Person", "name": "Kubernetes SIGs" }, "datePublished": "2016-07-23T05:07:52+00:00", "dateModified": "2023-10-10T07:17:12+00:00", "publisher": { "@type": "Organization", "name": "Kubernetes SIGs", "logo": { "@type": "ImageObject", "url": "https://avatars.githubusercontent.com/u/36015203?v=4" } }, "description": "Configuration file reference of nfd-worker Table of contents core core.sleepInterval core.featureSources core.labelSources core.sources core.labelW..." } </script> <link rel="dns-prefetch" href="https://cdn.jsdelivr.net"><link rel="prev" href="https://kubernetes-sigs.github.com/node-feature-discovery/v0.14/reference/master-configuration-reference.html"><link rel="next" href="https://kubernetes-sigs.github.com/node-feature-discovery/v0.14/reference/topology-updater-commandline-reference.html"><link rel="canonical" href="https://kubernetes-sigs.github.com/node-feature-discovery/v0.14/reference/worker-configuration-reference.html"><link rel="icon" type="image/svg+xml" href="/node-feature-discovery/v0.14/assets/images/favicon.svg"><link rel="icon" type="image/png" href="/node-feature-discovery/v0.14/assets/images/favicon-16x16.png" sizes="16x16"> <link rel="icon" type="image/png" href="/node-feature-discovery/v0.14/assets/images/favicon-32x32.png" sizes="32x32"> <link rel="icon" type="image/png" href="/node-feature-discovery/v0.14/assets/images/favicon-96x96.png" sizes="96x96"><link rel="mask-icon" href="/node-feature-discovery/v0.14/assets/images/favicon.svg" color="#2980b9"><link rel="apple-touch-icon" href="/node-feature-discovery/v0.14/assets/images/apple-touch-icon-300x300.jpg"> <link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme@2.0.10/assets/css/theme.min.css"><style>@media (min-width: 1280px){.content-wrap{max-width:1200px}}</style><script> window.ui = { title: "Node Feature Discovery", baseurl: "/node-feature-discovery/v0.14", 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> </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/v0.14/" 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">v0.14.2</span> <form class="search pt-2" action="/node-feature-discovery/v0.14/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/v0.14/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/v0.14/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/v0.14/get-started/quick-start.html">2. Quick start</a> </li></ul> <a class="caption d-block text-uppercase no-wrap px-2 py-0" href="/node-feature-discovery/v0.14/deployment/"> Deployment </a><ul> <li class="toc level-1 " data-sort="1" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/deployment/image-variants.html">1. Image variants</a> </li> <li class="toc level-1 " data-sort="2" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/deployment/kustomize.html">2. Kustomize</a> </li> <li class="toc level-1 " data-sort="3" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/deployment/helm.html">3. Helm</a> </li> <li class="toc level-1 " data-sort="4" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/deployment/operator.html">4. NFD Operator</a> </li> <li class="toc level-1 " data-sort="5" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/deployment/tls.html">5. TLS authentication</a> </li> <li class="toc level-1 " data-sort="6" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/deployment/uninstallation.html">6. Uninstallation</a> </li> <li class="toc level-1 " data-sort="7" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/deployment/metrics.html">7. Metrics</a> </li></ul> <a class="caption d-block text-uppercase no-wrap px-2 py-0" href="/node-feature-discovery/v0.14/usage/"> Usage </a><ul> <li class="toc level-1 " data-sort="1" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/usage/features.html">1. Feature labels</a> </li> <li class="toc level-1 " data-sort="2" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/usage/using-labels.html">2. Using node labels</a> </li> <li class="toc level-1 " data-sort="3" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/usage/nfd-master.html">3. NFD-Master</a> </li> <li class="toc level-1 " data-sort="4" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/usage/nfd-worker.html">4. NFD-Worker</a> </li> <li class="toc level-1 " data-sort="5" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/usage/nfd-topology-updater.html">5. NFD-Topology-Updater</a> </li> <li class="toc level-1 " data-sort="6" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/usage/nfd-gc.html">6. NFD-Garbage-Collector</a> </li> <li class="toc level-1 " data-sort="7" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/usage/custom-resources.html">7. CRDs</a> </li> <li class="toc level-1 " data-sort="8" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/usage/customization-guide.html">8. Customization guide</a> </li> <li class="toc level-1 " data-sort="9" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/usage/examples-and-demos.html">9. Examples and demos</a> </li></ul> <a class="caption d-block text-uppercase no-wrap px-2 py-0" href="/node-feature-discovery/v0.14/reference/"> Reference </a><ul> <li class="toc level-1 " data-sort="1" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/reference/master-commandline-reference.html">1. Master cmdline reference</a> </li> <li class="toc level-1 " data-sort="2" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/reference/worker-commandline-reference.html">2. Worker 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/v0.14/reference/master-configuration-reference.html">3. Master config 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/v0.14/reference/worker-configuration-reference.html">4. Worker config reference</a> </li> <li class="toc level-1 " data-sort="5" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/reference/topology-updater-commandline-reference.html">5. Topology Updater Cmdline Reference</a> </li> <li class="toc level-1 " data-sort="6" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/reference/topology-updater-configuration-reference.html">6. Topology-Updater config reference</a> </li> <li class="toc level-1 " data-sort="7" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/reference/gc-commandline-reference.html">7. Garbage Collector Cmdline Reference</a> </li> <li class="toc level-1 " data-sort="8" data-level="1"> <a class="d-flex flex-items-baseline " href="/node-feature-discovery/v0.14/reference/versions.html">8. Versions</a> </li></ul> <a class="caption d-block text-uppercase no-wrap px-2 py-0" href="/node-feature-discovery/v0.14/developer-guide/"> Developer guide </a><ul> </ul> <a class="caption d-block text-uppercase no-wrap px-2 py-0" href="/node-feature-discovery/v0.14/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" aria-label="Toggle menu" 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/v0.14/">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/v0.14/" title="/"> <i class="fa fa-home"></i> </a> </li><li class="breadcrumb-item" ><a href="/node-feature-discovery/v0.14/reference/">reference</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/reference/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="https://schema.org/Article"> <div class="markdown-body" itemprop="articleBody"> <h1 class="no_toc" id="configuration-file-reference-of-nfd-worker">Configuration file reference of nfd-worker</h1> <h2 class="no_toc text-delta" id="table-of-contents">Table of contents</h2> <ol id="markdown-toc"> <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="#corefeaturesources" id="markdown-toc-corefeaturesources">core.featureSources</a></li> <li><a href="#corelabelsources" id="markdown-toc-corelabelsources">core.labelSources</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="#sourceslocal" id="markdown-toc-sourceslocal">sources.local</a></li> <li><a href="#sourceslocalhooksenabled" id="markdown-toc-sourceslocalhooksenabled">sources.local.hooksEnabled</a></li> <li><a href="#sourcespci" id="markdown-toc-sourcespci">sources.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> <hr /> <p>See the <a href="https://github.com/kubernetes-sigs/node-feature-discovery/blob/v0.14.2/deployment/components/worker-config/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>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="corefeaturesources">core.featureSources</h3> <p><code class="language-plaintext highlighter-rouge notranslate">core.featureSources</code> specifies the list of enabled feature sources. A special value <code class="language-plaintext highlighter-rouge notranslate">all</code> enables all sources. Prefixing a source name with <code class="language-plaintext highlighter-rouge notranslate">-</code> indicates that the source will be disabled instead - this is only meaningful when used in conjunction with <code class="language-plaintext highlighter-rouge notranslate">all</code>. This option allows completely disabling the feature detection so that neither standard feature labels are generated nor the raw feature data is available for custom rule processing.</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="c1"># Enable all but cpu and local sources</span>
<span class="na">featureSources</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s2">"</span><span class="s">all"</span>
<span class="pi">-</span> <span class="s2">"</span><span class="s">-cpu"</span>
<span class="pi">-</span> <span class="s2">"</span><span class="s">-local"</span>
</code></pre> </div></div> <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="c1"># Enable only cpu and local sources</span>
<span class="na">featureSources</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s2">"</span><span class="s">cpu"</span>
<span class="pi">-</span> <span class="s2">"</span><span class="s">local"</span>
</code></pre> </div></div> <h3 id="corelabelsources">core.labelSources</h3> <p><code class="language-plaintext highlighter-rouge notranslate">core.labelSources</code> specifies the list of enabled label sources. A special value <code class="language-plaintext highlighter-rouge notranslate">all</code> enables all sources. Prefixing a source name with <code class="language-plaintext highlighter-rouge notranslate">-</code> indicates that the source will be disabled instead - this is only meaningful when used in conjunction with <code class="language-plaintext highlighter-rouge notranslate">all</code>. This configuration option affects the generation of node labels but not the actual discovery of the underlying feature data that is used e.g. in custom/<code class="language-plaintext highlighter-rouge notranslate">NodeFeatureRule</code> rules.</p> <blockquote> <p><strong>NOTE:</strong> Overridden by the <code class="language-plaintext highlighter-rouge notranslate">-label-sources</code> command line flag and the <code class="language-plaintext highlighter-rouge notranslate">core.sources</code> configurations option (if either of them is specified).</p> </blockquote> <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="c1"># Enable all but cpu and system sources</span>
<span class="na">labelSources</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s2">"</span><span class="s">all"</span>
<span class="pi">-</span> <span class="s2">"</span><span class="s">-cpu"</span>
<span class="pi">-</span> <span class="s2">"</span><span class="s">-system"</span>
</code></pre> </div></div> <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="c1"># Enable only cpu and system sources</span>
<span class="na">labelSources</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s2">"</span><span class="s">cpu"</span>
<span class="pi">-</span> <span class="s2">"</span><span class="s">system"</span>
</code></pre> </div></div> <h3 id="coresources">core.sources</h3> <p><strong>DEPRECATED</strong>: use <a href="#core.labelSources"><code class="language-plaintext highlighter-rouge notranslate">core.labelSources</code></a> instead.</p> <blockquote> <p><strong>NOTE:</strong> <code class="language-plaintext highlighter-rouge notranslate">core.sources</code> takes precedence over the <code class="language-plaintext highlighter-rouge notranslate">core.labelSources</code> configuration file option.</p> </blockquote> <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> <blockquote> <p><strong>NOTE:</strong> 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> </blockquote> <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 and the Kubernetes API server. It is effectively a "dry-run" option. NFD-Worker runs feature detection normally, but no labeling requests are sent to nfd-master and no <a href="/node-feature-discovery/v0.14/usage/custom-resources.html#nodefeature">NodeFeature</a> objects are created or updated in the API server.</p> <blockquote> <p><strong>NOTE:</strong> Overridden by the <a href="/node-feature-discovery/v0.14/reference/worker-commandline-reference.html#-no-publish"><code class="language-plaintext highlighter-rouge notranslate">-no-publish</code></a> command line flag (if specified).</p> </blockquote> <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> <blockquote> <p><strong>NOTE:</strong> The logger options can also be specified via command line flags which take precedence over any corresponding config file options.</p> </blockquote> <h4 id="coreklogadddirheader">core.klog.addDirHeader</h4> <p>If true, adds the file directory to the header of the log messages.</p> <p>Default: <code class="language-plaintext highlighter-rouge notranslate">false</code></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: <code class="language-plaintext highlighter-rouge notranslate">false</code></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: <code class="language-plaintext highlighter-rouge notranslate">1800</code></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: <code class="language-plaintext highlighter-rouge notranslate">true</code></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: <code class="language-plaintext highlighter-rouge notranslate">false</code></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: <code class="language-plaintext highlighter-rouge notranslate">false</code></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: <code class="language-plaintext highlighter-rouge notranslate">0</code></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> <h4 id="sourcescpucpuid">sources.cpu.cpuid</h4> <h5 id="sourcescpucpuidattributeblacklist">sources.cpu.cpuid.attributeBlacklist</h5> <p>Prevent publishing cpuid features listed in this option.</p> <blockquote> <p><strong>NOTE:</strong> overridden by <code class="language-plaintext highlighter-rouge notranslate">sources.cpu.cpuid.attributeWhitelist</code> (if specified)</p> </blockquote> <p>Default: <code class="language-plaintext highlighter-rouge notranslate">[BMI1, BMI2, CLMUL, CMOV, CX16, ERMS, F16C, HTT, LZCNT, MMX, MMXEXT, NX, POPCNT, RDRAND, RDSEED, RDTSCP, SGX, SGXLC, SSE, SSE2, SSE3, SSE4.1, SSE4.2, SSSE3, TDX_GUEST]</code></p> <p>Example:</p> <div class="language-yaml highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code><span class="na">sources</span><span class="pi">:</span>
<span class="na">cpu</span><span class="pi">:</span>
<span class="na">cpuid</span><span class="pi">:</span>
<span class="na">attributeBlacklist</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">MMX</span><span class="pi">,</span> <span class="nv">MMXEXT</span><span class="pi">]</span>
</code></pre> </div></div> <h5 id="sourcescpucpuidattributewhitelist">sources.cpu.cpuid.attributeWhitelist</h5> <p>Only publish the cpuid features listed in this option.</p> <blockquote> <p><strong>NOTE:</strong> takes precedence over <code class="language-plaintext highlighter-rouge notranslate">sources.cpu.cpuid.attributeBlacklist</code></p> </blockquote> <p>Default: <em>empty</em></p> <p>Example:</p> <div class="language-yaml highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code><span class="na">sources</span><span class="pi">:</span>
<span class="na">cpu</span><span class="pi">:</span>
<span class="na">cpuid</span><span class="pi">:</span>
<span class="na">attributeWhitelist</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">AVX512BW</span><span class="pi">,</span> <span class="nv">AVX512CD</span><span class="pi">,</span> <span class="nv">AVX512DQ</span><span class="pi">,</span> <span class="nv">AVX512F</span><span class="pi">,</span> <span class="nv">AVX512VL</span><span class="pi">]</span>
</code></pre> </div></div> <h3 id="sourceskernel">sources.kernel</h3> <h4 id="sourceskernelkconfigfile">sources.kernel.kconfigFile</h4> <p>Path of the kernel config file. If empty, NFD runs a search in the well-known standard locations.</p> <p>Default: <em>empty</em></p> <p>Example:</p> <div class="language-yaml highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code><span class="na">sources</span><span class="pi">:</span>
<span class="na">kernel</span><span class="pi">:</span>
<span class="na">kconfigFile</span><span class="pi">:</span> <span class="s2">"</span><span class="s">/path/to/kconfig"</span>
</code></pre> </div></div> <h4 id="sourceskernelconfigopts">sources.kernel.configOpts</h4> <p>Kernel configuration options to publish as feature labels.</p> <p>Default: <code class="language-plaintext highlighter-rouge notranslate">[NO_HZ, NO_HZ_IDLE, NO_HZ_FULL, PREEMPT]</code></p> <p>Example:</p> <div class="language-yaml highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code><span class="na">sources</span><span class="pi">:</span>
<span class="na">kernel</span><span class="pi">:</span>
<span class="na">configOpts</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">NO_HZ</span><span class="pi">,</span> <span class="nv">X86</span><span class="pi">,</span> <span class="nv">DMI</span><span class="pi">]</span>
</code></pre> </div></div> <h3 id="sourceslocal">sources.local</h3> <h3 id="sourceslocalhooksenabled">sources.local.hooksEnabled</h3> <p>Configuration option to disable/enable hooks execution. Enabled by default. Hooks are DEPRECATED since v0.12.0 release and support will be removed in a future release. Use <a href="/node-feature-discovery/v0.14/usage/customization-guide.html#feature-files">feature files</a> instead.</p> <blockquote> <p><strong>NOTE:</strong> The default NFD container image only supports statically linked binaries. Use the <a href="/node-feature-discovery/v0.14/deployment/image-variants.html#full">full</a> image variant for a slightly more extensive environment that additionally supports bash and perl runtimes.</p> </blockquote> <p>Related tracking issues:</p> <ol> <li>Config option to disable hooks <a href="https://github.com/kubernetes-sigs/node-feature-discovery/issues/859">#859</a>.</li> <li>Disable hook support by default <a href="https://github.com/kubernetes-sigs/node-feature-discovery/issues/855">#855</a>.</li> <li>Drop support for hooks <a href="https://github.com/kubernetes-sigs/node-feature-discovery/issues/856">#856</a>.</li> </ol> <p>Default: false</p> <p>Example:</p> <div class="language-yaml highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code><span class="na">sources</span><span class="pi">:</span>
<span class="na">local</span><span class="pi">:</span>
<span class="na">hooksEnabled</span><span class="pi">:</span> <span class="no">true</span>
</code></pre> </div></div> <h3 id="sourcespci">sources.pci</h3> <h4 id="sourcespcideviceclasswhitelist">sources.pci.deviceClassWhitelist</h4> <p>List of PCI <a href="https://pci-ids.ucw.cz/read/PD">device class</a> IDs for which to publish a label. Can be specified as a main class only (e.g. <code class="language-plaintext highlighter-rouge notranslate">03</code>) or full class-subclass combination (e.g. <code class="language-plaintext highlighter-rouge notranslate">0300</code>) - the former implies that all subclasses are accepted. The format of the labels can be further configured with <a href="#sources.pci.deviceLabelFields">deviceLabelFields</a>.</p> <p>Default: <code class="language-plaintext highlighter-rouge notranslate">["03", "0b40", "12"]</code></p> <p>Example:</p> <div class="language-yaml highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code><span class="na">sources</span><span class="pi">:</span>
<span class="na">pci</span><span class="pi">:</span>
<span class="na">deviceClassWhitelist</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">0200"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">03"</span><span class="pi">]</span>
</code></pre> </div></div> <h4 id="sourcespcidevicelabelfields">sources.pci.deviceLabelFields</h4> <p>The set of PCI ID fields to use when constructing the name of the feature label. Valid fields are <code class="language-plaintext highlighter-rouge notranslate">class</code>, <code class="language-plaintext highlighter-rouge notranslate">vendor</code>, <code class="language-plaintext highlighter-rouge notranslate">device</code>, <code class="language-plaintext highlighter-rouge notranslate">subsystem_vendor</code> and <code class="language-plaintext highlighter-rouge notranslate">subsystem_device</code>.</p> <p>Default: <code class="language-plaintext highlighter-rouge notranslate">[class, vendor]</code></p> <p>Example:</p> <div class="language-yaml highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code><span class="na">sources</span><span class="pi">:</span>
<span class="na">pci</span><span class="pi">:</span>
<span class="na">deviceLabelFields</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">class</span><span class="pi">,</span> <span class="nv">vendor</span><span class="pi">,</span> <span class="nv">device</span><span class="pi">]</span>
</code></pre> </div></div> <p>With the example config above NFD would publish labels like: <code class="language-plaintext highlighter-rouge notranslate">feature.node.kubernetes.io/pci-&lt;class-id&gt;_&lt;vendor-id&gt;_&lt;device-id&gt;.present=true</code></p> <h3 id="sourcesusb">sources.usb</h3> <h4 id="sourcesusbdeviceclasswhitelist">sources.usb.deviceClassWhitelist</h4> <p>List of USB <a href="https://www.usb.org/defined-class-codes">device class</a> IDs for which to publish a feature label. The format of the labels can be further configured with <a href="#sources.usb.deviceLabelFields">deviceLabelFields</a>.</p> <p>Default: <code class="language-plaintext highlighter-rouge notranslate">["0e", "ef", "fe", "ff"]</code></p> <p>Example:</p> <div class="language-yaml highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code><span class="na">sources</span><span class="pi">:</span>
<span class="na">usb</span><span class="pi">:</span>
<span class="na">deviceClassWhitelist</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">ef"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">ff"</span><span class="pi">]</span>
</code></pre> </div></div> <h4 id="sourcesusbdevicelabelfields">sources.usb.deviceLabelFields</h4> <p>The set of USB ID fields from which to compose the name of the feature label. Valid fields are <code class="language-plaintext highlighter-rouge notranslate">class</code>, <code class="language-plaintext highlighter-rouge notranslate">vendor</code>, <code class="language-plaintext highlighter-rouge notranslate">device</code> and <code class="language-plaintext highlighter-rouge notranslate">serial</code>.</p> <p>Default: <code class="language-plaintext highlighter-rouge notranslate">[class, vendor, device]</code></p> <p>Example:</p> <div class="language-yaml highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code><span class="na">sources</span><span class="pi">:</span>
<span class="na">pci</span><span class="pi">:</span>
<span class="na">deviceLabelFields</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">class</span><span class="pi">,</span> <span class="nv">vendor</span><span class="pi">]</span>
</code></pre> </div></div> <p>With the example config above NFD would publish labels like: <code class="language-plaintext highlighter-rouge notranslate">feature.node.kubernetes.io/usb-&lt;class-id&gt;_&lt;vendor-id&gt;.present=true</code></p> <h3 id="sourcescustom">sources.custom</h3> <p>List of rules to process in the custom feature source to create user-specific labels. Refer to the documentation of the <a href="/node-feature-discovery/v0.14/usage/customization-guide.html#custom-feature-source">custom feature source</a> for details of the available rules and their configuration.</p> <p>Default: <em>empty</em></p> <p>Example:</p> <div class="language-yaml highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code><span class="na">sources</span><span class="pi">:</span>
<span class="na">custom</span><span class="pi">:</span>
<span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">my</span><span class="nv"> </span><span class="s">custom</span><span class="nv"> </span><span class="s">rule"</span>
<span class="na">labels</span><span class="pi">:</span>
<span class="na">my-custom-feature</span><span class="pi">:</span> <span class="s2">"</span><span class="s">true"</span>
<span class="na">matchFeatures</span><span class="pi">:</span>
<span class="pi">-</span> <span class="na">feature</span><span class="pi">:</span> <span class="s">kernel.loadedmodule</span>
<span class="na">matchExpressions</span><span class="pi">:</span>
<span class="na">e1000e</span><span class="pi">:</span> <span class="pi">{</span><span class="nv">op</span><span class="pi">:</span> <span class="nv">Exists</span><span class="pi">}</span>
<span class="pi">-</span> <span class="na">feature</span><span class="pi">:</span> <span class="s">pci.device</span>
<span class="na">matchExpressions</span><span class="pi">:</span>
<span class="na">class</span><span class="pi">:</span> <span class="pi">{</span><span class="nv">op</span><span class="pi">:</span> <span class="nv">In</span><span class="pi">,</span> <span class="nv">value</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">0200"</span><span class="pi">]}</span>
<span class="na">vendor</span><span class="pi">:</span> <span class="pi">{</span><span class="nv">op</span><span class="pi">:</span> <span class="nv">In</span><span class="pi">,</span> <span class="nv">value</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">8086"</span><span class="pi">]}</span>
</code></pre> </div></div> </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/v0.14/reference/master-configuration-reference.html" class="btn" title="Master config reference" accesskey="p" rel="prev"> <i class="fa fa-arrow-circle-left"></i> Previous </a></div> <div class="next"><a href="/node-feature-discovery/v0.14/reference/topology-updater-commandline-reference.html" class="btn" title="Topology Updater Cmdline Reference" accesskey="n" rel="next"> Next <i class="fa fa-arrow-circle-right"></i> </a></div> </div><hr> <div class="copyright text-center text-gray" role="contentinfo"> <i class="fa fa-copyright"></i> <span class="time">2016-2023,</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://pages.github.com" rel="noreferrer" target="_blank" title="github-pages v228">GitHub Pages</a> using a <a href="https://github.com/rundocs/jekyll-rtd-theme" rel="noreferrer" target="_blank" title="rundocs/jekyll-rtd-theme v2.0.10">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"> v0.14 </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: 615"> <i class="fa fa-github"></i> Homepage </a> </dd> <dd> <a href="https://github.com/kubernetes-sigs/node-feature-discovery/issues" title="Open issues: 21"> <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: 94602 Kb"> <i class="fa fa-download"></i> Download </a> </dd> </dl> <hr> <div class="license f6 pb-2"> This <a href="/node-feature-discovery/v0.14/" title="Node Feature Discovery">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 src="https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme@2.0.10/assets/js/jquery.min.js"></script><script src="https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme@2.0.10/assets/js/theme.min.js"></script> </body> </html>
View git blame Copy permalink