Browse code

made several changes to guides to comply to doc conventions

“Speed not required” is not a sentence
Gb should be GB
added a , after floating IPs
fixed sentence around “To implement a true multi-node test of Swift
since it did not make sense
removed extra underline line after Machines
removed capitalization of service names to comply with docs conventions
https://wiki.openstack.org/wiki/Documentation/Conventions
changed to DevStack for consistency throughout
Change-Id: I531bf6b2bad62fbf9d1417b2b1ce06de3715e0f0

Shilla Saebi authored on 2015/04/22 04:02:13
Showing 5 changed files
... ...
@@ -54,7 +54,7 @@ that by ensuring `/dev/kvm` character device is present.
54 54
 
55 55
 
56 56
 Configure Nested KVM for AMD-based Machines
57
+-------------------------------------------
57 58
 
58 59
 Procedure to enable nested KVM virtualization on AMD-based machines.
59 60
 
... ...
@@ -121,7 +121,7 @@ attribute `virt_type = kvm` in `/etc/nova.conf`; otherwise, it'll fall
121 121
 back to `virt_type=qemu`, i.e. plain QEMU emulation.
122 122
 
123 123
 Optionally, to explicitly set the type of virtualization, to KVM, by the
124
-libvirt driver in Nova, the below config attribute can be used in
124
+libvirt driver in nova, the below config attribute can be used in
125 125
 DevStack's ``local.conf``:
126 126
 
127 127
 ::
... ...
@@ -262,17 +262,17 @@ for scripting:
262 262
 Swift
263 263
 -----
264 264
 
265
-Swift requires a significant amount of resources and is disabled by
266
-default in DevStack. The support in DevStack is geared toward a minimal
267
-installation but can be used for testing. To implement a true multi-node
268
-test of Swift required more than DevStack provides. Enabling it is as
265
+Swift, OpenStack Object Storage, requires a significant amount of resources
266
+and is disabled by default in DevStack. The support in DevStack is geared 
267
+toward a minimal installation but can be used for testing. To implement a
268
+true multi-node test of swift, additional steps will be required. Enabling it is as
269 269
 simple as enabling the ``swift`` service in ``local.conf``:
270 270
 
271 271
 ::
272 272
 
273 273
     enable_service s-proxy s-object s-container s-account
274 274
 
