51074b0a42
This patchset enables potentially full customization of Dockerfiles
provided by Kolla without having to change main Kolla code. Mechanism is
based on jinja2 block mechanism. In our dockerfiles we'll add blocks
(mostly empty) with highly standarized naming, then in override file
users will be able to fill/override contents of these blocks. Example is
shown in this patch.
To enable cutomized override file call build.py
--template-override=path-to-file Only caveat is that header {% extends
.. %} has to stay
Change-Id: I5957024e5652f9677c439fb2fcd524e467b951af
Partially-implements: blueprint third-party-plugin-support
315 lines
13 KiB
Python
315 lines
13 KiB
Python
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import itertools
|
|
|
|
from oslo_config import cfg
|
|
from oslo_config import types
|
|
|
|
from kolla.version import version_info as version
|
|
|
|
|
|
BASE_OS_DISTRO = ['centos', 'ubuntu', 'oraclelinux', 'debian']
|
|
DISTRO_RELEASE = {
|
|
'centos': '7',
|
|
'redhat': '7',
|
|
'oraclelinux': '7',
|
|
'debian': '8',
|
|
'ubuntu': '14.04',
|
|
}
|
|
RDO_MIRROR = "http://trunk.rdoproject.org/centos7"
|
|
DELOREAN = "{}/current-passed-ci/delorean.repo".format(RDO_MIRROR)
|
|
DELOREAN_DEPS = "{}/delorean-deps.repo".format(RDO_MIRROR)
|
|
INSTALL_TYPE_CHOICES = ['binary', 'source', 'rdo', 'rhos']
|
|
|
|
_PROFILE_OPTS = [
|
|
cfg.ListOpt('infra',
|
|
default=['ceph', 'cron', 'mariadb', 'haproxy',
|
|
'keepalived', 'kolla-toolbox', 'memcached',
|
|
'mongodb', 'openvswitch', 'rabbitmq', 'heka'],
|
|
help='Infra images'),
|
|
cfg.ListOpt('main',
|
|
default=['cinder', 'ceilometer', 'glance', 'heat',
|
|
'horizon', 'iscsi', 'keystone', 'neutron', 'nova',
|
|
'swift'],
|
|
help='Main images'),
|
|
cfg.ListOpt('aux',
|
|
default=['aodh', 'designate', 'gnocchi', 'ironic',
|
|
'magnum', 'mistral', 'trove,' 'zaqar', 'zookeeper'],
|
|
help='Aux Images'),
|
|
cfg.ListOpt('default',
|
|
default=['cron', 'kolla-toolbox', 'glance', 'haproxy',
|
|
'heat', 'horizon', 'keepalived', 'keystone',
|
|
'memcached', 'mariadb', 'neutron', 'nova',
|
|
'openvswitch', 'rabbitmq', 'heka'],
|
|
help='Default images'),
|
|
cfg.ListOpt('gate',
|
|
default=['cron', 'glance', 'haproxy', 'keepalived', 'keystone',
|
|
'kolla-toolbox', 'mariadb', 'memcached', 'neutron',
|
|
'nova', 'openvswitch', 'rabbitmq', 'heka'],
|
|
help='Gate images')
|
|
]
|
|
|
|
_CLI_OPTS = [
|
|
cfg.StrOpt('base', short='b', default='centos',
|
|
choices=BASE_OS_DISTRO,
|
|
deprecated_group='kolla-build',
|
|
help='The distro type of the base image'),
|
|
cfg.StrOpt('base-tag', default='latest',
|
|
deprecated_group='kolla-build',
|
|
help='The base distro image tag'),
|
|
cfg.StrOpt('base-image', default=None,
|
|
help='The base image name. Default is the same with base'),
|
|
cfg.BoolOpt('debug', short='d', default=False,
|
|
deprecated_group='kolla-build',
|
|
help='Turn on debugging log level'),
|
|
cfg.DictOpt('build-args',
|
|
help='Set docker build time variables'),
|
|
cfg.StrOpt('include-header', short='i',
|
|
deprecated_group='kolla-build',
|
|
help=('Path to custom file to be added at '
|
|
'beginning of base Dockerfile')),
|
|
cfg.StrOpt('include-footer', short='I',
|
|
deprecated_group='kolla-build',
|
|
help=('Path to custom file to be added at '
|
|
'end of Dockerfiles for final images')),
|
|
cfg.BoolOpt('keep', default=False,
|
|
deprecated_group='kolla-build',
|
|
help='Keep failed intermediate containers'),
|
|
cfg.BoolOpt('list-dependencies', short='l',
|
|
help='Show image dependencies (filtering supported)'),
|
|
cfg.BoolOpt('list-images',
|
|
help='Show all available images'),
|
|
cfg.StrOpt('namespace', short='n', default='kollaglue',
|
|
deprecated_group='kolla-build',
|
|
help='The Docker namespace name'),
|
|
cfg.BoolOpt('cache', default=True,
|
|
help='Use the Docker cache when building',
|
|
),
|
|
cfg.BoolOpt('no-cache', default=False,
|
|
help='Do not use the Docker cache when building',
|
|
deprecated_for_removal=True),
|
|
cfg.MultiOpt('profile', types.String(), short='p',
|
|
deprecated_group='kolla-build',
|
|
help=('Build a pre-defined set of images, see [profiles]'
|
|
' section in config. The default profiles are:'
|
|
' {}'.format(', '.join(
|
|
[opt.name for opt in _PROFILE_OPTS])
|
|
))),
|
|
cfg.BoolOpt('push', default=False,
|
|
deprecated_group='kolla-build',
|
|
help='Push images after building'),
|
|
cfg.IntOpt('push-threads', default=1, min=1,
|
|
deprecated_group='kolla-build',
|
|
help=('The number of threads to user while pushing'
|
|
' Images. Note: Docker can not handle threading'
|
|
' push properly.')),
|
|
cfg.IntOpt('retries', short='r', default=3, min=0,
|
|
deprecated_group='kolla-build',
|
|
help='The number of times to retry while building'),
|
|
cfg.MultiOpt('regex', types.String(), positional=True,
|
|
help=('Build only images matching regex and its'
|
|
' dependencies')),
|
|
cfg.StrOpt('registry', deprecated_group='kolla-build',
|
|
help=('The docker registry host. The default registry host'
|
|
' is Docker Hub')),
|
|
cfg.StrOpt('save-dependency',
|
|
help=('Path to the file to store the docker image'
|
|
' dependency in Graphviz dot format')),
|
|
cfg.StrOpt('type', short='t', default='binary',
|
|
choices=INSTALL_TYPE_CHOICES,
|
|
dest='install_type',
|
|
help=('The method of the OpenStack install')),
|
|
cfg.IntOpt('threads', short='T', default=8, min=1,
|
|
deprecated_group='kolla-build',
|
|
help=('The number of threads to use while building.'
|
|
' (Note: setting to one will allow real time'
|
|
' logging.)')),
|
|
cfg.StrOpt('tag', default=version.cached_version_string(),
|
|
deprecated_group='kolla-build',
|
|
help='The Docker tag'),
|
|
cfg.BoolOpt('template-only', default=False,
|
|
deprecated_group='kolla-build',
|
|
help=("Don't build images. Generate Dockerfile only")),
|
|
cfg.IntOpt('timeout', default=120,
|
|
help='Time in seconds after which any operation times out'),
|
|
cfg.StrOpt('template-override',
|
|
help='Path to template override file'),
|
|
]
|
|
|
|
_BASE_OPTS = [
|
|
cfg.StrOpt('maintainer', deprecated_group='kolla-build',
|
|
default='Kolla Project (https://launchpad.net/kolla)',
|
|
help='The MAINTAINER field'),
|
|
cfg.ListOpt('rpm_setup_config', default=[DELOREAN, DELOREAN_DEPS],
|
|
deprecated_group='kolla-build',
|
|
help=('Comma separated list of .rpm or .repo file(s) '
|
|
'or URL(s) to install before building containers')),
|
|
cfg.StrOpt('apt_sources_list', help=('Path to custom sources.list')),
|
|
cfg.StrOpt('apt_preferences', help=('Path to custom apt/preferences'))
|
|
]
|
|
|
|
|
|
SOURCES = {
|
|
'openstack-base': {
|
|
'type': 'url',
|
|
'location': ('https://github.com/openstack/requirements/tarball/'
|
|
'master')},
|
|
'aodh-base': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/aodh/'
|
|
'aodh-master.tar.gz')},
|
|
'ceilometer-base': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/ceilometer/'
|
|
'ceilometer-master.tar.gz')},
|
|
'cinder-base': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/cinder/'
|
|
'cinder-master.tar.gz')},
|
|
'designate-base': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/designate/'
|
|
'designate-master.tar.gz')},
|
|
'glance-base': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/glance/'
|
|
'glance-master.tar.gz')},
|
|
'gnocchi-base': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/gnocchi/'
|
|
'gnocchi-master.tar.gz')},
|
|
'heat-base': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/heat/'
|
|
'heat-master.tar.gz')},
|
|
'horizon': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/horizon/'
|
|
'horizon-master.tar.gz')},
|
|
'ironic-base': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/ironic/'
|
|
'ironic-master.tar.gz')},
|
|
'keystone': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/keystone/'
|
|
'keystone-master.tar.gz')},
|
|
'magnum-base': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/magnum/'
|
|
'magnum-master.tar.gz')},
|
|
'manila-base': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/manila/'
|
|
'manila-master.tar.gz')},
|
|
'mistral-base': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/mistral/'
|
|
'mistral-master.tar.gz')},
|
|
'murano-base': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/murano/'
|
|
'murano-master.tar.gz')},
|
|
'neutron-base': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/neutron/'
|
|
'neutron-master.tar.gz')},
|
|
'neutron-lbaas-agent': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/neutron-lbaas/'
|
|
'neutron-lbaas-master.tar.gz')},
|
|
'nova-base': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/nova/'
|
|
'nova-master.tar.gz')},
|
|
'nova-spicehtml5proxy': {
|
|
'type': 'url',
|
|
'location': ('http://github.com/SPICE/spice-html5/tarball/'
|
|
'spice-html5-0.1.6')},
|
|
'nova-novncproxy': {
|
|
'type': 'url',
|
|
'location': ('http://github.com/kanaka/noVNC/tarball/'
|
|
'v0.5.1')},
|
|
'sahara-base': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/sahara/'
|
|
'sahara-master.tar.gz')},
|
|
'swift-base': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/swift/'
|
|
'swift-master.tar.gz')},
|
|
'tempest': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/tempest/'
|
|
'tempest-master.tar.gz')},
|
|
'trove-base': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/trove/'
|
|
'trove-master.tar.gz')},
|
|
'zaqar': {
|
|
'type': 'url',
|
|
'location': ('http://tarballs.openstack.org/zaqar/'
|
|
'zaqar-master.tar.gz')}
|
|
|
|
}
|
|
|
|
|
|
def get_source_opts(type_=None, location=None, reference=None):
|
|
return [cfg.StrOpt('type', choices=['local', 'git', 'url'],
|
|
default=type_,
|
|
help='Source location type'),
|
|
cfg.StrOpt('location', default=location,
|
|
help='The location for source install'),
|
|
cfg.StrOpt('reference', default=reference,
|
|
help=('Git reference to pull, commit sha, tag '
|
|
'or branch name'))]
|
|
|
|
|
|
def gen_all_source_opts():
|
|
for name, params in SOURCES.items():
|
|
type_ = params['type']
|
|
location = params['location']
|
|
reference = params.get('reference')
|
|
yield name, get_source_opts(type_, location, reference)
|
|
|
|
|
|
def list_opts():
|
|
return itertools.chain([(None, _CLI_OPTS),
|
|
(None, _BASE_OPTS),
|
|
('profiles', _PROFILE_OPTS)],
|
|
gen_all_source_opts(),
|
|
)
|
|
|
|
|
|
def parse(conf, args, usage=None, prog=None,
|
|
default_config_files=None):
|
|
conf.register_cli_opts(_CLI_OPTS)
|
|
conf.register_opts(_BASE_OPTS)
|
|
conf.register_opts(_PROFILE_OPTS, group='profiles')
|
|
for name, opts in gen_all_source_opts():
|
|
conf.register_opts(opts, name)
|
|
|
|
conf(args=args,
|
|
project='kolla',
|
|
usage=usage,
|
|
prog=prog,
|
|
version=version.cached_version_string(),
|
|
default_config_files=default_config_files)
|
|
|
|
# NOTE(jeffrey4l): set the default base tag based on the
|
|
# base option
|
|
conf.set_default('base_tag', DISTRO_RELEASE.get(conf.base))
|
|
|
|
if not conf.base_image:
|
|
conf.base_image = conf.base
|