#!/usr/bin/env 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. # TODO(jpeeler): Add clean up handler for SIGINT import argparse import ConfigParser import datetime import json import logging import os import Queue import re import requests import shutil import signal import sys import tarfile import tempfile from threading import Thread import time import docker import git import jinja2 from requests.exceptions import ConnectionError logging.basicConfig() LOG = logging.getLogger(__name__) LOG.setLevel(logging.INFO) signal.signal(signal.SIGINT, signal.SIG_DFL) class KollaDirNotFoundException(Exception): pass class WorkerThread(Thread): def __init__(self, queue, args): self.queue = queue self.nocache = args['no_cache'] self.forcerm = not args['keep'] self.retries = args['retries'] self.threads = args['threads'] self.dc = docker.Client(**docker.utils.kwargs_from_env()) super(WorkerThread, self).__init__() def end_task(self, image): """Properly inform the queue we are finished""" # No matter whether the parent failed or not, we still process # the children. We have the code in place to catch a parent in # an 'error' status for child in image['children']: self.queue.put(child) LOG.debug('Added image {} to queue'.format(child['name'])) self.queue.task_done() LOG.debug('Processed: {}'.format(image['name'])) def run(self): """Executes tasks until the queue is empty""" while True: try: image = self.queue.get() for _ in range(self.retries): self.builder(image) if image['status'] in ['built', 'unmatched', 'parent_error']: break except ConnectionError as e: LOG.error(e) LOG.error('Make sure Docker is running and that you have ' 'the correct privileges to run Docker (root)') image['status'] = "connection_error" break self.end_task(image) def process_source(self, image): source = image['source'] dest_dir = image['path'] dest_tar = os.path.join(dest_dir, source['dest']) if source.get('type') == 'url': LOG.debug("Getting tarball from " + source['source']) r = requests.get(source['source']) if r.status_code == 200: with open(dest_tar, 'wb') as f: f.write(r.content) else: LOG.error( 'Failed to download tarball: status_code {}'.format( r.status_code)) image['status'] = "error" return elif source.get('type') == 'git': clone_dir = os.path.splitext(dest_tar)[0] + \ '-' + source['reference'] try: LOG.debug("Cloning from " + source['source']) git.Git().clone(source['source'], clone_dir) LOG.debug("Git checkout by reference " + source['reference']) git.Git(clone_dir).checkout(source['reference']) except Exception as e: LOG.error("Failed to get source from git") LOG.error("Error: " + str(e)) # clean-up clone folder to retry shutil.rmtree(clone_dir) image['status'] = "error" return with tarfile.open(dest_tar, 'w') as tar: tar.add(clone_dir, arcname=os.path.basename(clone_dir)) else: LOG.error("Wrong source type: " + source.get('type')) image['status'] = "error" return # Set time on destination tarball to epoch 0 os.utime(os.path.join(dest_dir, source['dest']), (0, 0)) def builder(self, image): LOG.debug('Processing: {}'.format(image['name'])) if image['status'] == 'unmatched': return if (image['parent'] is not None and image['parent']['status'] in ['error', 'parent_error', 'connection_error']): LOG.error('Parent image error\'d with message "{}"'.format( image['parent']['status'])) image['status'] = "parent_error" return image['status'] = "building" LOG.info('Building {}'.format(image['name'])) if 'source' in image and 'source' in image['source']: self.process_source(image) if image['status'] == "error": return # Pull the latest image for the base distro only pull = True if image['parent'] is None else False image['logs'] = str() for response in self.dc.build(path=image['path'], tag=image['fullname'], nocache=self.nocache, rm=True, pull=pull, forcerm=self.forcerm): stream = json.loads(response) if 'stream' in stream: image['logs'] = image['logs'] + stream['stream'] if self.threads == 1: LOG.info('{}:{}'.format(image['name'], stream['stream'].rstrip())) if 'errorDetail' in stream: image['status'] = "error" LOG.error(stream['errorDetail']['message']) return image['status'] = "built" if self.threads == 1: LOG.info('Built: {}'.format(image['name'])) else: LOG.info('{}Built: {}'.format(image['logs'], image['name'])) def arg_parser(): parser = argparse.ArgumentParser(description='Kolla build script') parser.add_argument('regex', help=('Build only images matching ' 'regex and its dependencies'), nargs='*') parser.add_argument('-n', '--namespace', help='Set the Docker namespace name', type=str, default='kollaglue') parser.add_argument('--tag', help='Set the Docker tag', type=str, default='latest') parser.add_argument('-b', '--base', help='The base distro to use when building', type=str, default='centos') parser.add_argument('--base-tag', help='The base distro image tag', type=str, default='latest') parser.add_argument('-t', '--type', help='The method of the Openstack install', type=str, default='binary') parser.add_argument('--no-cache', help='Do not use the Docker cache when building', action='store_true', default=False) parser.add_argument('--keep', help='Keep failed intermediate containers', action='store_true', default=False) parser.add_argument('--push', help='Push images after building', action='store_true', default=False) parser.add_argument('-T', '--threads', help='The number of threads to use while building.' ' (Note: setting to one will allow real time' ' logging.)', type=int, default=8) parser.add_argument('-r', '--retries', help='The number of times to retry while building', type=int, default=3) parser.add_argument('--template', help='Create dockerfiles from templates', action='store_true', default=False) parser.add_argument('-d', '--debug', help='Turn on debugging log level', action='store_true') parser.add_argument('-i', '--include-header', help=('Path to custom file to be added at ' 'beginning of base Dockerfile'), type=str) return vars(parser.parse_args()) class KollaWorker(object): def __init__(self, args): def find_base_dir(): script_path = os.path.dirname(os.path.realpath(sys.argv[0])) if os.path.basename(script_path) == 'cmd': return os.path.join(script_path, '..', '..') if os.path.basename(script_path) == 'bin': return '/usr/share/kolla' if os.path.exists(os.path.join(script_path, 'tests')): return script_path raise KollaDirNotFoundException( 'I do not know where your Kolla directory is' ) self.base_dir = os.path.abspath(find_base_dir()) LOG.debug("Kolla base directory: " + self.base_dir) self.images_dir = os.path.join(self.base_dir, 'docker') self.templates_dir = os.path.join(self.base_dir, 'docker_templates') self.namespace = args['namespace'] self.template = args['template'] self.base = args['base'] self.base_tag = args['base_tag'] self.type_ = args['type'] self.tag = args['tag'] self.prefix = self.base + '-' + self.type_ + '-' self.config = ConfigParser.SafeConfigParser() self.config.read(os.path.join(self.base_dir, 'build.ini')) self.include_header = args['include_header'] self.regex = args['regex'] self.image_statuses_bad = dict() self.image_statuses_good = dict() self.image_statuses_unmatched = dict() def setup_working_dir(self): """Creates a working directory for use while building""" ts = time.time() ts = datetime.datetime.fromtimestamp(ts).strftime('%Y-%m-%d_%H-%M-%S_') self.temp_dir = tempfile.mkdtemp(prefix='kolla-' + ts) self.working_dir = os.path.join(self.temp_dir, 'docker') if self.template: shutil.copytree(self.templates_dir, self.working_dir) else: shutil.copytree(self.images_dir, self.working_dir) LOG.debug('Created working dir: {}'.format(self.working_dir)) def set_time(self): for root, dirs, files in os.walk(self.working_dir): for file_ in files: os.utime(os.path.join(root, file_), (0, 0)) for dir_ in dirs: os.utime(os.path.join(root, dir_), (0, 0)) LOG.debug('Set atime and mtime to 0 for all content in working dir') def create_dockerfiles(self): for path in self.docker_build_paths: template_name = "Dockerfile.j2" env = jinja2.Environment(loader=jinja2.FileSystemLoader(path)) template = env.get_template(template_name) values = {'base_distro': self.base, 'base_distro_tag': self.base_tag, 'install_type': self.type_, 'namespace': self.namespace, 'tag': self.tag} if self.include_header: with open(self.include_header, 'r') as f: values['include_header'] = f.read() content = template.render(values) with open(os.path.join(path, 'Dockerfile'), 'w') as f: f.write(content) def find_dockerfiles(self): """Recursive search for Dockerfiles in the working directory""" self.docker_build_paths = list() if self.template: path = self.working_dir filename = 'Dockerfile.j2' else: path = os.path.join(self.working_dir, self.base, self.type_) filename = 'Dockerfile' for root, dirs, names in os.walk(path): if filename in names: self.docker_build_paths.append(root) LOG.debug('Found {}'.format(root.split(self.working_dir)[1])) LOG.debug('Found {} Dockerfiles'.format(len(self.docker_build_paths))) def cleanup(self): """Remove temp files""" shutil.rmtree(self.temp_dir) def filter_images(self): """Filter which images to build""" if self.regex: patterns = re.compile(r"|".join(self.regex).join('()')) for image in self.images: if image['status'] == 'matched': continue if re.search(patterns, image['name']): image['status'] = 'matched' while (image['parent'] is not None and image['parent']['status'] != 'matched'): image = image['parent'] image['status'] = 'matched' LOG.debug('Matched image {}'.format(image['name'])) else: image['status'] = 'unmatched' else: for image in self.images: image['status'] = 'matched' def summary(self): """Walk the dictionary of images statuses and print results""" self.get_image_statuses() if self.image_statuses_good: LOG.info("Successfully built images") LOG.info("=========================") for name in self.image_statuses_good.keys(): LOG.info(name) if self.image_statuses_bad: LOG.info("Images that failed to build") LOG.info("===========================") for name, status in self.image_statuses_bad.iteritems(): LOG.error('{}\r\t\t\t Failed with status: {}'.format( name, status)) if self.image_statuses_unmatched: LOG.debug("Images not matched for build by regex") LOG.debug("=====================================") for name in self.image_statuses_unmatched.keys(): LOG.debug(name) def get_image_statuses(self): if any(self.image_statuses_bad, self.image_statuses_good, self.image_statuses_unmatched): return (self.image_statuses_bad, self.image_statuses_good, self.image_statuses_unmatched) for image in self.images: if image['status'] == "built": self.image_statuses_good[image['name']] = image['status'] elif image['status'] == "unmatched": self.image_statuses_unmatched[image['name']] = image['status'] else: self.image_statuses_bad[image['name']] = image['status'] return (self.image_statuses_bad, self.image_statuses_good, self.image_statuses_unmatched) def build_image_list(self): self.images = list() # Walk all of the Dockerfiles and replace the %%KOLLA%% variables for path in self.docker_build_paths: with open(os.path.join(path, 'Dockerfile')) as f: content = f.read().replace('%%KOLLA_NAMESPACE%%', self.namespace) content = content.replace('%%KOLLA_PREFIX%%', self.prefix) content = content.replace('%%KOLLA_TAG%%', self.tag) with open(os.path.join(path, 'Dockerfile'), 'w') as f: f.write(content) image = dict() image['status'] = "unprocessed" image['name'] = os.path.basename(path) image['fullname'] = self.namespace + '/' + self.prefix + \ image['name'] + ':' + self.tag image['path'] = path image['parent_name'] = content.split(' ')[1].split('\n')[0] if self.namespace not in image['parent_name']: image['parent'] = None image['children'] = list() if self.type_ == 'source': image['source'] = dict() try: image['source']['type'] = self.config.get(image['name'], 'type') image['source']['source'] = self.config.get(image['name'], 'location') image['source']['dest'] = self.config.get(image['name'], 'dest_filename') if image['source']['type'] == 'git': image['source']['reference'] = \ self.config.get(image['name'], 'reference') except ConfigParser.NoSectionError: LOG.debug('No config found for {}'.format(image['name'])) pass self.images.append(image) def find_parents(self): """Associate all images with parents and children""" sort_images = dict() for image in self.images: sort_images[image['fullname']] = image for parent_name, parent in sort_images.iteritems(): for image in sort_images.values(): if image['parent_name'] == parent_name: parent['children'].append(image) image['parent'] = parent def build_queue(self): """Organizes Queue list Return a list of Queues that have been organized into a hierarchy based on dependencies """ self.build_image_list() self.find_parents() self.filter_images() queue = Queue.Queue() for image in self.images: if image['parent'] is None: queue.put(image) LOG.debug('Added image {} to queue'.format(image['name'])) return queue def push_image(image): dc = docker.Client(**docker.utils.kwargs_from_env()) image['push_logs'] = str() for response in dc.push(image['fullname'], stream=True, insecure_registry=True): stream = json.loads(response) if 'stream' in stream: image['push_logs'] = image['logs'] + stream['stream'] LOG.info('{}'.format(stream['stream'])) elif 'errorDetail' in stream: image['status'] = "error" LOG.error(stream['errorDetail']['message']) def main(): args = arg_parser() if args['debug']: LOG.setLevel(logging.DEBUG) kolla = KollaWorker(args) kolla.setup_working_dir() kolla.find_dockerfiles() if args['template']: kolla.create_dockerfiles() # We set the atime and mtime to 0 epoch to preserve allow the Docker cache # to work like we want. A different size or hash will still force a rebuild kolla.set_time() queue = kolla.build_queue() for x in xrange(args['threads']): worker = WorkerThread(queue, args) worker.setDaemon(True) worker.start() # block until queue is empty queue.join() if args['push']: for image in kolla.images: if image['status'] == "built": push_image(image) kolla.summary() kolla.cleanup() return kolla.get_image_statuses() if __name__ == '__main__': main()