Skip to content

Commit

Permalink
Deployed 8961d69 to dev with MkDocs 1.6.0 and mike 2.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
Doc Deploy Bot committed Aug 2, 2024
1 parent 1e969b8 commit 70a53ca
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions dev/guides/external-mgs/readme/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1132,7 +1132,7 @@ <h3 id="storage-profile">Storage Profile</h3>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="p p-Indicator">[</span><span class="nv">...</span><span class="p p-Indicator">]</span>
</code></pre></div>
<h3 id="nnflustremgt">NnfLustreMGT</h3>
<p>A <code>NnfLustreMGT</code> resource tracks which fsnames have been used on the MGT to prevent fsname re-use. Any Lustre file systems that are created through the NNF software will request an fsname to use from a <code>NnfLustreMGT</code> resource. Every MGT must have a corresponding <code>NnfLustreMGT</code> resource. For MGTs that are hosted on NNF hardware, the <code>NnfLustreMGT</code> resources are created automatically. The NNF software also erases any no longer used fsnames from disk for any internally hosted MGTs. For an MGT hosted on an external node, an admin must create an <code>NnfLustreMGT</code>. This resource ensures that fsnames will be created in a sequential order without any fsname re-use. However, after an fsname is no longer in use by a file system, it will not be erased from the MGT disk. An admin may decide to periodically run the <code>lctl erase_lcfg [fsname]</code> command to remove fsnames that are no longer in use.</p>
<p>A <code>NnfLustreMGT</code> resource tracks which fsnames have been used on the MGT to prevent fsname re-use. Any Lustre file systems that are created through the NNF software will request an fsname to use from a <code>NnfLustreMGT</code> resource. Every MGT must have a corresponding <code>NnfLustreMGT</code> resource. For MGTs that are hosted on NNF hardware, the <code>NnfLustreMGT</code> resources are created automatically. The NNF software also erases any unused fsnames from the MGT disk for any internally hosted MGTs. For a MGT hosted on an external node, an admin must create an <code>NnfLustreMGT</code> resource. This resource ensures that fsnames will be created in a sequential order without any fsname re-use. However, after an fsname is no longer in use by a file system, it will not be erased from the MGT disk. An admin may decide to periodically run the <code>lctl erase_lcfg [fsname]</code> command to remove fsnames that are no longer in use.</p>
<p>Below is an example <code>NnfLustreMGT</code> resource. The <code>NnfLustreMGT</code> resource for external MGSs should be created in the <code>nnf-system</code> namespace.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nnf.cray.hpe.com/v1alpha1</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">NnfLustreMGT</span>
Expand All @@ -1152,9 +1152,9 @@ <h3 id="nnflustremgt">NnfLustreMGT</h3>
</code></pre></div>
<ul>
<li><code>addresses</code> - This is a list of LNet addresses that could be used for this MGT. This should match any values that are used in the <code>externalMgs</code> field in the <code>NnfStorageProfiles</code>.</li>
<li><code>fsNameStart</code> - The first fsname to use. Subsequent fsnames will be incremented based on this starting fsname (e.g, <code>aaaaaaaa</code>, <code>aaaaaaab</code>, <code>aaaaaaac</code>). fsnames use lowercase letters <code>'a'</code>-<code>'z'</code>.</li>
<li><code>fsNameStart</code> - The first fsname to use. Subsequent fsnames will be incremented based on this starting fsname (e.g, <code>aaaaaaaa</code>, <code>aaaaaaab</code>, <code>aaaaaaac</code>). fsnames use lowercase letters <code>'a'</code>-<code>'z'</code>. <code>fsNameStart</code> should be exactly 8 characters long.</li>
<li><code>fsNameBlackList</code> - This is a list of fsnames that should not be given to any NNF Lustre file systems. If the MGT is hosting any non-NNF Lustre file systems, their fsnames should be included in this blacklist.</li>
<li><code>fsNameStartReference</code> - This is an optional ObjectReference to a <code>ConfigMap</code> that holds a starting fsname. If this field is specified, it takes precedence over the <code>fsNameStart</code> field in the spec. The <code>ConfigMap</code> will be updated to the next available fsname everytime an fsname is assigned to a new Lustre file system.</li>
<li><code>fsNameStartReference</code> - This is an optional <code>ObjectReference</code> to a <code>ConfigMap</code> that holds a starting fsname. If this field is specified, it takes precedence over the <code>fsNameStart</code> field in the spec. The <code>ConfigMap</code> will be updated to the next available fsname everytime an fsname is assigned to a new Lustre file system.</li>
</ul>
<h3 id="configmap">ConfigMap</h3>
<p>For external MGTs, the <code>fsNameStartReference</code> should be used to point to a <code>ConfigMap</code> in the default namespace. The <code>ConfigMap</code> should not be removed during an argocd undeploy/deploy. This allows the nnf-sos sofware to be undeployed (including any <code>NnfLustreMGT</code> resources), without having the fsname reset back to the <code>fsNameStart</code> value on a redeploy. The Configmap that is created should be left empty initially.</p>
Expand Down
2 changes: 1 addition & 1 deletion dev/search/search_index.json

Large diffs are not rendered by default.

0 comments on commit 70a53ca

Please sign in to comment.