openstack/openstack-ansible-repo_server
Code Issues Proposed changes

[doc] Add documentation around repo_server role

Browse Source 
Closes-Bug: #1437045
Change-Id: Iec96cf8050143584961dafd241cf87e28075383a
Signed-off-by: Dmitriy Rabotyagov <dmitriy.rabotyagov@cleura.com>
This commit is contained in:
Dmitriy Rabotyagov
2025-11-13 17:46:48 +01:00
parent af785c6bde
commit aba8670740
1 changed files with 49 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
doc/source/index.rst
View File

@@ -2,11 +2,57 @@
OpenStack-Ansible Repo Server
=============================
Ansible role that deploys a repository server for python packages, git
sources and package caching for deb/rpm.
Abstract
~~~~~~~~
Ansible role that deploys a repository server for built python packages
(wheels), requirements and constraints for specific builds.
To clone or view the source code for this repository, visit the role repository
for `repo_server <https://github.com/openstack/openstack-ansible-repo_server>`_.
for `repo_server <https://opendev.org/openstack/openstack-ansible-repo_server>`_.
Role purpose
~~~~~~~~~~~~
Repo container is used as a target by other OpenStack-Ansible roles and
collections when `venv_wheel_build_enable : true`.
In this scenario it is expected, that there will be a repo instance per each
Operating System family and major version, as well as for each CPU architecture
in the deployments.
Web server
~~~~~~~~~~
In order to serve pre-built content to clients (like ``pip`` or ``uv``), an
Apache Web server is being used.
We leverage `httpd <https://opendev.org/openstack/ansible-role-httpd>`_
role to set up a web server, and to manage a corresponding Virtual Host.
Using shared file system
~~~~~~~~~~~~~~~~~~~~~~~~
When multiple instances of a repo server exist, is designed to leverage a
shared filesystem, mounted for ``/var/www/repo`` directory.
This filesystem is used to store built results and ensure that each repo server
is able to serve wheels for all available variants in the deployment.
There are no requirements to filesystem performance or reliability, as stored
cache data can be re-built from scratch, in case of filesystem failure.
By default, ``openstack.osa.repo`` playbook will install a GlusterFS as a
shared filesystem directly on all repo servers.
You can disable this behavior by setting
``openstack_repo_server_enable_glusterfs: false``.
You can also use any existing shared filesystem by defining
``repo_server_systemd_mounts`` variable - in this case it will be mounted via
`systemd_mount <https://opendev.org/openstack/ansible-role-systemd_mount>`_ role.
Default variables
~~~~~~~~~~~~~~~~~