← Back to branch summary

~ubuntu-branches/ubuntu/saucy/nova/saucy-proposed

« back to all changes in this revision

Viewing changes to doc/source/runnova/nova.manage.rst

  • Committer: Package Import Robot
  • Author(s): Chuck Short
  • Date: 2012-05-24 13:12:53 UTC
  • mfrom: (1.1.55)
  • Revision ID: package-import@ubuntu.com-20120524131253-ommql08fg1en06ut
Tags: 2012.2~f1-0ubuntu1
https://launchpad.net/bugs/907197
* New upstream release.
* Prepare for quantal:
  - Dropped debian/patches/upstream/0006-Use-project_id-in-ec2.cloud._format_image.patch
  - Dropped debian/patches/upstream/0005-Populate-image-properties-with-project_id-again.patch
  - Dropped debian/patches/upstream/0004-Fixed-bug-962840-added-a-test-case.patch
  - Dropped debian/patches/upstream/0003-Allow-unprivileged-RADOS-users-to-access-rbd-volumes.patch
  - Dropped debian/patches/upstream/0002-Stop-libvirt-test-from-deleting-instances-dir.patch
  - Dropped debian/patches/upstream/0001-fix-bug-where-nova-ignores-glance-host-in-imageref.patch 
  - Dropped debian/patches/0001-fix-useexisting-deprecation-warnings.patch
