zuul-jobs/roles/configure-mirrors/README.rst
Ian Wienand 500eba3634
configure-mirrors: make each compontent in 9-stream configurable
When we added 9-stream with I2da3a5e8a45598c6b3ded132ea61b86b4480e262
we had some components pointing to the mirrors and some not.  This is
basically because the OpenDev mirrors choose to mirror these parts of
the distribution.  It was an oversight to do things like this, as this
is nominally a generic configuration tool.

This proposes that we put each component behind a variable which can
be enabled or disabled.  This way users of the role can switch
on-or-off whatever their local mirrors carry, and fall-back to the
generic mirror metalink in other cases.

I imagine that with future distros like this we would have everything
disabled by default in zuul-jobs, and leave it up to sites to
explicitly opt-in the various components.  We could announce this via
our usual deprecation path and do similar for 9-stream; but for now
this keeps the defaults as it is currently written.

Change-Id: Ibfd88c137855c22b960099cc8d582b241c3b1db6
2022-09-16 10:32:29 +10:00

59 lines
1.9 KiB
ReStructuredText

An ansible role to configure services to use mirrors.
**Role Variables**
.. zuul:rolevar:: mirror_fqdn
:default: {{ zuul_site_mirror_fqdn }}
The base host for mirror servers.
.. zuul:rolevar:: mirror_use_ssl
:default: False
Use ssl to communicate to mirror endpoints. Note if the platform
cannot use ssl (for example Ubuntu Xenial apt needs additional packages)
this will still use http instead of https when set for that platform.
.. zuul:rolevar:: pypi_fqdn
:default: {{ mirror_fqdn }}
The base host for PyPi mirror server.
.. zuul:rolevar:: pypi_mirror
URL to override the generated pypi mirror url based on
:zuul:rolevar:`configure-mirrors.pypi_fqdn`.
.. zuul:rolevar:: set_apt_mirrors_trusted
:default: False
Set to True in order to tag APT mirrors as trusted, needed
when accessing unsigned mirrors with newer releases like
Ubuntu Bionic.
.. zuul:rolevar:: enable_deb_src_repos
:default: False
Set this to True in order to enable deb-src entries in sources.list
configs for apt. Note this option currently only works on Debian
(not Ubuntu) installations.
.. zuul:rolevar:: configure_mirrors_extra_repos
:default: True
Set to False to opt-out of installing extra repositories such
as PowerTools and HighAvailability on centos-8-stream and
backports for Debian/Ubuntu. The intent is to match the upstream
distro state when this variable is set to False. Note that this
role is not necessarily consistent with the repos that are
enabled by default between distribution versions (centos stream
8 vs. 9 for example).
.. zuul:rolevar:: configure_mirrors_components_9_stream
:default: See `vars/CentOS-9.yaml`
A list of the components that should be redirected to the
`mirror_fqdn` when setting up a CentOS 9-stream host. For example,
your mirror may only mirror some components, or not the
debug/source components, etc.