summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAnne Gentle <anne@openstack.org>2011-04-19 00:42:57 +0000
committerTarmac <>2011-04-19 00:42:57 +0000
commit5f5874b0012e77e846ad02c7ce43f10356105f3d (patch)
treeca14015159c85ccd92ca07e9f2db8d78c3367f72
parent049b19ca9954e203804a32aec61a39846019d045 (diff)
parent0d40279353be6932a05e614f78e7b23d28177b94 (diff)
downloadnova-5f5874b0012e77e846ad02c7ce43f10356105f3d.tar.gz
nova-5f5874b0012e77e846ad02c7ce43f10356105f3d.tar.xz
nova-5f5874b0012e77e846ad02c7ce43f10356105f3d.zip
Adding projectname username to the nova-manage project commands to fix a doc bug, plus some edits and elimination of a few doc todos.
-rw-r--r--doc/source/runnova/flags.rst172
-rw-r--r--doc/source/runnova/index.rst4
-rw-r--r--doc/source/runnova/managing.images.rst7
-rw-r--r--doc/source/runnova/managing.instance.types.rst2
-rw-r--r--doc/source/runnova/managingsecurity.rst2
-rw-r--r--doc/source/runnova/network.vlan.rst5
-rw-r--r--doc/source/runnova/nova.manage.rst14
7 files changed, 19 insertions, 187 deletions
diff --git a/doc/source/runnova/flags.rst b/doc/source/runnova/flags.rst
index 1bfa022d9..3d16e1303 100644
--- a/doc/source/runnova/flags.rst
+++ b/doc/source/runnova/flags.rst
@@ -20,174 +20,4 @@ Flags and Flagfiles
Nova uses a configuration file containing flags located in /etc/nova/nova.conf. You can get the most recent listing of avaialble flags by running nova-(servicename) --help, for example, nova-api --help.
-Here's a list of available flags and their default settings.
-
- --ajax_console_proxy_port: port that ajax_console_proxy binds
- (default: '8000')
- --ajax_console_proxy_topic: the topic ajax proxy nodes listen on
- (default: 'ajax_proxy')
- --ajax_console_proxy_url: location of ajax console proxy, in the form
- "http://127.0.0.1:8000"
- (default: 'http://127.0.0.1:8000')
- --auth_token_ttl: Seconds for auth tokens to linger
- (default: '3600')
- (an integer)
- --aws_access_key_id: AWS Access ID
- (default: 'admin')
- --aws_secret_access_key: AWS Access Key
- (default: 'admin')
- --compute_manager: Manager for compute
- (default: 'nova.compute.manager.ComputeManager')
- --compute_topic: the topic compute nodes listen on
- (default: 'compute')
- --connection_type: libvirt, xenapi or fake
- (default: 'libvirt')
- --console_manager: Manager for console proxy
- (default: 'nova.console.manager.ConsoleProxyManager')
- --console_topic: the topic console proxy nodes listen on
- (default: 'console')
- --control_exchange: the main exchange to connect to
- (default: 'nova')
- --db_backend: The backend to use for db
- (default: 'sqlalchemy')
- --default_image: default image to use, testing only
- (default: 'ami-11111')
- --default_instance_type: default instance type to use, testing only
- (default: 'm1.small')
- --default_log_levels: list of logger=LEVEL pairs
- (default: 'amqplib=WARN,sqlalchemy=WARN,eventlet.wsgi.server=WARN')
- (a comma separated list)
- --default_project: default project for openstack
- (default: 'openstack')
- --ec2_dmz_host: internal ip of api server
- (default: '$my_ip')
- --ec2_host: ip of api server
- (default: '$my_ip')
- --ec2_path: suffix for ec2
- (default: '/services/Cloud')
- --ec2_port: cloud controller port
- (default: '8773')
- (an integer)
- --ec2_scheme: prefix for ec2
- (default: 'http')
- --[no]enable_new_services: Services to be added to the available pool on
- create
- (default: 'true')
- --[no]fake_network: should we use fake network devices and addresses
- (default: 'false')
- --[no]fake_rabbit: use a fake rabbit
- (default: 'false')
- --glance_host: glance host
- (default: '$my_ip')
- --glance_port: glance port
- (default: '9292')
- (an integer)
- -?,--[no]help: show this help
- --[no]helpshort: show usage only for this module
- --[no]helpxml: like --help, but generates XML output
- --host: name of this node
- (default: 'osdemo03')
- --image_service: The service to use for retrieving and searching for images.
- (default: 'nova.image.s3.S3ImageService')
- --instance_name_template: Template string to be used to generate instance
- names
- (default: 'instance-%08x')
- --logfile: output to named file
- --logging_context_format_string: format string to use for log messages with
- context
- (default: '%(asctime)s %(levelname)s %(name)s [%(request_id)s %(user)s
- %(project)s] %(message)s')
- --logging_debug_format_suffix: data to append to log format when level is
- DEBUG
- (default: 'from %(processName)s (pid=%(process)d) %(funcName)s
- %(pathname)s:%(lineno)d')
- --logging_default_format_string: format string to use for log messages without
- context
- (default: '%(asctime)s %(levelname)s %(name)s [-] %(message)s')
- --logging_exception_prefix: prefix each line of exception output with this
- format
- (default: '(%(name)s): TRACE: ')
- --my_ip: host ip address
- (default: '184.106.73.68')
- --network_manager: Manager for network
- (default: 'nova.network.manager.VlanManager')
- --network_topic: the topic network nodes listen on
- (default: 'network')
- --node_availability_zone: availability zone of this node
- (default: 'nova')
- --null_kernel: kernel image that indicates not to use a kernel, but to use a
- raw disk image instead
- (default: 'nokernel')
- --osapi_host: ip of api server
- (default: '$my_ip')
- --osapi_path: suffix for openstack
- (default: '/v1.0/')
- --osapi_port: OpenStack API port
- (default: '8774')
- (an integer)
- --osapi_scheme: prefix for openstack
- (default: 'http')
- --periodic_interval: seconds between running periodic tasks
- (default: '60')
- (a positive integer)
- --pidfile: pidfile to use for this service
- --rabbit_host: rabbit host
- (default: 'localhost')
- --rabbit_max_retries: rabbit connection attempts
- (default: '12')
- (an integer)
- --rabbit_password: rabbit password
- (default: 'guest')
- --rabbit_port: rabbit port
- (default: '5672')
- (an integer)
- --rabbit_retry_interval: rabbit connection retry interval
- (default: '10')
- (an integer)
- --rabbit_userid: rabbit userid
- (default: 'guest')
- --rabbit_virtual_host: rabbit virtual host
- (default: '/')
- --region_list: list of region=fqdn pairs separated by commas
- (default: '')
- (a comma separated list)
- --report_interval: seconds between nodes reporting state to datastore
- (default: '10')
- (a positive integer)
- --s3_dmz: s3 dmz ip (for instances)
- (default: '$my_ip')
- --s3_host: s3 host (for infrastructure)
- (default: '$my_ip')
- --s3_port: s3 port
- (default: '3333')
- (an integer)
- --scheduler_manager: Manager for scheduler
- (default: 'nova.scheduler.manager.SchedulerManager')
- --scheduler_topic: the topic scheduler nodes listen on
- (default: 'scheduler')
- --sql_connection: connection string for sql database
- (default: 'sqlite:///$state_path/nova.sqlite')
- --sql_idle_timeout: timeout for idle sql database connections
- (default: '3600')
- --sql_max_retries: sql connection attempts
- (default: '12')
- (an integer)
- --sql_retry_interval: sql connection retry interval
- (default: '10')
- (an integer)
- --state_path: Top-level directory for maintaining nova's state
- (default: '/usr/lib/pymodules/python2.6/nova/../')
- --[no]use_syslog: output to syslog
- (default: 'false')
- --[no]verbose: show debug output
- (default: 'false')
- --volume_manager: Manager for volume
- (default: 'nova.volume.manager.VolumeManager')
- --volume_name_template: Template string to be used to generate instance names
- (default: 'volume-%08x')
- --volume_topic: the topic volume nodes listen on
- (default: 'volume')
- --vpn_image_id: AMI for cloudpipe vpn server
- (default: 'ami-cloudpipe')
- --vpn_key_suffix: Suffix to add to project name for vpn key and secgroups
- (default: '-vpn') \ No newline at end of file
+The OpenStack wiki has a page with the flags listed by their purpose and use at http://wiki.openstack.org/FlagsGrouping. \ No newline at end of file
diff --git a/doc/source/runnova/index.rst b/doc/source/runnova/index.rst
index 283d268ce..769bbec84 100644
--- a/doc/source/runnova/index.rst
+++ b/doc/source/runnova/index.rst
@@ -18,7 +18,7 @@
Running Nova
============
-This guide describes the basics of running and managing Nova. For more administrator's documentation, refer to `docs.openstack.org <http://docs.openstack.org>`_.
+This guide describes the basics of running and managing Nova. This site is intended to provide developer documentation. For more administrator's documentation, refer to `docs.openstack.org <http://docs.openstack.org>`_.
Running the Cloud
-----------------
@@ -60,7 +60,7 @@ For background on the core objects referenced in this section, see :doc:`../obje
Deployment
----------
-For a starting multi-node architecture, you would start with two nodes - a cloud controller node and a compute node. The cloud controller node contains the nova- services plus the Nova database. The compute node installs all the nova-services but then refers to the database installation, which is hosted by the cloud controller node. Ensure that the nova.conf file is identical on each node. If you find performance issues not related to database reads or writes, but due to the messaging queue backing up, you could add additional messaging services (rabbitmq). For instructions on multi-server installations, refer to `Installing and Configuring OpenStack Compute <http://docs.openstack.org/openstack-compute/admin/content/ch03.html>`_.
+For a starting multi-node architecture, you would start with two nodes - a cloud controller node and a compute node. The cloud controller node contains the nova- services plus the Nova database. The compute node installs all the nova-services but then refers to the database installation, which is hosted by the cloud controller node. Ensure that the nova.conf file is identical on each node. If you find performance issues not related to database reads or writes, but due to the messaging queue backing up, you could add additional messaging services (rabbitmq). For instructions on multi-server installations, refer to `Installing and Configuring OpenStack Compute <http://docs.openstack.org/>`_.
.. toctree::
diff --git a/doc/source/runnova/managing.images.rst b/doc/source/runnova/managing.images.rst
index c5d93a6e8..a2e618602 100644
--- a/doc/source/runnova/managing.images.rst
+++ b/doc/source/runnova/managing.images.rst
@@ -18,4 +18,9 @@
Managing Images
===============
-.. todo:: Put info on managing images here!
+With Nova, you can manage images either using the built-in object store or using Glance, a related OpenStack project. Glance is a server that provides the following services:
+
+ * Ability to store and retrieve virtual machine images
+ * Ability to store and retrieve metadata about these virtual machine images
+
+Refer to http://glance.openstack.org for additional details. \ No newline at end of file
diff --git a/doc/source/runnova/managing.instance.types.rst b/doc/source/runnova/managing.instance.types.rst
index 746077716..a575e16b7 100644
--- a/doc/source/runnova/managing.instance.types.rst
+++ b/doc/source/runnova/managing.instance.types.rst
@@ -16,6 +16,8 @@
Managing Instance Types and Flavors
===================================
+You can manage instance types and instance flavors using the nova-manage command-line interface coupled with the instance_type subcommand for nova-manage.
+
What are Instance Types or Flavors ?
------------------------------------
diff --git a/doc/source/runnova/managingsecurity.rst b/doc/source/runnova/managingsecurity.rst
index 7893925e7..85329ed4a 100644
--- a/doc/source/runnova/managingsecurity.rst
+++ b/doc/source/runnova/managingsecurity.rst
@@ -18,8 +18,6 @@
Security Considerations
=======================
-.. todo:: This doc is vague and just high-level right now. Describe architecture that enables security.
-
The goal of securing a cloud computing system involves both protecting the instances, data on the instances, and
ensuring users are authenticated for actions and that borders are understood by the users and the system.
Protecting the system from intrusion or attack involves authentication, network protections, and
diff --git a/doc/source/runnova/network.vlan.rst b/doc/source/runnova/network.vlan.rst
index c06ce8e8b..df19c7a80 100644
--- a/doc/source/runnova/network.vlan.rst
+++ b/doc/source/runnova/network.vlan.rst
@@ -36,9 +36,7 @@ In this mode, each project gets its own VLAN, Linux networking bridge, and subne
While network traffic between VM instances belonging to the same VLAN is always open, Nova can enforce isolation of network traffic between different projects by enforcing one VLAN per project.
-In addition, the network administrator can specify a pool of public IP addresses that users may allocate and then assign to VMs, either at boot or dynamically at run-time. This capability is similar to Amazon's 'elastic IPs'. A public IP address may be associated with a running instances, allowing the VM instance to be accessed from the public network. The public IP addresses are accessible from the network host and NATed to the private IP address of the project.
-
-.. todo:: Describe how a public IP address could be associated with a project (a VLAN)
+In addition, the network administrator can specify a pool of public IP addresses that users may allocate and then assign to VMs, either at boot or dynamically at run-time. This capability is similar to Amazon's 'elastic IPs'. A public IP address may be associated with a running instances, allowing the VM instance to be accessed from the public network. The public IP addresses are accessible from the network host and NATed to the private IP address of the project. A public IP address could be associated with a project using the euca-allocate-address commands.
This is the default networking mode and supports the most features. For multiple machine installation, it requires a switch that supports host-managed vlan tagging. In this mode, nova will create a vlan and bridge for each project. The project gets a range of private ips that are only accessible from inside the vlan. In order for a user to access the instances in their project, a special vpn instance (code named :ref:`cloudpipe <cloudpipe>`) needs to be created. Nova generates a certificate and key for the user to access the vpn and starts the vpn automatically. More information on cloudpipe can be found :ref:`here <cloudpipe>`.
@@ -176,4 +174,3 @@ Setup
* project network size
* DMZ network
-.. todo:: need specific Nova configuration added
diff --git a/doc/source/runnova/nova.manage.rst b/doc/source/runnova/nova.manage.rst
index 0636e5752..af82b6a4f 100644
--- a/doc/source/runnova/nova.manage.rst
+++ b/doc/source/runnova/nova.manage.rst
@@ -83,13 +83,13 @@ Nova User
Nova Project
~~~~~~~~~~~~
-``nova-manage project add <projectname>``
+``nova-manage project add <projectname> <username>``
- Add a nova project with the name <projectname> to the database.
+ Add a nova project with the name <projectname> to the database that will be administered by the named user.
-``nova-manage project create <projectname>``
+``nova-manage project create <projectname> <projectmanager>``
- 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).
+ 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.
``nova-manage project delete <projectname>``
@@ -111,9 +111,9 @@ Nova Project
Deletes the project with the name <projectname>.
-``nova-manage project zipfile``
+``nova-manage project zipfile <projectname> <username> <directory for credentials>``
- Compresses all related files for a created project into a zip file nova.zip.
+ Compresses all related files for a created project into a named zip file such as nova.zip.
Nova Role
~~~~~~~~~
@@ -226,7 +226,7 @@ Concept: Plugins
Concept: IPC/RPC
----------------
-Rabbit!
+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.
Concept: Fakes