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

docs: add missing docs for some FDO variables


Signed-off-by: Peter Hutterer's avatarPeter Hutterer <peter.hutterer@who-t.net>
parent 33acdc19
......@@ -145,12 +145,28 @@
#
# **Variables required:**
#
# - ``FDO_UPSTREAM_REPO``: the GitLab project path to the upstream project
{% if not version %}
# - ``FDO_DISTRIBUTION_VERSION``: the {{distribution}} version to build, e.g. {{version_examples|join(', ')}}
{% endif %}
# - ``FDO_DISTRIBUTION_TAG``: string to identify the image in the registry
# - ``FDO_REPO_SUFFIX`` **(optional)**: the repository name suffix to use, see below.
#
# **Optional variables:**
#
# - ``FDO_UPSTREAM_REPO``: the GitLab project path to the upstream project
# - ``FDO_REPO_SUFFIX``: the repository name suffix to use, see below.
# - ``FDO_DISTRIBUTION_PACKAGES``: packages to install as a space-separated single string, e.g. "curl wget"
# - ``FDO_DISTRIBUTION_EXEC``: an executable run after the installation of the ``FDO_DISTRIBUTION_PACKAGES``
# - ``FDO_FORCE_REBUILD``: if set, the image will be built even if it exists in the registry already
# - ``FDO_EXPIRES_AFTER``: if set enables an expiration time on the image to
# aid the garbage collector in deciding when an image can be removed. This
# should be set for temporary images that are not intended to be kept
# forever. Allowed values are e.g. ``1h`` (one hour), ``2d`` (two days) or
# ``3w`` (three weeks).
# - ``FDO_CACHE_DIR``: If set, the given directory is mounted as ``/cache``
# when ``FDO_DISTRIBUTION_EXEC`` is run. This can allow for passing of
# cache values between build jobs (if run on the same runner). You should
# not usually need to set this, it defaults to ``/cache`` from the host
# and thus enables cache sharing by default.
#
# The resulting image will be pushed to the local registry.
#
......@@ -483,7 +499,7 @@
# {{distribution}} template that pulls the {{distribution}} image from the
# registry based on {% if not version %}``FDO_DISTRIBUTION_VERSION`` and {% endif -%} ``FDO_DISTRIBUTION_TAG``.
# This template must be provided the same variable values as supplied in
# ``container-build``.
# ``.fdo.container-build@{{distribution}}``.
#
# This template sets ``image:`` to the generated image. You may override this.
#
......@@ -521,7 +537,7 @@
# {{distribution}} template that pulls the {{distribution}} image from the
# registry based on ``FDO_REPO_SUFFIX``.
# This template must be provided the same variable values as supplied in
# ``container-build``.
# ``.fdo.container-build@{{distribution}}``.
#
# This template sets ``image:`` to the generated image. You may override this.
#
......
......@@ -138,9 +138,25 @@
#
# **Variables required:**
#
# - ``FDO_UPSTREAM_REPO``: the GitLab project path to the upstream project
# - ``FDO_DISTRIBUTION_TAG``: string to identify the image in the registry
# - ``FDO_REPO_SUFFIX`` **(optional)**: the repository name suffix to use, see below.
#
# **Optional variables:**
#
# - ``FDO_UPSTREAM_REPO``: the GitLab project path to the upstream project
# - ``FDO_REPO_SUFFIX``: the repository name suffix to use, see below.
# - ``FDO_DISTRIBUTION_PACKAGES``: packages to install as a space-separated single string, e.g. "curl wget"
# - ``FDO_DISTRIBUTION_EXEC``: an executable run after the installation of the ``FDO_DISTRIBUTION_PACKAGES``
# - ``FDO_FORCE_REBUILD``: if set, the image will be built even if it exists in the registry already
# - ``FDO_EXPIRES_AFTER``: if set enables an expiration time on the image to
# aid the garbage collector in deciding when an image can be removed. This
# should be set for temporary images that are not intended to be kept
# forever. Allowed values are e.g. ``1h`` (one hour), ``2d`` (two days) or
# ``3w`` (three weeks).
# - ``FDO_CACHE_DIR``: If set, the given directory is mounted as ``/cache``
# when ``FDO_DISTRIBUTION_EXEC`` is run. This can allow for passing of
# cache values between build jobs (if run on the same runner). You should
# not usually need to set this, it defaults to ``/cache`` from the host
# and thus enables cache sharing by default.
#
# The resulting image will be pushed to the local registry.
#
......@@ -261,7 +277,7 @@
# alpine template that pulls the alpine image from the
# registry based on ``FDO_DISTRIBUTION_TAG``.
# This template must be provided the same variable values as supplied in
# ``container-build``.
# ``.fdo.container-build@alpine``.
#
# This template sets ``image:`` to the generated image. You may override this.
#
......@@ -288,7 +304,7 @@
# alpine template that pulls the alpine image from the
# registry based on ``FDO_REPO_SUFFIX``.
# This template must be provided the same variable values as supplied in
# ``container-build``.
# ``.fdo.container-build@alpine``.
#
# This template sets ``image:`` to the generated image. You may override this.
#
......
......@@ -138,9 +138,25 @@
#
# **Variables required:**
#
# - ``FDO_UPSTREAM_REPO``: the GitLab project path to the upstream project
# - ``FDO_DISTRIBUTION_TAG``: string to identify the image in the registry
# - ``FDO_REPO_SUFFIX`` **(optional)**: the repository name suffix to use, see below.
#
# **Optional variables:**
#
# - ``FDO_UPSTREAM_REPO``: the GitLab project path to the upstream project
# - ``FDO_REPO_SUFFIX``: the repository name suffix to use, see below.
# - ``FDO_DISTRIBUTION_PACKAGES``: packages to install as a space-separated single string, e.g. "curl wget"
# - ``FDO_DISTRIBUTION_EXEC``: an executable run after the installation of the ``FDO_DISTRIBUTION_PACKAGES``
# - ``FDO_FORCE_REBUILD``: if set, the image will be built even if it exists in the registry already
# - ``FDO_EXPIRES_AFTER``: if set enables an expiration time on the image to
# aid the garbage collector in deciding when an image can be removed. This
# should be set for temporary images that are not intended to be kept
# forever. Allowed values are e.g. ``1h`` (one hour), ``2d`` (two days) or
# ``3w`` (three weeks).
# - ``FDO_CACHE_DIR``: If set, the given directory is mounted as ``/cache``
# when ``FDO_DISTRIBUTION_EXEC`` is run. This can allow for passing of
# cache values between build jobs (if run on the same runner). You should
# not usually need to set this, it defaults to ``/cache`` from the host
# and thus enables cache sharing by default.
#
# The resulting image will be pushed to the local registry.
#
......@@ -248,7 +264,7 @@
# arch template that pulls the arch image from the
# registry based on ``FDO_DISTRIBUTION_TAG``.
# This template must be provided the same variable values as supplied in
# ``container-build``.
# ``.fdo.container-build@arch``.
#
# This template sets ``image:`` to the generated image. You may override this.
#
......@@ -275,7 +291,7 @@
# arch template that pulls the arch image from the
# registry based on ``FDO_REPO_SUFFIX``.
# This template must be provided the same variable values as supplied in
# ``container-build``.
# ``.fdo.container-build@arch``.
#
# This template sets ``image:`` to the generated image. You may override this.
#
......
......@@ -138,10 +138,26 @@
#
# **Variables required:**
#
# - ``FDO_UPSTREAM_REPO``: the GitLab project path to the upstream project
# - ``FDO_DISTRIBUTION_VERSION``: the centos version to build, e.g. 7, 8
# - ``FDO_DISTRIBUTION_TAG``: string to identify the image in the registry
# - ``FDO_REPO_SUFFIX`` **(optional)**: the repository name suffix to use, see below.
#
# **Optional variables:**
#
# - ``FDO_UPSTREAM_REPO``: the GitLab project path to the upstream project
# - ``FDO_REPO_SUFFIX``: the repository name suffix to use, see below.
# - ``FDO_DISTRIBUTION_PACKAGES``: packages to install as a space-separated single string, e.g. "curl wget"
# - ``FDO_DISTRIBUTION_EXEC``: an executable run after the installation of the ``FDO_DISTRIBUTION_PACKAGES``
# - ``FDO_FORCE_REBUILD``: if set, the image will be built even if it exists in the registry already
# - ``FDO_EXPIRES_AFTER``: if set enables an expiration time on the image to
# aid the garbage collector in deciding when an image can be removed. This
# should be set for temporary images that are not intended to be kept
# forever. Allowed values are e.g. ``1h`` (one hour), ``2d`` (two days) or
# ``3w`` (three weeks).
# - ``FDO_CACHE_DIR``: If set, the given directory is mounted as ``/cache``
# when ``FDO_DISTRIBUTION_EXEC`` is run. This can allow for passing of
# cache values between build jobs (if run on the same runner). You should
# not usually need to set this, it defaults to ``/cache`` from the host
# and thus enables cache sharing by default.
#
# The resulting image will be pushed to the local registry.
#
......@@ -248,7 +264,7 @@
# centos template that pulls the centos image from the
# registry based on ``FDO_DISTRIBUTION_VERSION`` and ``FDO_DISTRIBUTION_TAG``.
# This template must be provided the same variable values as supplied in
# ``container-build``.
# ``.fdo.container-build@centos``.
#
# This template sets ``image:`` to the generated image. You may override this.
#
......@@ -276,7 +292,7 @@
# centos template that pulls the centos image from the
# registry based on ``FDO_REPO_SUFFIX``.
# This template must be provided the same variable values as supplied in
# ``container-build``.
# ``.fdo.container-build@centos``.
#
# This template sets ``image:`` to the generated image. You may override this.
#
......
......@@ -138,10 +138,26 @@
#
# **Variables required:**
#
# - ``FDO_UPSTREAM_REPO``: the GitLab project path to the upstream project
# - ``FDO_DISTRIBUTION_VERSION``: the debian version to build, e.g. stretch, sid, buster
# - ``FDO_DISTRIBUTION_TAG``: string to identify the image in the registry
# - ``FDO_REPO_SUFFIX`` **(optional)**: the repository name suffix to use, see below.
#
# **Optional variables:**
#
# - ``FDO_UPSTREAM_REPO``: the GitLab project path to the upstream project
# - ``FDO_REPO_SUFFIX``: the repository name suffix to use, see below.
# - ``FDO_DISTRIBUTION_PACKAGES``: packages to install as a space-separated single string, e.g. "curl wget"
# - ``FDO_DISTRIBUTION_EXEC``: an executable run after the installation of the ``FDO_DISTRIBUTION_PACKAGES``
# - ``FDO_FORCE_REBUILD``: if set, the image will be built even if it exists in the registry already
# - ``FDO_EXPIRES_AFTER``: if set enables an expiration time on the image to
# aid the garbage collector in deciding when an image can be removed. This
# should be set for temporary images that are not intended to be kept
# forever. Allowed values are e.g. ``1h`` (one hour), ``2d`` (two days) or
# ``3w`` (three weeks).
# - ``FDO_CACHE_DIR``: If set, the given directory is mounted as ``/cache``
# when ``FDO_DISTRIBUTION_EXEC`` is run. This can allow for passing of
# cache values between build jobs (if run on the same runner). You should
# not usually need to set this, it defaults to ``/cache`` from the host
# and thus enables cache sharing by default.
#
# The resulting image will be pushed to the local registry.
#
......@@ -447,7 +463,7 @@
# debian template that pulls the debian image from the
# registry based on ``FDO_DISTRIBUTION_VERSION`` and ``FDO_DISTRIBUTION_TAG``.
# This template must be provided the same variable values as supplied in
# ``container-build``.
# ``.fdo.container-build@debian``.
#
# This template sets ``image:`` to the generated image. You may override this.
#
......@@ -475,7 +491,7 @@
# debian template that pulls the debian image from the
# registry based on ``FDO_REPO_SUFFIX``.
# This template must be provided the same variable values as supplied in
# ``container-build``.
# ``.fdo.container-build@debian``.
#
# This template sets ``image:`` to the generated image. You may override this.
#
......
......@@ -138,10 +138,26 @@
#
# **Variables required:**
#
# - ``FDO_UPSTREAM_REPO``: the GitLab project path to the upstream project
# - ``FDO_DISTRIBUTION_VERSION``: the fedora version to build, e.g. 31, 30, 32, 33
# - ``FDO_DISTRIBUTION_TAG``: string to identify the image in the registry
# - ``FDO_REPO_SUFFIX`` **(optional)**: the repository name suffix to use, see below.
#
# **Optional variables:**
#
# - ``FDO_UPSTREAM_REPO``: the GitLab project path to the upstream project
# - ``FDO_REPO_SUFFIX``: the repository name suffix to use, see below.
# - ``FDO_DISTRIBUTION_PACKAGES``: packages to install as a space-separated single string, e.g. "curl wget"
# - ``FDO_DISTRIBUTION_EXEC``: an executable run after the installation of the ``FDO_DISTRIBUTION_PACKAGES``
# - ``FDO_FORCE_REBUILD``: if set, the image will be built even if it exists in the registry already
# - ``FDO_EXPIRES_AFTER``: if set enables an expiration time on the image to
# aid the garbage collector in deciding when an image can be removed. This
# should be set for temporary images that are not intended to be kept
# forever. Allowed values are e.g. ``1h`` (one hour), ``2d`` (two days) or
# ``3w`` (three weeks).
# - ``FDO_CACHE_DIR``: If set, the given directory is mounted as ``/cache``
# when ``FDO_DISTRIBUTION_EXEC`` is run. This can allow for passing of
# cache values between build jobs (if run on the same runner). You should
# not usually need to set this, it defaults to ``/cache`` from the host
# and thus enables cache sharing by default.
#
# The resulting image will be pushed to the local registry.
#
......@@ -438,7 +454,7 @@
# fedora template that pulls the fedora image from the
# registry based on ``FDO_DISTRIBUTION_VERSION`` and ``FDO_DISTRIBUTION_TAG``.
# This template must be provided the same variable values as supplied in
# ``container-build``.
# ``.fdo.container-build@fedora``.
#
# This template sets ``image:`` to the generated image. You may override this.
#
......@@ -466,7 +482,7 @@
# fedora template that pulls the fedora image from the
# registry based on ``FDO_REPO_SUFFIX``.
# This template must be provided the same variable values as supplied in
# ``container-build``.
# ``.fdo.container-build@fedora``.
#
# This template sets ``image:`` to the generated image. You may override this.
#
......
......@@ -138,10 +138,26 @@
#
# **Variables required:**
#
# - ``FDO_UPSTREAM_REPO``: the GitLab project path to the upstream project
# - ``FDO_DISTRIBUTION_VERSION``: the ubuntu version to build, e.g. 19.10, 18.04
# - ``FDO_DISTRIBUTION_TAG``: string to identify the image in the registry
# - ``FDO_REPO_SUFFIX`` **(optional)**: the repository name suffix to use, see below.
#
# **Optional variables:**
#
# - ``FDO_UPSTREAM_REPO``: the GitLab project path to the upstream project
# - ``FDO_REPO_SUFFIX``: the repository name suffix to use, see below.
# - ``FDO_DISTRIBUTION_PACKAGES``: packages to install as a space-separated single string, e.g. "curl wget"
# - ``FDO_DISTRIBUTION_EXEC``: an executable run after the installation of the ``FDO_DISTRIBUTION_PACKAGES``
# - ``FDO_FORCE_REBUILD``: if set, the image will be built even if it exists in the registry already
# - ``FDO_EXPIRES_AFTER``: if set enables an expiration time on the image to
# aid the garbage collector in deciding when an image can be removed. This
# should be set for temporary images that are not intended to be kept
# forever. Allowed values are e.g. ``1h`` (one hour), ``2d`` (two days) or
# ``3w`` (three weeks).
# - ``FDO_CACHE_DIR``: If set, the given directory is mounted as ``/cache``
# when ``FDO_DISTRIBUTION_EXEC`` is run. This can allow for passing of
# cache values between build jobs (if run on the same runner). You should
# not usually need to set this, it defaults to ``/cache`` from the host
# and thus enables cache sharing by default.
#
# The resulting image will be pushed to the local registry.
#
......@@ -491,7 +507,7 @@
# ubuntu template that pulls the ubuntu image from the
# registry based on ``FDO_DISTRIBUTION_VERSION`` and ``FDO_DISTRIBUTION_TAG``.
# This template must be provided the same variable values as supplied in
# ``container-build``.
# ``.fdo.container-build@ubuntu``.
#
# This template sets ``image:`` to the generated image. You may override this.
#
......@@ -519,7 +535,7 @@
# ubuntu template that pulls the ubuntu image from the
# registry based on ``FDO_REPO_SUFFIX``.
# This template must be provided the same variable values as supplied in
# ``container-build``.
# ``.fdo.container-build@ubuntu``.
#
# This template sets ``image:`` to the generated image. You may override this.
#
......
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