]> review.fuel-infra Code Review - openstack-build/heat-build.git/commitdiff
Rename heat client to heat-cfn.
authorSteve Baker <sbaker@redhat.com>
Sun, 4 Nov 2012 20:29:35 +0000 (09:29 +1300)
committerSteve Baker <sbaker@redhat.com>
Sun, 4 Nov 2012 23:23:17 +0000 (12:23 +1300)
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

bin/heat-boto
bin/heat-cfn [moved from bin/heat with 98% similarity]
docs/GettingStarted.rst
docs/man/man1/heat-cfn.1 [moved from docs/man/man1/heat.1 with 85% similarity]
etc/bash_completion.d/heat-cfn [moved from etc/bash_completion.d/heat with 56% similarity]
run_tests.sh
setup.py
tools/uninstall-heat

index 238b5a934e380367360bfbd32345b7548e6de9d5..4b4c848ea564284031614879d40c1d74a338fc88 120000 (symlink)
@@ -1 +1 @@
-heat
\ No newline at end of file
+heat-cfn
\ No newline at end of file
similarity index 98%
rename from bin/heat
rename to bin/heat-cfn
index a09c50adc229e32d0ebff8da7e5334457c4bda3f..d5a6d90fc7214cccf9f45154d2fb326f66848587 100755 (executable)
--- a/bin/heat
@@ -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()
index 5dde28ef90aaf6f86a9d9846d1394ac8dab9a822..e59e41b9bc45ef8390bdd6763db4f816f7aa7db0 100644 (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.
 
similarity index 85%
rename from docs/man/man1/heat.1
rename to docs/man/man1/heat-cfn.1
index d143a6941589316d2ec3299efcf25249a38748d5..ba6610898222257e7b75588fa41fde1458df5c3d 100644 (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
 .\" * 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
similarity index 56%
rename from etc/bash_completion.d/heat
rename to etc/bash_completion.d/heat-cfn
index 4b04ef52e7acfdfb0f0a43bcf152112ade2b2b4d..a4ed068e59b979f83e67fd374a13604d246ec765 100644 (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
index b867ef7b1ae2c4956033cf8d0a050efb882286aa..dbe12fd3e9033ad488680c9ca4272b33e8eedcbd 100755 (executable)
@@ -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
 }
 
index 4503489e08f89c9a410423f153f14bcb7efeb83d..1c8d7ff1585a4b61a4be81d3cbb9e4140d7d2257 100755 (executable)
--- a/setup.py
+++ b/setup.py
@@ -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',
index 915f8c06e654741480d5c12f3bd296a2e2b435a6..26a54661f68fb69b8bfc1d566daf6d103ebf4903 100755 (executable)
@@ -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