kolla/doc/image-building.rst
Kuo-tung Kao d4ac18c4fd build.py fails with error on AUFS
add workaround to avoid the issue to image-building document.

Change-Id: Icf34acb2f25c813dee7c7a3dfbb71560be5a970f
Closes-Bug: #1487458
2015-09-10 14:58:41 +08:00

120 lines
2.6 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
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 Opentack source code are written in ``build.ini``.
Now the source type support ``url`` and ``git``. The ``build.ini`` 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