python-zunclient/zunclient/v1/containers_shell.py
00129207 5a775df801 Add CLI support for add_security_group
Change-Id: I89af790cf2a82aa7a2718e84798b588541572667
Closes-Bug: #170779
2017-08-03 08:23:16 +08:00

699 lines
26 KiB
Python

# 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='<name>',
help='name of the container')
@utils.arg('--cpu',
metavar='<cpu>',
help='The number of virtual cpus.')
@utils.arg('-m', '--memory',
metavar='<memory>',
help='The container memory size in MiB')
@utils.arg('-e', '--environment',
metavar='<KEY=VALUE>',
action='append', default=[],
help='The environment variables')
@utils.arg('--workdir',
metavar='<workdir>',
help='The working directory for commands to run in')
@utils.arg('--rm',
action='store_true',
help='Automatically remove the container when it exits')
@utils.arg('--label',
metavar='<KEY=VALUE>',
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='<policy>',
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 repository.'
'"never": never pull the image')
@utils.arg('image', metavar='<image>', help='name or ID of the image')
@utils.arg('--restart',
metavar='<restart>',
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='<image_driver>',
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('--security-group',
metavar='security-group',
action='append', default=[],
help='The name of security group for the container. '
'May be used multiple times.')
@utils.arg('command',
metavar='<command>',
nargs=argparse.REMAINDER,
help='Send command to the container')
@utils.arg('--hint',
action='append',
default=[],
metavar='<key=value>',
help='The key-value pair(s) for scheduler to select host. '
'The format of this parameter is "key=value[,key=value]". '
'May be used multiple times.')
@utils.arg('--net',
action='append',
default=[],
metavar='<auto, network=network, port=port-uuid,'
'v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr>',
help='Create network enpoints for the container. '
'auto: do not specify the network, zun will automatically '
'create one. '
'network: attach container to the specified neturon networks. '
'port: attach container to the neutron port with this UUID. '
'v4-fixed-ip: IPv4 fixed address for container. '
'v6-fixed-ip: IPv6 fixed address for 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['auto_remove'] = args.rm
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
opts['hints'] = zun_utils.format_args(args.hint)
opts['nets'] = zun_utils.parse_nets(args.net)
if args.security_group:
opts['security_groups'] = args.security_group
if args.command:
opts['command'] = zun_utils.parse_command(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='<marker>',
default=None,
help='The last container UUID of the previous page; '
'displays list of containers after "marker".')
@utils.arg('--limit',
metavar='<limit>',
type=int,
help='Maximum number of containers to return')
@utils.arg('--sort-key',
metavar='<sort-key>',
help='Column to sort results by')
@utils.arg('--sort-dir',
metavar='<sort-dir>',
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='<container>',
nargs='+',
help='ID or name of the (container)s to delete.')
@utils.arg('-f', '--force',
action='store_true',
help='Force delete the container.')
@utils.arg('--all-tenants',
action="store_true",
default=False,
help='Delete container(s) in all tenant by name.')
def do_delete(cs, args):
"""Delete specified containers."""
for container in args.containers:
opts = {}
opts['id'] = container
opts['force'] = args.force
opts['all_tenants'] = args.all_tenants
opts = zun_utils.remove_null_parms(**opts)
try:
cs.containers.delete(**opts)
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='<container>',
help='ID or name of the container to show.')
@utils.arg('-f', '--format',
metavar='<format>',
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.')
@utils.arg('--all-tenants',
action="store_true",
default=False,
help='Show container(s) in all tenant by name.')
def do_show(cs, args):
"""Show details of a container."""
opts = {}
opts['id'] = args.container
opts['all_tenants'] = args.all_tenants
opts = zun_utils.remove_null_parms(**opts)
container = cs.containers.get(**opts)
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='<container>',
nargs='+',
help='ID or name of the (container)s to restart.')
@utils.arg('-t', '--timeout',
metavar='<timeout>',
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='<container>',
nargs='+',
help='ID or name of the (container)s to stop.')
@utils.arg('-t', '--timeout',
metavar='<timeout>',
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='<container>',
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='<container>',
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='<container>',
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='<container>',
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='<since>',
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='<tail>',
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='<container>',
help='ID or name of the container to execute command in.')
@utils.arg('command',
metavar='<command>',
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'] = zun_utils.parse_command(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='<container>',
nargs='+',
help='ID or name of the (container)s to kill signal to.')
@utils.arg('-s', '--signal',
metavar='<signal>',
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='<name>',
help='name of the container')
@utils.arg('--cpu',
metavar='<cpu>',
help='The number of virtual cpus.')
@utils.arg('-m', '--memory',
metavar='<memory>',
help='The container memory size in MiB')
@utils.arg('-e', '--environment',
metavar='<KEY=VALUE>',
action='append', default=[],
help='The environment variables')
@utils.arg('--workdir',
metavar='<workdir>',
help='The working directory for commands to run in')
@utils.arg('--rm',
action='store_true',
help='Automatically remove the container when it exits')
@utils.arg('--label',
metavar='<KEY=VALUE>',
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='<policy>',
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 repository.'
'"never": never pull the image')
@utils.arg('image', metavar='<image>', help='name or ID of the image')
@utils.arg('--restart',
metavar='<restart>',
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='<image_driver>',
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('--security-group',
metavar='security-group',
action='append', default=[],
help='The name of security group for the container. '
'May be used multiple times.')
@utils.arg('command',
metavar='<command>',
nargs=argparse.REMAINDER,
help='Send command to the container')
@utils.arg('--hint',
action='append',
default=[],
metavar='<key=value>',
help='The key-value pair(s) for scheduler to select host. '
'The format of this parameter is "key=value[,key=value]". '
'May be used multiple times.')
@utils.arg('--net',
action='append',
default=[],
metavar='<auto, network=network, port=port-uuid,'
'v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr>',
help='Create network enpoints for the container. '
'auto: do not specify the network, zun will automatically '
'create one. '
'network: attach container to the specified neutron networks. '
'port: attach container to the neutron port with this UUID. '
'v4-fixed-ip: IPv4 fixed address for container. '
'v6-fixed-ip: IPv6 fixed address for 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['auto_remove'] = args.rm
opts['labels'] = zun_utils.format_args(args.label)
opts['image_pull_policy'] = args.image_pull_policy
opts['image_driver'] = args.image_driver
opts['hints'] = zun_utils.format_args(args.hint)
opts['nets'] = zun_utils.parse_nets(args.net)
if args.security_group:
opts['security_groups'] = args.security_group
if args.command:
opts['command'] = zun_utils.parse_command(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='<container>',
help='ID or name of the container to rename.')
@utils.arg('name',
metavar='<name>',
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='<container>',
help="ID or name of the container to update.")
@utils.arg('--cpu',
metavar='<cpu>',
help='The number of virtual cpus.')
@utils.arg('-m', '--memory',
metavar='<memory>',
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='<container>',
help='ID or name of the container to be attached 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='<container>',
help='ID or name of the container to display processes.')
@utils.arg('ps_args',
metavar='<ps_args>',
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='<source>',
help='The source should be copied to the container or localhost. '
'The format of this parameter is [container:]src_path.')
@utils.arg('destination',
metavar='<destination>',
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='<container>',
help='ID or name of the container to display stats.')
def do_stats(cs, args):
"""Display stats snapshot of the container."""
stats_info = cs.containers.stats(args.container)
utils.print_dict(stats_info)
@utils.arg('container',
metavar='<container>',
help='ID or name of the container to commit.')
@utils.arg('--repository',
metavar='<repository>',
required=True,
help='The repository of the image.')
@utils.arg('--tag',
metavar='<tag>',
help='The tag of the image')
def do_commit(cs, args):
"""Create a new image from a container's changes."""
opts = {}
if args.repository is not None:
opts['repository'] = args.repository
if args.tag is not None:
opts['tag'] = args.tag
try:
image = cs.containers.commit(args.container, **opts)
print("Request to commit container %s has been accepted. "
"The image is %s." % (args.container, image))
except Exception as e:
print("Commit for container %(container)s failed: %(e)s" %
{'container': args.container, 'e': e})
@utils.arg('container',
metavar='<container>',
help='ID or name of the container to add security group.')
@utils.arg('security_group',
metavar='<security_group>',
help='The security group for specified container.')
def do_add_security_group(cs, args):
"""Add security group for specified container."""
opts = {}
opts['id'] = args.container
opts['security_group'] = args.security_group
opts = zun_utils.remove_null_parms(**opts)
try:
cs.containers.add_security_group(**opts)
print("Request to add security group for container %s "
"has been accepted." % args.container)
except Exception as e:
print("Add security group for container %(container)s "
"failed: %(e)s" % {'container': args.container, 'e': e})