diff --git a/doc/common/ch_getstart.xml b/doc/common/ch_getstart.xml index 1ff50b8142..a35bfec2f8 100644 --- a/doc/common/ch_getstart.xml +++ b/doc/common/ch_getstart.xml @@ -77,7 +77,8 @@ xlink:href="http://docs.openstack.org/developer/swift/" >Swift Stores and retrieves arbitrary unstructured - data objects via a RESTful, HTTP based API. It is highly + data objects via a RESTful, + HTTP based API. It is highly fault tolerant with its data replication and scale out architecture. Its implementation is not like a file server with mountable directories. diff --git a/doc/common/section_keystone-concepts.xml b/doc/common/section_keystone-concepts.xml index b68163d390..58dc8ebe11 100644 --- a/doc/common/section_keystone-concepts.xml +++ b/doc/common/section_keystone-concepts.xml @@ -5,7 +5,7 @@ xml:id="keystone-concepts"> Identity Service concepts - The Identity Service performs the following + The Identity Service performs the following functions: @@ -13,7 +13,8 @@ permissions. - Service catalog. Provides a catalog of available + Service + catalog. Provides a catalog of available services with their API endpoints. diff --git a/doc/install-guide/bk_openstackinstallguide.xml b/doc/install-guide/bk_openstackinstallguide.xml index 119c0c8a69..3355119e2a 100644 --- a/doc/install-guide/bk_openstackinstallguide.xml +++ b/doc/install-guide/bk_openstackinstallguide.xml @@ -568,4 +568,6 @@ + + diff --git a/doc/install-guide/ch_basics.xml b/doc/install-guide/ch_basics.xml index a62c2c3d71..fae0e33148 100644 --- a/doc/install-guide/ch_basics.xml +++ b/doc/install-guide/ch_basics.xml @@ -52,7 +52,8 @@ For simple test cases, you can use machines with a single network interface card. The following example configures Networking on two networks - with static IP addresses and manually manages a list of host + with static IP addresses + and manually manages a list of host names on each machine. If you manage a large network, you might already have systems in place to manage this. If so, you can skip this section but note that the rest of this guide assumes @@ -88,7 +89,8 @@ RHEL and derivatives including CentOS and Scientific Linux enable a - restrictive firewall by default. During this installation, certain steps + restrictive firewall by default. During this + installation, certain steps will fail unless you alter this setting or disable the firewall. For further information about securing your installation, refer to the OpenStack Security Guide. @@ -225,7 +227,8 @@ iface eth1 inet static
Network Time Protocol (NTP) To synchronize services across multiple machines, you must - install NTP. The examples in this guide configure the controller + install NTP. + The examples in this guide configure the controller node as the reference server and any additional nodes to set their time from the controller node. Install the ntp package on each system @@ -484,7 +487,8 @@ bind-address = 192.168.0.10 access the RDO repository. # yum install openstack-utils Use the Open Build Service repositories - for Havana based on your openSUSE or SUSE Linux Enterprise + for Havana based on your openSUSE or + SUSE Linux Enterprise Server version, for example if you run openSUSE 12.3 use: # zypper addrepo -f obs://Cloud:OpenStack:Havana/openSUSE_12.3 Havana If you use SUSE Linux Enterprise Server 11 SP3, @@ -533,7 +537,8 @@ bind-address = 192.168.0.10 allows you to install newer releases of OpenStack on the stable supported version of Ubuntu. - Install the Ubuntu Cloud Archive for Havana: + Install the Ubuntu Cloud Archive for + Havana: # apt-get install python-software-properties # add-apt-repository cloud-archive:havana @@ -547,7 +552,8 @@ bind-address = 192.168.0.10 To use the Debian Wheezy backports archive for Havana - The Havana release is available only in Debian Sid + The Havana release is available + only in Debian Sid (otherwise called Unstable). However, the Debian maintainers of OpenStack also maintain a non-official Debian repository for OpenStack containing Wheezy backports. @@ -609,10 +615,12 @@ bind-address = 192.168.0.10 Messaging server On the controller node, install the messaging queue server. Typically this is RabbitMQQpid but QpidRabbitMQ and ZeroMQ (0MQ) are also available. + >RabbitMQ + + Qpid but + Qpid + RabbitMQ + and ZeroMQ (0MQ) are also available. # apt-get install rabbitmq-server # zypper install rabbitmq-server # yum install qpid-cpp-server memcached diff --git a/doc/install-guide/ch_overview.xml b/doc/install-guide/ch_overview.xml index e89a679a60..13e4b43f4a 100644 --- a/doc/install-guide/ch_overview.xml +++ b/doc/install-guide/ch_overview.xml @@ -39,10 +39,14 @@ The compute node runs the hypervisor portion of Compute, - which operates tenant virtual machines. By default, Compute uses - KVM as the hypervisor. Compute also provisions and operates - tenant networks and implements security groups. You can run more - than one compute node. + which operates tenant virtual machines. + By default, Compute uses + KVM + as the hypervisor. Compute also + provisions and operates + tenant networks and implements + security groups. + You can run more than one compute node. When implementing this architecture, skip @@ -71,7 +75,9 @@ The network node runs the Networking plug-in agent and several layer 3 agents that provision tenant networks and - provide services to them, including routing, NAT, and DHCP. + provide services to them, including routing, NAT, + and DHCP. It also handles external (internet) connectivity for tenant virtual machines. diff --git a/doc/install-guide/pom.xml b/doc/install-guide/pom.xml index 04f68ba58b..c47d97b207 100644 --- a/doc/install-guide/pom.xml +++ b/doc/install-guide/pom.xml @@ -84,6 +84,7 @@ + ${basedir}/../glossary/glossary-terms.xml installer true diff --git a/doc/install-guide/section_cinder-controller.xml b/doc/install-guide/section_cinder-controller.xml index 4c53b7335a..02f24a84db 100644 --- a/doc/install-guide/section_cinder-controller.xml +++ b/doc/install-guide/section_cinder-controller.xml @@ -5,7 +5,7 @@ Configure a Block Storage Service controller This section describes how to configure OpenStack Block Storage - services on the Controller node + services on the Controller node and assumes that a second node provides storage through the cinder-volume service. For diff --git a/doc/install-guide/section_keystone-services.xml b/doc/install-guide/section_keystone-services.xml index b9666810fc..d342f76242 100644 --- a/doc/install-guide/section_keystone-services.xml +++ b/doc/install-guide/section_keystone-services.xml @@ -12,8 +12,9 @@ service. - keystone endpoint-create. Associates API - endpoints with the service. + keystone endpoint-create. Associates + API endpoints + with the service. You must also register the Identity Service itself. Use the diff --git a/doc/install-guide/section_keystone-users.xml b/doc/install-guide/section_keystone-users.xml index 555c36b946..8b021e8826 100644 --- a/doc/install-guide/section_keystone-users.xml +++ b/doc/install-guide/section_keystone-users.xml @@ -4,9 +4,12 @@ xml:id="keystone-users" os="rhel;centos;fedora;opensuse;sles;ubuntu"> Define users, tenants, and roles - After you install the Identity Service, set up users, - tenants, and roles to authenticate against. These are used to allow access to - services and endpoints, described in the next section. + After you install the Identity Service, set up + users, + tenants, and roles to authenticate + against. These are used to allow access to + services and endpoints, described + in the next section. Typically, you would indicate a user and password to authenticate with the Identity Service. At this point, however, we diff --git a/doc/install-guide/section_neutron-install.xml b/doc/install-guide/section_neutron-install.xml index 453260a6b0..c5f726b495 100644 --- a/doc/install-guide/section_neutron-install.xml +++ b/doc/install-guide/section_neutron-install.xml @@ -572,7 +572,7 @@ neutron_insecure = True # ovs-vsctl add-br br-ex - Add a port (connection) from + Add a port (connection) from the EXTERNAL_INTERFACE interface to br-ex interface: # ovs-vsctl add-port br-ex EXTERNAL_INTERFACE @@ -699,8 +699,8 @@ use_namespaces = True Configure a firewall plug-in. If you do not wish to - enforce firewall rules, called security groups + enforce firewall rules, called security groups by OpenStack, you can use neutron.agent.firewall.NoopFirewall. Otherwise, you can choose one of the Networking firewall diff --git a/doc/install-guide/section_neutron-provider-router-with-private_networks.xml b/doc/install-guide/section_neutron-provider-router-with-private_networks.xml index cbf732f989..7cbec44789 100644 --- a/doc/install-guide/section_neutron-provider-router-with-private_networks.xml +++ b/doc/install-guide/section_neutron-provider-router-with-private_networks.xml @@ -635,8 +635,8 @@ export OS_AUTH_URL="http://controller:5000/v2.0/" This model supports assigning public addresses to VMs by - using floating - IPs; the router maps public addresses from + using floating IPs; + the router maps public addresses from the external network to fixed IPs on private networks. Hosts without floating IPs can still create outbound connections to the external network because the provider diff --git a/doc/pom.xml b/doc/pom.xml index b4b9ff9466..8659558d21 100644 --- a/doc/pom.xml +++ b/doc/pom.xml @@ -47,7 +47,7 @@ com.rackspace.cloud.api clouddocs-maven-plugin - 1.12.2 + 1.13.0