openstack
/
fuel-docs
Code Issues Proposed changes

spelling fixes

This commit is contained in:
Matthew Mosesohn 2013-11-01 15:32:08 +04:00
parent a986b81e4c
commit 9e62accdf1
19 changed files with 59 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
conf.py
View File

@ -283,7 +283,7 @@ extensions += ['rst2pdf.pdfbuilder']
pdf_documents = [
('pdf_user', u'Fuel-for-OpenStack-3.2-UserGuide', u'User Guide',
u'2013, Mirantis Inc.'),
('pdf_install', u'Fuel-for-Openstack-3.2-InstallGuide', u'Installation Guide', u'2013, Mirantis Inc.'),
('pdf_install', u'Fuel-for-OpenStack-3.2-InstallGuide', u'Installation Guide', u'2013, Mirantis Inc.'),
('pdf_reference', u'Fuel-for-OpenStack-3.2-ReferenceArchitecture', u'Reference Architecture', u'2013, Mirantis Inc.'),
('pdf_preinstall', u'Fuel-for-OpenStack-3.2-Pre-InstallationGuide', u'Pre-Installation Guide', u'2013, Mirantis Inc.')
# (master_doc, project, project, copyright),

4
pages/install-guide/0000-intro.rst
View File

@ -10,7 +10,7 @@ This section introduces Fuel for OpenStack and its components.
Introducing Fuel for OpenStack
--------------------------------
Mirantis Fuel for Openstack is a set of deployment tools that helps you to
Mirantis Fuel for OpenStack is a set of deployment tools that helps you to
quickly deploy your cloud environment. Fuel includes the scripts that
dramatically facilitate and speed up the process of cloud deployment.
Typically, OpenStack installation requires you familiarize yourself
@ -56,7 +56,7 @@ Fuel includes the following components:
* **Master Node**
The Fuel Master Node is the lifecycle management application for
deployment and managing OpenStack. It sits outside the OpenStack
environment and services as a control plane for multiple Openstack
environment and services as a control plane for multiple OpenStack
envionments.
* **Controller Node**

2
pages/install-guide/networks.rst
View File

@ -19,7 +19,7 @@ can read these two resources:
* `OpenStack Networking – FlatManager and FlatDHCPManager
<http://www.mirantis.com/blog/openstack-networking-flatmanager-and-flatdhcpmanager/>`_
* `Openstack Networking for Scalability and Multi-tenancy with VLANManager
* `OpenStack Networking for Scalability and Multi-tenancy with VLANManager
<http://www.mirantis.com/blog/openstack-networking-vlanmanager/>`_
* `Neutron - OpenStack <https://wiki.openstack.org/wiki/Neutron/>`_

4
pages/pre-install-guide/0010-intro.rst
View File

@ -1,4 +1,4 @@
.. index:: Introductio
.. index:: Introduction
.. _QSIntro:
@ -27,4 +27,4 @@ Installing Fuel for OpenStack includes the following tasks:
#. Install Node servers.
#. Verify your succesesful deployment.
#. Verify your successful deployment.

2
pages/pre-install-guide/0020-system-requirements.rst
View File

@ -25,7 +25,7 @@ Suggested minimum configuration for installation in production environment:
- 128GB SAS Disk
- IPMI access through independent management network
Suggested minumum configuration for installation in lab environment:
Suggested minimum configuration for installation in lab environment:
- Dual-core CPU
- 2GB RAM

8
pages/pre-install-guide/0030-pre-installation-checklist.rst
View File

@ -37,7 +37,7 @@ a successful deployment.
| The node servers are set to network boot using PXE. | |
+--------------------------------------------------------+--------------+
| You have a method to reboot node servers (remotely or | |
| onsite). | |
| on-site). | |
+--------------------------------------------------------+--------------+
| The network equipment supports VLANs. | |
+--------------------------------------------------------+--------------+
@ -49,8 +49,8 @@ a successful deployment.
| the Fuel server from your PC).  | |
+--------------------------------------------------------+--------------+
.. note:: You needd this for VLAN Manager or Quantum VLAN mode, where tagged
ports are required.
.. note:: * You need tagged ports in order to use Nova-network VLAN Manager or
Neutron with VLAN segmentation.
If you checked all the boxes in the above table, you are ready to deploy
Mirantis Openstack with Fuel.
Mirantis OpenStack with Fuel.

