podman-compose/podman-compose.py

472 lines
15 KiB
Python
Raw Normal View History

2019-03-04 10:30:14 +01:00
#! /usr/bin/env python
# https://docs.docker.com/compose/compose-file/#service-configuration-reference
# https://docs.docker.com/samples/
# https://docs.docker.com/compose/gettingstarted/
# https://docs.docker.com/compose/django/
# https://docs.docker.com/compose/wordpress/
2019-03-04 10:30:14 +01:00
from __future__ import print_function
import os
import argparse
import subprocess
import time
import fnmatch
# fnmatch.fnmatchcase(env, "*_HOST")
2019-03-04 10:30:14 +01:00
import json
import yaml
# helpers
2019-03-23 20:42:04 +01:00
def try_int(i, fallback=None):
try:
return int(i)
except ValueError:
pass
except TypeError:
pass
2019-03-04 10:30:14 +01:00
return fallback
2019-03-23 20:42:04 +01:00
def norm_as_list(src):
"""
given a dictionary {key1:value1, key2: None} or list
return a list of ["key1=value1", "key2"]
"""
if src is None:
dst = []
elif isinstance(src, dict):
dst = [("{}={}".format(k, v) if v else k) for k, v in src.items()]
elif hasattr(src, '__iter__'):
dst = list(src)
else:
dst = [src]
return dst
2019-03-04 10:30:14 +01:00
2019-03-23 20:42:04 +01:00
def norm_as_dict(src):
"""
given a list ["key1=value1", "key2"]
return a dictionary {key1:value1, key2: None}
"""
if src is None:
dst = {}
elif isinstance(src, dict):
dst = dict(src)
elif hasattr(src, '__iter__'):
2019-03-23 20:42:04 +01:00
dst = [i.split("=", 1) for i in src if i]
dst = dict([(a if len(a) == 2 else (a[0], None)) for a in dst])
else:
raise ValueError("dictionary or iterable is expected")
return dst
# transformation helpers
2019-03-04 10:30:14 +01:00
2019-03-23 20:42:04 +01:00
def adj_hosts(services, cnt, dst="127.0.0.1"):
"""
adjust container cnt in-place to add hosts pointing to dst for services
"""
common_extra_hosts = []
for srv, cnts in services.items():
common_extra_hosts.append("{}:{}".format(srv, dst))
for cnt0 in cnts:
common_extra_hosts.append("{}:{}".format(cnt0, dst))
extra_hosts = list(cnt.get("extra_hosts", []))
extra_hosts.extend(common_extra_hosts)
# link aliases
for link in cnt.get("links", []):
a = link.strip().split(':', 1)
if len(a) == 2:
alias = a[1].strip()
extra_hosts.append("{}:{}".format(alias, dst))
cnt["extra_hosts"] = extra_hosts
2019-03-23 20:42:04 +01:00
2019-03-04 23:39:08 +01:00
def move_list(dst, containers, key):
"""
move key (like port forwarding) from containers to dst (a pod or a infra container)
"""
a = set(dst.get(key) or [])
2019-03-04 23:39:08 +01:00
for cnt in containers:
a0 = cnt.get(key)
if a0:
2019-03-04 23:46:42 +01:00
a.update(a0)
2019-03-04 23:39:08 +01:00
del cnt[key]
2019-03-23 20:42:04 +01:00
if a:
dst[key] = list(a)
2019-03-04 23:39:08 +01:00
def move_port_fw(dst, containers):
"""
move port forwarding from containers to dst (a pod or a infra container)
"""
2019-03-04 23:48:48 +01:00
move_list(dst, containers, "ports")
2019-03-04 23:39:08 +01:00
2019-03-23 20:42:04 +01:00
2019-03-04 23:39:08 +01:00
def move_extra_hosts(dst, containers):
"""
move port forwarding from containers to dst (a pod or a infra container)
"""
move_list(dst, containers, "extra_hosts")
# transformations
transformations = {}
2019-03-23 20:42:04 +01:00
def trans(func):
transformations[func.__name__.replace("tr_", "")] = func
return func
2019-03-23 20:42:04 +01:00
@trans
2019-03-04 10:30:14 +01:00
def tr_identity(project_name, services, given_containers):
containers = []
2019-03-04 10:30:14 +01:00
for cnt in given_containers:
containers.append(dict(cnt))
return [], containers
2019-03-23 20:42:04 +01:00
@trans
def tr_publishall(project_name, services, given_containers):
containers = []
for cnt0 in given_containers:
2019-03-23 20:42:04 +01:00
cnt = dict(cnt0, publishall=True)
# adjust hosts to point to the gateway, TODO: adjust host env
adj_hosts(services, cnt, '10.0.2.2')
containers.append(cnt)
return [], containers
2019-03-23 20:42:04 +01:00
@trans
def tr_hostnet(project_name, services, given_containers):
containers = []
for cnt0 in given_containers:
2019-03-23 20:42:04 +01:00
cnt = dict(cnt0, network_mode="host")
# adjust hosts to point to localhost, TODO: adjust host env
adj_hosts(services, cnt, '127.0.0.1')
containers.append(cnt)
2019-03-04 10:30:14 +01:00
return [], containers
2019-03-23 20:42:04 +01:00
@trans
def tr_cntnet(project_name, services, given_containers):
containers = []
infra_name = project_name + "_infra"
infra = dict(
2019-03-23 20:42:04 +01:00
name=infra_name,
image="k8s.gcr.io/pause:3.1",
)
for cnt0 in given_containers:
2019-03-23 20:42:04 +01:00
cnt = dict(cnt0, network_mode="container:"+infra_name)
deps = cnt.get("depends") or []
deps.append(infra_name)
cnt["depends"] = deps
# adjust hosts to point to localhost, TODO: adjust host env
adj_hosts(services, cnt, '127.0.0.1')
2019-03-23 20:42:04 +01:00
if "hostname" in cnt:
del cnt["hostname"]
containers.append(cnt)
move_port_fw(infra, containers)
2019-03-04 23:39:08 +01:00
move_extra_hosts(infra, containers)
containers.insert(0, infra)
return [], containers
2019-03-23 20:42:04 +01:00
@trans
2019-03-04 10:30:14 +01:00
def tr_1pod(project_name, services, given_containers):
"""
project_name:
services: {service_name: ["container_name1", "..."]}, currently only one is supported
given_containers: [{}, ...]
"""
2019-03-23 20:42:04 +01:00
pod = dict(name=project_name)
containers = []
2019-03-04 10:30:14 +01:00
for cnt0 in given_containers:
2019-03-23 20:42:04 +01:00
cnt = dict(cnt0, pod=project_name)
2019-03-04 10:30:14 +01:00
# services can be accessed as localhost because they are on one pod
# adjust hosts to point to localhost, TODO: adjust host env
adj_hosts(services, cnt, '127.0.0.1')
2019-03-04 10:30:14 +01:00
containers.append(cnt)
return [pod], containers
2019-03-23 20:42:04 +01:00
@trans
2019-03-04 10:30:14 +01:00
def tr_1podfw(project_name, services, given_containers):
pods, containers = tr_1pod(project_name, services, given_containers)
pod = pods[0]
move_port_fw(pod, containers)
2019-03-04 10:30:14 +01:00
return pods, containers
2019-03-23 20:42:04 +01:00
2019-03-23 21:04:07 +01:00
def run_podman(dry_run, podman_path, podman_args, wait=True, sleep=1):
print("podman " + " ".join(podman_args))
if dry_run:
return None
cmd = [podman_path]+podman_args
# subprocess.Popen(args, bufsize = 0, executable = None, stdin = None, stdout = None, stderr = None, preexec_fn = None, close_fds = False, shell = False, cwd = None, env = None, universal_newlines = False, startupinfo = None, creationflags = 0)
p = subprocess.Popen(cmd)
if wait:
print(p.wait())
if sleep:
time.sleep(sleep)
return p
2019-03-23 21:07:06 +01:00
# pylint: disable=unused-argument
def down(project_name, dirname, pods, containers, dry_run, podman_path):
2019-03-04 10:30:14 +01:00
for cnt in containers:
2019-03-23 21:07:06 +01:00
run_podman(dry_run, podman_path, [
"stop", "-t=1", cnt["name"]], sleep=0)
2019-03-04 10:30:14 +01:00
for cnt in containers:
2019-03-23 21:04:07 +01:00
run_podman(dry_run, podman_path, ["rm", cnt["name"]], sleep=0)
2019-03-04 10:30:14 +01:00
for pod in pods:
2019-03-23 21:04:07 +01:00
run_podman(dry_run, podman_path, ["pod", "rm", pod["name"]], sleep=0)
2019-03-23 20:42:04 +01:00
2019-03-23 21:07:06 +01:00
2019-03-23 21:04:07 +01:00
def container_to_args(cnt, dirname):
pod = cnt.get('pod') or ''
args = [
2019-03-23 21:04:07 +01:00
'run',
'--name={}'.format(cnt.get('name')),
'-d'
2019-03-04 10:30:14 +01:00
]
2019-03-23 20:42:04 +01:00
if pod:
args.append('--pod={}'.format(pod))
2019-03-04 10:30:14 +01:00
if cnt.get('read_only'):
args.append('--read-only')
for i in cnt.get('labels', []):
args.extend(['--label', i])
2019-03-23 20:42:04 +01:00
net = cnt.get("network_mode")
if net:
args.extend(['--network', net])
env = norm_as_list(cnt.get('environment', {}))
2019-03-04 10:30:14 +01:00
for e in env:
args.extend(['-e', e])
for i in cnt.get('env_file', []):
i = os.path.realpath(os.path.join(dirname, i))
2019-03-04 10:30:14 +01:00
args.extend(['--env-file', i])
for i in cnt.get('tmpfs', []):
args.extend(['--tmpfs', i])
for i in cnt.get('volumes', []):
# TODO: make it absolute using os.path.realpath(i)
args.extend(['-v', i])
for i in cnt.get('extra_hosts', []):
args.extend(['--add-host', i])
for i in cnt.get('expose', []):
args.extend(['--expose', i])
if cnt.get('publishall'):
args.append('-P')
2019-03-04 10:30:14 +01:00
for i in cnt.get('ports', []):
args.extend(['-p', i])
user = cnt.get('user')
2019-03-04 10:30:14 +01:00
if user is not None:
args.extend(['-u', user])
if cnt.get('working_dir') is not None:
args.extend(['-w', cnt.get('working_dir')])
if cnt.get('hostname'):
args.extend(['--hostname', cnt.get('hostname')])
if cnt.get('shm_size'):
args.extend(['--shm_size', '{}'.format(cnt.get('shm_size'))])
if cnt.get('stdin_open'):
args.append('-i')
if cnt.get('tty'):
args.append('--tty')
# currently podman shipped by fedora does not package this
2019-03-23 20:42:04 +01:00
# if cnt.get('init'):
2019-03-04 10:30:14 +01:00
# args.append('--init')
entrypoint = cnt.get('entrypoint')
if entrypoint is not None:
if isinstance(entrypoint, list):
args.extend(['--entrypoint', json.dumps(entrypoint)])
else:
args.extend(['--entrypoint', entrypoint])
2019-03-23 20:42:04 +01:00
args.append(cnt.get('image')) # command, ..etc.
command = cnt.get('command')
2019-03-04 10:30:14 +01:00
if command is not None:
# TODO: handle if command is string
args.extend(command)
return args
2019-03-23 20:42:04 +01:00
2019-03-09 22:25:32 +01:00
def rec_deps(services, container_by_name, cnt, init_service):
deps = cnt["_deps"]
2019-03-09 22:25:32 +01:00
for dep in deps:
dep_cnts = services.get(dep)
2019-03-23 20:42:04 +01:00
if not dep_cnts:
continue
dep_cnt = container_by_name.get(dep_cnts[0])
2019-03-09 22:25:32 +01:00
if dep_cnt:
# TODO: avoid creating loops, A->B->A
2019-03-23 20:42:04 +01:00
if init_service and init_service in dep_cnt["_deps"]:
continue
new_deps = rec_deps(services, container_by_name,
dep_cnt, init_service)
2019-03-09 22:25:32 +01:00
deps.update(new_deps)
return deps
2019-03-23 20:42:04 +01:00
2019-03-09 22:25:32 +01:00
def flat_deps(services, container_by_name):
for name, cnt in container_by_name.items():
2019-03-23 20:42:04 +01:00
deps = set([(c.split(":")[0] if ":" in c else c)
for c in cnt.get("links", [])])
2019-03-09 22:25:32 +01:00
deps.update(cnt.get("depends", []))
cnt["_deps"] = deps
2019-03-09 22:25:32 +01:00
for name, cnt in container_by_name.items():
rec_deps(services, container_by_name, cnt, cnt.get('_service'))
2019-03-23 20:42:04 +01:00
def up(project_name, dirname, pods, containers, no_cleanup, dry_run, podman_path):
2019-03-23 20:42:04 +01:00
if dry_run == False:
os.chdir(dirname)
2019-03-04 10:30:14 +01:00
# no need remove them if they have same hash label
2019-03-23 20:42:04 +01:00
if no_cleanup == False:
down(project_name, dirname, pods, containers, dry_run, podman_path)
2019-03-04 10:30:14 +01:00
for pod in pods:
args = [
2019-03-23 21:04:07 +01:00
"pod", "create",
"--name={}".format(pod["name"]),
"--share", "net",
]
ports = pod.get("ports") or []
for i in ports:
args.extend(['-p', i])
2019-03-23 21:04:07 +01:00
run_podman(dry_run, podman_path, args)
2019-03-23 20:42:04 +01:00
2019-03-04 10:30:14 +01:00
for cnt in containers:
# TODO: -e , --add-host, -v, --read-only
2019-03-23 21:04:07 +01:00
args = container_to_args(cnt, dirname)
run_podman(dry_run, podman_path, args)
2019-03-23 20:42:04 +01:00
2019-03-23 21:04:07 +01:00
def compose(
2019-03-23 21:07:06 +01:00
command, filename, project_name,
no_ansi, no_cleanup, dry_run,
transform_policy, podman_path, host_env=None,
):
2019-03-23 20:42:04 +01:00
filename = os.path.realpath(filename)
dirname = os.path.dirname(filename)
dir_basename = os.path.basename(dirname)
if podman_path != 'podman':
if os.path.isfile(podman_path) and os.access(podman_path, os.X_OK):
podman_path = os.path.realpath(podman_path)
else:
# this also works if podman hasn't been installed now
2019-03-23 20:42:04 +01:00
if dry_run == False:
raise IOError(
"Binary {} has not been found.".format(podman_path))
if not project_name:
project_name = dir_basename
2019-03-04 10:30:14 +01:00
with open(filename, 'r') as f:
compose = yaml.safe_load(f)
2019-03-23 20:42:04 +01:00
# debug mode
#print(json.dumps(compose, indent = 2))
2019-03-23 20:42:04 +01:00
ver = compose.get('version')
services = compose.get('services')
podman_compose_labels = [
"io.podman.compose.config-hash=123",
"io.podman.compose.project=" + project_name,
"io.podman.compose.version=0.0.1",
2019-03-04 10:30:14 +01:00
]
# other top-levels:
# volumes: {...}
# networks: {driver: ...}
# configs: {...}
# secrets: {...}
given_containers = []
container_names_by_service = {}
for service_name, service_desc in services.items():
replicas = try_int(service_desc.get('deploy', {}).get('replicas', '1'))
container_names_by_service[service_name] = []
2019-03-04 10:30:14 +01:00
for num in range(1, replicas+1):
name = "{project_name}_{service_name}_{num}".format(
2019-03-23 20:42:04 +01:00
project_name=project_name,
service_name=service_name,
num=num,
2019-03-04 10:30:14 +01:00
)
container_names_by_service[service_name].append(name)
# print(service_name,service_desc)
2019-03-23 20:42:04 +01:00
cnt = dict(name=name, num=num,
service_name=service_name, **service_desc)
labels = norm_as_list(cnt.get('labels'))
2019-03-04 10:30:14 +01:00
labels.extend(podman_compose_labels)
labels.extend([
"com.docker.compose.container-number={}".format(num),
"com.docker.compose.service=" + service_name,
2019-03-04 10:30:14 +01:00
])
cnt['labels'] = labels
2019-03-09 22:25:32 +01:00
cnt['_service'] = service_name
2019-03-04 10:30:14 +01:00
given_containers.append(cnt)
container_by_name = dict([(c["name"], c) for c in given_containers])
2019-03-09 22:25:32 +01:00
flat_deps(container_names_by_service, container_by_name)
#print("deps:", [(c["name"], c["_deps"]) for c in given_containers])
given_containers = container_by_name.values()
2019-03-23 20:42:04 +01:00
given_containers.sort(key=lambda c: len(c.get('_deps') or []))
2019-03-09 22:25:32 +01:00
#print("sorted:", [c["name"] for c in given_containers])
tr = transformations[transform_policy]
2019-03-23 20:42:04 +01:00
pods, containers = tr(
project_name, container_names_by_service, given_containers)
cmd = command[0]
if cmd == "up":
2019-03-23 20:42:04 +01:00
up(project_name, dirname, pods, containers,
no_cleanup, dry_run, podman_path)
elif cmd == "down":
down(project_name, dirname, pods, containers, dry_run, podman_path)
2019-03-04 23:22:27 +01:00
else:
raise NotImplementedError("command {} is not implemented".format(cmd))
2019-03-04 10:30:14 +01:00
2019-03-23 20:42:04 +01:00
2019-03-23 21:04:07 +01:00
def main():
parser = argparse.ArgumentParser()
2019-03-23 20:42:04 +01:00
parser.add_argument('command', metavar='command',
help='command to run',
choices=['up', 'down'], nargs=1, default="up")
parser.add_argument("-f", "--file",
2019-03-23 20:42:04 +01:00
help="Specify an alternate compose file (default: docker-compose.yml)",
type=str, default="docker-compose.yml")
parser.add_argument("-p", "--project-name",
2019-03-23 20:42:04 +01:00
help="Specify an alternate project name (default: directory name)",
type=str, default=None)
parser.add_argument("--podman-path",
2019-03-23 20:42:04 +01:00
help="Specify an alternate path to podman (default: use location in $PATH variable)",
type=str, default="podman")
parser.add_argument("--no-ansi",
2019-03-23 20:42:04 +01:00
help="Do not print ANSI control characters", action='store_true')
parser.add_argument("--no-cleanup",
2019-03-23 20:42:04 +01:00
help="Do not stop and remove existing pod & containers", action='store_true')
parser.add_argument("--dry-run",
2019-03-23 20:42:04 +01:00
help="No action; perform a simulation of commands", action='store_true')
parser.add_argument("-t", "--transform_policy",
2019-03-23 20:42:04 +01:00
help="how to translate docker compose to podman [1pod|hostnet|accurate]",
choices=['1pod', '1podfw', 'hostnet', 'cntnet', 'publishall', 'identity'], default='1podfw')
args = parser.parse_args()
2019-03-23 21:04:07 +01:00
compose(
2019-03-23 20:42:04 +01:00
command=args.command,
filename=args.file,
project_name=args.project_name,
no_ansi=args.no_ansi,
no_cleanup=args.no_cleanup,
dry_run=args.dry_run,
transform_policy=args.transform_policy,
podman_path=args.podman_path
)
2019-03-23 21:04:07 +01:00
2019-03-23 21:07:06 +01:00
2019-03-23 21:04:07 +01:00
if __name__ == "__main__":
2019-03-23 21:07:06 +01:00
main()