From 4f242adb4ef484326dacc48e2013590db7e0f709 Mon Sep 17 00:00:00 2001 From: "Jay S. Bryant" Date: Mon, 3 Jun 2013 10:01:58 -0500 Subject: [PATCH] Re-write of the cinder-manage man page. The cinder-manage man page didn't appear to have been re-written since splitting from Nova. There were numerous options that no longer exist documented and references to Nova instead of Cinder. This version has been re-written based on the current code in cinder-manage. (fixes bug 1174502) Change-Id: Ia03ca05bbd87444b2213bf719da0ffff96b67699 --- doc/source/man/cinder-manage.rst | 212 ++++++++----------------------- 1 file changed, 55 insertions(+), 157 deletions(-) diff --git a/doc/source/man/cinder-manage.rst b/doc/source/man/cinder-manage.rst index 188601bba..4d3f486cf 100644 --- a/doc/source/man/cinder-manage.rst +++ b/doc/source/man/cinder-manage.rst @@ -3,13 +3,13 @@ cinder-manage =========== ------------------------------------------------------ -control and manage cloud computer instances and images +Control and manage OpenStack block storage ------------------------------------------------------ :Author: openstack@lists.launchpad.net -:Date: 2012-04-05 +:Date: 2013-05-30 :Copyright: OpenStack LLC -:Version: 2012.1 +:Version: 2013.2 :Manual section: 1 :Manual group: cloud computing @@ -21,7 +21,7 @@ SYNOPSIS DESCRIPTION =========== -cinder-manage controls cloud computing instances by managing cinder users, cinder projects, cinder roles, shell selection, vpn connections, and floating IP address configuration. More information about OpenStack Cinder is at http://cinder.openstack.org. +cinder-manage provides control of cinder database migration, and provides an interface to get information about the current state of cinder. More information about OpenStack Cinder is available at http://cinder.openstack.org. OPTIONS ======= @@ -29,16 +29,16 @@ OPTIONS The standard pattern for executing a cinder-manage command is: ``cinder-manage []`` -For example, to obtain a list of all projects: -``cinder-manage project list`` +For example, to obtain a list of the cinder services currently running: +``cinder-manage service list`` Run without arguments to see a list of available command categories: ``cinder-manage`` -Categories are user, project, role, shell, vpn, and floating. Detailed descriptions are below. +Categories are shell, logs, migrate, db, volume, host, service, backup, version, sm and config. Detailed descriptions are below. -You can also run with a category argument such as user to see a list of all commands in that category: -``cinder-manage user`` +You can also run with a category argument such as 'db' to see a list of all commands in that category: +``cinder-manage db`` These sections describe the available categories and arguments for cinder-manage. @@ -53,80 +53,6 @@ Cinder Db Sync the database up to the most recent version. This is the standard way to create the db as well. -Cinder User -~~~~~~~~~ - -``cinder-manage user admin `` - - Create an admin user with the name . - -``cinder-manage user create `` - - Create a normal user with the name . - -``cinder-manage user delete `` - - Delete the user with the name . - -``cinder-manage user exports `` - - Outputs a list of access key and secret keys for user to the screen - -``cinder-manage user list`` - - Outputs a list of all the user names to the screen. - -``cinder-manage user modify `` - - Updates the indicated user keys, indicating with T or F if the user is an admin user. Leave any argument blank if you do not want to update it. - -Cinder Project -~~~~~~~~~~~~ - -``cinder-manage project add `` - - Add a cinder project with the name to the database. - -``cinder-manage project create `` - - Create a new cinder project with the name (you still need to do cinder-manage project add to add it to the database). - -``cinder-manage project delete `` - - Delete a cinder project with the name . - -``cinder-manage project environment `` - - Exports environment variables for the named project to a file named cinderrc. - -``cinder-manage project list`` - - Outputs a list of all the projects to the screen. - -``cinder-manage project quota `` - - Outputs the size and specs of the project's instances including gigabytes, instances, floating IPs, volumes, and cores. - -``cinder-manage project remove `` - - Deletes the project with the name . - -``cinder-manage project zipfile`` - - Compresses all related files for a created project into a zip file cinder.zip. - -Cinder Role -~~~~~~~~~ - -``cinder-manage role add <(optional) projectname>`` - - Add a user to either a global or project-based role with the indicated assigned to the named user. Role names can be one of the following five roles: cloudadmin, itsec, sysadmin, netadmin, developer. If you add the project name as the last argument then the role is assigned just for that project, otherwise the user is assigned the named role for all projects. - -``cinder-manage role has `` - Checks the user or project and responds with True if the user has a global role with a particular project. - -``cinder-manage role remove `` - Remove the indicated role from the user. Cinder Logs ~~~~~~~~~ @@ -135,9 +61,9 @@ Cinder Logs Displays cinder errors from log files. -``cinder-manage logs syslog `` +``cinder-manage logs syslog []`` - Displays cinder alerts from syslog. + Displays cinder the most recent entries from syslog. The optional number argument specifies the number of entries to display (default 10). Cinder Shell ~~~~~~~~~~ @@ -162,120 +88,92 @@ Cinder Shell Runs the named script from the specified path with flags set. -Cinder VPN -~~~~~~~~ - -``cinder-manage vpn list`` - - Displays a list of projects, their IP prot numbers, and what state they're in. - -``cinder-manage vpn run `` - - Starts the VPN for the named project. - -``cinder-manage vpn spawn`` - - Runs all VPNs. - -Cinder Floating IPs -~~~~~~~~~~~~~~~~~ - -``cinder-manage floating create [--pool ] [--interface ]`` - - Creates floating IP addresses for the given range, optionally specifying - a floating pool and a network interface. +Cinder Volume +~~~~~~~~~~ -``cinder-manage floating delete `` +``cinder-manage volume reattach `` - Deletes floating IP addresses in the range given. + Re-attach a volume that has previously been attached to an instance. -``cinder-manage floating list`` +``cinder-manage volume delete `` - Displays a list of all floating IP addresses. + Delete a volume without first checking that the volume is available. -Cinder Flavor -~~~~~~~~~~~ +Cinder Host +~~~~~~~~~~ -``cinder-manage flavor list`` +``cinder-manage host list []`` - Outputs a list of all active flavors to the screen. + Displays a list of all physical hosts and their zone. The optional zone argument allows the list to be filtered on the requested zone. -``cinder-manage flavor list --all`` +Cinder Service +~~~~~~~~~~ - Outputs a list of all flavors (active and inactive) to the screen. +``cinder-manage service list`` -``cinder-manage flavor create <(optional) swap> <(optional) RXTX Quota> <(optional) RXTX Cap>`` + Displays a list of all cinder services and their host, zone, status, state and when the information was last updated. - creates a flavor with the following positional arguments: - * memory (expressed in megabytes) - * vcpu(s) (integer) - * local storage (expressed in gigabytes) - * flavorid (unique integer) - * swap space (expressed in megabytes, defaults to zero, optional) - * RXTX quotas (expressed in gigabytes, defaults to zero, optional) - * RXTX cap (expressed in gigabytes, defaults to zero, optional) +Cinder Backup +~~~~~~~~~~ -``cinder-manage flavor delete `` +``cinder-manage backup list`` - Delete the flavor with the name . This marks the flavor as inactive and cannot be launched. However, the record stays in the database for archival and billing purposes. + Displays a list of all backups (including ones in progress) and the host on which the backup operation is running. -``cinder-manage flavor delete --purge`` +Cinder Version +~~~~~~~~~~ - Purges the flavor with the name . This removes this flavor from the database. +``cinder-manage version list`` -Cinder Instance_type -~~~~~~~~~~~~~~~~~~ + Displays the codebase version cinder is running upon. -The instance_type command is provided as an alias for the flavor command. All the same subcommands and arguments from cinder-manage flavor can be used. +Cinder Storage Management +~~~~~~~~~~ -Cinder Images -~~~~~~~~~~~ +``cinder-manage sm flavor_create