Merge "Support squash docker images layers"

2 files changed, 82 insertions, 1 deletions

diff --git a/kolla/common/config.py b/kolla/common/config.py
index 081f6063e..02ab17f09 100755
--- a/kolla/common/config.py
+++ b/kolla/common/config.py
@@ -258,6 +258,10 @@ _CLI_OPTS = [
                 help='Attempt to pull a newer version of the base image'),
     cfg.StrOpt('work-dir', help=('Path to be used as working directory.'
                                  ' By default, a temporary dir is created')),
+    cfg.BoolOpt('squash', default=False,
+                help=('Squash the image layers. WARNING: it will consume lots'
+                      ' of disk IO. "docker-squash" tool is required, install'
+                      ' it by "pip install docker-squash"')),
 ]
 
 _BASE_OPTS = [
@@ -269,7 +273,11 @@ _BASE_OPTS = [
                 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'))
+    cfg.StrOpt('apt_preferences', help=('Path to custom apt/preferences')),
+    cfg.BoolOpt('squash-cleanup', default=True,
+                help='Remove source image from Docker after squashing'),
+    cfg.StrOpt('squash-tmp-dir',
+               help='Temporary directory to be used during squashing')
 ]
 
 
diff --git a/kolla/common/utils.py b/kolla/common/utils.py
new file mode 100644
index 000000000..bb499dfe5
--- /dev/null
+++ b/kolla/common/utils.py
@@ -0,0 +1,73 @@
+# 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 logging
+import os
+import subprocess  # nosec
+import sys
+
+
+def make_a_logger(conf=None, image_name=None):
+    if image_name:
+        log = logging.getLogger(".".join([__name__, image_name]))
+    else:
+        log = logging.getLogger(__name__)
+    if not log.handlers:
+        if conf is None or not conf.logs_dir or not image_name:
+            handler = logging.StreamHandler(sys.stderr)
+            log.propagate = False
+        else:
+            filename = os.path.join(conf.logs_dir, "%s.log" % image_name)
+            handler = logging.FileHandler(filename, delay=True)
+        handler.setFormatter(logging.Formatter(logging.BASIC_FORMAT))
+        log.addHandler(handler)
+    if conf is not None and conf.debug:
+        log.setLevel(logging.DEBUG)
+    else:
+        log.setLevel(logging.INFO)
+    return log
+
+
+LOG = make_a_logger()
+
+
+def get_docker_squash_version():
+
+    try:
+        stdout = subprocess.check_output(  # nosec
+            ['docker-squash', '--version'], stderr=subprocess.STDOUT)
+        return stdout.split()[0]
+    except OSError as ex:
+        if ex.errno == 2:
+            LOG.error(('"docker-squash" command is not found.'
+                       ' try to install it by "pip install docker-squash"'))
+        raise
+
+
+def squash(old_image, new_image,
+           from_layer=None,
+           cleanup=False,
+           tmp_dir=None):
+
+    cmds = ['docker-squash', '--tag', new_image, old_image]
+    if cleanup:
+        cmds += ['--cleanup']
+    if from_layer:
+        cmds += ['--from-layer', from_layer]
+    if tmp_dir:
+        cmds += ['--tmp-dir', tmp_dir]
+    try:
+        subprocess.check_output(cmds, stderr=subprocess.STDOUT)  # nosec
+    except subprocess.CalledProcessError as ex:
+        LOG.exception('Get error during squashing image: %s',
+                      ex.stdout)
+        raise