* debian/control: Add python-keystone as a dependency. (LP: #907197)
* debian/patches/kombu_tests_timeout.patch: Refreshed.
* debian/nova.conf, debian/nova-common.postinst: Convert to new ini
  file configuration
* debian/patches/nova-manage_flagfile_location.patch: Refreshed

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/source/runnova/nova.manage.rst
1
 
..
2
 
      Copyright 2010-2011 United States Government as represented by the
3
 
      Administrator of the National Aeronautics and Space Administration.
4
 
      All Rights Reserved.
5
 
 
6
 
      Licensed under the Apache License, Version 2.0 (the "License"); you may
7
 
      not use this file except in compliance with the License. You may obtain
8
 
      a copy of the License at
9
 
 
10
 
          http://www.apache.org/licenses/LICENSE-2.0
11
 
 
12
 
      Unless required by applicable law or agreed to in writing, software
13
 
      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14
 
      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15
 
      License for the specific language governing permissions and limitations
16
 
      under the License.
17
 
 
18
 
 
19
 
The nova-manage command
20
 
=======================
21
 
 
22
 
Introduction
23
 
~~~~~~~~~~~~
24
 
 
25
 
The nova-manage command is used to perform many essential functions for
26
 
administration and ongoing maintenance of nova, such as user creation,
27
 
vpn management, and much more.
28
 
 
29
 
The standard pattern for executing a nova-manage command is:
30
 
``nova-manage <category> <command> [<args>]``
31
 
 
32
 
For example, to obtain a list of all projects:
33
 
``nova-manage project list``
34
 
 
35
 
Run without arguments to see a list of available command categories:
36
 
``nova-manage``
37
 
 
38
 
Categories are user, project, role, shell, vpn, and floating. Detailed descriptions are below.
39
 
 
40
 
You can also run with a category argument such as user to see a list of all commands in that category:
41
 
``nova-manage user``
42
 
 
43
 
These sections describe the available categories and arguments for nova-manage.
44
 
 
45
 
Nova Db
46
 
~~~~~~~
47
 
 
48
 
``nova-manage db version``
49
 
 
50
 
    Print the current database version.
51
 
 
52
 
``nova-manage db sync``
53
 
 
54
 
    Sync the database up to the most recent version. This is the standard way to create the db as well.
55
 
 
56
 
Nova User
57
 
~~~~~~~~~
58
 
 
59
 
``nova-manage user admin <username>``
60
 
 
61
 
    Create an admin user with the name <username>.
62
 
 
63
 
``nova-manage user create <username>``
64
 
 
65
 
    Create a normal user with the name <username>.
66
 
 
67
 
``nova-manage user delete <username>``
68
 
 
69
 
    Delete the user with the name <username>.
70
 
 
71
 
``nova-manage user exports <username>``
72
 
 
73
 
    Outputs a list of access key and secret keys for user to the screen
74
 
 
75
 
``nova-manage user list``
76
 
 
77
 
    Outputs a list of all the user names to the screen.
78
 
 
79
 
``nova-manage user modify <accesskey> <secretkey> <admin?T/F>``
80
 
 
81
 
    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.
82
 
 
83
 
Nova Project
84
 
~~~~~~~~~~~~
85
 
 
86
 
``nova-manage project add <projectname> <username>``
87
 
 
88
 
    Add a nova project with the name <projectname> to the database that will be administered by the named user.
89
 
 
90
 
``nova-manage project create <projectname> <projectmanager>``
91
 
 
92
 
    Create a new nova project with the name <projectname> (you still need to do nova-manage project add <projectname> to add it to the database). The <projectmanager> username is the administrator of the project.
93
 
 
94
 
``nova-manage project delete <projectname>``
95
 
 
96
 
    Delete a nova project with the name <projectname>.
97
 
 
98
 
``nova-manage project environment <projectname> <username>``
99
 
 
100
 
    Exports environment variables for the named project to a file named novarc.
101
 
 
102
 
``nova-manage project list``
103
 
 
104
 
    Outputs a list of all the projects to the screen.
105
 
 
106
 
``nova-manage project quota <projectname>``
107
 
 
108
 
    Outputs the size and specs of the project's instances including gigabytes, instances, floating IPs, volumes, and cores.
109
 
 
110
 
``nova-manage project remove <projectname>``
111
 
 
112
 
    Deletes the project with the name <projectname>.
113
 
 
114
 
``nova-manage project zipfile <projectname> <username> <directory for credentials>``
115
 
 
116
 
    Compresses all related files for a created project into a named zip file such as nova.zip.
117
 
 
118
 
Nova Role
119
 
~~~~~~~~~
120
 
 
121
 
nova-manage role <action> [<argument>]
122
 
``nova-manage role add <username> <rolename> <(optional) projectname>``
123
 
 
124
 
    Add a user to either a global or project-based role with the indicated <rolename> assigned to the named user. Role names can be one of the following five roles: admin, itsec, projectmanager, 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.
125
 
 
126
 
``nova-manage role has <username> <projectname>``
127
 
    Checks the user or project and responds with True if the user has a global role with a particular project.
128
 
 
129
 
``nova-manage role remove <username> <rolename>``
130
 
    Remove the indicated role from the user.
131
 
 
132
 
Nova Shell
133
 
~~~~~~~~~~
134
 
 
135
 
``nova-manage shell bpython``
136
 
 
137
 
    Starts a new bpython shell.
138
 
 
139
 
``nova-manage shell ipython``
140
 
 
141
 
    Starts a new ipython shell.
142
 
 
143
 
``nova-manage shell python``
144
 
 
145
 
    Starts a new python shell.
146
 
 
147
 
``nova-manage shell run``
148
 
 
149
 
    Starts a new shell using python.
150
 
 
151
 
``nova-manage shell script <path/scriptname>``
152
 
 
153
 
    Runs the named script from the specified path with flags set.
154
 
 
155
 
Nova VPN
156
 
~~~~~~~~
157
 
 
158
 
``nova-manage vpn list``
159
 
 
160
 
    Displays a list of projects, their IP prot numbers, and what state they're in.
161
 
 
162
 
``nova-manage vpn run <projectname>``
163
 
 
164
 
    Starts the VPN for the named project.
165
 
 
166
 
``nova-manage vpn spawn``
167
 
 
168
 
    Runs all VPNs.
169
 
 
170
 
Nova Floating IPs
171
 
~~~~~~~~~~~~~~~~~
172
 
 
173
 
``nova-manage floating create <ip_range> [--pool <pool>] [--interface <interface>]``
174
 
 
175
 
    Creates floating IP addresses for the given range, optionally specifying
176
 
    a floating pool and a network interface.
177
 
 
178
 
``nova-manage floating delete <ip_range>``
179
 
 
180
 
    Deletes floating IP addresses in the range given.
181
 
 
182
 
``nova-manage floating list``
183
 
 
184
 
    Displays a list of all floating IP addresses.
185
 
 
186
 
Nova Images
187
 
~~~~~~~~~~~
188
 
 
189
 
``nova-manage image image_register <path> <owner>``
190
 
 
191
 
    Registers an image with the image service.
192
 
 
193
 
``nova-manage image kernel_register <path> <owner>``
194
 
 
195
 
    Registers a kernel with the image service.
196
 
 
197
 
``nova-manage image ramdisk_register <path> <owner>``
198
 
 
199
 
    Registers a ramdisk with the image service.
200
 
 
201
 
``nova-manage image all_register <image_path> <kernel_path> <ramdisk_path> <owner>``
202
 
 
203
 
    Registers an image kernel and ramdisk with the image service.
204
 
 
205
 
``nova-manage image convert <directory>``
206
 
 
207
 
    Converts all images in directory from the old (Bexar) format to the new format.
208
 
 
209
 
Concept: Flags
210
 
--------------
211
 
 
212
 
python-gflags
213
 
 
214
 
 
215
 
Concept: Plugins
216
 
----------------
217
 
 
218
 
* Managers/Drivers: utils.import_object from string flag
219
 
* virt/connections: conditional loading from string flag
220
 
* db: LazyPluggable via string flag
221
 
* auth_manager: utils.import_class based on string flag
222
 
* Volumes: moving to pluggable driver instead of manager
223
 
* Network: pluggable managers
224
 
* Compute: same driver used, but pluggable at connection
225
 
 
226
 
 
227
 
Concept: IPC/RPC
228
 
----------------
229
 
 
230
 
Rabbit is the main messaging queue, used for all communication between Nova components and it also does the remote procedure calls and inter-process communication.
231
 
 
232
 
 
233
 
Concept: Fakes
234
 
--------------
235
 
 
236
 
* auth
237
 
* ldap
238
 
 
239
 
 
240
 
Concept: Scheduler
241
 
------------------
242
 
 
243
 
* simple
244
 
* random
245
 
 
246
 
 
247
 
Concept: Security Groups
248
 
------------------------
249
 
 
250
 
Security groups
251
 
 
252
 
 
253
 
Concept: Certificate Authority
254
 
------------------------------
255
 
 
256
 
Nova does a small amount of certificate management.  These certificates are used for :ref:`project vpns <cloudpipe>` and decrypting bundled images.
257
 
 
258
 
 
259
 
Concept: Images
260
 
---------------
261
 
 
262
 
* launching
263
 
* bundling