8
pages/pre-install-guide/0031-fuel-configuration.rst
View File

@ -88,7 +88,7 @@ including networking, storage, and optional parameters.
| 1 | Point your browser to the | For example: http://10.20.0.2:8000/ |
| | Fuel server (on port 8000) | |
+----+----------------------------+-------------------------------------------+
| 2 | Click on the **New** | The **Create a new Openstack |
| 2 | Click on the **New** | The **Create a new OpenStack |
| | *OpenStack environment* | Environment** wizard launches |
| | icon to create a new | automatically. |
| | environment. | |
@ -112,7 +112,7 @@ including networking, storage, and optional parameters.
| | service (Nova-network, | choose FlatDHCP or VLAN Manager later in |
| | Neutron with GRE | the **Network** settings tab. |
| | segmentation or Neutron | |
| | with vlan segmentation. | |
| | with VLAN segmentation. | |
+----+----------------------------+-------------------------------------------+
| 7 | Select your storage | If you select **default**, then the Local |
| | backend for Cinder. | Volumes over iSCSI are used as backend for|
@ -142,7 +142,7 @@ including networking, storage, and optional parameters.
| | | compute role. |
+----+----------------------------+-------------------------------------------+
| 12 | In **Network** tab, | If you chose Neutron as your network |
| | configure the network | service, additioanl sections are |
| | configure the network | service, additional sections are |
| | settings from the address | available for setting your L2 and L3 |
| | plan prepared earlier. | configuration. |
+----+----------------------------+-------------------------------------------+
@ -158,7 +158,7 @@ including networking, storage, and optional parameters.
| | logging, and other | |
| | OpenStack options. | |
+----+----------------------------+-------------------------------------------+
| 15 | Click the **Deploy** | Mirantis OpenStack deploymenent may take |
| 15 | Click the **Deploy** | Mirantis OpenStack deployment may take |
| | **Changes** button. | 15-60 minutes, depending on your the |
| | | selected options. You can monitor status |
| | | by opening the **Nodes** tab or by |

20
pages/pre-install-guide/0050-network-overview.rst
View File

@ -11,28 +11,28 @@ your environment requirements and prerequisites.
Networks used by OpenStack
--------------------------
Public network is used for communication between a cluster and external
**Public network** is used for communication between a cluster and external
networks (the Internet, corporate network, end users).
Floating network is used for communication from external networks to
**Floating network** is used for communication from external networks to
VMs. A Floating network IP address can be assigned to a single VM.
Storage network is part of cluster’s internal network. It is used
**Storage network** is part of cluster’s internal network. It is used
to separate storage traffic (Swift, Ceph, iSCSI, and so on) from other types of
cluster’s internal communications.
Management network is also part of a cluster’s internal network. It serves
**Management network** is also part of a cluster’s internal network. It serves
all other internal communications, including DB queries, AMQP messaging,
high availability services, and so on.
Private network is an internal network used for VM’s communications between
**Private network** is an internal network used for VM’s communications between
tenants (also called Fixed network).
Administrative network is a network shared between the Fuel master node
**Administrative network** is a network shared between the Fuel master node
and all clusters deployed by the Fuel master node. It’s used for
administrative purposes and network-based installation of Node servers.
OVS is an abbreviation for Open vSwitch, a production quality, multilayer
**OVS** is an abbreviation for Open vSwitch, a production quality, multilayer
virtual switch licensed under the open source `Apache
2.0 <http://www.apache.org/licenses/LICENSE-2.0.html>`_  license.
@ -42,10 +42,10 @@ For more information about networks, see
Network Deployment Models
=========================
This section describes the following network deployement models:
This section describes the following network deployment models:
* :ref:`Nova-network <novanetwork>`
* :ref:`Nuetron <neutron>`
* :ref:`Neutron <neutron>`
.. _novanetwork:
@ -83,7 +83,7 @@ Assigning OpenStack Networks to Network Interfaces
You must associate each OpenStack network with a server NIC.
To assigna OpenStack networks to server NICs, using Fuel UI:
To assign a OpenStack networks to server NICs, using Fuel UI:
1. Click **Add Nodes**.
2. Select the role for this host.

2
pages/pre-install-guide/0060-quick-install-fuel.rst
View File

@ -52,7 +52,7 @@ To install Fuel using the ISO image:
4. Click **Apply**.
14. Click **Deploy Changes**.
Depending on your environemnt deployment of Mirantis OpenStack may take
Depending on your environment deployment of Mirantis OpenStack may take
some time.
After you deployed Mirantis OpenStack, verify the configuration by

40
pages/pre-install-guide/0090-appendix.rst
View File

@ -9,7 +9,7 @@ As a model example, the following configuration is used:
**Hardware and environment:**
* 7 servers with two 1Gb/s ethernet NIC and IPMI
* 7 servers with two 1Gb/s Ethernet NIC and IPMI
* 1 Cisco Catalyst 2960G switch
* Independent out of band management network for IPMI
* Connection to the Internet or/and DC network via a router called
@ -26,7 +26,7 @@ As a model example, the following configuration is used:
**Network configuration plan:**
* Public network 172.16.1.0/24
* Floting network 172.16.0.0/24 in VLAN 100
* Floating network 172.16.0.0/24 in VLAN 100
* Management network 192.168.0.0/24 in VLAN 101
* Storage network 192.168.1.0/24 in VLAN 102
* Private (Fixed) network 10.0.0.0/24 in VLAN 103
@ -39,7 +39,7 @@ As a model example, the following configuration is used:
* DNS 10.20.0.1
.. note:: The Internet and rest of DC access is available through the Public
network (for Openstack Nodes) and Administrative network (Fuel server)
network (for OpenStack Nodes) and Administrative network (Fuel server)
From the server node side, ports with the following VLAN IDs for
networks are used:
@ -92,23 +92,22 @@ assignment.
+--------+-------------------+--------+-----------+-------------------------+
Connect the cable servers to the switch as in the diagram below:
Connect the servers to the switch as in the diagram below:
.. image:: /_images/preinstall_d_switch_connect.jpg
:align: center
The following diagram describes network for this environment.
The following diagram describes the network topology for this environment.
.. image:: /_images/preinstall_d_logic_network.jpg
:align: center
To deploy Mirantis OpenStack, use the following switch
configuration.
Switch configuration (Cisco Catalyst 2960G)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
Use the following configuration to deploy Mirantis OpenStack using a Cisco
Catalyst 2960G network switch.::
service timestamps debug datetime msec localtime show-timezone
service timestamps log datetime msec localtime show-timezone
@ -152,13 +151,13 @@ Switch configuration (Cisco Catalyst 2960G)
name Admin
!
interface GigabitEthernet0/1
description Fule Node eth0
description Fuel Node eth0
switchport access vlan 104
switchport mode access
spanning-tree portfast
!
interface GigabitEthernet0/2
description Fule Node eth1 (optional to have direct access to Public net)
description Fuel Node eth1 (optional to have direct access to Public net)
switchport access vlan 100
switchport mode access
spanning-tree portfast
@ -275,7 +274,8 @@ Switch configuration (Cisco Catalyst 2960G)
Switch configuration (Juniper EX4200)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
Use the following configuration to deploy Mirantis OpenStack using
Juniper EX4200 network switch.::
system {
host-name OpenStack_sw1;
@ -296,7 +296,7 @@ Switch configuration (Juniper EX4200)
interfaces {
ge-0/0/0 {
description Fule Node eth0;
description Fuel Node eth0;
unit 0 {
family ethernet-switching {
port-mode access;
@ -307,7 +307,7 @@ Switch configuration (Juniper EX4200)
}
}
ge-0/0/1 {
description Fule Node eth1 (optional to have direct access to Public
description Fuel Node eth1 (optional to have direct access to Public
net);
unit 0 {
family ethernet-switching {
@ -552,7 +552,7 @@ As a model example, the following configuration is used:
**Network Configuration Plan:**
* Floating/Public network 172.16.0.0/24 in VLAN 100 (unttaged on
* Floating/Public network 172.16.0.0/24 in VLAN 100 (untagged on
servers)
* Floating IP range 172.16.0.130 - 254
* Internal network (private) 192.168.111.0/24
@ -569,7 +569,7 @@ As a model example, the following configuration is used:
* Default gateway: 10.20.0.1
* DNS: 10.20.0.1
.. note:: The Internet and rest of DC access via Public network (for Openstack
.. note:: The Internet and rest of DC access via Public network (for OpenStack
Nodes) and Administrative network (Fuel server).
From server side, ports with following VLAN IDs are used:
@ -623,7 +623,7 @@ The following table describes port configuration for this deployment.
Switch configuration (Cisco Catalyst 2960G)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use the following configuration to deploy Mirantis OpenStack using Cisco
Use the following configuration to deploy Mirantis OpenStack using a Cisco
Catalyst 2960G network switch.
::
@ -668,13 +668,13 @@ Catalyst 2960G network switch.
name Admin
!
interface GigabitEthernet0/1
description Fule Node eth0
description Fuel Node eth0
switchport access vlan 103
switchport mode access
spanning-tree portfast
!
interface GigabitEthernet0/2
description Fule Node eth1 (optional to have direct access to Public net)
description Fuel Node eth1 (optional to have direct access to Public net)
switchport access vlan 100
switchport mode access
spanning-tree portfast
@ -820,7 +820,7 @@ Juniper EX4200 network switch.
interfaces {
ge-0/0/0 {
description Fule Node eth0;
description Fuel Node eth0;
unit 0 {
family ethernet-switching {
port-mode access;
@ -831,7 +831,7 @@ Juniper EX4200 network switch.
}
}
ge-0/0/1 {
description Fule Node eth1 (optional to have direct access to Public
description Fuel Node eth1 (optional to have direct access to Public
net);
unit 0 {
family ethernet-switching {

6
pages/pre-install-guide/0091-glossary.rst
View File

@ -3,14 +3,14 @@ Dictionary of terms used in this document
* **Tagged port** 802.1q frames from a switch to a server network card
* **Native VLAN** An untagged VLAN on a tagged port
* **Mirantis OpenStack** Hardened Openstack distribution plus additional
* **Mirantis OpenStack** Hardened OpenStack distribution plus additional
services for high availability deployed by Fuel
* **Fuel server** A server with the Mirantis Fuel application installed
- also commonly referred to as the Fuel Master Node
* **Node server** A server that will be used as a node within an
OpenStack environment
* **NIC** Network Interface Card (physical ethernet port)
* **NIC** Network Interface Card (physical Ethernet port)
* **STP** Spanning Tree Protocol
* **L2 network** A separate Layer 2 network (VLAN) as a singlebroadcast domain
* **L2 network** A separate Layer 2 network (VLAN) as a single broadcast domain
* **OVS** is an abbreviation for Open vSwitch, a production quality, multilayer- virtual switch licensed under the open source `Apache
2.0 <http://www.apache.org/licenses/LICENSE-2.0.html>`__  license.

4
pages/reference-architecture/0060-quantum-vs-nova-network.rst
View File

@ -72,8 +72,8 @@ It is important to note:
* if you use tagged networks for your configuration
and combine multiple networks onto one NIC, you should make the Public
network untagged on this NIC.
It is not a requirement, but best for access to the Openstack Dashboard
and public Openstack API.
It is not a requirement, but best for access to the OpenStack Dashboard
and public OpenStack API.
* Is a best if you place the Private, Admin, Public and Management networks on a
separate NIC to ensure that traffic is separated adequately.
* Admin and Private networks must be located together on separate NIC from the

4
pages/release-notes/v3-2-grizzly-full.rst
View File

@ -173,7 +173,7 @@ Inclusion of Inktank’s Ceph software-defined storage system in the
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
hardened packages and the ability to deploy Ceph via Fuel
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Included now in the Mirantis Openstack hardened packages is Inktank’s
Included now in the Mirantis OpenStack hardened packages is Inktank’s
Ceph software-defined storage system. Ceph can be used either as an
object storage option for Glance or as a block storage option for Cinder.
As you define an OpenStack environment through the Fuel UI, you may
@ -195,7 +195,7 @@ Inclusion of the OpenStack Savanna and Murano projects in the hardened
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
packages and the ability to deploy them via Fuel
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Savanna and Murano are related Openstack projects initially led by
Savanna and Murano are related OpenStack projects initially led by
Mirantis. Savanna enables on demand provisioning of Hadoop clusters
that can run on top of OpenStack. Savanna includes support for many
different distributions of Hadoop including Hortonworks, Cloudera and

2
pdf_install.rst
View File

@ -4,7 +4,7 @@
.. cssclass:: header-table
+-------------------------------------+-----------------------------------+
| Fuel for Openstack v3.2 | .. cssclass:: right|
| Fuel for OpenStack v3.2 | .. cssclass:: right|
| | |
| Installation Guide | ###Section### |
+-------------------------------------+-----------------------------------+

2
pdf_pre-install.rst
View File

@ -4,7 +4,7 @@
.. cssclass:: header-table
+-------------------------------------+-----------------------------------+
| Fuel for Openstack v3.2 | .. cssclass:: right|
| Fuel for OpenStack v3.2 | .. cssclass:: right|
| | |
| Pre-Installation Guide | ###Section### |
+-------------------------------------+-----------------------------------+

2
pdf_preinstall.rst
View File

@ -4,7 +4,7 @@
.. cssclass:: header-table
+-------------------------------------+-----------------------------------+
| Fuel for Openstack v3.2 | .. cssclass:: right|
| Fuel for OpenStack v3.2 | .. cssclass:: right|
| | |
| Pre-Installation Guide | ###Section### |
+-------------------------------------+-----------------------------------+

2
pdf_reference.rst
View File

@ -4,7 +4,7 @@
.. cssclass:: header-table
+-------------------------------------+-----------------------------------+
| Fuel for Openstack v3.2 | .. cssclass:: right|
| Fuel for OpenStack v3.2 | .. cssclass:: right|
| | |
| Reference Architecture | ###Section### |
+-------------------------------------+-----------------------------------+

2
pdf_user.rst
View File

@ -4,7 +4,7 @@
.. cssclass:: header-table
+-------------------------------------+-----------------------------------+
| Fuel for Openstack v3.2 | .. cssclass:: right|
| Fuel for OpenStack v3.2 | .. cssclass:: right|
| | |
| User Guide | ###Section### |
+-------------------------------------+-----------------------------------+

2
relnotes/index.rst
View File

@ -3,7 +3,7 @@
.. cssclass:: header-table
+-------------------------------------+-----------------------------------+
| Fuel 3.2 for Openstack | .. cssclass:: right|
| Fuel 3.2 for OpenStack | .. cssclass:: right|
| | |
| | Release Notes |
+-------------------------------------+-----------------------------------+