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 Dec 2, 2024
1 parent 073eac1 commit 418c3b3
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 2 deletions.
2 changes: 1 addition & 1 deletion static/docs/main/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: c5c0899caad85ddf7a11a57600d1580e
config: 7754c3b5914ecc3683b4c669b8ee8b89
tags: 645f666f9bcd5a90fca523b33c5a78b7
11 changes: 11 additions & 0 deletions static/docs/main/_sources/contents/containers.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -464,3 +464,14 @@ tools 1.21 or newer. Below is an example for building wwclient for arm64:
# cp wwclient /var/lib/warewulf/overlays/wwclient_arm64/rootfs/warewulf
Then, apply the new "wwclient_arm64" system overlay to your arm64 node/profile

Read-only containers
====================

A container may be marked "read-only" by creating a ``readonly`` file in its
source directory, typically next to ``rootfs``.

.. note::

Read-only containers are a preview feature primarily meant to enable future
support for container subscriptions and updates.
11 changes: 11 additions & 0 deletions static/docs/main/contents/containers.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@
<li class="toctree-l2"><a class="reference internal" href="#container-size-considerations">Container Size Considerations</a></li>
<li class="toctree-l2"><a class="reference internal" href="#duplicating-a-container">Duplicating a container</a></li>
<li class="toctree-l2"><a class="reference internal" href="#multi-arch-container-management">Multi-arch container management</a></li>
<li class="toctree-l2"><a class="reference internal" href="#read-only-containers">Read-only containers</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="kernel.html">Kernel Management</a></li>
Expand Down Expand Up @@ -525,6 +526,16 @@ <h2>Multi-arch container management<a class="headerlink" href="#multi-arch-conta
</div>
<p>Then, apply the new “wwclient_arm64” system overlay to your arm64 node/profile</p>
</section>
<section id="read-only-containers">
<h2>Read-only containers<a class="headerlink" href="#read-only-containers" title="Link to this heading"></a></h2>
<p>A container may be marked “read-only” by creating a <code class="docutils literal notranslate"><span class="pre">readonly</span></code> file in its
source directory, typically next to <code class="docutils literal notranslate"><span class="pre">rootfs</span></code>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Read-only containers are a preview feature primarily meant to enable future
support for container subscriptions and updates.</p>
</div>
</section>
</section>


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 @@ -166,6 +166,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/containers.html#container-size-considerations">Container Size Considerations</a></li>
<li class="toctree-l2"><a class="reference internal" href="contents/containers.html#duplicating-a-container">Duplicating a container</a></li>
<li class="toctree-l2"><a class="reference internal" href="contents/containers.html#multi-arch-container-management">Multi-arch container management</a></li>
<li class="toctree-l2"><a class="reference internal" href="contents/containers.html#read-only-containers">Read-only containers</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contents/kernel.html">Kernel Management</a><ul>
Expand Down
2 changes: 1 addition & 1 deletion static/docs/main/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 418c3b3

Please sign in to comment.