From 30fab6117729e31756359c91aea9420cc74bff90 Mon Sep 17 00:00:00 2001 From: sdake Date: Thu, 14 Mar 2013 11:31:19 -0700 Subject: [PATCH] Add a manual page for heat-db-setup Change-Id: I628d9e1295238b0bc405fc6ccb464889b85090e0 Fixes: Bug #1153691 --- doc/source/conf.py | 3 ++ doc/source/man/heat-db-setup.rst | 63 ++++++++++++++++++++++++++++++++ 2 files changed, 66 insertions(+) create mode 100644 doc/source/man/heat-db-setup.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index 04dab029..87dbdc43 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -237,6 +237,9 @@ man_pages = [ ('man/heat-cfn', 'heat-cfn', u'Command line utility to run heat actions over the CloudFormation API', [u'Heat Developers'], 1), + ('man/heat-db-setup', 'heat-db-setup', + u'Command line utility to setup the Heat database', + [u'Heat Developers'], 1), ('man/heat-engine', 'heat-engine', u'Service which performs the actions from the API calls made by the user', [u'Heat Developers'], 1), diff --git a/doc/source/man/heat-db-setup.rst b/doc/source/man/heat-db-setup.rst new file mode 100644 index 00000000..c0aa58fc --- /dev/null +++ b/doc/source/man/heat-db-setup.rst @@ -0,0 +1,63 @@ +======== +heat-db-setup +======== + +.. program:: heat-db-setup + + +SYNOPSIS +======== + +``heat-db-setup [COMMANDS] [OPTIONS]`` + + +DESCRIPTION +=========== +heat-db-setup is a tool which configures the local MySQL database for +heat. Typically distro-specific tools would provide this functionality +so please read the distro-specific documentation for configuring Heat. + + +COMMANDS +======== + +``rpm`` + + Indicate the distribution is a RPM packaging based distribution. + +``deb`` + + Indicate the distribution is a DEB packaging based distribution. + + +OPTIONS +======= + +.. cmdoption:: -h, --help + + Print usage information. + +.. cmdoption:: -p, --password + + Specify the password for the 'heat' MySQL user that will use to connect to the 'heat' MySQL database. By default, the password 'heat' will be used. + +.. cmdoption:: -r, --rootpw + + Specify the root MySQL password. If the script installs the MySQL server, it will set the root password to this value instead of prompting for a password. If the MySQL server is already installed, this password will be used to connect to the database instead of having to prompt for it. + +.. cmdoption:: -y, --yes + + In cases where the script would normally ask for confirmation before doing something, such as installing mysql-server, just assume yes. This is useful if you want to run the script non-interactively. + +EXAMPLES +======== + + heat-db-setup rpm -p heat_password -r mysql_pwd -y + + heat-db-setup deb -p heat_password -r mysql_pwd -y + + heat-db-setup rpm + +BUGS +==== +Heat bugs are managed through Launchpad -- 2.45.2