Holiday docs and comment formatting cleanup
Change-Id: Ia4ca88c67d3b94e306a79a669805a2fa1b0dc069
diff --git a/lib/ceilometer b/lib/ceilometer
index aa1b396..76ab254 100644
--- a/lib/ceilometer
+++ b/lib/ceilometer
@@ -1,9 +1,9 @@
# lib/ceilometer
-# Install and start Ceilometer service
+# Install and start **Ceilometer** service
+
# To enable, add the following to localrc
# ENABLED_SERVICES+=ceilometer-acompute,ceilometer-acentral,ceilometer-collector,ceilometer-api
-
# Dependencies:
# - functions
# - OS_AUTH_URL for auth in api
@@ -12,12 +12,12 @@
# stack.sh
# ---------
-# install_XXX
-# configure_XXX
-# init_XXX
-# start_XXX
-# stop_XXX
-# cleanup_XXX
+# install_ceilometer
+# configure_ceilometer
+# init_ceilometer
+# start_ceilometer
+# stop_ceilometer
+# cleanup_ceilometer
# Save trace setting
XTRACE=$(set +o | grep xtrace)
@@ -27,17 +27,18 @@
# Defaults
# --------
-# set up default directories
+# Set up default directories
CEILOMETER_DIR=$DEST/ceilometer
+CEILOMETER_CONF_DIR=/etc/ceilometer
+CEILOMETER_CONF=$CEILOMETER_CONF_DIR/ceilometer.conf
+CEILOMETER_API_LOG_DIR=/var/log/ceilometer-api
+
# Support potential entry-points console scripts
if [ -d $CEILOMETER_DIR/bin ] ; then
CEILOMETER_BIN_DIR=$CEILOMETER_DIR/bin
else
CEILOMETER_BIN_DIR=/usr/local/bin
fi
-CEILOMETER_CONF_DIR=/etc/ceilometer
-CEILOMETER_CONF=$CEILOMETER_CONF_DIR/ceilometer.conf
-CEILOMETER_API_LOG_DIR=/var/log/ceilometer-api
# cleanup_ceilometer() - Remove residual data files, anything left over from previous
# runs that a clean run would need to clean up
diff --git a/lib/cinder b/lib/cinder
index dadc8f1..701effd 100644
--- a/lib/cinder
+++ b/lib/cinder
@@ -1,5 +1,5 @@
# lib/cinder
-# Install and start Cinder volume service
+# Install and start **Cinder** volume service
# Dependencies:
# - functions
diff --git a/lib/databases/mysql b/lib/databases/mysql
index 68e9adc..1c0f5eb 100644
--- a/lib/databases/mysql
+++ b/lib/databases/mysql
@@ -1,5 +1,5 @@
-# lib/mysql
-# Functions to control the configuration and operation of the MySQL database backend
+# lib/databases/mysql
+# Functions to control the configuration and operation of the **MySQL** database backend
# Dependencies:
# DATABASE_{HOST,USER,PASSWORD} must be defined
diff --git a/lib/databases/postgresql b/lib/databases/postgresql
index e1463c5..04db714 100644
--- a/lib/databases/postgresql
+++ b/lib/databases/postgresql
@@ -1,5 +1,5 @@
-# lib/postgresql
-# Functions to control the configuration and operation of the PostgreSQL database backend
+# lib/databases/postgresql
+# Functions to control the configuration and operation of the **PostgreSQL** database backend
# Dependencies:
# DATABASE_{HOST,USER,PASSWORD} must be defined
diff --git a/lib/glance b/lib/glance
index 8ba04b3..dff247a 100644
--- a/lib/glance
+++ b/lib/glance
@@ -1,5 +1,5 @@
# lib/glance
-# Functions to control the configuration and operation of the Glance service
+# Functions to control the configuration and operation of the **Glance** service
# Dependencies:
# ``functions`` file
@@ -25,8 +25,6 @@
# Defaults
# --------
-# <define global variables here that belong to this project>
-
# Set up default directories
GLANCE_DIR=$DEST/glance
GLANCECLIENT_DIR=$DEST/python-glanceclient
@@ -141,7 +139,6 @@
iniset $GLANCE_CACHE_CONF DEFAULT admin_password $SERVICE_PASSWORD
cp -p $GLANCE_DIR/etc/policy.json $GLANCE_POLICY_JSON
-
}
# init_glance() - Initialize databases, etc.
diff --git a/lib/heat b/lib/heat
index 43115cb..a6f7286 100644
--- a/lib/heat
+++ b/lib/heat
@@ -1,5 +1,6 @@
# lib/heat
-# Install and start Heat service
+# Install and start **Heat** service
+
# To enable, add the following to localrc
# ENABLED_SERVICES+=,heat,h-api-cfn,h-api-cw,h-eng
@@ -8,12 +9,14 @@
# stack.sh
# ---------
-# install_XXX
-# configure_XXX
-# init_XXX
-# start_XXX
-# stop_XXX
-# cleanup_XXX
+# install_heatclient
+# install_heat
+# configure_heatclient
+# configure_heat
+# init_heat
+# start_heat
+# stop_heat
+# cleanup_heat
# Save trace setting
XTRACE=$(set +o | grep xtrace)
@@ -57,7 +60,7 @@
HEAT_API_HOST=${HEAT_API_HOST:-$SERVICE_HOST}
HEAT_API_PORT=${HEAT_API_PORT:-8004}
- # cloudformation api
+ # Cloudformation API
HEAT_API_CFN_CONF=$HEAT_CONF_DIR/heat-api-cfn.conf
cp $HEAT_DIR/etc/heat/heat-api-cfn.conf $HEAT_API_CFN_CONF
iniset $HEAT_API_CFN_CONF DEFAULT debug True
@@ -86,7 +89,7 @@
iniset $HEAT_API_CFN_PASTE_INI filter:ec2authtoken auth_uri $KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v2.0
iniset $HEAT_API_CFN_PASTE_INI filter:ec2authtoken keystone_ec2_uri $KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v2.0/ec2tokens
- # openstack api
+ # OpenStack API
HEAT_API_CONF=$HEAT_CONF_DIR/heat-api.conf
cp $HEAT_DIR/etc/heat/heat-api.conf $HEAT_API_CONF
iniset $HEAT_API_CONF DEFAULT debug True
@@ -139,7 +142,7 @@
iniset $HEAT_ENGINE_CONF DEFAULT rpc_backend heat.openstack.common.rpc.impl_qpid
fi
- # cloudwatch api
+ # Cloudwatch API
HEAT_API_CW_CONF=$HEAT_CONF_DIR/heat-api-cloudwatch.conf
cp $HEAT_DIR/etc/heat/heat-api-cloudwatch.conf $HEAT_API_CW_CONF
iniset $HEAT_API_CW_CONF DEFAULT debug True
diff --git a/lib/keystone b/lib/keystone
index 4dddedb..34f3372 100644
--- a/lib/keystone
+++ b/lib/keystone
@@ -8,7 +8,6 @@
# ``SERVICE_TOKEN``
# ``S3_SERVICE_PORT`` (template backend only)
-
# ``stack.sh`` calls the entry points in this order:
#
# install_keystone
@@ -27,8 +26,6 @@
# Defaults
# --------
-# <define global variables here that belong to this project>
-
# Set up default directories
KEYSTONE_DIR=$DEST/keystone
KEYSTONE_CONF_DIR=${KEYSTONE_CONF_DIR:-/etc/keystone}
diff --git a/lib/nova b/lib/nova
index 5224d4d..594195e 100644
--- a/lib/nova
+++ b/lib/nova
@@ -1,5 +1,5 @@
# lib/nova
-# Functions to control the configuration and operation of the XXXX service
+# Functions to control the configuration and operation of the **Nova** service
# Dependencies:
# ``functions`` file
diff --git a/lib/swift b/lib/swift
index 713b38c..8934264 100644
--- a/lib/swift
+++ b/lib/swift
@@ -1,5 +1,5 @@
# lib/swift
-# Functions to control the configuration and operation of the swift service
+# Functions to control the configuration and operation of the **Swift** service
# Dependencies:
# ``functions`` file
@@ -23,10 +23,7 @@
# Defaults
# --------
-# <define global variables here that belong to this project>
-
# Set up default directories
-
SWIFT_DIR=$DEST/swift
SWIFTCLIENT_DIR=$DEST/python-swiftclient
SWIFT_AUTH_CACHE_DIR=${SWIFT_AUTH_CACHE_DIR:-/var/cache/swift}
@@ -71,6 +68,7 @@
CONTAINER_PORT_BASE=6011
ACCOUNT_PORT_BASE=6012
+
# Entry Points
# ------------
@@ -293,7 +291,6 @@
sudo chown -R $USER:adm ${swift_log_dir}
sed "s,%SWIFT_LOGDIR%,${swift_log_dir}," $FILES/swift/rsyslog.conf | sudo \
tee /etc/rsyslog.d/10-swift.conf
-
}
# configure_swiftclient() - Set config files, create data dirs, etc
diff --git a/lib/tempest b/lib/tempest
index 337be75..190d77f 100644
--- a/lib/tempest
+++ b/lib/tempest
@@ -1,4 +1,5 @@
# lib/tempest
+# Install and configure Tempest
# Dependencies:
# ``functions`` file
@@ -23,33 +24,29 @@
#
# install_tempest
# configure_tempest
-# init_tempest
-## start_tempest
-## stop_tempest
-## cleanup_tempest
# Save trace setting
XTRACE=$(set +o | grep xtrace)
set +o xtrace
+
# Defaults
# --------
-# <define global variables here that belong to this project>
-
# Set up default directories
-NOVA_SOURCE_DIR=$DEST/nova
TEMPEST_DIR=$DEST/tempest
TEMPEST_CONF_DIR=$TEMPEST_DIR/etc
TEMPEST_CONF=$TEMPEST_CONF_DIR/tempest.conf
+NOVA_SOURCE_DIR=$DEST/nova
+
BUILD_INTERVAL=3
BUILD_TIMEOUT=400
+
# Entry Points
# ------------
-
# configure_tempest() - Set config files, create data dirs, etc
function configure_tempest() {
local image_lines
@@ -66,7 +63,7 @@
local public_network_id
local tenant_networks_reachable
- #TODO(afazekas):
+ # TODO(afazekas):
# sudo python setup.py deploy
# This function exits on an error so that errors don't compound and you see
@@ -74,7 +71,7 @@
errexit=$(set +o | grep errexit)
set -o errexit
- #Save IFS
+ # Save IFS
ifs=$IFS
# Glance should already contain images to be used in tempest
@@ -240,7 +237,6 @@
$errexit
}
-
# install_tempest() - Collect source and prepare
function install_tempest() {
git_clone $TEMPEST_REPO $TEMPEST_DIR $TEMPEST_BRANCH