1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2025-03-06 16:57:10 +00:00
node-feature-discovery/v0.8/get-started/introduction.html

14 lines
17 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=1, user-scalable=no"> <meta name="description" content="Introduction Table of contents NFD-Master NFD-Worker Feature discovery Node annotations This software enables node feature discovery for Kubernetes..."> <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="Introduction · Node Feature Discovery"> <meta property="og:description" content="Introduction Table of contents NFD-Master NFD-Worker Feature discovery Node annotations This software enables node feature discovery for Kubernetes..."> <meta property="og:locale" content="en"> <meta property="og:url" content="https://kubernetes-sigs.github.com/node-feature-discovery/v0.8/get-started/introduction.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="2022-02-14T03:27:50-06:00"> <meta name="twitter:title" content="Introduction · Node Feature Discovery"> <meta name="twitter:description" content="Introduction Table of contents NFD-Master NFD-Worker Feature discovery Node annotations This software enables node feature discovery for Kubernetes..."> <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.8/get-started/introduction.html"> <meta name="twitter:creator" content="@jekyll-rtd-theme v2.0.9"> <title>Introduction · 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/v0.8/get-started/introduction.html"><link rel="next" href="https://kubernetes-sigs.github.com/node-feature-discovery/v0.8/get-started/quick-start.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/v0.8/assets/images/favicon.svg"> <link rel="icon" type="image/png" href="/node-feature-discovery/v0.8/assets/images/favicon-16x16.png" sizes="16x16"> <link rel="icon" type="image/png" href="/node-feature-discovery/v0.8/assets/images/favicon-32x32.png" sizes="32x32"> <link rel="icon" type="image/png" href="/node-feature-discovery/v0.8/assets/images/favicon-96x96.png" sizes="96x96"> <link rel="mask-icon" href="/node-feature-discovery/v0.8/assets/images/favicon.svg" color="#2980b9"> <link rel="apple-touch-icon" href="/node-feature-discovery/v0.8/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/v0.8/get-started/introduction.html" }, "headline": "Introduction · Node Feature Discovery", "image": [], "author": { "@type": "Person", "name": "Kubernetes SIGs" }, "datePublished": "2016-07-23T00:07:52-05:00", "dateModified": "2022-02-14T03:27:50-06:00", "publisher": { "@type": "Organization", "name": "Kubernetes SIGs", "logo": { "@type": "ImageObject", "url": "https://avatars.githubusercontent.com/u/36015203?v=4" } }, "description": "Introduction Table of contents NFD-Master NFD-Worker Feature discovery Node annotations This software enables node feature discovery for Kubernetes..." } </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.8/" title="Documentation
</span><span class="nl">"feature.node.kubernetes.io/cpu-&lt;feature-name&gt;"</span><span class="p">:</span><span class="w"> </span><span class="s2">"true"</span><span class="p">,</span><span class="w">
</span><span class="nl">"feature.node.kubernetes.io/custom-&lt;feature-name&gt;"</span><span class="p">:</span><span class="w"> </span><span class="s2">"true"</span><span class="p">,</span><span class="w">
</span><span class="nl">"feature.node.kubernetes.io/iommu-&lt;feature-name&gt;"</span><span class="p">:</span><span class="w"> </span><span class="s2">"true"</span><span class="p">,</span><span class="w">
</span><span class="nl">"feature.node.kubernetes.io/kernel-&lt;feature name&gt;"</span><span class="p">:</span><span class="w"> </span><span class="s2">"&lt;feature value&gt;"</span><span class="p">,</span><span class="w">
</span><span class="nl">"feature.node.kubernetes.io/memory-&lt;feature-name&gt;"</span><span class="p">:</span><span class="w"> </span><span class="s2">"true"</span><span class="p">,</span><span class="w">
</span><span class="nl">"feature.node.kubernetes.io/network-&lt;feature-name&gt;"</span><span class="p">:</span><span class="w"> </span><span class="s2">"true"</span><span class="p">,</span><span class="w">
</span><span class="nl">"feature.node.kubernetes.io/pci-&lt;device label&gt;.present"</span><span class="p">:</span><span class="w"> </span><span class="s2">"true"</span><span class="p">,</span><span class="w">
</span><span class="nl">"feature.node.kubernetes.io/storage-&lt;feature-name&gt;"</span><span class="p">:</span><span class="w"> </span><span class="s2">"true"</span><span class="p">,</span><span class="w">
</span><span class="nl">"feature.node.kubernetes.io/system-&lt;feature name&gt;"</span><span class="p">:</span><span class="w"> </span><span class="s2">"&lt;feature value&gt;"</span><span class="p">,</span><span class="w">
</span><span class="nl">"feature.node.kubernetes.io/usb-&lt;device label&gt;.present"</span><span class="p">:</span><span class="w"> </span><span class="s2">"&lt;feature value&gt;"</span><span class="p">,</span><span class="w">
</span><span class="nl">"feature.node.kubernetes.io/&lt;file name&gt;-&lt;feature name&gt;"</span><span class="p">:</span><span class="w"> </span><span class="s2">"&lt;feature value&gt;"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre> </div></div> <h2 id="node-annotations">Node annotations</h2> <p>NFD also annotates nodes it is running on:</p> <table> <thead> <tr> <th>Annotation</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>[&lt;instance&gt;.]nfd.node.kubernetes.io/master.version</td> <td>Version of the nfd-master instance running on the node. Informative use only.</td> </tr> <tr> <td>[&lt;instance&gt;.]nfd.node.kubernetes.io/worker.version</td> <td>Version of the nfd-worker instance running on the node. Informative use only.</td> </tr> <tr> <td>[&lt;instance&gt;.]nfd.node.kubernetes.io/feature-labels</td> <td>Comma-separated list of node labels managed by NFD. NFD uses this internally so must not be edited by users.</td> </tr> <tr> <td>[&lt;instance&gt;.]nfd.node.kubernetes.io/extended-resources</td> <td>Comma-separated list of node extended resources managed by NFD. NFD uses this internally so must not be edited by users.</td> </tr> </tbody> </table> <p>NOTE: the <a href="/node-feature-discovery/v0.8/advanced/master-commandline-reference.html#instance"><code class="language-plaintext highlighter-rouge notranslate">--instance</code></a> command line flag affects the annotation names</p> <p>Unapplicable annotations are not created, i.e. for example master.version is only created on nodes running nfd-master.</p> </div> </div> <div class="navigation-bottom d-flex flex-justify-between py-3" role="navigation" aria-label="footer navigation"> <div class="prev"></div> <div class="next"><a href="/node-feature-discovery/v0.8/get-started/quick-start.html" class="btn" title="Quick start" 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-2022,</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"> v0.8 </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: 404"> <i class="fa fa-github"></i> Homepage </a> </dd> <dd> <a href="https://github.com/kubernetes-sigs/node-feature-discovery/issues" title="Open issues: 30"> <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: 82821 Kb"> <i class="fa fa-download"></i> Download </a> </dd> </dl> <hr> <div class="license f6 pb-2"> The <a href="/node-feature-discovery/v0.8/">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/v0