Skip to content

Commit

Permalink
Update main docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jan 8, 2025
1 parent 81c15f8 commit bbf9375
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 1 deletion.
10 changes: 10 additions & 0 deletions static/docs/main/_sources/contents/profiles.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ customizations. For example, a few hundred nodes that are running a
particular container or kernel, and another group of nodes that are
running a different kernel or container.

Profiles may, themselves, reference other profiles, supporting complex
mixtures of profile configuration and negation.

Any node configuration attributes can be applied to a profile, but
there are always going to be some node configurations which must be
specific to a node, like a network HW/MAC address or an IP address.
Expand Down Expand Up @@ -174,6 +177,13 @@ as can be seen here:
n0000 Cluster test_profile cluster01
n0000 Profiles -- default,test_profile
Negating Profiles
=================

Profiles may also be negated by later profiles. For example, ``p2,~p1``
adds the profile ``p2`` to a node and removes a previously-applied ``p1``
profile from a node.

How To Use Profiles Effectively
===============================

Expand Down
9 changes: 9 additions & 0 deletions static/docs/main/contents/profiles.html
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
<li class="toctree-l2"><a class="reference internal" href="#multiple-profiles">Multiple Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="#cascading-profiles">Cascading Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="#overriding-profiles">Overriding Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="#negating-profiles">Negating Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="#how-to-use-profiles-effectively">How To Use Profiles Effectively</a></li>
</ul>
</li>
Expand Down Expand Up @@ -127,6 +128,8 @@ <h1>Node Profiles<a class="headerlink" href="#node-profiles" title="Link to this
customizations. For example, a few hundred nodes that are running a
particular container or kernel, and another group of nodes that are
running a different kernel or container.</p>
<p>Profiles may, themselves, reference other profiles, supporting complex
mixtures of profile configuration and negation.</p>
<p>Any node configuration attributes can be applied to a profile, but
there are always going to be some node configurations which must be
specific to a node, like a network HW/MAC address or an IP address.</p>
Expand Down Expand Up @@ -268,6 +271,12 @@ <h2>Overriding Profiles<a class="headerlink" href="#overriding-profiles" title="
</pre></div>
</div>
</section>
<section id="negating-profiles">
<h2>Negating Profiles<a class="headerlink" href="#negating-profiles" title="Link to this heading"></a></h2>
<p>Profiles may also be negated by later profiles. For example, <code class="docutils literal notranslate"><span class="pre">p2,~p1</span></code>
adds the profile <code class="docutils literal notranslate"><span class="pre">p2</span></code> to a node and removes a previously-applied <code class="docutils literal notranslate"><span class="pre">p1</span></code>
profile from a node.</p>
</section>
<section id="how-to-use-profiles-effectively">
<h2>How To Use Profiles Effectively<a class="headerlink" href="#how-to-use-profiles-effectively" title="Link to this heading"></a></h2>
<p>There are a lot of ways to use profiles to facilitate the management
Expand Down
1 change: 1 addition & 0 deletions static/docs/main/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,7 @@ <h1>User Guide<a class="headerlink" href="#user-guide" title="Link to this headi
<li class="toctree-l2"><a class="reference internal" href="contents/profiles.html#multiple-profiles">Multiple Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="contents/profiles.html#cascading-profiles">Cascading Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="contents/profiles.html#overriding-profiles">Overriding Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="contents/profiles.html#negating-profiles">Negating Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="contents/profiles.html#how-to-use-profiles-effectively">How To Use Profiles Effectively</a></li>
</ul>
</li>
Expand Down
2 changes: 1 addition & 1 deletion static/docs/main/searchindex.js

Large diffs are not rendered by default.

0 comments on commit bbf9375

Please sign in to comment.