# Copyright 2015 NEC Corporation. All rights reserved. # # 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 argparse from contextlib import closing import io import json import os import tarfile import time import yaml from zunclient.common import cliutils as utils from zunclient.common import utils as zun_utils from zunclient.common.websocketclient import exceptions from zunclient.common.websocketclient import websocketclient from zunclient import exceptions as exc def _show_container(container): zun_utils.format_container_addresses(container) utils.print_dict(container._info) @utils.arg('-n', '--name', metavar='', help='name of the container') @utils.arg('--cpu', metavar='', help='The number of virtual cpus.') @utils.arg('-m', '--memory', metavar='', help='The container memory size in MiB') @utils.arg('-e', '--environment', metavar='', action='append', default=[], help='The environment variables') @utils.arg('--workdir', metavar='', help='The working directory for commands to run in') @utils.arg('--label', metavar='', action='append', default=[], help='Adds a map of labels to a container. ' 'May be used multiple times.') @utils.arg('--image-pull-policy', dest='image_pull_policy', metavar='', choices=['never', 'always', 'ifnotpresent'], help='The policy which determines if the image should ' 'be pulled prior to starting the container. ' 'It can have following values: ' '"ifnotpresent": only pull the image if it does not ' 'already exist on the node. ' '"always": Always pull the image from repositery.' '"never": never pull the image') @utils.arg('image', metavar='', help='name or ID of the image') @utils.arg('--restart', metavar='', help='Restart policy to apply when a container exits' '(no, on-failure[:max-retry], always, unless-stopped)') @utils.arg('-i', '--interactive', dest='interactive', action='store_true', default=False, help='Keep STDIN open even if not attached, allocate a pseudo-TTY') @utils.arg('--image-driver', metavar='', help='The image driver to use to pull container image. ' 'It can have following values: ' '"docker": pull the image from Docker Hub. ' '"glance": pull the image from Glance. ') @utils.arg('command', metavar='', nargs=argparse.REMAINDER, help='Send command to the container') def do_create(cs, args): """Create a container.""" opts = {} opts['name'] = args.name opts['image'] = args.image opts['memory'] = args.memory opts['cpu'] = args.cpu opts['environment'] = zun_utils.format_args(args.environment) opts['workdir'] = args.workdir opts['labels'] = zun_utils.format_args(args.label) opts['image_pull_policy'] = args.image_pull_policy opts['image_driver'] = args.image_driver if args.command: opts['command'] = ' '.join(args.command) if args.restart: opts['restart_policy'] = zun_utils.check_restart_policy(args.restart) if args.interactive: opts['interactive'] = True opts = zun_utils.remove_null_parms(**opts) _show_container(cs.containers.create(**opts)) @utils.arg('--all-tenants', action="store_true", default=False, help='List containers in all tenants') @utils.arg('--marker', metavar='', default=None, help='The last container UUID of the previous page; ' 'displays list of containers after "marker".') @utils.arg('--limit', metavar='', type=int, help='Maximum number of containers to return') @utils.arg('--sort-key', metavar='', help='Column to sort results by') @utils.arg('--sort-dir', metavar='', choices=['desc', 'asc'], help='Direction to sort. "asc" or "desc".') def do_list(cs, args): """Print a list of available containers.""" opts = {} opts['all_tenants'] = args.all_tenants opts['marker'] = args.marker opts['limit'] = args.limit opts['sort_key'] = args.sort_key opts['sort_dir'] = args.sort_dir opts = zun_utils.remove_null_parms(**opts) containers = cs.containers.list(**opts) zun_utils.list_containers(containers) @utils.arg('containers', metavar='', nargs='+', help='ID or name of the (container)s to delete.') @utils.arg('-f', '--force', action='store_true', help='Force delete the container.') def do_delete(cs, args): """Delete specified containers.""" for container in args.containers: try: cs.containers.delete(container, args.force) print("Request to delete container %s has been accepted." % container) except Exception as e: print("Delete for container %(container)s failed: %(e)s" % {'container': container, 'e': e}) @utils.arg('container', metavar='', help='ID or name of the container to show.') @utils.arg('-f', '--format', metavar='', action='store', choices=['json', 'yaml', 'table'], default='table', help='Print representation of the container.' 'The choices of the output format is json,table,yaml.' 'Defaults to table.') def do_show(cs, args): """Show details of a container.""" container = cs.containers.get(args.container) if args.format == 'json': print(json.dumps(container._info, indent=4, sort_keys=True)) elif args.format == 'yaml': print(yaml.safe_dump(container._info, default_flow_style=False)) elif args.format == 'table': _show_container(container) @utils.arg('containers', metavar='', nargs='+', help='ID or name of the (container)s to restart.') @utils.arg('-t', '--timeout', metavar='', default=10, help='Seconds to wait for stop before restarting (container)s') def do_restart(cs, args): """Restart specified containers.""" for container in args.containers: try: cs.containers.restart(container, args.timeout) print("Request to restart container %s has been accepted." % container) except Exception as e: print("Restart for container %(container)s failed: %(e)s" % {'container': container, 'e': e}) @utils.arg('containers', metavar='', nargs='+', help='ID or name of the (container)s to stop.') @utils.arg('-t', '--timeout', metavar='', default=10, help='Seconds to wait for stop before killing (container)s') def do_stop(cs, args): """Stop specified containers.""" for container in args.containers: try: cs.containers.stop(container, args.timeout) print("Request to stop container %s has been accepted." % container) except Exception as e: print("Stop for container %(container)s failed: %(e)s" % {'container': container, 'e': e}) @utils.arg('containers', metavar='', nargs='+', help='ID of the (container)s to start.') def do_start(cs, args): """Start specified containers.""" for container in args.containers: try: cs.containers.start(container) print("Request to start container %s has been accepted." % container) except Exception as e: print("Start for container %(container)s failed: %(e)s" % {'container': container, 'e': e}) @utils.arg('containers', metavar='', nargs='+', help='ID or name of the (container)s to pause.') def do_pause(cs, args): """Pause specified containers.""" for container in args.containers: try: cs.containers.pause(container) print("Request to pause container %s has been accepted." % container) except Exception as e: print("Pause for container %(container)s failed: %(e)s" % {'container': container, 'e': e}) @utils.arg('containers', metavar='', nargs='+', help='ID or name of the (container)s to unpause.') def do_unpause(cs, args): """Unpause specified containers.""" for container in args.containers: try: cs.containers.unpause(container) print("Request to unpause container %s has been accepted." % container) except Exception as e: print("Unpause for container %(container)s failed: %(e)s" % {'container': container, 'e': e}) @utils.arg('container', metavar='', help='ID or name of the container to get logs for.') @utils.arg('--stdout', action='store_true', help='Only stdout logs of container.') @utils.arg('--stderr', action='store_true', help='Only stderr logs of container.') @utils.arg('--since', metavar='', default=None, help='Show logs since a given datetime or integer ' 'epoch (in seconds).') @utils.arg('-t', '--timestamps', dest='timestamps', action='store_true', default=False, help='Show timestamps.') @utils.arg('--tail', metavar='', default='all', help='Number of lines to show from the end of the logs.') def do_logs(cs, args): """Get logs of a container.""" opts = {} opts['id'] = args.container opts['stdout'] = args.stdout opts['stderr'] = args.stderr opts['since'] = args.since opts['timestamps'] = args.timestamps opts['tail'] = args.tail opts = zun_utils.remove_null_parms(**opts) logs = cs.containers.logs(**opts) print(logs) @utils.arg('container', metavar='', help='ID or name of the container to execute command in.') @utils.arg('command', metavar='', nargs=argparse.REMAINDER, help='The command to execute in a container') @utils.arg('-i', '--interactive', dest='interactive', action='store_true', default=False, help='Keep STDIN open and allocate a pseudo-TTY for interactive') def do_exec(cs, args): """Execute command in a running container.""" opts = {} opts['command'] = ' '.join(args.command) if args.interactive: opts['interactive'] = True opts['run'] = False response = cs.containers.execute(args.container, **opts) if args.interactive: exec_id = response['exec_id'] url = response['url'] websocketclient.do_exec(cs, url, args.container, exec_id, "~", 0.5) else: output = response['output'] exit_code = response['exit_code'] print(output) return exit_code @utils.arg('containers', metavar='', nargs='+', help='ID or name of the (container)s to kill signal to.') @utils.arg('-s', '--signal', metavar='', default=None, help='The signal to kill') def do_kill(cs, args): """Kill one or more running container(s).""" for container in args.containers: opts = {} opts['id'] = container opts['signal'] = args.signal opts = zun_utils.remove_null_parms(**opts) try: cs.containers.kill(**opts) print( "Request to kill signal to container %s has been accepted." % container) except Exception as e: print( "kill signal for container %(container)s failed: %(e)s" % {'container': container, 'e': e}) @utils.arg('-n', '--name', metavar='', help='name of the container') @utils.arg('--cpu', metavar='', help='The number of virtual cpus.') @utils.arg('-m', '--memory', metavar='', help='The container memory size in MiB') @utils.arg('-e', '--environment', metavar='', action='append', default=[], help='The environment variables') @utils.arg('--workdir', metavar='', help='The working directory for commands to run in') @utils.arg('--label', metavar='', action='append', default=[], help='Adds a map of labels to a container. ' 'May be used multiple times.') @utils.arg('--image-pull-policy', dest='image_pull_policy', metavar='', choices=['never', 'always', 'ifnotpresent'], help='The policy which determines if the image should ' 'be pulled prior to starting the container. ' 'It can have following values: ' '"ifnotpresent": only pull the image if it does not ' 'already exist on the node. ' '"always": Always pull the image from repositery.' '"never": never pull the image') @utils.arg('image', metavar='', help='name or ID of the image') @utils.arg('--restart', metavar='', help='Restart policy to apply when a container exits' '(no, on-failure[:max-retry], always, unless-stopped)') @utils.arg('-i', '--interactive', dest='interactive', action='store_true', default=False, help='Keep STDIN open even if not attached, allocate a pseudo-TTY') @utils.arg('--image-driver', metavar='', help='The image driver to use to pull container image. ' 'It can have following values: ' '"docker": pull the image from Docker Hub. ' '"glance": pull the image from Glance. ') @utils.arg('command', metavar='', nargs=argparse.REMAINDER, help='Send command to the container') def do_run(cs, args): """Run a command in a new container.""" opts = {} opts['name'] = args.name opts['image'] = args.image opts['memory'] = args.memory opts['cpu'] = args.cpu opts['environment'] = zun_utils.format_args(args.environment) opts['workdir'] = args.workdir opts['labels'] = zun_utils.format_args(args.label) opts['image_pull_policy'] = args.image_pull_policy opts['image_driver'] = args.image_driver if args.command: opts['command'] = ' '.join(args.command) if args.restart: opts['restart_policy'] = zun_utils.check_restart_policy(args.restart) if args.interactive: opts['interactive'] = True opts = zun_utils.remove_null_parms(**opts) container = cs.containers.run(**opts) _show_container(container) container_uuid = getattr(container, 'uuid', None) if args.interactive: ready_for_attach = False while True: container = cs.containers.get(container_uuid) if zun_utils.check_container_status(container, 'Running'): ready_for_attach = True break if zun_utils.check_container_status(container, 'Error'): raise exceptions.ContainerStateError(container_uuid) print("Waiting for container start") time.sleep(1) if ready_for_attach is True: response = cs.containers.attach(container_uuid) websocketclient.do_attach(cs, response, container_uuid, "~", 0.5) else: raise exceptions.InvalidWebSocketLink(container_uuid) @utils.arg('container', metavar='', help='ID or name of the container to rename.') @utils.arg('name', metavar='', help='The new name for the container') def do_rename(cs, args): """Rename a container.""" cs.containers.rename(args.container, args.name) @utils.arg('container', metavar='', help="ID or name of the container to udate.") @utils.arg('--cpu', metavar='', help='The number of virtual cpus.') @utils.arg('-m', '--memory', metavar='', help='The container memory size in MiB') def do_update(cs, args): """Update one or more attributes of the container.""" opts = {} opts['memory'] = args.memory opts['cpu'] = args.cpu opts = zun_utils.remove_null_parms(**opts) if not opts: raise exc.CommandError("You must update at least one property") container = cs.containers.update(args.container, **opts) _show_container(container) @utils.arg('container', metavar='', help='ID or name of the container to be attahed to.') def do_attach(cs, args): """Attach to a running container.""" response = cs.containers.attach(args.container) websocketclient.do_attach(cs, response, args.container, "~", 0.5) @utils.arg('container', metavar='', help='ID or name of the container to display processes.') @utils.arg('ps_args', metavar='', nargs=argparse.REMAINDER, help='The args of the ps command.') def do_top(cs, args): """Display the running processes inside the container.""" output = cs.containers.top(args.container, ' '.join(args.ps_args)) for titles in output['Titles']: print("%-20s") % titles, for process in output['Processes']: print("") for info in process: print("%-20s") % info, @utils.arg('source', metavar='', help='The source should be copied to the container or localhost. ' 'The format of this parameter is [container:]src_path.') @utils.arg('destination', metavar='', help='The directory destination where save the source. ' 'The format of this parameter is [container:]dest_path.') def do_cp(cs, args): """Copy files/tars between a container and the local filesystem.""" if ':' in args.source: source_parts = args.source.split(':', 1) container_id = source_parts[0] container_path = source_parts[1] opts = {} opts['id'] = container_id opts['path'] = container_path res = cs.containers.get_archive(**opts) dest_path = args.destination tardata = io.BytesIO(res['data'].encode()) with closing(tarfile.open(fileobj=tardata)) as tar: tar.extractall(dest_path) elif ':' in args.destination: dest_parts = args.destination.split(':', 1) container_id = dest_parts[0] container_path = dest_parts[1] filename = os.path.split(args.source)[1] opts = {} opts['id'] = container_id opts['path'] = container_path tardata = io.BytesIO() with closing(tarfile.open(fileobj=tardata, mode='w')) as tar: tar.add(args.source, arcname=filename) opts['data'] = tardata.getvalue() cs.containers.put_archive(**opts) else: print("Please check the parameters for zun copy!") print("Usage:") print("zun cp container:src_path dest_path|-") print("zun cp src_path|- container:dest_path") @utils.arg('container', metavar='', help='ID or name of the container to display stats.') def do_stats(cs, args): """Display stats snapshot of the container.""" res = cs.containers.stats(args.container) cpu_usage = res['cpu_stats']['cpu_usage']['total_usage'] system_cpu_usage = res['cpu_stats']['system_cpu_usage'] cpu_percent = float(cpu_usage) / float(system_cpu_usage) * 100 mem_usage = res['memory_stats']['usage'] / zun_utils.M mem_limit = res['memory_stats']['limit'] / zun_utils.M mem_percent = float(mem_usage) / float(mem_limit) * 100 blk_stats = res['blkio_stats']['io_service_bytes_recursive'] io_read = 0 io_write = 0 for item in blk_stats: if 'Read' == item['op']: io_read = io_read + item['value'] if 'Write' == item['op']: io_write = io_write + item['value'] net_stats = res['networks'] net_rxb = 0 net_txb = 0 for k, v in net_stats.items(): net_rxb = net_rxb + v['rx_bytes'] net_txb = net_txb + v['tx_bytes'] stats = {"CONTAINER": args.container, "CPU %": cpu_percent, "MEM USAGE(MiB)": mem_usage, "MEM LIMIT(MiB)": mem_limit, "MEM %": mem_percent, "BLOCK I/O(B)": str(io_read) + "/" + str(io_write), "NET I/O(B)": str(net_rxb) + "/" + str(net_txb)} utils.print_dict(stats)