openstack/deb-heat
Code Issues Proposed changes

Rename heat client to heat-cfn.

Browse Source 
This is to allow python-heatclient to eventually become the default heat
client.

Documentation in heat.wiki will be updated to refer to heat-cfn when this
change is pushed.

Change-Id: I2209c36adf41fa5d0df0caf9200f7fedbdd51805
This commit is contained in:
Steve Baker 2012-11-05 09:29:35 +13:00
parent 8135da2fb4
commit f77c09c2a5
8 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
bin/heat-boto
View File

@ -1 +1 @@
heat
heat-cfn

14
bin/heat → bin/heat-cfn
View File

@ -113,7 +113,7 @@ def template_validate(options, arguments):
Validate a template. This command parses a template and verifies that
it is in the correct format.
Usage: heat validate \\
Usage: heat-cfn validate \\
[--template-file=<template file>|--template-url=<template URL>] \\
[options]
@ -180,7 +180,7 @@ def stack_create(options, arguments):
'''
Create a new stack from a template.
Usage: heat create <stack name> \\
Usage: heat-cfn create <stack name> \\
[--template-file=<template file>|--template-url=<template URL>] \\
[options]
@ -220,7 +220,7 @@ def stack_update(options, arguments):
'''
Update an existing stack.
Usage: heat update <stack name> \\
Usage: heat-cfn update <stack name> \\
[--template-file=<template file>|--template-url=<template URL>] \\
[options]
@ -263,7 +263,7 @@ def stack_delete(options, arguments):
the stack and (perhaps wrongly) also removes all events associated
with the given stack.
Usage: heat delete <stack name>
Usage: heat-cfn delete <stack name>
'''
parameters = {}
try:
@ -283,7 +283,7 @@ def stack_describe(options, arguments):
'''
Describes an existing stack.
Usage: heat describe <stack name>
Usage: heat-cfn describe <stack name>
'''
parameters = {}
try:
@ -301,7 +301,7 @@ def stack_events_list(options, arguments):
'''
List events associated with the given stack.
Usage: heat event-list <stack name>
Usage: heat-cfn event-list <stack name>
'''
parameters = {}
try:
@ -397,7 +397,7 @@ def stack_list(options, arguments):
'''
List all running stacks.
Usage: heat list
Usage: heat-cfn list
'''
c = get_client(options)
result = c.list_stacks()

14
docs/GettingStarted.rst
View File

@ -210,21 +210,21 @@ Launch a Wordpress instance
::
heat create wordpress --template-file=templates/WordPress_Single_Instance.template --parameters="InstanceType=m1.xlarge;DBUsername=${USER};DBPassword=verybadpass;KeyName=${USER}_key"
heat-cfn create wordpress --template-file=templates/WordPress_Single_Instance.template --parameters="InstanceType=m1.xlarge;DBUsername=${USER};DBPassword=verybadpass;KeyName=${USER}_key"
List stacks
-----------
::
heat list
heat-cfn list
List stack events
-----------------
::
heat event-list wordpress
heat-cfn event-list wordpress
Describe the ``wordpress`` stack
--------------------------------
@ -234,7 +234,7 @@ Describe the ``wordpress`` stack
::
heat describe wordpress
heat-cfn describe wordpress
..
EOF
@ -294,7 +294,7 @@ Because the software takes some time to install from the repository, it may be a
echo "Pausing to wait for application startup..." >&2
sleep 60
Point a web browser at the location given by the ``WebsiteURL`` Output as shown by ``heat describe``::
Point a web browser at the location given by the ``WebsiteURL`` Output as shown by ``heat-cfn describe``::
wget ${WebsiteURL}
@ -303,8 +303,8 @@ Delete the instance when done
::
heat delete wordpress
heat list
heat-cfn delete wordpress
heat-cfn list
Note: This operation will show no running stack.

28
docs/man/man1/heat.1 → docs/man/man1/heat-cfn.1
View File

@ -1,5 +1,5 @@
'\" t
.\" Title: heat
.\" Title: heat-cfn
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 03/31/2012
@ -19,17 +19,17 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
heat \- perform a heat action via the heat API
heat-cfn \- perform a heat action via the heat API
.SH "SYNOPSIS"
.sp
heat COMMAND [OPTIONS]
heat-cfn COMMAND [OPTIONS]
.SH "DESCRIPTION"
.sp
\fBheat\fR is a tool to orchestrate the setup of multiple cloud applications\&.
\fBheat-cfn\fR is a tool to orchestrate the setup of multiple cloud applications\&.
.SH CONFIGURATION
heat uses keystone authentication, and expects some variables to be set in
heat-cfn uses keystone authentication, and expects some variables to be set in
your environment, without these heat will not be able to establish an
authenticated connection with the heat API server.
@ -213,23 +213,23 @@ Do not prompt for confirmation, assume yes
.SH "USAGE EXAMPLES"
.sp
heat -d create wordpress --template-file=templates/WordPress_Single_Instance.template --parameters="InstanceType=m1.xlarge;DBUsername=${USER};DBPassword=verybadpass;KeyName=${USER}_key"
heat-cfn -d create wordpress --template-file=templates/WordPress_Single_Instance.template --parameters="InstanceType=m1.xlarge;DBUsername=${USER};DBPassword=verybadpass;KeyName=${USER}_key"
heat list
heat-cfn list
heat describe wordpress
heat-cfn describe wordpress
heat resource-list wordpress
heat-cfn resource-list wordpress
heat resource-list-details wordpress
heat-cfn resource-list-details wordpress
heat resource-list-details wordpress WikiDatabase
heat-cfn resource-list-details wordpress WikiDatabase
heat resource wordpress WikiDatabase
heat-cfn resource wordpress WikiDatabase
heat event-list
heat-cfn event-list
heat delete wordpress
heat-cfn delete wordpress
.SH "AUTHOR"
.sp

6
etc/bash_completion.d/heat → etc/bash_completion.d/heat-cfn
View File

@ -6,7 +6,7 @@ _heat()
prev="${COMP_WORDS[COMP_CWORD-1]}"
if [[ ${cur} == -* ]]; then
opts=$(heat --help | grep -A100 "^Options" | sed -r "s/^[[:space:]]*-[[:alpha:]]([[:space:]][[:alpha:]_]*,|,)[[:space:]]//" | cut -d "=" -f1 | grep "^--" | awk '{print $1}')
opts=$(heat-cfn --help | grep -A100 "^Options" | sed -r "s/^[[:space:]]*-[[:alpha:]]([[:space:]][[:alpha:]_]*,|,)[[:space:]]//" | cut -d "=" -f1 | grep "^--" | awk '{print $1}')
COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
return 0
fi
@ -14,9 +14,9 @@ _heat()
if [[ ${#COMP_WORDS[@]} -gt 2 ]]; then
return 0
else
cmds=$(heat help | awk '{print $1}' | egrep -v "^(Usage|Commands|$)")
cmds=$(heat-cfn help | awk '{print $1}' | egrep -v "^(Usage|Commands|$)")
COMPREPLY=( $(compgen -W "${cmds}" -- ${cur}) )
return 0
fi
}
complete -F _heat heat
complete -F _heat heat-cfn

2
run_tests.sh
View File

@ -46,7 +46,7 @@ function run_tests {
function run_pep8 {
echo "Running pep8..."
PEP8_OPTIONS="--exclude=$PEP8_EXCLUDE --repeat"
PEP8_INCLUDE="bin/heat bin/heat-boto bin/heat-api-cfn bin/heat-api bin/heat-engine heat tools setup.py heat/testing/runner.py"
PEP8_INCLUDE="bin/heat-cfn bin/heat-boto bin/heat-api-cfn bin/heat-api bin/heat-engine heat tools setup.py heat/testing/runner.py"
${wrapper} pep8 $PEP8_OPTIONS $PEP8_INCLUDE
}

2
setup.py
View File

@ -43,7 +43,7 @@ setuptools.setup(
'Programming Language :: Python :: 2.6',
'Environment :: No Input/Output (Daemon)',
],
scripts=['bin/heat',
scripts=['bin/heat-cfn',
'bin/heat-api',
'bin/heat-api-cfn',
'bin/heat-api-cloudwatch',

2
tools/uninstall-heat
View File

@ -62,7 +62,7 @@ if user_wants 'Delete Heat binaries?'; then
sudo rm -f $BIN_PATH/heat-api
sudo rm -f $BIN_PATH/heat-api-cfn
sudo rm -f $BIN_PATH/heat-engine
sudo rm -f $BIN_PATH/heat
sudo rm -f $BIN_PATH/heat-cfn
echo 1>&2
fi