Skip to content

Commit

Permalink
deploy: 168a40b
Browse files Browse the repository at this point in the history
  • Loading branch information
rollandf committed Mar 11, 2024
1 parent b026c98 commit f7d7929
Show file tree
Hide file tree
Showing 3 changed files with 197 additions and 2 deletions.
19 changes: 18 additions & 1 deletion customizations/customization.html
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,24 @@
<h1>Customization Options<a class="headerlink" href="#customization-options" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="helm.html">Helm Chart</a></li>
<li class="toctree-l1"><a class="reference internal" href="helm.html">Helm Chart</a><ul>
<li class="toctree-l2"><a class="reference internal" href="helm.html#general-parameters">General Parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="helm.html#mlnx-ofed-driver">MLNX_OFED Driver</a></li>
<li class="toctree-l2"><a class="reference internal" href="helm.html#mlnx-ofed-driver-environment-variables">MLNX_OFED Driver Environment Variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="helm.html#rdma-shared-device-plugin">RDMA Shared Device Plugin</a></li>
<li class="toctree-l2"><a class="reference internal" href="helm.html#rdma-device-plugin-resource-configurations">RDMA Device Plugin Resource Configurations</a></li>
<li class="toctree-l2"><a class="reference internal" href="helm.html#sr-iov-network-device-plugin">SR-IOV Network Device Plugin</a></li>
<li class="toctree-l2"><a class="reference internal" href="helm.html#sr-iov-network-device-plugin-resource-configuration">SR-IOV Network Device Plugin Resource Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="helm.html#ib-kubernetes">IB Kubernetes</a></li>
<li class="toctree-l2"><a class="reference internal" href="helm.html#ufm-secret">UFM Secret</a></li>
<li class="toctree-l2"><a class="reference internal" href="helm.html#secondary-network">Secondary Network</a></li>
<li class="toctree-l2"><a class="reference internal" href="helm.html#cni-plugin">CNI Plugin</a></li>
<li class="toctree-l2"><a class="reference internal" href="helm.html#multus-cni">Multus CNI</a></li>
<li class="toctree-l2"><a class="reference internal" href="helm.html#ipoib-cni">IPoIB CNI</a></li>
<li class="toctree-l2"><a class="reference internal" href="helm.html#ipam-cni-plugin">IPAM CNI Plugin</a></li>
<li class="toctree-l2"><a class="reference internal" href="helm.html#nvidia-ipam-plugin">NVIDIA IPAM Plugin</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="crds.html">CRDs</a></li>
</ul>
</div>
Expand Down
178 changes: 178 additions & 0 deletions customizations/helm.html
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,184 @@

