868 lines
34 KiB
Python
868 lines
34 KiB
Python
# Copyright 2012 OpenStack Foundation
|
|
# 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 logging
|
|
import six
|
|
from six.moves.urllib import request
|
|
import yaml
|
|
|
|
from heatclient.common import template_utils
|
|
from heatclient.common import utils
|
|
from heatclient.openstack.common import jsonutils
|
|
from heatclient.openstack.common import strutils
|
|
|
|
import heatclient.exc as exc
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
@utils.arg('-f', '--template-file', metavar='<FILE>',
|
|
help='Path to the template.')
|
|
@utils.arg('-e', '--environment-file', metavar='<FILE or URL>',
|
|
help='Path to the environment, it can be specified multiple times.',
|
|
action='append')
|
|
@utils.arg('-u', '--template-url', metavar='<URL>',
|
|
help='URL of template.')
|
|
@utils.arg('-o', '--template-object', metavar='<URL>',
|
|
help='URL to retrieve template object (e.g. from swift).')
|
|
@utils.arg('-c', '--create-timeout', metavar='<TIMEOUT>',
|
|
type=int,
|
|
help='Stack creation timeout in minutes.'
|
|
' DEPRECATED use --timeout instead.')
|
|
@utils.arg('-t', '--timeout', metavar='<TIMEOUT>',
|
|
type=int,
|
|
help='Stack creation timeout in minutes.')
|
|
@utils.arg('-r', '--enable-rollback', default=False, action="store_true",
|
|
help='Enable rollback on create/update failure.')
|
|
@utils.arg('-P', '--parameters', metavar='<KEY1=VALUE1;KEY2=VALUE2...>',
|
|
help='Parameter values used to create the stack. '
|
|
'This can be specified multiple times, or once with parameters '
|
|
'separated by a semicolon.',
|
|
action='append')
|
|
@utils.arg('name', metavar='<STACK_NAME>',
|
|
help='Name of the stack to create.')
|
|
def do_create(hc, args):
|
|
'''DEPRECATED! Use stack-create instead.'''
|
|
logger.warning('DEPRECATED! Use stack-create instead.')
|
|
do_stack_create(hc, args)
|
|
|
|
|
|
@utils.arg('-f', '--template-file', metavar='<FILE>',
|
|
help='Path to the template.')
|
|
@utils.arg('-e', '--environment-file', metavar='<FILE or URL>',
|
|
help='Path to the environment, it can be specified multiple times.',
|
|
action='append')
|
|
@utils.arg('-u', '--template-url', metavar='<URL>',
|
|
help='URL of template.')
|
|
@utils.arg('-o', '--template-object', metavar='<URL>',
|
|
help='URL to retrieve template object (e.g. from swift).')
|
|
@utils.arg('-c', '--create-timeout', metavar='<TIMEOUT>',
|
|
type=int,
|
|
help='Stack creation timeout in minutes.'
|
|
' DEPRECATED use --timeout instead.')
|
|
@utils.arg('-t', '--timeout', metavar='<TIMEOUT>',
|
|
type=int,
|
|
help='Stack creation timeout in minutes.')
|
|
@utils.arg('-r', '--enable-rollback', default=False, action="store_true",
|
|
help='Enable rollback on create/update failure.')
|
|
@utils.arg('-P', '--parameters', metavar='<KEY1=VALUE1;KEY2=VALUE2...>',
|
|
help='Parameter values used to create the stack. '
|
|
'This can be specified multiple times, or once with parameters '
|
|
'separated by a semicolon.',
|
|
action='append')
|
|
@utils.arg('name', metavar='<STACK_NAME>',
|
|
help='Name of the stack to create.')
|
|
def do_stack_create(hc, args):
|
|
'''Create the stack.'''
|
|
tpl_files, template = template_utils.get_template_contents(
|
|
args.template_file,
|
|
args.template_url,
|
|
args.template_object,
|
|
hc.http_client.raw_request)
|
|
env_files, env = template_utils.process_multiple_environments_and_files(
|
|
env_paths=args.environment_file)
|
|
|
|
if args.create_timeout:
|
|
logger.warning('-c/--create-timeout is deprecated, '
|
|
'please use -t/--timeout instead')
|
|
|
|
fields = {
|
|
'stack_name': args.name,
|
|
'disable_rollback': not(args.enable_rollback),
|
|
'parameters': utils.format_parameters(args.parameters),
|
|
'template': template,
|
|
'files': dict(list(tpl_files.items()) + list(env_files.items())),
|
|
'environment': env
|
|
}
|
|
|
|
timeout = args.timeout or args.create_timeout
|
|
if timeout:
|
|
fields['timeout_mins'] = timeout
|
|
|
|
hc.stacks.create(**fields)
|
|
do_stack_list(hc)
|
|
|
|
|
|
@utils.arg('-e', '--environment-file', metavar='<FILE or URL>',
|
|
help='Path to the environment, it can be specified multiple times.',
|
|
action='append')
|
|
@utils.arg('-c', '--create-timeout', metavar='<TIMEOUT>',
|
|
type=int,
|
|
help='Stack creation timeout in minutes.'
|
|
' DEPRECATED use --timeout instead.')
|
|
@utils.arg('-t', '--timeout', metavar='<TIMEOUT>',
|
|
type=int,
|
|
help='Stack creation timeout in minutes.')
|
|
@utils.arg('-a', '--adopt-file', metavar='<FILE or URL>',
|
|
help='Path to adopt stack data file.')
|
|
@utils.arg('-r', '--enable-rollback', default=False, action="store_true",
|
|
help='Enable rollback on create/update failure.')
|
|
@utils.arg('-P', '--parameters', metavar='<KEY1=VALUE1;KEY2=VALUE2...>',
|
|
help='Parameter values used to create the stack. '
|
|
'This can be specified multiple times, or once with parameters '
|
|
'separated by a semicolon.',
|
|
action='append')
|
|
@utils.arg('name', metavar='<STACK_NAME>',
|
|
help='Name of the stack to adopt.')
|
|
def do_stack_adopt(hc, args):
|
|
'''Adopt a stack.'''
|
|
env_files, env = template_utils.process_environment_and_files(
|
|
env_path=args.environment_file)
|
|
|
|
if not args.adopt_file:
|
|
raise exc.CommandError('Need to specify --adopt-file')
|
|
|
|
adopt_url = template_utils.normalise_file_path_to_url(args.adopt_file)
|
|
adopt_data = request.urlopen(adopt_url).read()
|
|
|
|
if args.create_timeout:
|
|
logger.warning('-c/--create-timeout is deprecated, '
|
|
'please use -t/--timeout instead')
|
|
|
|
fields = {
|
|
'stack_name': args.name,
|
|
'disable_rollback': not(args.enable_rollback),
|
|
'adopt_stack_data': adopt_data,
|
|
'parameters': utils.format_parameters(args.parameters),
|
|
'files': dict(list(env_files.items())),
|
|
'environment': env
|
|
}
|
|
|
|
timeout = args.timeout or args.create_timeout
|
|
if timeout:
|
|
fields['timeout_mins'] = timeout
|
|
|
|
hc.stacks.create(**fields)
|
|
do_stack_list(hc)
|
|
|
|
|
|
@utils.arg('-f', '--template-file', metavar='<FILE>',
|
|
help='Path to the template.')
|
|
@utils.arg('-e', '--environment-file', metavar='<FILE or URL>',
|
|
help='Path to the environment, it can be specified multiple times.',
|
|
action='append')
|
|
@utils.arg('-u', '--template-url', metavar='<URL>',
|
|
help='URL of template.')
|
|
@utils.arg('-o', '--template-object', metavar='<URL>',
|
|
help='URL to retrieve template object (e.g. from swift)')
|
|
@utils.arg('-t', '--timeout', metavar='<TIMEOUT>', type=int,
|
|
help='Stack creation timeout in minutes. This is only used during'
|
|
'validation in preview.')
|
|
@utils.arg('-r', '--enable-rollback', default=False, action="store_true",
|
|
help='Enable rollback on failure. This option is not used during'
|
|
'preview and exists only for symmetry with stack-create.')
|
|
@utils.arg('-P', '--parameters', metavar='<KEY1=VALUE1;KEY2=VALUE2...>',
|
|
help='Parameter values used to preview the stack. '
|
|
'This can be specified multiple times, or once with parameters '
|
|
'separated by semicolon.',
|
|
action='append')
|
|
@utils.arg('name', metavar='<STACK_NAME>',
|
|
help='Name of the stack to preview.')
|
|
def do_stack_preview(hc, args):
|
|
'''Preview the stack.'''
|
|
tpl_files, template = template_utils.get_template_contents(
|
|
args.template_file,
|
|
args.template_url,
|
|
args.template_object,
|
|
hc.http_client.raw_request)
|
|
env_files, env = template_utils.process_multiple_environments_and_files(
|
|
env_paths=args.environment_file)
|
|
|
|
fields = {
|
|
'stack_name': args.name,
|
|
'disable_rollback': not(args.enable_rollback),
|
|
'timeout_mins': args.timeout,
|
|
'parameters': utils.format_parameters(args.parameters),
|
|
'template': template,
|
|
'files': dict(list(tpl_files.items()) + list(env_files.items())),
|
|
'environment': env
|
|
}
|
|
|
|
stack = hc.stacks.preview(**fields)
|
|
formatters = {
|
|
'description': utils.text_wrap_formatter,
|
|
'template_description': utils.text_wrap_formatter,
|
|
'stack_status_reason': utils.text_wrap_formatter,
|
|
'parameters': utils.json_formatter,
|
|
'outputs': utils.json_formatter,
|
|
'resources': utils.json_formatter,
|
|
'links': utils.link_formatter,
|
|
}
|
|
utils.print_dict(stack.to_dict(), formatters=formatters)
|
|
|
|
|
|
@utils.arg('id', metavar='<NAME or ID>', nargs='+',
|
|
help='Name or ID of stack(s) to delete.')
|
|
def do_delete(hc, args):
|
|
'''DEPRECATED! Use stack-delete instead.'''
|
|
logger.warning('DEPRECATED! Use stack-delete instead.')
|
|
do_stack_delete(hc, args)
|
|
|
|
|
|
@utils.arg('id', metavar='<NAME or ID>', nargs='+',
|
|
help='Name or ID of stack(s) to delete.')
|
|
def do_stack_delete(hc, args):
|
|
'''Delete the stack(s).'''
|
|
failure_count = 0
|
|
|
|
for sid in args.id:
|
|
fields = {'stack_id': sid}
|
|
try:
|
|
hc.stacks.delete(**fields)
|
|
except exc.HTTPNotFound as e:
|
|
failure_count += 1
|
|
print(e)
|
|
if failure_count == len(args.id):
|
|
raise exc.CommandError("Unable to delete any of the specified "
|
|
"stacks.")
|
|
do_stack_list(hc)
|
|
|
|
|
|
@utils.arg('-O', '--output-file', metavar='<FILE>',
|
|
help='file to output abandon result. '
|
|
'If the option is specified, the result will be'
|
|
' output into <FILE>.')
|
|
@utils.arg('id', metavar='<NAME or ID>',
|
|
help='Name or ID of stack to abandon.')
|
|
def do_stack_abandon(hc, args):
|
|
'''Abandon the stack.
|
|
|
|
This will delete the record of the stack from Heat, but will not delete
|
|
any of the underlying resources. Prints an adoptable JSON representation
|
|
of the stack to stdout or a file on success.
|
|
'''
|
|
fields = {'stack_id': args.id}
|
|
try:
|
|
stack = hc.stacks.abandon(**fields)
|
|
except exc.HTTPNotFound:
|
|
raise exc.CommandError('Stack not found: %s' % args.id)
|
|
else:
|
|
result = jsonutils.dumps(stack, indent=2)
|
|
if args.output_file is not None:
|
|
try:
|
|
with open(args.output_file, "w") as f:
|
|
f.write(result)
|
|
except IOError as err:
|
|
print(result)
|
|
raise exc.CommandError(str(err))
|
|
else:
|
|
print(result)
|
|
|
|
|
|
@utils.arg('id', metavar='<NAME or ID>',
|
|
help='Name or ID of stack to suspend.')
|
|
def do_action_suspend(hc, args):
|
|
'''Suspend the stack.'''
|
|
fields = {'stack_id': args.id}
|
|
try:
|
|
hc.actions.suspend(**fields)
|
|
except exc.HTTPNotFound:
|
|
raise exc.CommandError('Stack not found: %s' % args.id)
|
|
else:
|
|
do_stack_list(hc)
|
|
|
|
|
|
@utils.arg('id', metavar='<NAME or ID>', help='Name or ID of stack to resume.')
|
|
def do_action_resume(hc, args):
|
|
'''Resume the stack.'''
|
|
fields = {'stack_id': args.id}
|
|
try:
|
|
hc.actions.resume(**fields)
|
|
except exc.HTTPNotFound:
|
|
raise exc.CommandError('Stack not found: %s' % args.id)
|
|
else:
|
|
do_stack_list(hc)
|
|
|
|
|
|
@utils.arg('id', metavar='<NAME or ID>',
|
|
help='Name or ID of stack to describe.')
|
|
def do_describe(hc, args):
|
|
'''DEPRECATED! Use stack-show instead.'''
|
|
logger.warning('DEPRECATED! Use stack-show instead.')
|
|
do_stack_show(hc, args)
|
|
|
|
|
|
@utils.arg('id', metavar='<NAME or ID>',
|
|
help='Name or ID of stack to describe.')
|
|
def do_stack_show(hc, args):
|
|
'''Describe the stack.'''
|
|
fields = {'stack_id': args.id}
|
|
try:
|
|
stack = hc.stacks.get(**fields)
|
|
except exc.HTTPNotFound:
|
|
raise exc.CommandError('Stack not found: %s' % args.id)
|
|
else:
|
|
formatters = {
|
|
'description': utils.text_wrap_formatter,
|
|
'template_description': utils.text_wrap_formatter,
|
|
'stack_status_reason': utils.text_wrap_formatter,
|
|
'parameters': utils.json_formatter,
|
|
'outputs': utils.json_formatter,
|
|
'links': utils.link_formatter
|
|
}
|
|
utils.print_dict(stack.to_dict(), formatters=formatters)
|
|
|
|
|
|
@utils.arg('-f', '--template-file', metavar='<FILE>',
|
|
help='Path to the template.')
|
|
@utils.arg('-e', '--environment-file', metavar='<FILE or URL>',
|
|
help='Path to the environment, it can be specified multiple times.',
|
|
action='append')
|
|
@utils.arg('-u', '--template-url', metavar='<URL>',
|
|
help='URL of template.')
|
|
@utils.arg('-o', '--template-object', metavar='<URL>',
|
|
help='URL to retrieve template object (e.g. from swift).')
|
|
@utils.arg('-t', '--timeout', metavar='<TIMEOUT>',
|
|
type=int,
|
|
help='Stack update timeout in minutes.')
|
|
@utils.arg('-r', '--enable-rollback', default=False, action="store_true",
|
|
help='DEPRECATED! Use --rollback argument instead. '
|
|
'Enable rollback on stack update failure. '
|
|
'NOTE: default behavior is now to use the rollback value '
|
|
'of existing stack.')
|
|
@utils.arg('--rollback', default=None, metavar='<VALUE>',
|
|
help='Set rollback on update failure. '
|
|
'Values %(true)s set rollback to enabled. '
|
|
'Values %(false)s set rollback to disabled. '
|
|
'Default is to use the value of existing stack to be updated.'
|
|
% {'true': strutils.TRUE_STRINGS, 'false': strutils.FALSE_STRINGS})
|
|
@utils.arg('-P', '--parameters', metavar='<KEY1=VALUE1;KEY2=VALUE2...>',
|
|
help='Parameter values used to create the stack. '
|
|
'This can be specified multiple times, or once with parameters '
|
|
'separated by a semicolon.',
|
|
action='append')
|
|
@utils.arg('-x', '--existing', default=False, action="store_true",
|
|
help='Re-use the set of parameters of the current stack. '
|
|
'Parameters specified in --parameters will patch over the existing '
|
|
'values in the current stack. Parameters omitted will keep '
|
|
'the existing values.')
|
|
@utils.arg('-c', '--clear-parameter', metavar='<PARAMETER>',
|
|
help='Remove the parameters from the set of parameters of current '
|
|
'stack for the stack-update. The default value in the template '
|
|
'will be used. This can be specified multiple times.',
|
|
action='append')
|
|
@utils.arg('id', metavar='<NAME or ID>',
|
|
help='Name or ID of stack to update.')
|
|
def do_update(hc, args):
|
|
'''DEPRECATED! Use stack-update instead.'''
|
|
logger.warning('DEPRECATED! Use stack-update instead.')
|
|
do_stack_update(hc, args)
|
|
|
|
|
|
@utils.arg('-f', '--template-file', metavar='<FILE>',
|
|
help='Path to the template.')
|
|
@utils.arg('-e', '--environment-file', metavar='<FILE or URL>',
|
|
help='Path to the environment, it can be specified multiple times.',
|
|
action='append')
|
|
@utils.arg('-u', '--template-url', metavar='<URL>',
|
|
help='URL of template.')
|
|
@utils.arg('-o', '--template-object', metavar='<URL>',
|
|
help='URL to retrieve template object (e.g. from swift).')
|
|
@utils.arg('-t', '--timeout', metavar='<TIMEOUT>',
|
|
type=int,
|
|
help='Stack update timeout in minutes.')
|
|
@utils.arg('-r', '--enable-rollback', default=False, action="store_true",
|
|
help='DEPRECATED! Use --rollback argument instead. '
|
|
'Enable rollback on stack update failure. '
|
|
'NOTE: default behavior is now to use the rollback value '
|
|
'of existing stack.')
|
|
@utils.arg('--rollback', default=None, metavar='<VALUE>',
|
|
help='Set rollback on update failure. '
|
|
'Values %(true)s set rollback to enabled. '
|
|
'Values %(false)s set rollback to disabled. '
|
|
'Default is to use the value of existing stack to be updated.'
|
|
% {'true': strutils.TRUE_STRINGS, 'false': strutils.FALSE_STRINGS})
|
|
@utils.arg('-P', '--parameters', metavar='<KEY1=VALUE1;KEY2=VALUE2...>',
|
|
help='Parameter values used to create the stack. '
|
|
'This can be specified multiple times, or once with parameters '
|
|
'separated by a semicolon.',
|
|
action='append')
|
|
@utils.arg('-x', '--existing', default=False, action="store_true",
|
|
help='Re-use the set of parameters of the current stack. '
|
|
'Parameters specified in --parameters will patch over the existing '
|
|
'values in the current stack. Parameters omitted will keep '
|
|
'the existing values.')
|
|
@utils.arg('-c', '--clear-parameter', metavar='<PARAMETER>',
|
|
help='Remove the parameters from the set of parameters of current '
|
|
'stack for the stack-update. The default value in the template '
|
|
'will be used. This can be specified multiple times.',
|
|
action='append')
|
|
@utils.arg('id', metavar='<NAME or ID>',
|
|
help='Name or ID of stack to update.')
|
|
def do_stack_update(hc, args):
|
|
'''Update the stack.'''
|
|
|
|
tpl_files, template = template_utils.get_template_contents(
|
|
args.template_file,
|
|
args.template_url,
|
|
args.template_object,
|
|
hc.http_client.raw_request)
|
|
|
|
env_files, env = template_utils.process_multiple_environments_and_files(
|
|
env_paths=args.environment_file)
|
|
|
|
fields = {
|
|
'stack_id': args.id,
|
|
'parameters': utils.format_parameters(args.parameters),
|
|
'existing': args.existing,
|
|
'template': template,
|
|
'files': dict(list(tpl_files.items()) + list(env_files.items())),
|
|
'environment': env
|
|
}
|
|
|
|
if args.timeout:
|
|
fields['timeout_mins'] = args.timeout
|
|
if args.clear_parameter:
|
|
fields['clear_parameters'] = list(args.clear_parameter)
|
|
|
|
if args.rollback is not None:
|
|
try:
|
|
rollback = strutils.bool_from_string(args.rollback, strict=True)
|
|
except ValueError as ex:
|
|
raise exc.CommandError(six.text_type(ex))
|
|
else:
|
|
fields['disable_rollback'] = not(rollback)
|
|
# TODO(pshchelo): remove the following 'else' clause after deprecation
|
|
# period of --enable-rollback switch and assign -r shortcut to --rollback
|
|
else:
|
|
if args.enable_rollback:
|
|
fields['disable_rollback'] = False
|
|
|
|
hc.stacks.update(**fields)
|
|
do_stack_list(hc)
|
|
|
|
|
|
def do_list(hc):
|
|
'''DEPRECATED! Use stack-list instead.'''
|
|
logger.warning('DEPRECATED! Use stack-list instead.')
|
|
do_stack_list(hc)
|
|
|
|
|
|
@utils.arg('-s', '--show-deleted', default=False, action="store_true",
|
|
help='Include soft-deleted stacks in the stack listing.')
|
|
@utils.arg('-n', '--show-nested', default=False, action="store_true",
|
|
help='Include nested stacks in the stack listing.')
|
|
@utils.arg('-f', '--filters', metavar='<KEY1=VALUE1;KEY2=VALUE2...>',
|
|
help='Filter parameters to apply on returned stacks. '
|
|
'This can be specified multiple times, or once with parameters '
|
|
'separated by a semicolon.',
|
|
action='append')
|
|
@utils.arg('-l', '--limit', metavar='<LIMIT>',
|
|
help='Limit the number of stacks returned.')
|
|
@utils.arg('-m', '--marker', metavar='<ID>',
|
|
help='Only return stacks that appear after the given stack ID.')
|
|
@utils.arg('-g', '--global-tenant', action='store_true', default=False,
|
|
help='Display stacks from all tenants. Operation only authorized '
|
|
'for users who match the policy in heat\'s policy.json.')
|
|
@utils.arg('-o', '--show-owner', action='store_true', default=False,
|
|
help='Display stack owner information. This is automatically '
|
|
'enabled when using --global-tenant.')
|
|
def do_stack_list(hc, args=None):
|
|
'''List the user's stacks.'''
|
|
kwargs = {}
|
|
fields = ['id', 'stack_name', 'stack_status', 'creation_time']
|
|
if args:
|
|
kwargs = {'limit': args.limit,
|
|
'marker': args.marker,
|
|
'filters': utils.format_parameters(args.filters),
|
|
'global_tenant': args.global_tenant,
|
|
'show_deleted': args.show_deleted}
|
|
if args.show_nested:
|
|
fields.append('parent')
|
|
kwargs['show_nested'] = True
|
|
|
|
if args.global_tenant or args.show_owner:
|
|
fields.insert(2, 'stack_owner')
|
|
if args.global_tenant:
|
|
fields.insert(2, 'project')
|
|
|
|
stacks = hc.stacks.list(**kwargs)
|
|
utils.print_list(stacks, fields, sortby_index=3)
|
|
|
|
|
|
@utils.arg('id', metavar='<NAME or ID>',
|
|
help='Name or ID of stack to query.')
|
|
def do_output_list(hc, args):
|
|
'''Show available outputs.'''
|
|
try:
|
|
stack = hc.stacks.get(stack_id=args.id)
|
|
except exc.HTTPNotFound:
|
|
raise exc.CommandError('Stack not found: %s' % args.id)
|
|
else:
|
|
outputs = stack.to_dict()['outputs']
|
|
fields = ['output_key', 'description']
|
|
formatters = {
|
|
'output_key': lambda x: x['output_key'],
|
|
'description': lambda x: x['description'],
|
|
}
|
|
|
|
utils.print_list(outputs, fields, formatters=formatters)
|
|
|
|
|
|
@utils.arg('id', metavar='<NAME or ID>',
|
|
help='Name or ID of stack to query.')
|
|
@utils.arg('output', metavar='<OUTPUT NAME>',
|
|
help='Name of an output to display.')
|
|
def do_output_show(hc, args):
|
|
'''Show a specific stack output.'''
|
|
try:
|
|
stack = hc.stacks.get(stack_id=args.id)
|
|
except exc.HTTPNotFound:
|
|
raise exc.CommandError('Stack not found: %s' % args.id)
|
|
else:
|
|
for output in stack.to_dict().get('outputs', []):
|
|
if output['output_key'] == args.output:
|
|
value = output['output_value']
|
|
break
|
|
else:
|
|
return
|
|
|
|
print (jsonutils.dumps(value, indent=2, ensure_ascii=False))
|
|
|
|
|
|
def do_resource_type_list(hc, args):
|
|
'''List the available resource types.'''
|
|
types = hc.resource_types.list()
|
|
utils.print_list(types, ['resource_type'], sortby_index=0)
|
|
|
|
|
|
@utils.arg('resource_type', metavar='<RESOURCE_TYPE>',
|
|
help='Resource type to get the details for.')
|
|
def do_resource_type_show(hc, args):
|
|
'''Show the resource type.'''
|
|
try:
|
|
resource_type = hc.resource_types.get(args.resource_type)
|
|
except exc.HTTPNotFound:
|
|
raise exc.CommandError(
|
|
'Resource Type not found: %s' % args.resource_type)
|
|
else:
|
|
print(jsonutils.dumps(resource_type, indent=2))
|
|
|
|
|
|
@utils.arg('resource_type', metavar='<RESOURCE_TYPE>',
|
|
help='Resource type to generate a template for.')
|
|
@utils.arg('-F', '--format', metavar='<FORMAT>',
|
|
help="The template output format, one of: %s."
|
|
% ', '.join(utils.supported_formats.keys()))
|
|
def do_resource_type_template(hc, args):
|
|
'''Generate a template based on a resource type.'''
|
|
fields = {'resource_type': args.resource_type}
|
|
try:
|
|
template = hc.resource_types.generate_template(**fields)
|
|
except exc.HTTPNotFound:
|
|
raise exc.CommandError(
|
|
'Resource Type %s not found.' % args.resource_type)
|
|
else:
|
|
if args.format:
|
|
print(utils.format_output(template, format=args.format))
|
|
else:
|
|
print(utils.format_output(template))
|
|
|
|
|
|
@utils.arg('id', metavar='<NAME or ID>',
|
|
help='Name or ID of stack to get the template for.')
|
|
def do_gettemplate(hc, args):
|
|
'''DEPRECATED! Use template-show instead.'''
|
|
logger.warning('DEPRECATED! Use template-show instead.')
|
|
do_template_show(hc, args)
|
|
|
|
|
|
@utils.arg('id', metavar='<NAME or ID>',
|
|
help='Name or ID of stack to get the template for.')
|
|
def do_template_show(hc, args):
|
|
'''Get the template for the specified stack.'''
|
|
fields = {'stack_id': args.id}
|
|
try:
|
|
template = hc.stacks.template(**fields)
|
|
except exc.HTTPNotFound:
|
|
raise exc.CommandError('Stack not found: %s' % args.id)
|
|
else:
|
|
if 'heat_template_version' in template:
|
|
print(yaml.safe_dump(template, indent=2))
|
|
else:
|
|
print(jsonutils.dumps(template, indent=2, ensure_ascii=False))
|
|
|
|
|
|
@utils.arg('-u', '--template-url', metavar='<URL>',
|
|
help='URL of template.')
|
|
@utils.arg('-f', '--template-file', metavar='<FILE>',
|
|
help='Path to the template.')
|
|
@utils.arg('-e', '--environment-file', metavar='<FILE or URL>',
|
|
help='Path to the environment, it can be specified multiple times.',
|
|
action='append')
|
|
@utils.arg('-o', '--template-object', metavar='<URL>',
|
|
help='URL to retrieve template object (e.g. from swift).')
|
|
def do_validate(hc, args):
|
|
'''DEPRECATED! Use template-validate instead.'''
|
|
logger.warning('DEPRECATED! Use template-validate instead.')
|
|
do_template_validate(hc, args)
|
|
|
|
|
|
@utils.arg('-u', '--template-url', metavar='<URL>',
|
|
help='URL of template.')
|
|
@utils.arg('-f', '--template-file', metavar='<FILE>',
|
|
help='Path to the template.')
|
|
@utils.arg('-e', '--environment-file', metavar='<FILE or URL>',
|
|
help='Path to the environment, it can be specified multiple times.',
|
|
action='append')
|
|
@utils.arg('-o', '--template-object', metavar='<URL>',
|
|
help='URL to retrieve template object (e.g. from swift).')
|
|
def do_template_validate(hc, args):
|
|
'''Validate a template with parameters.'''
|
|
|
|
tpl_files, template = template_utils.get_template_contents(
|
|
args.template_file,
|
|
args.template_url,
|
|
args.template_object,
|
|
hc.http_client.raw_request)
|
|
|
|
env_files, env = template_utils.process_multiple_environments_and_files(
|
|
env_paths=args.environment_file)
|
|
fields = {
|
|
'template': template,
|
|
'files': dict(list(tpl_files.items()) + list(env_files.items())),
|
|
'environment': env
|
|
}
|
|
|
|
validation = hc.stacks.validate(**fields)
|
|
print(jsonutils.dumps(validation, indent=2, ensure_ascii=False))
|
|
|
|
|
|
@utils.arg('id', metavar='<NAME or ID>',
|
|
help='Name or ID of stack to show the resources for.')
|
|
@utils.arg('-n', '--nested-depth', metavar='<DEPTH>',
|
|
help='Depth of nested stacks from which to display resources.')
|
|
def do_resource_list(hc, args):
|
|
'''Show list of resources belonging to a stack.'''
|
|
fields = {
|
|
'stack_id': args.id,
|
|
'nested_depth': args.nested_depth,
|
|
}
|
|
try:
|
|
resources = hc.resources.list(**fields)
|
|
except exc.HTTPNotFound:
|
|
raise exc.CommandError('Stack not found: %s' % args.id)
|
|
else:
|
|
fields = ['physical_resource_id', 'resource_type',
|
|
'resource_status', 'updated_time']
|
|
if len(resources) >= 1 and not hasattr(resources[0], 'resource_name'):
|
|
fields.insert(0, 'logical_resource_id')
|
|
else:
|
|
fields.insert(0, 'resource_name')
|
|
|
|
if args.nested_depth:
|
|
fields.append('parent_resource')
|
|
|
|
utils.print_list(resources, fields, sortby_index=4)
|
|
|
|
|
|
@utils.arg('id', metavar='<NAME or ID>',
|
|
help='Name or ID of stack to show the resource for.')
|
|
@utils.arg('resource', metavar='<RESOURCE>',
|
|
help='Name of the resource to show the details for.')
|
|
def do_resource(hc, args):
|
|
'''DEPRECATED! Use resource-show instead.'''
|
|
logger.warning('DEPRECATED! Use resource-show instead.')
|
|
do_resource_show(hc, args)
|
|
|
|
|
|
@utils.arg('id', metavar='<NAME or ID>',
|
|
help='Name or ID of stack to show the resource for.')
|
|
@utils.arg('resource', metavar='<RESOURCE>',
|
|
help='Name of the resource to show the details for.')
|
|
def do_resource_show(hc, args):
|
|
'''Describe the resource.'''
|
|
fields = {'stack_id': args.id,
|
|
'resource_name': args.resource}
|
|
try:
|
|
resource = hc.resources.get(**fields)
|
|
except exc.HTTPNotFound:
|
|
raise exc.CommandError('Stack or resource not found: %s %s' %
|
|
(args.id, args.resource))
|
|
else:
|
|
formatters = {
|
|
'links': utils.link_formatter,
|
|
'required_by': utils.newline_list_formatter
|
|
}
|
|
utils.print_dict(resource.to_dict(), formatters=formatters)
|
|
|
|
|
|
@utils.arg('resource_type', metavar='<RESOURCE_TYPE>',
|
|
help='Resource type to generate a template for.')
|
|
@utils.arg('-F', '--format', metavar='<FORMAT>',
|
|
help="The template output format, one of: %s."
|
|
% ', '.join(utils.supported_formats.keys()))
|
|
def do_resource_template(hc, args):
|
|
'''DEPRECATED! Use resource-type-template instead.'''
|
|
logger.warning('DEPRECATED! Use resource-type-template instead.')
|
|
do_resource_type_template(hc, args)
|
|
|
|
|
|
@utils.arg('id', metavar='<NAME or ID>',
|
|
help='Name or ID of stack to show the resource metadata for.')
|
|
@utils.arg('resource', metavar='<RESOURCE>',
|
|
help='Name of the resource to show the metadata for.')
|
|
def do_resource_metadata(hc, args):
|
|
'''List resource metadata.'''
|
|
fields = {'stack_id': args.id,
|
|
'resource_name': args.resource}
|
|
try:
|
|
metadata = hc.resources.metadata(**fields)
|
|
except exc.HTTPNotFound:
|
|
raise exc.CommandError('Stack or resource not found: %s %s' %
|
|
(args.id, args.resource))
|
|
else:
|
|
print(jsonutils.dumps(metadata, indent=2))
|
|
|
|
|
|
@utils.arg('id', metavar='<NAME or ID>',
|
|
help='Name or ID of stack the resource belongs to.')
|
|
@utils.arg('resource', metavar='<RESOURCE>',
|
|
help='Name of the resource to signal.')
|
|
@utils.arg('-D', '--data', metavar='<DATA>',
|
|
help='JSON Data to send to the signal handler.')
|
|
@utils.arg('-f', '--data-file', metavar='<FILE>',
|
|
help='File containing JSON data to send to the signal handler.')
|
|
def do_resource_signal(hc, args):
|
|
'''Send a signal to a resource.'''
|
|
fields = {'stack_id': args.id,
|
|
'resource_name': args.resource}
|
|
data = args.data
|
|
data_file = args.data_file
|
|
if data and data_file:
|
|
raise exc.CommandError('Can only specify one of data and data-file')
|
|
if data_file:
|
|
data_url = template_utils.normalise_file_path_to_url(data_file)
|
|
data = request.urlopen(data_url).read()
|
|
if data:
|
|
if isinstance(data, six.binary_type):
|
|
data = data.decode('utf-8')
|
|
try:
|
|
data = jsonutils.loads(data)
|
|
except ValueError as ex:
|
|
raise exc.CommandError('Data should be in JSON format: %s' % ex)
|
|
if not isinstance(data, dict):
|
|
raise exc.CommandError('Data should be a JSON dict')
|
|
fields['data'] = data
|
|
try:
|
|
hc.resources.signal(**fields)
|
|
except exc.HTTPNotFound:
|
|
raise exc.CommandError('Stack or resource not found: %s %s' %
|
|
(args.id, args.resource))
|
|
|
|
|
|
@utils.arg('id', metavar='<NAME or ID>',
|
|
help='Name or ID of stack to show the events for.')
|
|
@utils.arg('-r', '--resource', metavar='<RESOURCE>',
|
|
help='Name of the resource to filter events by.')
|
|
@utils.arg('-f', '--filters', metavar='<KEY1=VALUE1;KEY2=VALUE2...>',
|
|
help='Filter parameters to apply on returned events. '
|
|
'This can be specified multiple times, or once with parameters '
|
|
'separated by a semicolon.',
|
|
action='append')
|
|
@utils.arg('-l', '--limit', metavar='<LIMIT>',
|
|
help='Limit the number of events returned.')
|
|
@utils.arg('-m', '--marker', metavar='<ID>',
|
|
help='Only return events that appear after the given event ID.')
|
|
def do_event_list(hc, args):
|
|
'''List events for a stack.'''
|
|
fields = {'stack_id': args.id,
|
|
'resource_name': args.resource,
|
|
'limit': args.limit,
|
|
'marker': args.marker,
|
|
'filters': utils.format_parameters(args.filters)}
|
|
try:
|
|
events = hc.events.list(**fields)
|
|
except exc.HTTPNotFound as ex:
|
|
# it could be the stack or resource that is not found
|
|
# just use the message that the server sent us.
|
|
raise exc.CommandError(str(ex))
|
|
else:
|
|
fields = ['id', 'resource_status_reason',
|
|
'resource_status', 'event_time']
|
|
if len(events) >= 1:
|
|
if hasattr(events[0], 'resource_name'):
|
|
fields.insert(0, 'resource_name')
|
|
else:
|
|
fields.insert(0, 'logical_resource_id')
|
|
utils.print_list(events, fields, sortby_index=None)
|
|
|
|
|
|
@utils.arg('id', metavar='<NAME or ID>',
|
|
help='Name or ID of stack to show the events for.')
|
|
@utils.arg('resource', metavar='<RESOURCE>',
|
|
help='Name of the resource the event belongs to.')
|
|
@utils.arg('event', metavar='<EVENT>',
|
|
help='ID of event to display details for.')
|
|
def do_event(hc, args):
|
|
'''DEPRECATED! Use event-show instead.'''
|
|
logger.warning('DEPRECATED! Use event-show instead.')
|
|
do_event_show(hc, args)
|
|
|
|
|
|
@utils.arg('id', metavar='<NAME or ID>',
|
|
help='Name or ID of stack to show the events for.')
|
|
@utils.arg('resource', metavar='<RESOURCE>',
|
|
help='Name of the resource the event belongs to.')
|
|
@utils.arg('event', metavar='<EVENT>',
|
|
help='ID of event to display details for.')
|
|
def do_event_show(hc, args):
|
|
'''Describe the event.'''
|
|
fields = {'stack_id': args.id,
|
|
'resource_name': args.resource,
|
|
'event_id': args.event}
|
|
try:
|
|
event = hc.events.get(**fields)
|
|
except exc.HTTPNotFound as ex:
|
|
# it could be the stack/resource/or event that is not found
|
|
# just use the message that the server sent us.
|
|
raise exc.CommandError(str(ex))
|
|
else:
|
|
formatters = {
|
|
'links': utils.link_formatter,
|
|
'resource_properties': utils.json_formatter
|
|
}
|
|
utils.print_dict(event.to_dict(), formatters=formatters)
|
|
|
|
|
|
def do_build_info(hc, args):
|
|
'''Retrieve build information.'''
|
|
result = hc.build_info.build_info()
|
|
formatters = {
|
|
'api': utils.json_formatter,
|
|
'engine': utils.json_formatter,
|
|
}
|
|
utils.print_dict(result, formatters=formatters)
|