275
-Swift will put its data files in ``SWIFT_DATA_DIR`` (default
275
+Swift, OpenStack Object Storage, will put its data files in ``SWIFT_DATA_DIR`` (default
276 276
 ``/opt/stack/data/swift``). The size of the data 'partition' created
277 277
 (really a loop-mounted file) is set by ``SWIFT_LOOPBACK_DISK_SIZE``. The
278 278
 Swift config files are located in ``SWIFT_CONF_DIR`` (default
... ...
@@ -334,14 +334,14 @@ After making changes to the repository or branch, if ``RECLONE`` is not
334 334
 set in ``localrc`` it may be necessary to remove the corresponding
335 335
 directory from ``/opt/stack`` to force git to re-clone the repository.
336 336
 
337
-For example, to pull Nova from a proposed release candidate in the
338
-primary Nova repository:
337
+For example, to pull nova, OpenStack Compute, from a proposed release candidate
338
+in the primary nova repository:
339 339
 
340 340
 ::
341 341
 
342 342
     NOVA_BRANCH=rc-proposed
343 343
 
344
-To pull Glance from an experimental fork:
344
+To pull glance, OpenStack Image service, from an experimental fork:
345 345
 
346 346
 ::
347 347
 
... ...
@@ -1,14 +1,14 @@
1 1
 ======================================
2
-Using DevStack with Neutron Networking
2
+Using DevStack with neutron Networking
3 3
 ======================================
4 4
 
5
-This guide will walk you through using OpenStack Neutron with the ML2
5
+This guide will walk you through using OpenStack neutron with the ML2
6 6
 plugin and the Open vSwitch mechanism driver.
7 7
 
8 8
 Network Interface Configuration
9 9
 ===============================
10 10
 
11
-To use Neutron, it is suggested that two network interfaces be present
11
+To use neutron, it is suggested that two network interfaces be present
12 12
 in the host operating system.
13 13
 
14 14
 The first interface, eth0 is used for the OpenStack management (API,
... ...
@@ -62,7 +62,7 @@ connectivity.
62 62
 Disabling Next Generation Firewall Tools
63 63
 ========================================
64 64
 
65
-Devstack does not properly operate with modern firewall tools.  Specifically
65
+DevStack does not properly operate with modern firewall tools.  Specifically
66 66
 it will appear as if the guest VM can access the external network via ICMP,
67 67
 but UDP and TCP packets will not be delivered to the guest VM.  The root cause
68 68
 of the issue is that both ufw (Uncomplicated Firewall) and firewalld (Fedora's
... ...
@@ -96,13 +96,13 @@ disable ufw if it was enabled, do the following:
96 96
 Neutron Networking with Open vSwitch
97 97
 ====================================
98 98
 
99
-Configuring Neutron networking in DevStack is very similar to
99
+Configuring neutron, OpenStack Networking in DevStack is very similar to
100 100
 configuring `nova-network` - many of the same configuration variables
101 101
 (like `FIXED_RANGE` and `FLOATING_RANGE`) used by `nova-network` are
102
-used by Neutron, which is intentional.
102
+used by neutron, which is intentional.
103 103
 
104 104
 The only difference is the disabling of `nova-network` in your
105
-local.conf, and the enabling of the Neutron components.
105
+local.conf, and the enabling of the neutron components.
106 106
 
107 107
 
108 108
 Configuration
... ...
@@ -134,16 +134,16 @@ in a real setup FLOATING_RANGE would be a public IP address range.
134 134
 Neutron Networking with Open vSwitch and Provider Networks
135 135
 ==========================================================
136 136
 
137
-In some instances, it is desirable to use Neutron's provider
137
+In some instances, it is desirable to use neutron's provider
138 138
 networking extension, so that networks that are configured on an
139
-external router can be utilized by Neutron, and instances created via
139
+external router can be utilized by neutron, and instances created via
140 140
 Nova can attach to the network managed by the external router.
141 141
 
142 142
 For example, in some lab environments, a hardware router has been
143 143
 pre-configured by another party, and an OpenStack developer has been
144 144
 given a VLAN tag and IP address range, so that instances created via
145 145
 DevStack will use the external router for L3 connectivity, as opposed
146
-to the Neutron L3 service.
146
+to the neutron L3 service.
147 147
 
148 148
 
149 149
 Service Configuration
... ...
@@ -152,8 +152,8 @@ Service Configuration
152 152
 **Control Node**
153 153
 
154 154
 In this example, the control node will run the majority of the
155
-OpenStack API and management services (Keystone, Glance,
156
-Nova, Neutron, etc..)
155
+OpenStack API and management services (keystone, glance,
156
+nova, neutron)
157 157
 
158 158
 
159 159
 **Compute Nodes**
... ...
@@ -226,4 +226,4 @@ DevStack will automatically add the network interface defined in
226 226
 For example, with the above  configuration, a bridge is
227 227
 created, named `br-ex` which is managed by Open vSwitch, and the
228 228
 second interface on the compute node, `eth1` is attached to the
229
-bridge, to forward traffic sent by guest vms.
229
+bridge, to forward traffic sent by guest VMs.
... ...
@@ -1,15 +1,15 @@
1 1
 =================
2
-Nova and devstack
2
+Nova and DevStack
3 3
 =================
4 4
 
5 5
 This is a rough guide to various configuration parameters for nova
6
-running with devstack.
6
+running with DevStack.
7 7
 
8 8
 
9 9
 nova-serialproxy
10 10
 ================
11 11
 
12
-In Juno nova implemented a `spec
12
+In Juno, nova implemented a `spec
13 13
 <http://specs.openstack.org/openstack/nova-specs/specs/juno/implemented/serial-ports.html>`_
14 14
 to allow read/write access to the serial console of an instance via
15 15
 `nova-serialproxy
... ...
@@ -60,7 +60,7 @@ The service can be enabled by adding ``n-sproxy`` to
60 60
     #proxyclient_address=127.0.0.1
61 61
 
62 62
 
63
-Enabling the service is enough to be functional for a single machine devstack.
63
+Enabling the service is enough to be functional for a single machine DevStack.
64 64
 
65 65
 These config options are defined in `nova.console.serial
66 66
 <https://github.com/openstack/nova/blob/master/nova/console/serial.py#L33-L52>`_
... ...
@@ -3,10 +3,10 @@ All-In-One Single VM
3 3
 ====================
4 4
 
5 5
 Use the cloud to build the cloud! Use your cloud to launch new versions
6
-of OpenStack in about 5 minutes. When you break it, start over! The VMs
6
+of OpenStack in about 5 minutes. If you break it, start over! The VMs
7 7
 launched in the cloud will be slow as they are running in QEMU
8 8
 (emulation), but their primary use is testing OpenStack development and
9
-operation. Speed not required.
9
+operation.
10 10
 
11 11
 Prerequisites Cloud & Image
12 12
 ===========================
... ...
@@ -15,7 +15,7 @@ Virtual Machine
15 15
 ---------------
16 16
 
17 17
 DevStack should run in any virtual machine running a supported Linux
18
-release. It will perform best with 4Gb or more of RAM.
18
+release. It will perform best with 4GB or more of RAM.
19 19
 
20 20
 OpenStack Deployment & cloud-init
21 21
 ---------------------------------
... ...
@@ -88,7 +88,7 @@ Using OpenStack
88 88
 ---------------
89 89
 
90 90
 At this point you should be able to access the dashboard. Launch VMs and
91
-if you give them floating IPs access those VMs from other machines on
91
+if you give them floating IPs, access those VMs from other machines on
92 92
 your network.
93 93
 
94 94
 One interesting use case is for developers working on a VM on their