1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2025-03-09 10:17:04 +00:00
node-feature-discovery/master/reference/master-configuration-reference.html

8 lines
22 KiB
HTML
Raw Normal View History

<!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-master Table of contents noPublish extraLabelNs denyLabelNs resourceLabels enableTaints labelWhiteList resyncPe..."> <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>Master config reference · Node Feature Discovery</title> <meta name="twitter:title" content="Master config reference · Node Feature Discovery"> <meta name="twitter:description" content="Configuration file reference of nfd-master Table of contents noPublish extraLabelNs denyLabelNs resourceLabels enableTaints labelWhiteList resyncPe..."> <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/reference/master-configuration-reference.html"> <meta name="twitter:creator" content="@rundocs/jekyll-rtd-theme v2.0.10"> <meta property="og:title" content="Master config reference · Node Feature Discovery"> <meta property="og:description" content="Configuration file reference of nfd-master Table of contents noPublish extraLabelNs denyLabelNs resourceLabels enableTaints labelWhiteList resyncPe..."> <meta property="og:locale" content="en"> <meta property="og:url" content="https://kubernetes-sigs.github.com/node-feature-discovery/master/reference/master-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="2023-04-28T09:57:53-05:00"> <script type="application/ld+json"> { "@context": "https://schema.org", "@type": "Article", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://kubernetes-sigs.github.com/node-feature-discovery/master/reference/master-configuration-reference.html" }, "headline": "Master config reference · Node Feature Discovery", "image": [], "author": { "@type": "Person", "name": "Kubernetes SIGs" }, "datePublished": "2016-07-23T00:07:52-05:00", "dateModified": "2023-04-28T09:57:53-05: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-master Table of contents noPublish extraLabelNs denyLabelNs resourceLabels enableTaints labelWhiteList resyncPe..." } </script> <link rel="dns-prefetch" href="https://cdn.jsdelivr.net"><link rel="prev" href="https://kubernetes-sigs.github.com/node-feature-discovery/master/reference/worker-commandline-reference.html"><link rel="next" href="https://kubernetes-sigs.github.com/node-feature-discovery/master/reference/worker-configuration-reference.html"><link rel="canonical" href="https://kubernetes-sigs.github.com/node-feature-discovery/master/reference/master-configuration-reference.html"><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"> <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
</code></pre> </div></div> <h2 id="extralabelns">extraLabelNs</h2> <p><code class="language-plaintext highlighter-rouge notranslate">extraLabelNs</code> specifies a list of allowed feature label namespaces. This option can be used to allow other vendor or application specific namespaces for custom labels from the local and custom feature sources, even though these labels were denied using the <code class="language-plaintext highlighter-rouge notranslate">denyLabelNs</code> parameter.</p> <p>The same namespace control and this option applies to Extended Resources (created with <code class="language-plaintext highlighter-rouge notranslate">resourceLabels</code>), too.</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">extraLabelNs</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">added.ns.io"</span><span class="pi">,</span><span class="s2">"</span><span class="s">added.kubernets.io"</span><span class="pi">]</span>
</code></pre> </div></div> <h2 id="denylabelns">denyLabelNs</h2> <p><code class="language-plaintext highlighter-rouge notranslate">denyLabelNs</code> specifies a list of excluded label namespaces. By default, nfd-master allows creating labels in all namespaces, excluding <code class="language-plaintext highlighter-rouge notranslate">kubernetes.io</code> namespace and its sub-namespaces (i.e. <code class="language-plaintext highlighter-rouge notranslate">*.kubernetes.io</code>). However, you should note that <code class="language-plaintext highlighter-rouge notranslate">kubernetes.io</code> and its sub-namespaces are always denied. This option can be used to exclude some vendors or application specific namespaces. Note that the namespaces <code class="language-plaintext highlighter-rouge notranslate">feature.node.kubernetes.io</code> and <code class="language-plaintext highlighter-rouge notranslate">profile.node.kubernetes.io</code> and their sub-namespaces are always allowed and cannot be denied.</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">denyLabelNs</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">denied.ns.io"</span><span class="pi">,</span><span class="s2">"</span><span class="s">denied.kubernetes.io"</span><span class="pi">]</span>
</code></pre> </div></div> <h2 id="resourcelabels">resourceLabels</h2> <p><strong>DEPRECATED</strong>: <a href="/node-feature-discovery/master/usage/custom-resources.html#nodefeaturerule">NodeFeatureRule</a> should be used for managing extended resources in NFD.</p> <p>The <code class="language-plaintext highlighter-rouge notranslate">resourceLabels</code> option specifies a list of features to be advertised as extended resources instead of labels. Features that have integer values can be published as Extended Resources by listing them in this option.</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">resourceLabels</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">vendor-1.com/feature-1"</span><span class="pi">,</span><span class="s2">"</span><span class="s">vendor-2.io/feature-2"</span><span class="pi">]</span>
</code></pre> </div></div> <h2 id="enabletaints">enableTaints</h2> <p><code class="language-plaintext highlighter-rouge notranslate">enableTaints</code> enables/disables node tainting feature of NFD.</p> <p>Default: <em>false</em></p> <p>Example:</p> <div class="language-yaml highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code><span class="na">enableTaints</span><span class="pi">:</span> <span class="no">true</span>
</code></pre> </div></div> <h2 id="labelwhitelist">labelWhiteList</h2> <p><code class="language-plaintext highlighter-rouge notranslate">labelWhiteList</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>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">labelWhiteList</span><span class="pi">:</span> <span class="s2">"</span><span class="s">foo"</span>
</code></pre> </div></div> <h3 id="resyncperiod">resyncPeriod</h3> <p>The <code class="language-plaintext highlighter-rouge notranslate">resyncPeriod</code> option specifies the NFD API controller resync period. The resync means nfd-master replaying all NodeFeature and NodeFeatureRule objects, thus effectively re-syncing all nodes in the cluster (i.e. ensuring labels, annotations, extended resources and taints are in place). Only has effect when the <a href="/node-feature-discovery/master/usage/custom-resources.html#nodefeature">NodeFeature</a> CRD API has been enabled with <a href="/node-feature-discovery/master/reference/master-commandline-reference.html#-enable-nodefeature-api"><code class="language-plaintext highlighter-rouge notranslate">-enable-nodefeature-api</code></a>.</p> <p>Default: 1 hour.</p> <p>Example:</p> <div class="language-yaml highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code><span class="s">resyncPeriod=2h</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/master/reference/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"><a href="/node-feature-discovery/master/reference/worker-configuration-reference.html" class="btn" title="Worker config 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 v227">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"> 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: 557"> <i class="fa fa-github"></i> Homepage </a> </dd> <dd> <a href="https://github.com/kubernetes-sigs/node-feature-discovery/issues" title="Open issues: 34"> <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: 89934 Kb"> <i class="fa fa-download"></i> Download </a> </dd> </dl> <hr> <div class="license f6 pb-2"> This <a href="/node-feature-discovery/master/" 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>