Skip to content

Commit

Permalink
Update docs per review
Browse files Browse the repository at this point in the history
  • Loading branch information
schaefi committed Oct 16, 2024
1 parent 3624270 commit 7c92ff3
Showing 1 changed file with 30 additions and 11 deletions.
41 changes: 30 additions & 11 deletions doc/source/image_description/elements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1238,12 +1238,14 @@ For details see: :ref:`installmedia_customize`
<registry>
----------

Setup containers to fetch from one ore more registry elements
Setup containers to fetch from one or more registry elements

.. code:: xml
<registry source="registry.opensuse.org">
<container name="some" use_with="podman"/>
<containers backend="podman">
<container name="some"/>
</containers>
</registry>
The optional registry element specifies the location of one ore
Expand All @@ -1253,22 +1255,39 @@ the image. On first boot those container archives will be loaded
into the local container backend store for the selected
backend and the archive files gets deleted.

<registry><container>
---------------------
<registry><containers>
----------------------

Details about a container to fetch from a given source registry
Details about the container backend

.. code:: xml
<registry source="registry.opensuse.org">
<container name="some" use_with="podman"/>
<containers backend="podman">
<container name="some"/>
</containers>
</registry>
The `name` and `use_with` attributes are mandatory and specifies
the name of the container and for which backend it should be used.
So far `docker` and `podman` are supported backend values for
the `use_with` attribute. The `container` element has the following
optional attributes
Supported `backend` values as of today are `docker` and `podman`.
The `backend` attribute is mandatory and specifies for which
container backend the image should be available in the system.

<registry><containers><container>
---------------------------------

Details about the container to fetch from a given source registry

.. code:: xml
<registry source="registry.opensuse.org">
<containers backend="podman">
<container name="some"/>
</containers>
</registry>
The `name` attributes is mandatory and specifies
the name of the container as it exists in the registry.
The `container` element has the following optional attributes

path="some/path"
The path to the container in the registry. If not specified
Expand Down

0 comments on commit 7c92ff3

Please sign in to comment.