Files
openstack-helm-images/doc/source/index.rst
Jean-Philippe Evrard 0acfaab7b1 Add openstack-helm repo images
This adds the building of the images present in the OpenStack-Helm
repository.

Images follow the same process as images from the osh-infra
repository.

Kubernetes-entrypoint is not used anymore and therefore was
not migrated over.

Likewise, LOCI is not following these images building process,
and therefore will be included in a different patch.

The manual build script do not expose the extra arguments
previously exposed, like KUBE_VERSION or OVS_VERSION by default.
It also means a future tagged version of this repository will
use the KUBE_VERSION or OVS_VERSION that are in tree, and
therefore very explicit.

Change-Id: If4ff73c37ed8bccb9f6951f3ccdbb7640e9b55a5
2018-11-29 08:45:54 +00:00

74 lines
1.8 KiB
ReStructuredText

=================================================
Welcome to OpenStack-Helm-Images's documentation!
=================================================
This repository is in charge of the image building for
openstack-helm repositories.
Please check the documentation of each section for the
relevant build instructions.
By default, these images are built on a Ubuntu 18.04 LTS
node.
Setup a build node
==================
Here are the instructions to setup a build node with
Ubuntu 18.04 LTS:
::
apt update
apt install -y docker.io git
Modifying the build with environment
====================================
Unless explicitly written, all the `build.sh`
convenience scripts allow to pass arguments to the
docker build process: The `build.sh` scripts have a
environment variable (`extra_build_args`), which can
be used to pass arbitrary data.
Next to the extra arguments, you can modify the
`build.sh` behavior by setting the following
environment variables:
::
VERSION
DISTRO
REGISTRY_URI=${REGISTRY_URI:-"openstackhelm/"}
`VERSION` is the expected tag version of the image,
and defaults to `latest`
`DISTRO` is used if you want to build an image with
a different Dockerfile, for example with another
distribution. `Dockerfile.${DISTRO}` must match
an existing filename.
`REGISTRY_URI` is part of the image name, representing
the location of the image, used in the image tagging
process. For example `REGISTRY_URI` could be
`docker.io/openstackhelm/`. In that case, the full
name and tag of the `vbmc` image would be:
::
docker.io/openstackhelm/vbmc:latest
Please check each section of the documentation for
an overview of the build process for each container.
.. toctree::
:maxdepth: 2
:caption: Contents:
ceph-config-helper
gate-utils
libvirt
mariadb
openvswitch
tempest
vbmc
loci