Roles

build-pdf-docs

Build PDFs from sphinx documents

If the tox environment specified in tox_pdf_envlist does not exist, the PDF build will be skipped.

Role Variables

tox_pdf_envlist
Default: pdf-docs

The tox environment used for PDF doc build.

zuul_work_dir
Default: {{ zuul.project.src_dir }}

The location of the main working directory of the job.

build-wheel-cache

Build the wheel cache from requirements

Run the build scripts to create the wheel cache of the requirements project that lives on the mirror nodes.

configure-swap

Configure a swap partition

Creates a swap partition on the ephemeral block device (the rest of which will be mounted on /opt).

Role Variables

configure_swap_size
Default: 1024

The size of the swap partition, in MiB.

legacy-copy-jenkins-scripts

Copy scripts to /usr/jenkins/slave_scripts directory on remote hosts.

Note

This role is deprecated and only exists for transition purposes. It should not be used for new jobs.

neutron-horizon-hack

Hack around some requirements being declared in tox_install.sh

Note

TODO(mordred) ZOMG DELETE THIS

neutron and horizon plugin repos currently require running the tox_install.sh script where a list of additional dependencies are listed that are not in their requirements files. Luckily, tox_install.sh is designed to be run inside of a virtualenv, so we can just run it in the sphinx ~/.venv and get them installed. This will let us work towards a solution that does not involve a custom install script.

Note that this role only works if the file is called tools/tox_install.sh and takes three arguments constraints-file, opts and packages. The script must allow invocation with the single constraints-file argument as well.

Role Variables

constraints_file

Optional path to a constraints file to use.

zuul_work_virtualenv
Default: ~/.venv

Virtualenv that sphinx is installed in.

zuul_work_dir
Default: {{ zuul.project.src_dir }}

Directory to operate in.

openafs-rpm-package-build

Build OpenAFS RPM packages

This builds RPM packages for openafs

prepare-build-pdf-docs

Install Packages for build-pdf-docs

Install binary packages for build-pdf-docs.

This role currently only supports Ubuntu Bionic.

If the tox environment specified in tox_pdf_envlist does not exist, package installation will be skipped.

Role Variables

tox_pdf_envlist
Default: pdf-docs

The tox environment used for PDF doc building.

zuul_work_dir
Default: {{ zuul.project.src_dir }}

The location of the main working directory of the job.

prepare-docs-for-afs

Prepare built OpenStack docs to be published to the OpenStack AFS cell.

sphinx_build_dir
Default: doc/build

Directory relative to zuul_work_dir where Sphinx build output was put.

zuul_work_dir
Default: {{ zuul.project.src_dir }}

Directory to build documentation in.

doc_toplevel_dir
Default: doc

Directory where the documentation lives, the build documentation is in a sub directory called build, by default doc/build.

prepare-infra-docs-for-afs

Prepare built openstack-infra docs to be published to the OpenStack AFS cell.

sphinx_build_dir
Default: doc/build

Directory relative to zuul_work_dir where Sphinx build output was put.

zuul_work_dir
Default: {{ zuul.project.src_dir }}

Directory to build documentation in.

prepare-zanata-client

Prepare zanata client use

Note

This role is only available for Debian based platforms currently.

Role Variables

zanata_api_credentials

Complex argument which contains the ssh key information. It is expected that this argument comes from a Secret

zanata_api_credentials.server_id

This is the ID of the zanata server to use

zanata_api_credentials.url

The url to the zanata server

zanata_api_credentials.username

The username to use with the zanata server

zanata_api_credentials.key

The key to login with

zanata_client_version
:default: 4.3.3

The version of zanata client to install

zanata_client_checksum
:default: 25368516c2c6b94a8ad3397317abf69c723f3ba47a4f0357a31a1e075dd6f810

The expected SHA256 checksum of the zanata client

set-service-type-data-fact

Set service_type facts for a given project

Sets a type service_type_data which contains the service information for the current project as defined by the “service” definition in:

http://specs.openstack.org/openstack/service-types-authority/downloads/published-schema.json