Commit c1f129bf authored by Peter Hutterer's avatar Peter Hutterer
Browse files

doc: improve some of the docs regarding suffixes etc.


Signed-off-by: Peter Hutterer's avatarPeter Hutterer <peter.hutterer@who-t.net>
parent fb8b6d63
......@@ -197,17 +197,17 @@
#
# The resulting image will be pushed to the local registry.
#
# If the repository suffix was specified, the image path is
# ``$CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG``. The
# ``.fdo.suffixed-image@{{distribution}}`` template provides access to this image.
# If :attr:`FDO_REPO_SUFFIX` was specified, the image path is
# ``$CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG``.
# Use the ``.fdo.suffixed-image@{{distribution}}`` template to access or use this image.
#
# If the repository suffix was **not** specified, the image path is
# If :attr:`FDO_REPO_SUFFIX` was **not** specified, the image path is
{% if version %}
# ``$CI_REGISTRY_IMAGE/{{distribution}}/{{version}}:$FDO_DISTRIBUTION_TAG``.
{% else %}
# ``$CI_REGISTRY_IMAGE/{{distribution}}/$FDO_DISTRIBUTION_VERSION:$FDO_DISTRIBUTION_TAG``.
{% endif %}
# The ``.fdo.distribution-image@{{distribution}}`` template provides access to this image.
# Use the ``.fdo.distribution-image@{{distribution}}`` template to access or use this image.
#
.fdo.container-build@{{distribution}}:
extends: .fdo.{{distribution}}
......@@ -539,6 +539,8 @@
#
# The {{distribution}} version to build, e.g. {{version_examples|join(', ')}}.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@{{distribution}}``.
#
{% endif %}
# .. attribute:: FDO_DISTRIBUTION_TAG
#
......@@ -546,6 +548,8 @@
#
# String to identify the image in the registry.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@{{distribution}}``.
#
# .. attribute:: FDO_DISTRIBUTION_IMAGE
#
# **This variable is set by this template and should be treated as read-only**
......@@ -588,7 +592,9 @@
#
# **This variable is required**
#
# The repository name suffix
# The repository name suffix.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@{{distribution}}``.
#
# .. attribute:: FDO_DISTRIBUTION_TAG
#
......@@ -596,6 +602,8 @@
#
# String to identify the image in the registry.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@{{distribution}}``.
#
# .. attribute:: FDO_DISTRIBUTION_IMAGE
#
# **This variable is set by this template and should be treated as read-only**
......
......@@ -182,13 +182,13 @@
#
# The resulting image will be pushed to the local registry.
#
# If the repository suffix was specified, the image path is
# ``$CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG``. The
# ``.fdo.suffixed-image@alpine`` template provides access to this image.
# If :attr:`FDO_REPO_SUFFIX` was specified, the image path is
# ``$CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG``.
# Use the ``.fdo.suffixed-image@alpine`` template to access or use this image.
#
# If the repository suffix was **not** specified, the image path is
# If :attr:`FDO_REPO_SUFFIX` was **not** specified, the image path is
# ``$CI_REGISTRY_IMAGE/alpine/latest:$FDO_DISTRIBUTION_TAG``.
# The ``.fdo.distribution-image@alpine`` template provides access to this image.
# Use the ``.fdo.distribution-image@alpine`` template to access or use this image.
#
.fdo.container-build@alpine:
extends: .fdo.alpine
......@@ -311,6 +311,8 @@
#
# String to identify the image in the registry.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@alpine``.
#
# .. attribute:: FDO_DISTRIBUTION_IMAGE
#
# **This variable is set by this template and should be treated as read-only**
......@@ -345,7 +347,9 @@
#
# **This variable is required**
#
# The repository name suffix
# The repository name suffix.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@alpine``.
#
# .. attribute:: FDO_DISTRIBUTION_TAG
#
......@@ -353,6 +357,8 @@
#
# String to identify the image in the registry.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@alpine``.
#
# .. attribute:: FDO_DISTRIBUTION_IMAGE
#
# **This variable is set by this template and should be treated as read-only**
......
......@@ -182,13 +182,13 @@
#
# The resulting image will be pushed to the local registry.
#
# If the repository suffix was specified, the image path is
# ``$CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG``. The
# ``.fdo.suffixed-image@arch`` template provides access to this image.
# If :attr:`FDO_REPO_SUFFIX` was specified, the image path is
# ``$CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG``.
# Use the ``.fdo.suffixed-image@arch`` template to access or use this image.
#
# If the repository suffix was **not** specified, the image path is
# If :attr:`FDO_REPO_SUFFIX` was **not** specified, the image path is
# ``$CI_REGISTRY_IMAGE/arch/rolling:$FDO_DISTRIBUTION_TAG``.
# The ``.fdo.distribution-image@arch`` template provides access to this image.
# Use the ``.fdo.distribution-image@arch`` template to access or use this image.
#
.fdo.container-build@arch:
extends: .fdo.arch
......@@ -298,6 +298,8 @@
#
# String to identify the image in the registry.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@arch``.
#
# .. attribute:: FDO_DISTRIBUTION_IMAGE
#
# **This variable is set by this template and should be treated as read-only**
......@@ -332,7 +334,9 @@
#
# **This variable is required**
#
# The repository name suffix
# The repository name suffix.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@arch``.
#
# .. attribute:: FDO_DISTRIBUTION_TAG
#
......@@ -340,6 +344,8 @@
#
# String to identify the image in the registry.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@arch``.
#
# .. attribute:: FDO_DISTRIBUTION_IMAGE
#
# **This variable is set by this template and should be treated as read-only**
......
......@@ -188,13 +188,13 @@
#
# The resulting image will be pushed to the local registry.
#
# If the repository suffix was specified, the image path is
# ``$CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG``. The
# ``.fdo.suffixed-image@centos`` template provides access to this image.
# If :attr:`FDO_REPO_SUFFIX` was specified, the image path is
# ``$CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG``.
# Use the ``.fdo.suffixed-image@centos`` template to access or use this image.
#
# If the repository suffix was **not** specified, the image path is
# If :attr:`FDO_REPO_SUFFIX` was **not** specified, the image path is
# ``$CI_REGISTRY_IMAGE/centos/$FDO_DISTRIBUTION_VERSION:$FDO_DISTRIBUTION_TAG``.
# The ``.fdo.distribution-image@centos`` template provides access to this image.
# Use the ``.fdo.distribution-image@centos`` template to access or use this image.
#
.fdo.container-build@centos:
extends: .fdo.centos
......@@ -303,12 +303,16 @@
#
# The centos version to build, e.g. 7, 8.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@centos``.
#
# .. attribute:: FDO_DISTRIBUTION_TAG
#
# **This variable is required**
#
# String to identify the image in the registry.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@centos``.
#
# .. attribute:: FDO_DISTRIBUTION_IMAGE
#
# **This variable is set by this template and should be treated as read-only**
......@@ -343,7 +347,9 @@
#
# **This variable is required**
#
# The repository name suffix
# The repository name suffix.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@centos``.
#
# .. attribute:: FDO_DISTRIBUTION_TAG
#
......@@ -351,6 +357,8 @@
#
# String to identify the image in the registry.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@centos``.
#
# .. attribute:: FDO_DISTRIBUTION_IMAGE
#
# **This variable is set by this template and should be treated as read-only**
......
......@@ -188,13 +188,13 @@
#
# The resulting image will be pushed to the local registry.
#
# If the repository suffix was specified, the image path is
# ``$CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG``. The
# ``.fdo.suffixed-image@debian`` template provides access to this image.
# If :attr:`FDO_REPO_SUFFIX` was specified, the image path is
# ``$CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG``.
# Use the ``.fdo.suffixed-image@debian`` template to access or use this image.
#
# If the repository suffix was **not** specified, the image path is
# If :attr:`FDO_REPO_SUFFIX` was **not** specified, the image path is
# ``$CI_REGISTRY_IMAGE/debian/$FDO_DISTRIBUTION_VERSION:$FDO_DISTRIBUTION_TAG``.
# The ``.fdo.distribution-image@debian`` template provides access to this image.
# Use the ``.fdo.distribution-image@debian`` template to access or use this image.
#
.fdo.container-build@debian:
extends: .fdo.debian
......@@ -502,12 +502,16 @@
#
# The debian version to build, e.g. stretch, sid, buster.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@debian``.
#
# .. attribute:: FDO_DISTRIBUTION_TAG
#
# **This variable is required**
#
# String to identify the image in the registry.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@debian``.
#
# .. attribute:: FDO_DISTRIBUTION_IMAGE
#
# **This variable is set by this template and should be treated as read-only**
......@@ -542,7 +546,9 @@
#
# **This variable is required**
#
# The repository name suffix
# The repository name suffix.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@debian``.
#
# .. attribute:: FDO_DISTRIBUTION_TAG
#
......@@ -550,6 +556,8 @@
#
# String to identify the image in the registry.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@debian``.
#
# .. attribute:: FDO_DISTRIBUTION_IMAGE
#
# **This variable is set by this template and should be treated as read-only**
......
......@@ -188,13 +188,13 @@
#
# The resulting image will be pushed to the local registry.
#
# If the repository suffix was specified, the image path is
# ``$CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG``. The
# ``.fdo.suffixed-image@fedora`` template provides access to this image.
# If :attr:`FDO_REPO_SUFFIX` was specified, the image path is
# ``$CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG``.
# Use the ``.fdo.suffixed-image@fedora`` template to access or use this image.
#
# If the repository suffix was **not** specified, the image path is
# If :attr:`FDO_REPO_SUFFIX` was **not** specified, the image path is
# ``$CI_REGISTRY_IMAGE/fedora/$FDO_DISTRIBUTION_VERSION:$FDO_DISTRIBUTION_TAG``.
# The ``.fdo.distribution-image@fedora`` template provides access to this image.
# Use the ``.fdo.distribution-image@fedora`` template to access or use this image.
#
.fdo.container-build@fedora:
extends: .fdo.fedora
......@@ -493,12 +493,16 @@
#
# The fedora version to build, e.g. 31, 30, 32, 33.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@fedora``.
#
# .. attribute:: FDO_DISTRIBUTION_TAG
#
# **This variable is required**
#
# String to identify the image in the registry.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@fedora``.
#
# .. attribute:: FDO_DISTRIBUTION_IMAGE
#
# **This variable is set by this template and should be treated as read-only**
......@@ -533,7 +537,9 @@
#
# **This variable is required**
#
# The repository name suffix
# The repository name suffix.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@fedora``.
#
# .. attribute:: FDO_DISTRIBUTION_TAG
#
......@@ -541,6 +547,8 @@
#
# String to identify the image in the registry.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@fedora``.
#
# .. attribute:: FDO_DISTRIBUTION_IMAGE
#
# **This variable is set by this template and should be treated as read-only**
......
......@@ -188,13 +188,13 @@
#
# The resulting image will be pushed to the local registry.
#
# If the repository suffix was specified, the image path is
# ``$CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG``. The
# ``.fdo.suffixed-image@ubuntu`` template provides access to this image.
# If :attr:`FDO_REPO_SUFFIX` was specified, the image path is
# ``$CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG``.
# Use the ``.fdo.suffixed-image@ubuntu`` template to access or use this image.
#
# If the repository suffix was **not** specified, the image path is
# If :attr:`FDO_REPO_SUFFIX` was **not** specified, the image path is
# ``$CI_REGISTRY_IMAGE/ubuntu/$FDO_DISTRIBUTION_VERSION:$FDO_DISTRIBUTION_TAG``.
# The ``.fdo.distribution-image@ubuntu`` template provides access to this image.
# Use the ``.fdo.distribution-image@ubuntu`` template to access or use this image.
#
.fdo.container-build@ubuntu:
extends: .fdo.ubuntu
......@@ -546,12 +546,16 @@
#
# The ubuntu version to build, e.g. 19.10, 18.04.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@ubuntu``.
#
# .. attribute:: FDO_DISTRIBUTION_TAG
#
# **This variable is required**
#
# String to identify the image in the registry.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@ubuntu``.
#
# .. attribute:: FDO_DISTRIBUTION_IMAGE
#
# **This variable is set by this template and should be treated as read-only**
......@@ -586,7 +590,9 @@
#
# **This variable is required**
#
# The repository name suffix
# The repository name suffix.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@ubuntu``.
#
# .. attribute:: FDO_DISTRIBUTION_TAG
#
......@@ -594,6 +600,8 @@
#
# String to identify the image in the registry.
#
# The value supplied must be the same as supplied in ``.fdo.container-build@ubuntu``.
#
# .. attribute:: FDO_DISTRIBUTION_IMAGE
#
# **This variable is set by this template and should be treated as read-only**
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment