From 916c3383b777733fbc3112f18069bb97d02e366a Mon Sep 17 00:00:00 2001 From: annegentle Date: Fri, 17 Aug 2012 15:38:28 -0500 Subject: [PATCH] Fix doc bugs - bug 1034021 trailing off sentence in overview bug 1034772 included typo bug 1034462 scheduler typo bug 1017691 change in name of root wrap config option Change-Id: Ia7ecf12f39771c49915b927ea3f0de89c9f28327 --- .gitignore | 1 + doc/src/docbkx/common/getstart.xml | 14 +-- .../computescheduler.xml | 96 ++++++++++--------- .../openstack-compute-admin/rootwrap.xml | 2 +- .../tables/common-nova-conf.xml | 2 +- 5 files changed, 63 insertions(+), 52 deletions(-) diff --git a/.gitignore b/.gitignore index 11d6e3f715..c7aa5541c2 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ .DS_Store target/ *.xpr +.bak diff --git a/doc/src/docbkx/common/getstart.xml b/doc/src/docbkx/common/getstart.xml index 5b3ffd5c3c..3323fb9004 100644 --- a/doc/src/docbkx/common/getstart.xml +++ b/doc/src/docbkx/common/getstart.xml @@ -297,7 +297,7 @@ xml:id="ch_getting-started-with-openstack"> A database (configurable to which one). As it relies mostly on the other services for data, it stores very - little data of it's own. + little data of its own. @@ -384,7 +384,7 @@ xml:id="ch_getting-started-with-openstack"> - During the last two releases, Nova has augmented it's + During the last two releases, Nova has augmented its console services. Console services allow end users to access their virtual instance's console through a proxy. This involves a pair of new daemons (nova-console and @@ -480,10 +480,12 @@ xml:id="ch_getting-started-with-openstack"> availability through the cluster. Other periodic processes include auditors, updaters and reapers. - As you can see from the diagram, Glance serves a central - role to the overall IaaS picture. It accepts API requests for - images (or image metadata) from end users or Nova components - and can store it's disk files in + As you can see from the diagram in the Conceptual + Architecture section, Glance serves a central role to the + overall IaaS picture. It accepts API requests for images (or + image metadata) from end users or Nova components and can + store its disk files in the object storage service, + Swift.
Identity diff --git a/doc/src/docbkx/openstack-compute-admin/computescheduler.xml b/doc/src/docbkx/openstack-compute-admin/computescheduler.xml index 902b2f9302..c41431cda6 100644 --- a/doc/src/docbkx/openstack-compute-admin/computescheduler.xml +++ b/doc/src/docbkx/openstack-compute-admin/computescheduler.xml @@ -81,31 +81,35 @@ servicing the request (ComputeFilter). - The scheduler_available_filters configuration option - in nova.conf provides the Compute service with the - list of the filters that will be used by the scheduler. The default setting - specifies all of the filter that are incldued with the Compute service: - + The scheduler_available_filters + configuration option in nova.conf + provides the Compute service with the list of the filters + that will be used by the scheduler. The default setting + specifies all of the filter that are included with the + Compute service: + scheduler_available_filters=nova.scheduler.filters.standard_filters - This configuration option can be specified multiple times. For example, - if you implemented your own custom filter in Python called - myfilter.MyFilter and you wanted to use both the - built-in filters and your custom filter, your nova.conf - file would contain: - + This configuration option can be specified multiple times. + For example, if you implemented your own custom filter in + Python called myfilter.MyFilter and you + wanted to use both the built-in filters and your custom + filter, your nova.conf file would + contain: + scheduler_available_filters=nova.scheduler.filters.standard_filters scheduler_available_filters=myfilter.MyFilter - - The scheduler_default_filters configuration option - in nova.conf defines the list of filters - that will be applied by the nova-scheduler service. - As mentioned above, the default filtes are: - + + The scheduler_default_filters + configuration option in nova.conf + defines the list of filters that will be applied by the + nova-scheduler service. As + mentioned above, the default filters are: + scheduler_default_filters=AvailabilityZoneFilter,RamFilter,ComputeFilter - + The available filters are described below.
@@ -118,10 +122,9 @@ scheduler_default_filters=AvailabilityZoneFilter,RamFilter,ComputeFilter AvailabilityZoneFilter - - Filters hosts by availabilty zone. This filter must be enabled for - the scheduler to respect availability zones in requests. - + Filters hosts by availability zone. This filter must be + enabled for the scheduler to respect availability + zones in requests.
@@ -178,19 +181,21 @@ scheduler_default_filters=AvailabilityZoneFilter,RamFilter,ComputeFilter
DifferentHostFilter - Schedule the instance on a different host from a - set of instances. To take advantage of this filter, the requester - must pass a scheduler hint, using different_host - as the keyand a list of instance uuids as the value. This - filter is the opposite of the SameHostFilter. - Using the - nova command-line tool, use the --hint - flag. For example: - + Schedule the instance on a different host from a set + of instances. To take advantage of this filter, the + requester must pass a scheduler hint, using + different_host as the key and a + list of instance uuids as the value. This filter is + the opposite of the SameHostFilter. + Using the nova command-line tool, + use the --hint flag. For example: + $ nova boot --image cedef40a-ed67-4d10-800e-17455edce175 --flavor 1 --hint different_host=[a0cf03a5-d921-4877-bb5c-86d26cf818e1,8c19174f-4220-44f0-824a-cd1eeef10287] server-1 -With the API, use the os:scheduler_hints key. For example: - + With the API, use the + os:scheduler_hints key. For + example: + { 'server': { 'name': 'server-1', @@ -258,17 +263,20 @@ ram_allocation_ratio=1.5
SameHostFilter - Schedule the instance on the same host as another instance - in a set of of instances. To take advantage of this filter, the - requester must pass a scheduler hint, using same_host - as the key and a list of instance uuids as the value. This - filter is the opposite of the DifferentHostFilter. Using the - nova command-line tool, use the --hint - flag: - + Schedule the instance on the same host as another + instance in a set of instances. To take advantage of + this filter, the requester must pass a scheduler hint, + using same_host as the key and a + list of instance uuids as the value. This filter is + the opposite of the + DifferentHostFilter. Using the + nova command-line tool, use the + --hint flag: + $ nova boot --image cedef40a-ed67-4d10-800e-17455edce175 --flavor 1 --hint same_host=[a0cf03a5-d921-4877-bb5c-86d26cf818e1,8c19174f-4220-44f0-824a-cd1eeef10287] server-1 -With the API, use the os:scheduler_hints key: - + With the API, use the + os:scheduler_hints key: + { 'server': { 'name': 'server-1', @@ -428,7 +436,7 @@ compute_fill_first_cost_fn_weight=-1.0 configuration option.
- Simple Scheulder + Simple Scheduler The Simple Scheduler (nova.scheduler.simple.SimpleScheduler) implements a naive scheduler that tries to find the least loaded host (i.e., implements a "spread-first" algorithm). It can schedule requests diff --git a/doc/src/docbkx/openstack-compute-admin/rootwrap.xml b/doc/src/docbkx/openstack-compute-admin/rootwrap.xml index d687863bd8..93ca20ac37 100644 --- a/doc/src/docbkx/openstack-compute-admin/rootwrap.xml +++ b/doc/src/docbkx/openstack-compute-admin/rootwrap.xml @@ -39,7 +39,7 @@ Details of rootwrap.conf The rootwrap.conf file is used to influence how nova-rootwrap works. Since it's in the trusted security path, it needs to be owned and writeable only by the root user. - Its location is specified both in the sudoers entry and in the nova.conf configuration file with the root_helper= entry. + Its location is specified both in the sudoers entry and in the nova.conf configuration file with the rootwrap_config= entry. It uses an INI file format with the following sections and parameters: diff --git a/doc/src/docbkx/openstack-compute-admin/tables/common-nova-conf.xml b/doc/src/docbkx/openstack-compute-admin/tables/common-nova-conf.xml index a66ff6a83b..5e519f503a 100644 --- a/doc/src/docbkx/openstack-compute-admin/tables/common-nova-conf.xml +++ b/doc/src/docbkx/openstack-compute-admin/tables/common-nova-conf.xml @@ -509,7 +509,7 @@ it is left untouched. -
root_helper=sudo nova-rootwrap + rootwrap_config=sudo nova-rootwrap /etc/nova/rootwrap.conf (StrOpt) Command prefix to use for running commands as root. Note that the configuration