Attachment 666532 Details for Bug 888744 – fixes for the text

[patch] fixes for the text

packstack.rst.diff (text/plain), 8.72 KB, created by Yaniv Kaul on 2012-12-20 07:42:09 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Yaniv Kaul

Created: 2012-12-20 07:42:09 UTC

Size: 8.72 KB

patch

obsolete

>diff --git a/docs/packstack.rst b/docs/packstack.rst
>index bc14246..7df4335 100644
>--- a/docs/packstack.rst
>+++ b/docs/packstack.rst
>@@ -1,5 +1,5 @@
>-==============
>-packstack
>+ï»¿==============
>+Packstack
> ==============
> 
> SYNOPSIS
>@@ -9,17 +9,17 @@ SYNOPSIS
> 
> DESCRIPTION
> ===========
>-  Packstack is a utility that uses uses puppet modules to install openstack. It can be used to install each openstack service on seperate servers, all on one server or any combination of these. There are 3 ways that packstack can be run.
>+  Packstack is a utility that uses uses puppet modules to install OpenStack. It can be used to install each openstack service on separate servers, all on one server or any combination of these. There are 3 ways that Packstack can be run.
> - packstack
> - packstack [options]
> - packstack --gen-answer-file=<file>  / packstack --answer-file=<file>
> 
>-  The third of these options allows the user to generate a default answer file, edit the default options and finally run packstack a second time using this answerfile, this is the easyies way to run packstack and the one that will be documented here. When <file> is created the OPTIONS below will be contained and can be edited by the user.
>+  The third option allows the user to generate a default answer file, edit the default options and finally run Packstack a second time using this answer file. This is the easiest way to run Packstack and the one that will be documented here. When <file> is created the OPTIONS below will be contained and can be edited by the user.
> 
> OPTIONS
> =======
> 
>-Installer Config paramaters
>+Installer Config parameters
> ---------------------------
> 
> **CONFIG_DEBUG**               : Should we turn on debug in logging ['y', 'n']
>@@ -27,24 +27,24 @@ Installer Config paramaters
> SSH Configs
> ------------
> 
>-**CONFIG_SSH_KEY**             : Path to a Public key to install on servers, if a usable key has not been installed on remote servers the user will be prompted for a password and this key will be installed so the password will not be required again
>+**CONFIG_SSH_KEY**             : Path to a Public key to install on servers. If a usable key has not been installed on the remote servers the user will be prompted for a password and this key will be installed so the password will not be required again
> 
> Global Options
> --------------
> 
>-**CONFIG_GLANCE_INSTALL**      : Set to 'y' if you would like packstack to install Glance ['y', 'n']
>+**CONFIG_GLANCE_INSTALL**      : Set to 'y' if you would like Packstack to install Glance ['y', 'n']
> 
>-**CONFIG_CINDER_INSTALL**      : Set to 'y' if you would like packstack to install Cinder ['y', 'n']
>+**CONFIG_CINDER_INSTALL**      : Set to 'y' if you would like Packstack to install Cinder ['y', 'n']
> 
>-**CONFIG_NOVA_INSTALL**        : Set to 'y' if you would like packstack to install Nova ['y', 'n']
>+**CONFIG_NOVA_INSTALL**        : Set to 'y' if you would like Packstack to install Nova ['y', 'n']
> 
>-**CONFIG_HORIZON_INSTALL**     : Set to 'y' if you would like packstack to install Horizon ['y', 'n']
>+**CONFIG_HORIZON_INSTALL**     : Set to 'y' if you would like Packstack to install Horizon ['y', 'n']
> 
>-**CONFIG_SWIFT_INSTALL**       : Set to 'y' if you would like packstack to install swift ['y', 'n']
>+**CONFIG_SWIFT_INSTALL**       : Set to 'y' if you would like Packstack to install swift ['y', 'n']
> 
>-**CONFIG_CLIENT_INSTALL**      : Set to 'y' if you would like packstack to install the openstack client packages, an admin "rc" file will also be installed ['y', 'n']
>+**CONFIG_CLIENT_INSTALL**      : Set to 'y' if you would like Packstack to install the openstack client packages. An admin "rc" file will also be installed ['y', 'n']
> 
>-MySQL Config paramaters
>+MySQL Config parameters
> -----------------------
> 
> **CONFIG_MYSQL_HOST**          : The IP address of the server on which to install MySQL
>@@ -53,26 +53,26 @@ MySQL Config paramaters
> 
> **CONFIG_MYSQL_PW**            : Password for the MySQL admin user
> 
>-QPID Config paramaters
>+QPID Config parameters
> ----------------------
> 
> **CONFIG_QPID_HOST**           : The IP address of the server on which to install the QPID service
> 
>-Keystone Config paramaters
>+Keystone Config parameters
> --------------------------
> 
> **CONFIG_KEYSTONE_HOST**       : The IP address of the server on which to install Keystone
> 
>-**CONFIG_KEYSTONE_ADMINTOKEN** : The token to use for the keystone service api
>+**CONFIG_KEYSTONE_ADMINTOKEN** : The token to use for the Keystone service api
> 
>-**CONFIG_KEYSTONE_ADMINPASSWD** : The password to use for the keystone admin user
>+**CONFIG_KEYSTONE_ADMINPASSWD** : The password to use for the Keystone admin user
> 
>-Glance Config paramaters
>+Glance Config parameters
> ------------------------
> 
> **CONFIG_GLANCE_HOST**         : The IP address of the server on which to install Glance
> 
>-Cinder Config paramaters
>+Cinder Config parameters
> ------------------------
> 
> **CONFIG_CINDER_HOST**         : The IP address of the server on which to install Cinder
>@@ -86,7 +86,7 @@ Nova Options
> 
> **CONFIG_NOVA_VNCPROXY_HOST**  : The IP address of the server on which to install the Nova VNC proxy
> 
>-**CONFIG_NOVA_COMPUTE_HOSTS**  : A comma seperated list of IP addresses on which to install the Nova Compute services
>+**CONFIG_NOVA_COMPUTE_HOSTS**  : A comma separated list of IP addresses on which to install the Nova Compute services
> 
> **CONFIG_NOVA_COMPUTE_PRIVIF** : Private interface for Flat DHCP on the Nova compute servers
> 
>@@ -102,41 +102,41 @@ Nova Options
> 
> **CONFIG_NOVA_SCHED_HOST**     : The IP address of the server on which to install the Nova Scheduler service
> 
>-NOVACLIENT Config paramaters
>+NOVACLIENT Config parameters
> ----------------------------
> 
>-**CONFIG_OSCLIENT_HOST**       : The IP address of the server on which to install the openstack client packages, an admin "rc" file will also be installed
>+**CONFIG_OSCLIENT_HOST**       : The IP address of the server on which to install the openstack client packages. An admin "rc" file will also be installed
> 
>-OpenStack Horizon Config paramaters
>+OpenStack Horizon Config parameters
> -----------------------------------
> 
> **CONFIG_HORIZON_HOST**        : The IP address of the server on which to install Horizon
> 
> **CONFIG_HORIZON_SECRET_KEY**  : Horizon Secret Encryption Key
> 
>-OpenStack Swift Config paramaters
>+OpenStack Swift Config parameters
> ---------------------------------
> 
> **CONFIG_SWIFT_PROXY_HOSTS**   : The IP address on which to install the Swift proxy service
> 
>-**CONFIG_SWIFT_STORAGE_HOSTS** : A comma seperated list of IP addresses on which to install the Swift Storage services, each entry should take the format <ipaddress>[/dev], for example 127.0.0.1/vdb will install /dev/vdb on 127.0.0.1 as a swift storage device, if /dev is ommited packstack will create a loopback device for a test setup
>+**CONFIG_SWIFT_STORAGE_HOSTS** : A comma separated list of IP addresses on which to install the Swift Storage services, each entry should take the format <ipaddress>[/dev], for example 127.0.0.1/vdb will install /dev/vdb on 127.0.0.1 as a swift storage device, if /dev is omitted Packstack will create a loopback device for a test setup
> 
>-**CONFIG_SWIFT_STORAGE_ZONES** : Number of swift storage zones, this number MUST be no bigger then number of storage devices configured
>+**CONFIG_SWIFT_STORAGE_ZONES** : Number of swift storage zones, this number MUST be no bigger than the number of storage devices configured
> 
>-**CONFIG_SWIFT_STORAGE_REPLICAS** : Number of swift storage replicas, this number MUST be no bigger then number of storage zones configured
>+**CONFIG_SWIFT_STORAGE_REPLICAS** : Number of swift storage replicas, this number MUST be no bigger than the number of storage zones configured
> 
> **CONFIG_SWIFT_STORAGE_FSTYPE** : FileSystem type for storage nodes ['xfs', 'ext4']
> 
> Server Prepare Configs
> -----------------------
> 
>-**CONFIG_USE_EPEL**            : Install openstack from epel, If set to "y" EPEL will be installed on each server ['y', 'n']
>+**CONFIG_USE_EPEL**            : Install OpenStack from EPEL. If set to "y" EPEL will be installed on each server ['y', 'n']
> 
>-**CONFIG_REPO**                : A comma seperated list of urls to any additional yum repositories to install
>+**CONFIG_REPO**                : A comma separated list of URLs to any additional yum repositories to install
> 
>-**CONFIG_RH_USERNAME**         : To subscribe each server with redhat subscription manager, include this with CONFIG_RH_PASSWORD
>+**CONFIG_RH_USERNAME**         : To subscribe each server with Red Hat subscription manager, include this with CONFIG_RH_PASSWORD
> 
>-**CONFIG_RH_PASSWORD**         : To subscribe each server with redhat subscription manager, include this with CONFIG_RH_USERNAME
>+**CONFIG_RH_PASSWORD**         : To subscribe each server with Red Hat subscription manager, include this with CONFIG_RH_USERNAME
> 
> 
> SOURCE

Flags:

ykaul: review?

Actions: View | Diff

Attachments on bug 888744: 666532