docker/docker-toool

   1 #!/usr/bin/env python
   2 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
   3 #    not use this file except in compliance with the License. You may obtain
   4 #    a copy of the License at
   5 #
   6 #         http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 #    Unless required by applicable law or agreed to in writing, software
   9 #    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  10 #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  11 #    License for the specific language governing permissions and limitations
  12 #    under the License.
  13
  14 import argparse
  15 import os
  16 import shutil
  17 import sys
  18 import json
  19
  20 docker_cmd = '/bin/docker'
  21
  22 # Tool to start docker containers as configured via
  23 # tripleo-heat-templates.
  24 #
  25 # This tool reads data from a json file generated from heat when the
  26 # TripleO stack is run.  All the configuration data used to start the
  27 # containerized services is in this file.
  28 #
  29 # By default this tool lists all the containers that are started and
  30 # their start order.
  31 #
  32 # If you wish to see the command line used to start a given container,
  33 # specify it by name using the --container argument.  --run can then be
  34 # used with this to actually execute docker to run the container.\n
  35 #
  36 # Other options listed allow you to modify this command line for
  37 # debugging purposes.  For example:
  38 #
  39 # docker-toool -c swift-proxy -r -e /bin/bash -u root -i -n test
  40 #
  41 # will run the swift proxy container as user root, executing /bin/bash,
  42 #
  43 # named 'test', and will run interactively (eg -ti).
  44
  45
  46 def parse_opts(argv):
  47     parser = argparse.ArgumentParser("Tool to start docker containers via "
  48                                      "TripleO configurations")
  49     parser.add_argument('-f', '--config',
  50                         help="""File to use as docker startup configuration data.""",
  51                         default='/var/lib/docker-container-startup-configs.json')
  52     parser.add_argument('-r', '--run',
  53                         action='store_true',
  54                         help="""Run the container as specified with --container.""",
  55                         default=False)
  56     parser.add_argument('-e', '--command',
  57                         help="""Override the command used to run the container.""",
  58                         default='')
  59     parser.add_argument('-c', '--container',
  60                         help="""Specify a container to run or show the command for.""",
  61                         default='')
  62     parser.add_argument('-u', '--user',
  63                         help="""User to run container as.""",
  64                         default='')
  65     parser.add_argument('-n', '--name',
  66                         help="""Name of container.""",
  67                         default='')
  68     parser.add_argument('-i', '--interactive',
  69                         action='store_true',
  70                         help="""Start docker container interactively (-ti).""",
  71                         default=False)
  72     opts = parser.parse_args(argv[1:])
  73
  74     return opts
  75
  76 def docker_arg_map(key, value):
  77     value = str(value).encode('ascii', 'ignore')
  78     if len(value) == 0:
  79         return ''
  80
  81     return {
  82         'environment': "--env=%s" % value,
  83         # 'image': value,
  84         'net': "--net=%s" % value,
  85         'pid': "--pid=%s" % value,
  86         'privileged': "--privileged=%s" % value.lower(),
  87         #'restart': "--restart=%s" % "false",
  88         'user': "--user=%s" % value,
  89         'volumes': "--volume=%s" % value,
  90         'volumes_from': "--volumes-from=%s" % value,
  91     }.get(key, None)
  92
  93 def run_docker_container(opts, container_name):
  94     container_found = False
  95
  96     with open(opts.config) as f:
  97         json_data = json.load(f)
  98
  99     for step in (json_data or []):
 100         if step is None:
 101             continue
 102         for container in (json_data[step] or []):
 103             if container == container_name:
 104                 print('container found: %s' % container)
 105                 container_found = True
 106                 # A few positional arguments:
 107                 command = ''
 108                 image = ''
 109
 110                 cmd = [
 111                     docker_cmd,
 112                     'run',
 113                     '--name',
 114                     opts.name or container
 115                 ]
 116                 for container_data in (json_data[step][container] or []):
 117                     if container_data == "environment":
 118                         for env in (json_data[step][container][container_data] or []):
 119                             arg = docker_arg_map("environment", env)
 120                             if arg:
 121                                 cmd.append(arg)
 122                     elif container_data == "volumes":
 123                         for volume in (json_data[step][container][container_data] or []):
 124                             arg = docker_arg_map("volumes", volume)
 125                             if arg:
 126                                 cmd.append(arg)
 127                     elif container_data == "volumes_from":
 128                         for volume in (json_data[step][container][container_data] or []):
 129                             arg = docker_arg_map("volumes_from", volume)
 130                             if arg:
 131                                 cmd.append(arg)
 132                     elif container_data == 'command':
 133                         command = json_data[step][container][container_data]
 134                     elif container_data == 'image':
 135                         image = json_data[step][container][container_data]
 136                     else:
 137                         # Only add a restart if we're not interactive
 138                         if container_data == 'restart':
 139                             if opts.interactive:
 140                                 continue
 141                         if container_data == 'user':
 142                             if opts.user:
 143                                 continue
 144                         arg = docker_arg_map(container_data,
 145                                 json_data[step][container][container_data])
 146                         if arg:
 147                             cmd.append(arg)
 148
 149                 if opts.user:
 150                     cmd.append('--user')
 151                     cmd.append(opts.user)
 152                 if opts.interactive:
 153                     cmd.append('-ti')
 154                     # May as well remove it when we're done too
 155                     cmd.append('--rm')
 156                 cmd.append(image)
 157                 if opts.command:
 158                     cmd.append(opts.command)
 159                 elif command:
 160                     cmd.extend(command)
 161
 162                 print ' '.join(cmd)
 163
 164                 if opts.run:
 165                     os.execl(docker_cmd, *cmd)
 166
 167     if not container_found:
 168         print("Container '%s' not found!" % container_name)
 169
 170 def list_docker_containers(opts):
 171     print opts
 172     with open(opts.config) as f:
 173         json_data = json.load(f)
 174
 175     for step in (json_data or []):
 176         if step is None:
 177             continue
 178         print step
 179         for container in (json_data[step] or []):
 180             print('\tcontainer: %s' % container)
 181             for container_data in (json_data[step][container] or []):
 182                 #print('\t\tcontainer_data: %s' % container_data)
 183                 if container_data == "start_order":
 184                     print('\t\tstart_order: %s' % json_data[step][container][container_data])
 185
 186 opts = parse_opts(sys.argv)
 187
 188 if opts.container:
 189     run_docker_container(opts, opts.container)
 190 else:
 191     list_docker_containers(opts)
 192