added nova-manage docs

2010-10-27 17:14:24 -07:00
parent 21d4fce6dd
commit 938caf0eb6
1 changed files with 111 additions and 2 deletions
@@ -135,11 +135,120 @@ Concept: Services
 * nova-network
 * nova-instancemonitor

-
 Concept: nova-manage
 --------------------

-nova-manage is a command line utility for performing administrative tasks and checking on the health of the system.
+Introduction
++++++++++++
+
+The nova-manage command is used to perform many essential functions for
+administration and ongoing maintenance of nova, such as user creation,
+vpn management, and much more.
+
+The standard pattern for executing a nova-manage command is:
+
+``nova-manage <command> <subcommand> [<args>]``
+
+For example, to obtain a list of all projects:
+
+``nova-manage project list``
+
+User Maintenance
++++++++++++++++
+
+* user admin: creates a new admin and prints exports
+    * arguments: name [access] [secret]
+* user create: creates a new user and prints exports
+    * arguments: name [access] [secret]
+* user delete: deletes an existing user
+    * arguments: name
+* user exports: prints access and secrets for user in export format
+    * arguments: name
+* user list: lists all users
+    * arguments: none
+* user modify: update a users keys & admin flag
+    *  arguments: accesskey secretkey admin
+    *  leave any field blank to ignore it, admin should be 'T', 'F', or blank
+
+Project Maintenance
+++++++++++++++++++
+
+* project add: Adds user to project
+    * arguments: project user
+* project create: Creates a new project
+    * arguments: name project_manager [description]
+* project delete: Deletes an existing project
+    * arguments: project_id
+* project environment: Exports environment variables to an sourcable file
+    * arguments: project_id user_id [filename='novarc]
+* project list: lists all projects
+    * arguments: none
+* project quota: Set or display quotas for project
+    * arguments: project_id [key] [value]
+* project remove: Removes user from project
+    * arguments: project user
+* project scrub: Deletes data associated with project
+    * arguments: project
+* project zipfile: Exports credentials for project to a zip file
+    * arguments: project_id user_id [filename='nova.zip]
+
+User Role Management
++++++++++++++++++++
+
+* role add: adds role to user
+    * if project is specified, adds project specific role
+    * arguments: user, role [project]
+* role has: checks to see if user has role
+    * if project is specified, returns True if user has
+      the global role and the project role
+    * arguments: user, role [project]
+* role remove: removes role from user
+    * if project is specified, removes project specific role
+    * arguments: user, role [project]
+
+
+Nova Shell
++++++++++
+
+* shell bpython
+    * start a new bpython shell
+* shell ipython
+    * start a new ipython shell
+* shell python
+    * start a new python shell
+* shell run
+    * ???
+* shell script: Runs the script from the specifed path with flags set properly.
+    * arguments: path
+
+VPN Management
++++++++++++++
+
+* vpn list: Print a listing of the VPNs for all projects.
+    * arguments: none
+* vpn run: Start the VPN for a given project.
+    * arguments: project
+* vpn spawn: Run all VPNs.
+    * arguments: none
+
+
+Floating IP Management
++++++++++++++++++++++
+
+* floating create: Creates floating ips for host by range
+    * arguments: host ip_range
+* floating delete: Deletes floating ips by range
+    * arguments: range
+* floating list: Prints a listing of all floating ips
+    * arguments: none
+
+Network Management
++++++++++++++++++
+
+* network create: Creates fixed ips for host by range
+    * arguments: [fixed_range=FLAG], [num_networks=FLAG],
+                 [network_size=FLAG], [vlan_start=FLAG],
+                 [vpn_start=FLAG]


 Concept: Flags