From cab7a28567cd6c4e6da92962096643f0c5125162 Mon Sep 17 00:00:00 2001 From: Derek Higgins Date: Fri, 16 Nov 2012 15:31:17 +0000 Subject: [PATCH] Man page update --- docs/packstack.rst | 165 +++++++++++++++++++++++++++++++-------------- 1 file changed, 113 insertions(+), 52 deletions(-) diff --git a/docs/packstack.rst b/docs/packstack.rst index 71e48794f..79dd049d9 100644 --- a/docs/packstack.rst +++ b/docs/packstack.rst @@ -10,7 +10,7 @@ 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 +- packstack - packstack [options] - packstack --gen-answer-file= / packstack --answer-file= @@ -18,58 +18,119 @@ DESCRIPTION OPTIONS ======= -:: - Global Options - CONFIG_GLANCE_INSTALL : Install Glance? ['y', 'n'] - CONFIG_CINDER_INSTALL : Install Cinder? ['y', 'n'] - CONFIG_NOVA_INSTALL : Install Nova? ['y', 'n'] - CONFIG_DASHBOARD_INSTALL : Install Dashboard? ['y', 'n'] - CONFIG_SWIFT_INSTALL : Install Swift? ['y', 'n'] - CONFIG_CLIENT_INSTALL : Install OS Client server? ['y', 'n'] - SSH Configs - CONFIG_SSH_KEY : Public key to install on servers ['/home/derekh/.ssh/id_rsa.pub'] - MySQL Config paramaters - CONFIG_MYSQL_HOST : Hostname of the MySQL server '' - CONFIG_MYSQL_USER : Username of the MySQL admin user '' - CONFIG_MYSQL_PW : Password for the MySQL admin user '' - QPID Config paramaters - CONFIG_QPID_HOST : Hostname of the QPID server '' - Keystone Config paramaters - CONFIG_KEYSTONE_HOST : Hostname of the Keystone server '' - CONFIG_KEYSTONE_ADMINTOKEN : Keystone Admin Token '' - CONFIG_KEYSTONE_ADMINPASSWD : Keystone Admin Password '' - Glance Config paramaters - CONFIG_GLANCE_HOST : Hostname of the Glance server '' - Cinder Config paramaters - CONFIG_CINDER_HOST : Hostname of the Cinder server '' - Nova Options - CONFIG_NOVA_API_HOST : Hostname of the Nova API server '' - CONFIG_NOVA_CERT_HOST : Hostname of the Nova CERT server '' - CONFIG_NOVA_COMPUTE_HOSTS : Hostname of the Nova Compute servers (commma seperated) '' - CONFIG_LIBVIRT_TYPE : Libvirt Type to use ['qemu', 'kvm'] - CONFIG_NOVA_COMPUTE_PRIVIF : Private interface for Flat DHCP on the Nova compute servers '' - CONFIG_NOVA_NETWORK_HOST : Hostname of the Nova Network server '' - CONFIG_NOVA_NETWORK_PUBIF : Public interface on the Nova network server '' - CONFIG_NOVA_NETWORK_PRIVIF : Private interface for Flat DHCP on the Nova network server '' - CONFIG_NOVA_NETWORK_FIXEDRANGE : Fixed IP Range for Flat DHCP ['^([\\d]{1,3}\\.){3}[\\d]{1,3}/\\d\\d?$'] - CONFIG_NOVA_NETWORK_FLOATINGRANGE : Fixed IP Range for Floating IP's ['^([\\d]{1,3}\\.){3}[\\d]{1,3}/\\d\\d?$'] - CONFIG_NOVA_SCHED_HOST : Hostname of the Nova Sched server '' - NOVACLIENT Config paramaters - CONFIG_OSCLIENT_HOST : Hostname of the OpenStack client '' - OpenStack Dashboard Config paramaters - CONFIG_DASHBOARD_HOST : Hostname of the Dashoard '' - CONFIG_DASHBOARD_SECRET_KEY : Keystone Secret Encryption Key '' - OpenStack Swift Config paramaters - CONFIG_SWIFT_PROXY_HOSTS : Hostname of the Swift Proxy server '' - CONFIG_SWIFT_STORAGE_HOSTS : Hostname of the Swift Storage servers e.g. host/dev,host/dev '' - CONFIG_SWIFT_STORAGE_ZONES : Number of swift storage zone '' - CONFIG_SWIFT_STORAGE_REPLICAS : Number of swift storage replicas '' - CONFIG_SWIFT_STORAGE_FSTYPE : FileSystem type for storage nodes ['xfs', 'ext4'] - Server Prepare Configs - CONFIG_USE_EPEL : Install openstack from epel ['y', 'n'] - Puppet Config paramaters - CONFIG_PUPPET_REMOVEMODULES : Causes the Puppet modules to be removed (if present), and as a result re-cloned from git ['y', 'n'] +Global Options +-------------- + +**CONFIG_GLANCE_INSTALL** : Selects if packstack does or does not install Glance ['y', 'n'] + +**CONFIG_CINDER_INSTALL** : Selects if packstack does or does not install Cinder ['y', 'n'] + +**CONFIG_NOVA_INSTALL** : Selects if packstack does or does not install Nova ['y', 'n'] + +**CONFIG_HORIZON_INSTALL** : Selects if packstack does or does not install Horizon ['y', 'n'] + +**CONFIG_SWIFT_INSTALL** : Selects if packstack does or does not install swift ['y', 'n'] + +**CONFIG_CLIENT_INSTALL** : Selects if packstack does or does not install the openstack client packages, a admin "rc" file will also be installed ['y', 'n'] + +SSH Configs +------------ + +**CONFIG_SSH_KEY** : 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 ['/home/derekh/.ssh/id_rsa.pub'] + +MySQL Config paramaters +----------------------- + +**CONFIG_MYSQL_HOST** : The IP address of the server on which to install MySQL + +**CONFIG_MYSQL_USER** : Username of the MySQL admin user + +**CONFIG_MYSQL_PW** : Password for the MySQL admin user + +QPID Config paramaters +---------------------- + +**CONFIG_QPID_HOST** : The IP address of the server on which to install the QPID service + +Keystone Config paramaters +-------------------------- + +**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_ADMINPASSWD** : The token password to use for the keystone admin user + +Glance Config paramaters +------------------------ + +**CONFIG_GLANCE_HOST** : The IP address of the server on which to install Glance + +Cinder Config paramaters +------------------------ + +**CONFIG_CINDER_HOST** : The IP address of the server on which to install Cinder + +Nova Options +------------ + +**CONFIG_NOVA_API_HOST** : The IP address of the server on which to install the Nova API service + +**CONFIG_NOVA_CERT_HOST** : The IP address of the server on which to install the Nova Cert service + +**CONFIG_NOVA_COMPUTE_HOSTS** : A comma seperated list of IP addresses on which to install the Nova Compute services + +**CONFIG_LIBVIRT_TYPE** : The libvirt type to use, if your compute server is bare metal set to kvm, if testing on a vm set to qemu ['qemu', 'kvm'] + +**CONFIG_NOVA_COMPUTE_PRIVIF** : Private interface for Flat DHCP on the Nova compute servers + +**CONFIG_NOVA_NETWORK_HOST** : The IP address of the server on which to install the Nova Network service + +**CONFIG_NOVA_NETWORK_PUBIF** : Public interface on the Nova network server + +**CONFIG_NOVA_NETWORK_PRIVIF** : Private interface for Flat DHCP on the Nova network server + +**CONFIG_NOVA_NETWORK_FIXEDRANGE** : IP Range for Flat DHCP ['^([\\d]{1,3}\\.){3}[\\d]{1,3}/\\d\\d?$'] + +**CONFIG_NOVA_NETWORK_FLOATRANGE** : IP Range for Floating IP's ['^([\\d]{1,3}\\.){3}[\\d]{1,3}/\\d\\d?$'] + +**CONFIG_NOVA_SCHED_HOST** : The IP address of the server on which to install the Nova Scheduler service + +NOVACLIENT Config paramaters +---------------------------- + +**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 +----------------------------------- + +**CONFIG_HORIZON_HOST** : The IP address of the server on which to install Horizon + +**CONFIG_HORIZON_SECRET_KEY** : Keystone Secret Encryption Key + +OpenStack Swift Config paramaters +--------------------------------- + +**CONFIG_SWIFT_PROXY_HOSTS** : A comma seperated list of IP addresses on which to install the Swift proxy services + +**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 [/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_ZONES** : Number of swift storage zones, this number MUST be no bigger then number of storage devices configered + +**CONFIG_SWIFT_STORAGE_REPLICAS** : Number of swift storage replicas, this number MUST be no bigger then number of storage zones configered + +**CONFIG_SWIFT_STORAGE_FSTYPE** : FileSystem type for storage nodes ['xfs', 'ext4'] + +Server Prepare Configs +----------------------- + +**CONFIG_USE_EPEL** : Install openstack from epel, If set to "n" this causes EPEL to be permanently disabled before installing openstack, i.e. you should have alternative openstack repositories in place ['y', 'n'] + +Puppet Config paramaters +------------------------ + +**CONFIG_PUPPET_REMOVEMODULES** : Causes the Puppet modules to be removed (if present), and recloned from git (NOTE : may clone a untested version) ['y', 'n'] SOURCE