diff --git a/doc/source/man/cinder-manage.rst b/doc/source/man/cinder-manage.rst index 188601bbad3..4d3f486cf08 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 Volume +~~~~~~~~~~ -``cinder-manage vpn list`` +``cinder-manage volume reattach `` - Displays a list of projects, their IP prot numbers, and what state they're in. + Re-attach a volume that has previously been attached to an instance. -``cinder-manage vpn run `` +``cinder-manage volume delete `` - Starts the VPN for the named project. + Delete a volume without first checking that the volume is available. -``cinder-manage vpn spawn`` +Cinder Host +~~~~~~~~~~ - Runs all VPNs. +``cinder-manage host list []`` -Cinder Floating IPs -~~~~~~~~~~~~~~~~~ + 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 floating create [--pool ] [--interface ]`` +Cinder Service +~~~~~~~~~~ - Creates floating IP addresses for the given range, optionally specifying - a floating pool and a network interface. +``cinder-manage service list`` -``cinder-manage floating delete `` + Displays a list of all cinder services and their host, zone, status, state and when the information was last updated. - Deletes floating IP addresses in the range given. +Cinder Backup +~~~~~~~~~~ -``cinder-manage floating list`` +``cinder-manage backup list`` - Displays a list of all floating IP addresses. + Displays a list of all backups (including ones in progress) and the host on which the backup operation is running. -Cinder Flavor -~~~~~~~~~~~ +Cinder Version +~~~~~~~~~~ -``cinder-manage flavor list`` +``cinder-manage version list`` - Outputs a list of all active flavors to the screen. + Displays the codebase version cinder is running upon. -``cinder-manage flavor list --all`` +Cinder Storage Management +~~~~~~~~~~ - Outputs a list of all flavors (active and inactive) to the screen. +``cinder-manage sm flavor_create