kolla/doc/image-building.rst
Martin André 6c5aeeee41 Consolidate kolla-build configuration in one file
The source location definition previously in build.ini was merged in
etc/kolla/kolla-build.conf since it is really configuration for the
kolla-build tool.

Change-Id: I7531af0029bdfeabbaefb8a6aa97b70bb12c021a
Closes-Bug: #1496702
2015-09-21 21:20:48 +09:00

126 lines
2.8 KiB
ReStructuredText

Image building
==============
The ``tools/build.py`` script in this repository is
responsible for building docker images.
Guide
-----
In general, you will build images like this:
::
$ tools/build.py
By default, the above command would build all images based on centos image.
If you want to change the base distro image, add ``-b``:
::
$ tools/build.py -b ubuntu
There are following distros available for building images:
- fedora
- centos
- oraclelinux
- ubuntu
To push the image after building, add ``--push``:
::
$ tools/build.py --push
If you want to build only keystone image, use the following command:
::
$ tools/build.py keystone
If you want to build multiple images e.g. keystone and nova, use the following command:
::
$ tools/build.py keystone nova
``tools/build.py`` use ``kollaglue`` as default namespace. If you
want to push images to your dockerhub, change the namespace like:
::
$ tools/build.py -n yourusername --push
The build script reads its configuration from ``/etc/kolla/kolla-build.conf``
or ``etc/kolla/kolla-build.conf``. This is where to change the default
settings.
Build OpenStack from Source
---------------------------
When building images, there are two methods of the OpenStack install.
One is ``binary``. Another is ``source``.
The ``binary`` means that OpenStack will be installed from apt/yum.
And the ``source`` means that OpenStack will be installed from source code.
The default method of the OpenStack install is ``binary``.
You can change it to ``source`` using the following command:
::
tools/build.py -t source
The locations of OpenStack source code are written in
``etc/kolla/kolla-build.conf``.
Now the source type support ``url`` and ``git``. The
``etc/kolla/kolla-build.conf`` looks like:
::
[glance-base]
type = url
location = http://tarballs.openstack.org/glance/glance-master.tar.gz
[keystone]
type = git
location = https://github.com/openstack/keystone
reference = stable/kilo
To build RHEL containers, it is necessary to use the -i (include header)
feature to include registration with RHN of the container runtime operating
system. To obtain a RHN username/password/pool id, contact Red Hat.
First create a file called rhel-include:
::
RUN subscription-manager register --user=<user-name> --password=<password> \
&& subscription-manager attach --pool <pool-id>
Then build RHEL containers:
::
build -b rhel -i ./rhel-include
Known issues
------------
1. Can't build base image because docker fails to install systemd.
There are some issue between docker and AUFS. The simple workaround
to avoid the issue is that add ``-s devicemapper`` to ``DOCKER_OPTS``.
Get more information about the issue from DockerBug_.
.. _DockerBug: https://github.com/docker/docker/issues/6980