<section id="helm-chart-customization-options">
<h1>Helm Chart Customization Options<a class="headerlink" href="#helm-chart-customization-options" title="Permalink to this headline"></a></h1>
<p>There are various customizations you can do to tailor the deployment of the Network Operator to your cluster needs. You
can find those below.</p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#general-parameters" id="id1">General Parameters</a></p></li>
<li><p><a class="reference internal" href="#mlnx-ofed-driver" id="id2">MLNX_OFED Driver</a></p></li>
<li><p><a class="reference internal" href="#mlnx-ofed-driver-environment-variables" id="id3">MLNX_OFED Driver Environment Variables</a></p></li>
<li><p><a class="reference internal" href="#rdma-shared-device-plugin" id="id4">RDMA Shared Device Plugin</a></p></li>
<li><p><a class="reference internal" href="#rdma-device-plugin-resource-configurations" id="id5">RDMA Device Plugin Resource Configurations</a></p></li>
<li><p><a class="reference internal" href="#sr-iov-network-device-plugin" id="id6">SR-IOV Network Device Plugin</a></p></li>
<li><p><a class="reference internal" href="#sr-iov-network-device-plugin-resource-configuration" id="id7">SR-IOV Network Device Plugin Resource Configuration</a></p></li>
<li><p><a class="reference internal" href="#ib-kubernetes" id="id8">IB Kubernetes</a></p></li>
<li><p><a class="reference internal" href="#ufm-secret" id="id9">UFM Secret</a></p></li>
<li><p><a class="reference internal" href="#secondary-network" id="id10">Secondary Network</a></p></li>
<li><p><a class="reference internal" href="#cni-plugin" id="id11">CNI Plugin</a></p></li>
<li><p><a class="reference internal" href="#multus-cni" id="id12">Multus CNI</a></p></li>
<li><p><a class="reference internal" href="#ipoib-cni" id="id13">IPoIB CNI</a></p></li>
<li><p><a class="reference internal" href="#ipam-cni-plugin" id="id14">IPAM CNI Plugin</a></p></li>
<li><p><a class="reference internal" href="#nvidia-ipam-plugin" id="id15">NVIDIA IPAM Plugin</a></p></li>
</ul>
</div>
<section id="general-parameters">
<h2>General Parameters<a class="headerlink" href="#general-parameters" title="Permalink to this headline"></a></h2>
<p>In order to tailor the deployment of the Network Operator to your cluster needs, use the following parameters:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Name</p></th>
<th class="head"><p>Type</p></th>
<th class="head"><p>Default</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>nfd.enabled</p></td>
<td><p>Bool</p></td>
<td><p>true</p></td>
<td><p>Deploy Node Feature Discovery</p></td>
</tr>
<tr class="row-odd"><td><p>sriovNetworkOperator.enabled</p></td>
<td><p>Bool</p></td>
<td><p>false</p></td>
<td><p>Deploy SR-IOV Network Operator</p></td>
</tr>
<tr class="row-even"><td><p>sriovNetworkOperator.configDaemonNodeSelectorExtra</p></td>
<td><p>List</p></td>
<td><p>node-role.kubernetes.io/worker: “”</p></td>
<td><p>Additional values for SR-IOV Config Daemon nodes selector</p></td>
</tr>
<tr class="row-odd"><td><p>upgradeCRDs</p></td>
<td><p>Bool</p></td>
<td><p>true</p></td>
<td><p>Enable CRDs upgrade with helm pre-install and pre-upgrade hooks</p></td>
</tr>
<tr class="row-even"><td><p>psp.enabled</p></td>
<td><p>Bool</p></td>
<td><p>false</p></td>
<td><p>Deploy Pod Security Policy</p></td>
</tr>
<tr class="row-odd"><td><p>operator.repository</p></td>
<td><p>String</p></td>
<td><p>nvcr.io/nvidia</p></td>
<td><p>Network Operator image repository</p></td>
</tr>
<tr class="row-even"><td><p>operator.image</p></td>
<td><p>String</p></td>
<td><p>network-operator</p></td>
<td><p>Network Operator image name</p></td>
</tr>
<tr class="row-odd"><td><p>operator.tag</p></td>
<td><p>String</p></td>
<td><p>None</p></td>
<td><p>Network Operator image tag. If set to None, the chart’s appVersion will be used</p></td>
</tr>
<tr class="row-even"><td><p>operator.imagePullSecrets</p></td>
<td><p>List</p></td>
<td><p>[]</p></td>
<td><p>An optional list of references to secrets to use for pulling any of the Network Operator images</p></td>
</tr>
<tr class="row-odd"><td><p>deployCR</p></td>
<td><p>Bool</p></td>
<td><p>false</p></td>
<td><p>Network Operator image repository</p></td>
</tr>
<tr class="row-even"><td><p>nodeAffinity</p></td>
<td><p>Object</p></td>
<td><div class="line-block">
<div class="line">requiredDuringSchedulingIgnoredDuringExecution:</div>
<div class="line-block">
<div class="line">nodeSelectorTerms:</div>
<div class="line-block">
<div class="line">- matchExpressions:</div>
<div class="line-block">
<div class="line">- key: node-role.kubernetes.io/master</div>
<div class="line-block">
<div class="line">operator: DoesNotExist</div>
</div>
<div class="line">- key: node-role.kubernetes.io/control-plane</div>
<div class="line-block">
<div class="line">operator: DoesNotExist</div>
</div>
</div>
</div>
</div>
</div>
</td>
<td><p>Configure node affinity settings for Network Operator components</p></td>
</tr>
</tbody>
</table>
<p>The NFD labels required by the Network Operator and GPU Operator:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Label</p></th>
<th class="head"><p>Location</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>feature.node.kubernetes.io/pci-15b3.present</p></td>
<td><p>Nodes containing NVIDIA Networking hardware</p></td>
</tr>
<tr class="row-odd"><td><p>feature.node.kubernetes.io/pci-10de.present</p></td>
<td><p>Nodes containing NVIDIA GPU hardware</p></td>
</tr>
</tbody>
</table>
</section>
<section id="mlnx-ofed-driver">
<h2>MLNX_OFED Driver<a class="headerlink" href="#mlnx-ofed-driver" title="Permalink to this headline"></a></h2>
</section>
<section id="mlnx-ofed-driver-environment-variables">
<h2>MLNX_OFED Driver Environment Variables<a class="headerlink" href="#mlnx-ofed-driver-environment-variables" title="Permalink to this headline"></a></h2>
</section>
<section id="rdma-shared-device-plugin">
<h2>RDMA Shared Device Plugin<a class="headerlink" href="#rdma-shared-device-plugin" title="Permalink to this headline"></a></h2>
</section>
<section id="rdma-device-plugin-resource-configurations">
<h2>RDMA Device Plugin Resource Configurations<a class="headerlink" href="#rdma-device-plugin-resource-configurations" title="Permalink to this headline"></a></h2>
</section>
<section id="sr-iov-network-device-plugin">
<h2>SR-IOV Network Device Plugin<a class="headerlink" href="#sr-iov-network-device-plugin" title="Permalink to this headline"></a></h2>
</section>
<section id="sr-iov-network-device-plugin-resource-configuration">
<h2>SR-IOV Network Device Plugin Resource Configuration<a class="headerlink" href="#sr-iov-network-device-plugin-resource-configuration" title="Permalink to this headline"></a></h2>
</section>
<section id="ib-kubernetes">
<h2>IB Kubernetes<a class="headerlink" href="#ib-kubernetes" title="Permalink to this headline"></a></h2>
</section>
<section id="ufm-secret">
<h2>UFM Secret<a class="headerlink" href="#ufm-secret" title="Permalink to this headline"></a></h2>
</section>
<section id="secondary-network">
<h2>Secondary Network<a class="headerlink" href="#secondary-network" title="Permalink to this headline"></a></h2>
</section>
<section id="cni-plugin">
<h2>CNI Plugin<a class="headerlink" href="#cni-plugin" title="Permalink to this headline"></a></h2>
</section>
<section id="multus-cni">
<h2>Multus CNI<a class="headerlink" href="#multus-cni" title="Permalink to this headline"></a></h2>
</section>
<section id="ipoib-cni">
<h2>IPoIB CNI<a class="headerlink" href="#ipoib-cni" title="Permalink to this headline"></a></h2>
</section>
<section id="ipam-cni-plugin">
<h2>IPAM CNI Plugin<a class="headerlink" href="#ipam-cni-plugin" title="Permalink to this headline"></a></h2>
</section>
<section id="nvidia-ipam-plugin">
<h2>NVIDIA IPAM Plugin<a class="headerlink" href="#nvidia-ipam-plugin" title="Permalink to this headline"></a></h2>
</section>
</section>


Expand Down
Loading

0 comments on commit f7d7929

Please sign in to comment.