mirrors/node-feature-discovery
mirrors/node-feature-discovery
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2025-03-06 08:47:04 +00:00
Code Activity
node-feature-discovery/v0.10/advanced/topology-updater-commandline-reference.html

13 lines
22 KiB
HTML
Raw Normal View History

Update documentation for v0.10 Auto-generated from v0.10.1-3-g681a645 by 'update-gh-pages.sh'
2022-01-25 09:21:18 +00:00
<!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="NFD-Topology-Updater Commandline Flags Table of Contents NFD-Topology-Updater Commandline Flags -h, -help -version -server -ca-file -cert-file -key..."> <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>Topology Updater Cmdline Reference · Node Feature Discovery</title> <meta name="twitter:title" content="Topology Updater Cmdline Reference · Node Feature Discovery"> <meta name="twitter:description" content="NFD-Topology-Updater Commandline Flags Table of Contents NFD-Topology-Updater Commandline Flags -h, -help -version -server -ca-file -cert-file -key..."> <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.10/advanced/topology-updater-commandline-reference.html"> <meta name="twitter:creator" content="@rundocs/jekyll-rtd-theme v2.0.10"> <meta property="og:title" content="Topology Updater Cmdline Reference · Node Feature Discovery"> <meta property="og:description" content="NFD-Topology-Updater Commandline Flags Table of Contents NFD-Topology-Updater Commandline Flags -h, -help -version -server -ca-file -cert-file -key..."> <meta property="og:locale" content="en"> <meta property="og:url" content="https://kubernetes-sigs.github.com/node-feature-discovery/v0.10/advanced/topology-updater-commandline-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="2022-01-25T03:21:08-06: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.10/advanced/topology-updater-commandline-reference.html" }, "headline": "Topology Updater Cmdline Reference · Node Feature Discovery", "image": [], "author": { "@type": "Person", "name": "Kubernetes SIGs" }, "datePublished": "2016-07-23T00:07:52-05:00", "dateModified": "2022-01-25T03:21:08-06:00", "publisher": { "@type": "Organization", "name": "Kubernetes SIGs", "logo": { "@type": "ImageObject", "url": "https://avatars.githubusercontent.com/u/36015203?v=4" } }, "description": "NFD-Topology-Updater Commandline Flags Table of Contents NFD-Topology-Updater Commandline Flags -h, -help -version -server -ca-file -cert-file -key..." } </script> <link rel="dns-prefetch" href="https://cdn.jsdelivr.net"><link rel="prev" href="https://kubernetes-sigs.github.com/node-feature-discovery/v0.10/advanced/worker-configuration-reference.html"><link rel="next" href="https://kubernetes-sigs.github.com/node-feature-discovery/v0.10/advanced/customization-guide.html"><link rel="canonical" href="https://kubernetes-sigs.github.com/node-feature-discovery/v0.10/advanced/topology-updater-commandline-reference.html"><link rel="icon" type="image/svg+xml" href="/node-feature-discovery/v0.10/assets/images/favicon.svg"><link rel="icon" type="image/png" href="/node-feature-discovery/v0.10/assets/images/favicon-16x16.png" sizes="16x16"> <link rel="icon" type="image/png" href="/node-feature-discovery/v0.10/assets/images/favicon-32x32.png" sizes="32x32"> <link rel="icon" type="image/png" href="/node-feature-discovery/v0.10/assets/images/favicon-96x96.png" sizes="96x96"><link rel="mask-icon" href="/node-feature-discovery/v0.10/assets/images/favicon.svg" color="#2980b9"><link rel="apple-touch-icon" href="/node-feature-discovery/v0.10/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 (
Update documentation for v0.10 Auto-generated from v0.10.0 by 'update-gh-pages.sh'
2022-01-11 18:18:50 +00:00
</code></pre> </div></div> <h3 id="-h--help">-h, -help</h3> <p>Print usage and exit.</p> <h3 id="-version">-version</h3> <p>Print version and exit.</p> <h3 id="-server">-server</h3> <p>The <code class="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> <div class="language-bash highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code>nfd-topology-updater <span class="nt">-server</span><span class="o">=</span>nfd-master.nfd.svc.cluster.local:443
</code></pre> </div></div> <h3 id="-ca-file">-ca-file</h3> <p>The <code class="language-plaintext highlighter-rouge notranslate">-ca-file</code> is one of the three flags (together with <code class="language-plaintext highlighter-rouge notranslate">-cert-file</code> and <code class="language-plaintext highlighter-rouge notranslate">-key-file</code>) controlling the mutual TLS authentication on the topology-updater 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 <code class="language-plaintext highlighter-rouge notranslate">-cert-file</code> and <code class="language-plaintext highlighter-rouge notranslate">-key-file</code></p> <p>Example:</p> <div class="language-bash highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code>nfd-topology-updater <span class="nt">-ca-file</span><span class="o">=</span>/opt/nfd/ca.crt <span class="nt">-cert-file</span><span class="o">=</span>/opt/nfd/updater.crt <span class="nt">-key-file</span><span class="o">=</span>/opt/nfd/updater.key
</code></pre> </div></div> <h3 id="-cert-file">-cert-file</h3> <p>The <code class="language-plaintext highlighter-rouge notranslate">-cert-file</code> is one of the three flags (together with <code class="language-plaintext highlighter-rouge notranslate">-ca-file</code> and <code class="language-plaintext highlighter-rouge notranslate">-key-file</code>) controlling mutual TLS authentication on the topology-updater 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 <code class="language-plaintext highlighter-rouge notranslate">-ca-file</code> and <code class="language-plaintext highlighter-rouge notranslate">-key-file</code></p> <p>Example:</p> <div class="language-bash highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code>nfd-topology-updater <span class="nt">-cert-file</span><span class="o">=</span>/opt/nfd/updater.crt <span class="nt">-key-file</span><span class="o">=</span>/opt/nfd/updater.key <span class="nt">-ca-file</span><span class="o">=</span>/opt/nfd/ca.crt
</code></pre> </div></div> <h3 id="-key-file">-key-file</h3> <p>The <code class="language-plaintext highlighter-rouge notranslate">-key-file</code> is one of the three flags (together with <code class="language-plaintext highlighter-rouge notranslate">-ca-file</code> and <code class="language-plaintext highlighter-rouge notranslate">-cert-file</code>) controlling the mutual TLS authentication on topology-updater side. This flag specifies the private key corresponding the given certificate file (<code class="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 <code class="language-plaintext highlighter-rouge notranslate">-cert-file</code> and <code class="language-plaintext highlighter-rouge notranslate">-ca-file</code></p> <p>Example:</p> <div class="language-bash highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code>nfd-topology-updater <span class="nt">-key-file</span><span class="o">=</span>/opt/nfd/updater.key <span class="nt">-cert-file</span><span class="o">=</span>/opt/nfd/updater.crt <span class="nt">-ca-file</span><span class="o">=</span>/opt/nfd/ca.crt
</code></pre> </div></div> <h3 id="-server-name-override">-server-name-override</h3> <p>The <code class="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> <div class="language-bash highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code>nfd-topology-updater <span class="nt">-server-name-override</span><span class="o">=</span>localhost
</code></pre> </div></div> <h3 id="-no-publish">-no-publish</h3> <p>The <code class="language-plaintext highlighter-rouge notranslate">-no-publish</code> flag disables all communication with the nfd-master, making it a "dry-run" flag for nfd-topology-updater. NFD-Topology-Updater runs resource hardware topology detection normally, but no CR requests are sent to nfd-master.</p> <p>Default: <em>false</em></p> <p>Example:</p> <div class="language-bash highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code>nfd-topology-updater <span class="nt">-no-publish</span>
</code></pre> </div></div> <h3 id="-oneshot">-oneshot</h3> <p>The <code class="language-plaintext highlighter-rouge notranslate">-oneshot</code> flag causes nfd-topology-updater to exit after one pass of resource hardware topology detection.</p> <p>Default: <em>false</em></p> <p>Example:</p> <div class="language-bash highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code>nfd-topology-updater <span class="nt">-oneshot</span> <span class="nt">-no-publish</span>
</code></pre> </div></div> <h3 id="-sleep-interval">-sleep-interval</h3> <p>The <code class="language-plaintext highlighter-rouge notranslate">-sleep-interval</code> specifies the interval between resource hardware topology re-examination (and CR updates). A non-positive value implies infinite sleep interval, i.e. no re-detection is done.</p> <p>Default: 60s</p> <p>Example:</p> <div class="language-bash highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code>nfd-topology-updater <span class="nt">-sleep-interval</span><span class="o">=</span>1h
</code></pre> </div></div> <h3 id="-watch-namespace">-watch-namespace</h3> <p>The <code class="language-plaintext highlighter-rouge notranslate">-watch-namespace</code> specifies the namespace to ensure that resource hardware topology examination only happens for the pods running in the specified namespace. Pods that are not running in the specified namespace are not considered during resource accounting. This is particularly useful for testing/debugging purpose. A "*" value would mean that all the pods would be considered during the accounting process.</p> <p>Default: "*"</p> <p>Example:</p> <div class="language-bash highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code>nfd-topology-updater <span class="nt">-watch-namespace</span><span class="o">=</span>rte
</code></pre> </div></div> <h3 id="-kubelet-config-file">-kubelet-config-file</h3> <p>The <code class="language-plaintext highlighter-rouge notranslate">-kubelet-config-file</code> specifies the path to the Kubelet's configuration file.</p> <p>Default: /host-var/lib/kubelet/config.yaml</p> <p>Example:</p> <div class="language-bash highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code>nfd-topology-updater <span class="nt">-kubelet-config-file</span><span class="o">=</span>/var/lib/kubelet/config.yaml
</code></pre> </div></div> <h3 id="-podresources-socket">-podresources-socket</h3> <p>The <code class="language-plaintext highlighter-rouge notranslate">-podresources-socket</code> specifies the path to the Unix socket where kubelet exports a gRPC service to enable discovery of in-use CPUs and devices, and to provide metadata for them.</p> <p>Default: /host-var/lib/kubelet/pod-resources/kubelet.sock</p> <p>Example:</p> <div class="language-bash highlighter-rouge notranslate"><div class="highlight"><pre class="highlight"><code>nfd-topology-updater <span class="nt">-podresources-socket</span><span class="o">=</span>/var/lib/kubelet/pod-resources/kubelet.sock
Update documentation for v0.10 Auto-generated from v0.10.1-3-g681a645 by 'update-gh-pages.sh'
2022-01-25 09:21:18 +00:00
</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.10/advanced/worker-configuration-reference.html" class="btn" title="Worker 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.10/advanced/customization-guide.html" class="btn" title="Customization guide" 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://pages.github.com" rel="noreferrer" target="_blank" title="github-pages v209">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.10 </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: 396"> <i class="fa fa-github"></i> Homepage </a> </dd> <dd> <a href="https://github.com/kubernetes-sigs/node-feature-discovery/issues" title="Open issues: 28"> <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: 82378 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.10/" 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>
Copy permalink