openstack/fuel-docs
Code Issues Proposed changes

Break big Fuel screens file into smaller files

Browse Source 
2000-install-boot.rst -- includes files in initialize-fuel subdirectory

3000-create-environment.rst -- includes files in create-environment subdirectory

4000-configure-environment -- includes files in configure-environment subdirectory and configure-environment/settings sub-subdirectory

5000-deploy-environment.rst -- includes files in stop_reset subdirectory

No content changes in this commit.

Change-Id: I812c88e250b182cf2cec95f443ef395493c3be0e
This commit is contained in:
Meg McRoberts
2014-06-18 11:14:23 -07:00
parent 52d0fb96f8
commit 67b19ecd33
25 changed files with 715 additions and 675 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
contents/contents-user.rst
View File

@@ -1,6 +1,9 @@
.. include:: /pages/user-guide/0070-introduction.rst
.. include:: /pages/user-guide/1500-confirm-hardware.rst
.. include:: /pages/user-guide/2000-deploy-new-environment.rst
.. include:: /pages/user-guide/2000-install-boot.rst
.. include:: /pages/user-guide/3000-create-environment.rst
.. include:: /pages/user-guide/4000-configure-environment.rst
.. include:: /pages/user-guide/5000-deploy-environment.rst
.. include:: /pages/user-guide/post-install-healthchecks.rst
.. include:: /pages/user-guide/7000-sahara-install.rst
.. include:: /pages/user-guide/vcenter.rst

674
pages/user-guide/2000-deploy-new-environment.rst
View File

@@ -1,674 +0,0 @@
.. _download-install-ug:
Download and Install Fuel
=========================
Mirantis provides the images you will use to
install Fuel and Mirantis OpenStack.
Download the Fuel image from the
`Mirantis web-site <http://software.mirantis.com/>`_.
Depending on the speed of your Internet connection,
this could take a half hour or more.
.. _create-media-ug:
Create the Installation Media
-----------------------------
You can download an ISO file and,
for many modern servers,
use a remote control utility such as
`ipmitool <http://sourceforge.net/projects/ipmitool/>`_,
HP iLO, or Dell iDRAC
to mount the ISO image directly
to the server's virtual DVD drive.
For a bare-metal installation,
you can instead burn the ISO image to a DVD or
burn the IMG file to a USB drive,
then use that media to install the software.
.. note:: You can use the same ISO image
to install Fuel and Mirantis OpenStack
in VirtualBox.
In that case, copy the ISO file to the approriate directory
and boot directly from that disk file.
See the `Quick Start Guide <http://software.mirantis.com/quick-start/>`_.
and :ref:`virtualbox-top`.
Use any standard software to burn the ISO to a writeable DVD.
Some popular options:
- **Linux** --
`Brasero` and `Xfburn` are commonly pre-installed applications
- **Mac OS X** --
Open `Disk Utility` from `Applications > Utilities`,
drag the ISO into the disk list on the left side of the window and select it,
insert a blank DVD, and click `Burn`.
If you prefer a different utility,
check out the open source
`Burn <http://burn-osx.sourceforge.net/Pages/English/home.html>`_.
- **Windows** --
Use `ImgBurn <http://www.imgburn.com/>`_ or the
open source `InfraRecorder <http://infrarecorder.org/>`_
.. _initialize-fuel-ug:
.. _boot-fuel-ug:
Install Fuel Master Node
------------------------
Insert (or mount through IPMI) the media
you created in :ref:`download-install-ug`
on the server that will be your Fuel Master Node
and power the machine on,
just as you would for any operating system installation.
Set the boot order for the system
with the installation media as the first device.
Or you can set the hard drive as the first device,
then select the location of the media that contains
the installation file to install the software.
The following screen appears.
.. image:: /_images/user_screen_shots/fuel_starts.png
:width: 50%
If necessary, you can modify the boot settings from this screen;
press the "Tab" key to display the **grub** command line
and edit that line.
This allows you to configure the IP address,
default gateway, and DNS server for the Fuel Master Node.
.. include:: /pages/user-guide/initialize-fuel/0400-pxe-config.rst
.. include:: /pages/user-guide/initialize-fuel/0500-fuel-boot.rst
.. include:: /pages/user-guide/initialize-fuel/0600-boot-nodes.rst
.. raw:: pdf
PageBreak
.. _create-env-ug:
Create a new OpenStack environment
==================================
After you complete the steps in
:ref:`download-install-ug`,
the Fuel UI screen shows all your Slave nodes as "Unallocated nodes").
You can now create, configure, and deploy
your first OpenStack environment.
One Fuel Master can deploy and manage multiple OpenStack environments
but you must create each environment separately.
+----------------------------+-------------------------------------------+
| Step Description | Additional Information |
+============================+===========================================+
| Click on the "New" | See :ref:`start-create-env-ug` |
| OpenStack environment" | |
| icon to create a new | |
| environment. | |
+----------------------------+-------------------------------------------+
| Choose the name for your | See :ref:`name-distro-ug` |
| environment and choose the | |
| Operating System (distro) | |
+----------------------------+-------------------------------------------+
| Choose your Deployment | See :ref:`mode-ha-ug` |
| Mode (Multi-node HA or non | |
| HA). | |
+----------------------------+-------------------------------------------+
| Choose your | See :ref:`hypervisor-ug` |
| :ref:`hypervisor-term` | |
+----------------------------+-------------------------------------------+
| Select your network | See :ref:`choose-network-ug`. |
| service (Nova-network, | If you choose Nova-network, you can |
| Neutron with GRE | choose FlatDHCP or VLAN Manager later in |
| segmentation or Neutron | the **Network** settings tab. |
| with VLAN segmentation. | |
+----------------------------+-------------------------------------------+
| Select your storage | See :ref:`cinder-glance-backend-ug` |
| backends for Cinder and | |
| Glance. | |
+----------------------------+-------------------------------------------+
| Choose additional related | See :ref:`platform-services-ug` |
| projects. | |
+----------------------------+-------------------------------------------+
| Select Create and click on | See :ref:`deploy-ug` |
| the icon with your named | |
| environment. | |
+----------------------------+-------------------------------------------+
.. _start-create-env-ug:
Launch Wizard to Create New Environment
---------------------------------------
Follow the instructions in :ref:`boot-fuel-master-ug`
to log into the Fuel UI if you have not already done so.
The Fuel UI screen appears:
.. image:: /_images/user_screen_shots/create_new_environ.png
:width: 50%
Click on the "New OpenStack environment" icon
to launch the wizard that creates a new OpenStack environment.
If you are deploying a Mirantis OpenStack environment
that is integrated with VMware vSphere,
follow the instructions in :ref:`vcenter-deploy`.
.. _name-distro-ug:
Name Environment and Choose Distribution
----------------------------------------
When you click on the "New OpenStack Environment" icon
on the Fuel UI, the following screen is displayed:
.. image:: /_images/user_screen_shots/name_environ.png
:width: 50%
Give the environment a name
and select the Linux distribution from the drop-down list;
see :ref:`linux-distro-plan`.
This is the operating system that will be installed
on the Controller, Compute, and Storage nodes in the environment.
.. raw:: pdf
PageBreak
.. _mode-ha-ug:
High-availability (HA) or non-HA mode
-------------------------------------
.. image:: /_images/user_screen_shots/choose_deploy_mode.png
:width: 50%
All new deployments should use the Multi-node :ref:`ha-term` mode.
.. raw:: pdf
PageBreak
.. _hypervisor-ug:
Hypervisor
----------
.. image:: /_images/user_screen_shots/choose-hypervisor-ug.png
:width: 50%
Choose one of the following:
- :ref:`kvm-term` -- Choose this option for bare-metal installations.
- :ref:`qemu-term` -- Choose this option for VirtualBox installations.
- :ref:`vcenter-term` -- Choose this option if you have a vCenter environment
with ESXi servers to be used as hypervisors.
You must also :ref:`configure communication<vcenter-config-ug>`
with vCenter.
.. raw:: pdf
PageBreak
.. _choose-network-ug:
Network service
---------------
.. image:: /_images/user_screen_shots/network-services.png
:width: 50%
Four network topologies are supported;
see :ref:`net-topology-plan`.
You can choose either of the Neutron topologies on this screen.
If you choose Nova-network here,
you can choose between the FlatDHCP and VLAN topologies
on the Network Settings page.
.. raw:: pdf
PageBreak
.. _cinder-glance-backend-ug:
Storage backend for Cinder and Glance
----------------------------------------
.. image:: /_images/user_screen_shots/cinder-storage-backend.png
:width: 50%
Select the storage backend for :ref:`cinder-term`:
- If you select "Default" here,
then the Local Volumes over iSCSI are used as the backend for Cinder.
You must configure at least one node with the "cinder" role
on the :ref:`assign-roles-ug` screen.
Disk space for Cinder will be allocated automatically.
- If you select "Ceph",
you must assign at least two nodes as Ceph-OSD nodes
on the :ref:`assign-roles-ug` screen.
Select the storage backend for :ref:`glance-term`:
- If you select "Default" and are using the Multi-node HA mode,
Swift is used as a backend for Cinder
and is automatically installed on the Controller nodes.
- If you select "Default" and are using the Multi-node (no HA) mode,
local storage is used as the backend for Glance.
- If you select Ceph,
you must assign the Ceph-OSD role on at least two nodes
on the :ref:`assign-roles-ug` screen.
You can later change these settings
on the :ref:`settings-storage-ug` screen,
where you can also set the Ceph replication factor.
See :ref:`Storage-Architecture-arch` for more information
about Cinder, Glance, and Ceph.
.. raw:: pdf
PageBreak
.. _platform-services-ug:
Related projects
----------------
.. image:: /_images/user_screen_shots/platform_services.png
:width: 50%
Choose additional related projects
that should be included in your environment:
- For additional information about deploying :ref:`ceilometer-term`,
see :ref:`ceilometer-deployment-notes`.
- For additional information about deploying :ref:`sahara-term`,
see :ref:`sahara-install`.
- For additional information about deploying :ref:`murano-term`,
see :ref:`Murano-deployment-notes`.
Note that you can modify these choices later
on the :ref:`modify-services-ug` screen.
.. raw:: pdf
PageBreak
.. _deploy-ug:
Complete the creation of your environment
-----------------------------------------
.. image:: /_images/user_screen_shots/deploy_env.png
:width: 50%
Select "Create" and click on the icon for your named environment.
.. raw:: pdf
PageBreak
.. _configure-env-ug:
Configure your Environment
==========================
After you exit from the "Create a New OpenStack Environment" wizard,
Fuel displays a set of configuration tabs
that you use to finish configuring your environment.
+----------------------------+-------------------------------------------+
| Step Description | Additional Information |
+============================+===========================================+
| Assign a role or roles to | See :ref:`assign-roles-ug` |
| each node server. | |
+----------------------------+-------------------------------------------+
| Customize disk partitions | See :ref:`customize-partitions-ug` |
+----------------------------+-------------------------------------------+
| In **Network** tab, | See :ref:`network-settings-ug` |
| configure the network | |
| settings from the address | |
| plan prepared earlier. | |
+----------------------------+-------------------------------------------+
| Set up NIC bonding | See :ref:`nic-bonding-ui` |
| (optional) | |
+----------------------------+-------------------------------------------+
| Map logical networks to | See :ref:`map-logical-to-physical` |
| NICs | |
+----------------------------+-------------------------------------------+
| Click **Verify Networks** | See :ref:`verify-networks-ug` |
| to check and confirm the | |
| network configuration. | |
+----------------------------+-------------------------------------------+
| (Optional) In the | See :ref:`settings-ug` |
| **Settings** tab, you can | |
| configure or modify the | |
| options for Horizon | |
| access, scheduler type, | |
| logging, and other | |
| OpenStack options. | |
+----------------------------+-------------------------------------------+
| Click the **Deploy** | See :ref:`deploy-changes` |
| **Changes** button. | |
+----------------------------+-------------------------------------------+
| (Optional) Set up and test | See :ref:`sahara-install` |
| Sahara | |
+----------------------------+-------------------------------------------+
Each of these steps is discussed below in more detail.
If necessary, you can :ref:`stop deployment<Stop_Deployment>`
or :ref:`reset the environment<Reset_Environment>`.
.. raw:: pdf
PageBreak
.. _assign-roles-ug:
Assign a role or roles to each node server
------------------------------------------
.. image:: /_images/user_screen_shots/assign-roles1.png
:width: 50%
.. image:: /_images/user_screen_shots/assign-roles2.png
:width: 50%
For each role you want to assign,
drag it to the appropriate node
in the "Unallocated Nodes" list.
For more information, see:
- :ref:`nodes-roles-arch`
- :ref:`Storage-Architecture-arch`
- :ref:`mongodb-term`
.. _customize-partitions-ug:
Disk partitioning
-----------------
.. image:: /_images/user_screen_shots/partition-disks.png
:width: 80%
Note that the disk partitions can be customized
only after a role is assigned to the node.
.. raw:: pdf
PageBreak
.. _network-settings-ug:
Network settings
----------------
Use the network settings screens to notify Fuel
about the network hardware that is configured.
Different pages are used,
depending on the network topology you chose
on the :ref:`choose-network-ug` screen.
For more information,
see :ref:`public-floating-ips-arch`.
Neutron network settings
++++++++++++++++++++++++
These example screens are for a Neutron deployment,
which includes sections for setting the L2 and L3 configuration
that are not provided for Nova-network deployments.
.. image:: /_images/user_screen_shots/net-settings1.png
:width: 80%
.. image:: /_images/user_screen_shots/net-settings2.png
:width: 80%
.. image:: /_images/user_screen_shots/net-settings3.png
:width: 80%
.. raw:: pdf
PageBreak
Nova-network settings
++++++++++++++++++++++++
These example screens illustrate the Network Settings page
when using Nova-network:
.. image:: /_images/fuel-network-settings.png
:width: 80%
.. include:: /pages/user-guide/config-environment/3000-nic-bonding-ui.rst
.. include:: /pages/user-guide/config-environment/0220-map-logical-to-physical-nic.rst
.. raw:: pdf
PageBreak
.. _verify-networks-ug:
Verify Networks
---------------
When you have applied all your information to the "Network Settings" screen,
click the "Verify Networks" button at the bottom of the screen.
This checks and confirms the network configuration
The network check includes tests for connectivity between
nodes via configured VLANs on configured host interfaces.
Additionally, checks for an unexpected DHCP server are done
to ensure that outside DHCP servers will not interfere with deployment.
The image below shows a sample result of the check.
If there are errors, it is either in your configuration of interfaces
or possibly the VLAN tagging feature is disabled on your switch port.
.. image:: /_images/net_verify_failure.jpg
:width: 90%
Resolve any errors before attempting to deploy your environment.
.. raw:: pdf
PageBreak
.. _settings-ug:
Settings tab
------------
* Modify access permissions for Horizon
* Modify OpenStack Components to include
* Hypervisor type
* Scheduler driver
* Storage
.. _access-horizon-ug:
Access permissions for Horizon
++++++++++++++++++++++++++++++
.. image:: /_images/user_screen_shots/settings-access.png
:width: 80%
This section of the Settings screen allows you to modify
the user name, password, and tenant used
to access the Horizon dashboard.
.. raw:: pdf
PageBreak
.. _modify-services-ug:
Services included in the environment
+++++++++++++++++++++++++++++++++++++++++++
.. image:: /_images/user_screen_shots/settings-mod-services.png
:width: 50%
Use this screen to modify the services
you chose on the :ref:`platform-services-ug` screen
when you first created your environment.
.. raw:: pdf
PageBreak
.. _vcenter-config-ug:
vCenter
+++++++
If you selected vCenter as your :ref:`hypervisor<hypervisor-ug>`,
you must fill in this section
to configure communication with vCenter:
.. image:: /_images/user_screen_shots/settings-vcenter.png
:width: 50%
Common settings
+++++++++++++++
This section of the screen enables you to:
- Turn debug logging on/off
- Define Nova quotas
- Modify the Hypervisor choice you made when first creating your environment
- Choose whether to auto-assign floating IPs
- Choose the scheduler driver to use in the environment
- Select whether to use qcow format for images
- Select whether to start/restart guests when the host boots
- Set Public key for deployed nodes
.. raw:: pdf
PageBreak
.. _vlan-splinters-ug:
VLAN splinters
++++++++++++++
VLAN splinters are provided so that CentOS deployments
can support Neutron VLANS or GRE
(with VLAN tags on the management, storage, or public networks).
The kernel used for the CentOS version used with OpenStack
is based on a pre-3.3 kernel
and so has poor support for VLAN tagged packets
moving through :ref:`ovs-term` bridges.
Without VLAN splinters,
CentOS deployments may experience poor performance issues,
intermittent connectivity problems,
situations where one VLAN is working but others are not,
or a total failure to pass traffic.
Ubuntu deployments use a kernel that includes strong VLAN support
and so are not affected by these issues.
.. image:: /_images/user_screen_shots/settings-vlan-splinters.png
:width: 50%
You can select either the soft trunks or hard trunks mode:
* The **soft trunks mode** configures OVS to enable splinters
and attempts to automatically detect in-use VLANs.
This provides the least amount of performance overhead
but the traffic may not be passed onto the OVS bridge in some edge cases.
* The **hard trunks mode** also configures OVS to enable splinters
but uses an explicitly defined list of all VLANs across all interfaces.
This should prevent the occasional failures associated with the soft mode
but requires that corresponding tags be created on all of the interfaces.
This introduces additional performance overhead.
You should use fewer than 50 VLANs
if you run the Neutron VLAN mode and use the hard trunks mode.
.. raw:: pdf
PageBreak
.. raw:: pdf
PageBreak
.. _settings-storage-ug:
Storage
+++++++
.. image:: /_images/user_screen_shots/settings-storage.png
You can use this screen to modify the choices made
on the :ref:`cinder-glance-backend-ug` screen.
Be sure that you have assigned the appropriate roles
on the :ref:`assign-roles-ug` screen
to support the storage backends you select here.
For example, if you configure any Ceph storage options here,
you must configure an appropriate number of Ceph OSD nodes;
if you configure a Cinder LVM over iSCSI role here,
you must configure a Cinder LVM node.
.. raw:: pdf
PageBreak
.. _deploy-changes:
Deploy Changes
==============
When you have made all the configuration changes you want to make,
click the "Deploy Changes" button
to deploy the environment you have defined.
It can take fifteen minutes to an hour to deploy Mirantis OpenStack,
depending on the options chosen;
deployment times out at two hours.
You can monitor the progress by opening the **Nodes** tab
or by checking individual node logs in the **Logs** tab.
.. include:: /pages/user-guide/stop_reset/0200-stop-deploy-ui.rst
.. include:: /pages/user-guide/stop_reset/0500-reset-environment.rst

90
pages/user-guide/2000-install-boot.rst Normal file
View File

@@ -0,0 +1,90 @@
.. _download-install-ug:
Download and Install Fuel
=========================
Mirantis provides the images you will use to
install Fuel and Mirantis OpenStack.
Download the Fuel image from the
`Mirantis web-site <http://software.mirantis.com/>`_.
Depending on the speed of your Internet connection,
this could take a half hour or more.
.. _create-media-ug:
Create the Installation Media
-----------------------------
You can download an ISO file and,
for many modern servers,
use a remote control utility such as
`ipmitool <http://sourceforge.net/projects/ipmitool/>`_,
HP iLO, or Dell iDRAC
to mount the ISO image directly
to the server's virtual DVD drive.
For a bare-metal installation,
you can instead burn the ISO image to a DVD or
burn the IMG file to a USB drive,
then use that media to install the software.
.. note:: You can use the same ISO image
to install Fuel and Mirantis OpenStack
in VirtualBox.
In that case, copy the ISO file to the approriate directory
and boot directly from that disk file.
See the `Quick Start Guide <http://software.mirantis.com/quick-start/>`_.
and :ref:`virtualbox-top`.
Use any standard software to burn the ISO to a writeable DVD.
Some popular options:
- **Linux** --
`Brasero` and `Xfburn` are commonly pre-installed applications
- **Mac OS X** --
Open `Disk Utility` from `Applications > Utilities`,
drag the ISO into the disk list on the left side of the window and select it,
insert a blank DVD, and click `Burn`.
If you prefer a different utility,
check out the open source
`Burn <http://burn-osx.sourceforge.net/Pages/English/home.html>`_.
- **Windows** --
Use `ImgBurn <http://www.imgburn.com/>`_ or the
open source `InfraRecorder <http://infrarecorder.org/>`_
.. _initialize-fuel-ug:
.. _boot-fuel-ug:
Install Fuel Master Node
------------------------
Insert (or mount through IPMI) the media
you created in :ref:`download-install-ug`
on the server that will be your Fuel Master Node
and power the machine on,
just as you would for any operating system installation.
Set the boot order for the system
with the installation media as the first device.
Or you can set the hard drive as the first device,
then select the location of the media that contains
the installation file to install the software.
The following screen appears.
.. image:: /_images/user_screen_shots/fuel_starts.png
:width: 50%
If necessary, you can modify the boot settings from this screen;
press the "Tab" key to display the **grub** command line
and edit that line.
This allows you to configure the IP address,
default gateway, and DNS server for the Fuel Master Node.
.. include:: /pages/user-guide/initialize-fuel/0400-pxe-config.rst
.. include:: /pages/user-guide/initialize-fuel/0500-fuel-boot.rst
.. include:: /pages/user-guide/initialize-fuel/0600-boot-nodes.rst

65
pages/user-guide/3000-create-environment.rst Normal file
View File

@@ -0,0 +1,65 @@
.. raw:: pdf
PageBreak
.. _create-env-ug:
Create a new OpenStack environment
==================================
After you complete the steps in
:ref:`download-install-ug`,
the Fuel UI screen shows all your Slave nodes as "Unallocated nodes").
You can now create, configure, and deploy
your first OpenStack environment.
One Fuel Master can deploy and manage multiple OpenStack environments
but you must create each environment separately.
+----------------------------+-------------------------------------------+
| Step Description | Additional Information |
+============================+===========================================+
| Click on the "New" | See :ref:`start-create-env-ug` |
| OpenStack environment" | |
| icon to create a new | |
| environment. | |
+----------------------------+-------------------------------------------+
| Choose the name for your | See :ref:`name-distro-ug` |
| environment and choose the | |
| Operating System (distro) | |
+----------------------------+-------------------------------------------+
| Choose your Deployment | See :ref:`mode-ha-ug` |
| Mode (Multi-node HA or non | |
| HA). | |
+----------------------------+-------------------------------------------+
| Choose your | See :ref:`hypervisor-ug` |
| :ref:`hypervisor-term` | |
+----------------------------+-------------------------------------------+
| Select your network | See :ref:`choose-network-ug`. |
| service (Nova-network, | If you choose Nova-network, you can |
| Neutron with GRE | choose FlatDHCP or VLAN Manager later in |
| segmentation or Neutron | the **Network** settings tab. |
| with VLAN segmentation. | |
+----------------------------+-------------------------------------------+
| Select your storage | See :ref:`cinder-glance-backend-ug` |
| backends for Cinder and | |
| Glance. | |
+----------------------------+-------------------------------------------+
| Choose additional related | See :ref:`platform-services-ug` |
| projects. | |
+----------------------------+-------------------------------------------+
| Select Create and click on | See :ref:`deploy-ug` |
| the icon with your named | |
| environment. | |
+----------------------------+-------------------------------------------+
.. include:: /pages/user-guide/create-environment/1000-start-create-env.rst
.. include:: /pages/user-guide/create-environment/1500-name-distro.rst
.. include:: /pages/user-guide/create-environment/2000-mode-ha.rst
.. include:: /pages/user-guide/create-environment/2500-hypervisor.rst
.. include:: /pages/user-guide/create-environment/3000-choose-network.rst
.. include:: /pages/user-guide/create-environment/3500-cinder-glance-backend.rst
.. include:: /pages/user-guide/create-environment/4000-platform-services.rst
.. include:: /pages/user-guide/create-environment/5000-deploy.rst

70
pages/user-guide/4000-configure-environment.rst Normal file
View File

@@ -0,0 +1,70 @@
.. raw:: pdf
PageBreak
.. _configure-env-ug:
Configure your Environment
==========================
After you exit from the "Create a New OpenStack Environment" wizard,
Fuel displays a set of configuration tabs
that you use to finish configuring your environment.
+----------------------------+-------------------------------------------+
| Step Description | Additional Information |
+============================+===========================================+
| Assign a role or roles to | See :ref:`assign-roles-ug` |
| each node server. | |
+----------------------------+-------------------------------------------+
| Customize disk partitions | See :ref:`customize-partitions-ug` |
+----------------------------+-------------------------------------------+
| In **Network** tab, | See :ref:`network-settings-ug` |
| configure the network | |
| settings from the address | |
| plan prepared earlier. | |
+----------------------------+-------------------------------------------+
| Set up NIC bonding | See :ref:`nic-bonding-ui` |
| (optional) | |
+----------------------------+-------------------------------------------+
| Map logical networks to | See :ref:`map-logical-to-physical` |
| NICs | |
+----------------------------+-------------------------------------------+
| Click **Verify Networks** | See :ref:`verify-networks-ug` |
| to check and confirm the | |
| network configuration. | |
+----------------------------+-------------------------------------------+
| (Optional) In the | See :ref:`settings-ug` |
| **Settings** tab, you can | |
| configure or modify the | |
| options for Horizon | |
| access, scheduler type, | |
| logging, and other | |
| OpenStack options. | |
+----------------------------+-------------------------------------------+
| Click the **Deploy** | See :ref:`deploy-changes` |
| **Changes** button. | |
+----------------------------+-------------------------------------------+
| (Optional) Set up and test | See :ref:`sahara-install` |
| Sahara | |
+----------------------------+-------------------------------------------+
Each of these steps is discussed below in more detail.
If necessary, you can :ref:`stop deployment<Stop_Deployment>`
or :ref:`reset the environment<Reset_Environment>`.
.. raw:: pdf
PageBreak
.. include:: /pages/user-guide/config-environment/1000-assign-roles.rst
.. include:: /pages/user-guide/config-environment/1200-customize-partitions.rst
.. include:: /pages/user-guide/config-environment/1400-network-settings.rst
.. include:: /pages/user-guide/config-environment/3000-nic-bonding-ui.rst
.. include:: /pages/user-guide/config-environment/0220-map-logical-to-physical-nic.rst
.. include:: /pages/user-guide/config-environment/3400-verify-networks.rst
.. include:: /pages/user-guide/config-environment/5000-settings.rst

22
pages/user-guide/5000-deploy-environment.rst Normal file
View File

@@ -0,0 +1,22 @@
.. raw:: pdf
PageBreak
.. _deploy-changes:
Deploy Changes
==============
When you have made all the configuration changes you want to make,
click the "Deploy Changes" button
to deploy the environment you have defined.
It can take fifteen minutes to an hour to deploy Mirantis OpenStack,
depending on the options chosen;
deployment times out at two hours.
You can monitor the progress by opening the **Nodes** tab
or by checking individual node logs in the **Logs** tab.
.. include:: /pages/user-guide/stop_reset/0200-stop-deploy-ui.rst
.. include:: /pages/user-guide/stop_reset/0500-reset-environment.rst

25
pages/user-guide/config-environment/1000-assign-roles.rst Normal file
View File

@@ -0,0 +1,25 @@
.. _assign-roles-ug:
Assign a role or roles to each node server
------------------------------------------
.. image:: /_images/user_screen_shots/assign-roles1.png
:width: 50%
.. image:: /_images/user_screen_shots/assign-roles2.png
:width: 50%
For each role you want to assign,
drag it to the appropriate node
in the "Unallocated Nodes" list.
For more information, see:
- :ref:`nodes-roles-arch`
- :ref:`Storage-Architecture-arch`
- :ref:`mongodb-term`

12
pages/user-guide/config-environment/1200-customize-partitions.rst Normal file
View File

@@ -0,0 +1,12 @@
.. _customize-partitions-ug:
Disk partitioning
-----------------
.. image:: /_images/user_screen_shots/partition-disks.png
:width: 80%
Note that the disk partitions can be customized
only after a role is assigned to the node.

50
pages/user-guide/config-environment/1400-network-settings.rst Normal file
View File

@@ -0,0 +1,50 @@
.. raw:: pdf
PageBreak
.. _network-settings-ug:
Network settings
----------------
Use the network settings screens to notify Fuel
about the network hardware that is configured.
Different pages are used,
depending on the network topology you chose
on the :ref:`choose-network-ug` screen.
For more information,
see :ref:`public-floating-ips-arch`.
Neutron network settings
++++++++++++++++++++++++
These example screens are for a Neutron deployment,
which includes sections for setting the L2 and L3 configuration
that are not provided for Nova-network deployments.
.. image:: /_images/user_screen_shots/net-settings1.png
:width: 80%
.. image:: /_images/user_screen_shots/net-settings2.png
:width: 80%
.. image:: /_images/user_screen_shots/net-settings3.png
:width: 80%
.. raw:: pdf
PageBreak
Nova-network settings
++++++++++++++++++++++++
These example screens illustrate the Network Settings page
when using Nova-network:
.. image:: /_images/fuel-network-settings.png
:width: 80%

28
pages/user-guide/config-environment/3400-verify-networks.rst Normal file
View File

@@ -0,0 +1,28 @@
.. raw:: pdf
PageBreak
.. _verify-networks-ug:
Verify Networks
---------------
When you have applied all your information to the "Network Settings" screen,
click the "Verify Networks" button at the bottom of the screen.
This checks and confirms the network configuration
The network check includes tests for connectivity between
nodes via configured VLANs on configured host interfaces.
Additionally, checks for an unexpected DHCP server are done
to ensure that outside DHCP servers will not interfere with deployment.
The image below shows a sample result of the check.
If there are errors, it is either in your configuration of interfaces
or possibly the VLAN tagging feature is disabled on your switch port.
.. image:: /_images/net_verify_failure.jpg
:width: 90%
Resolve any errors before attempting to deploy your environment.

27
pages/user-guide/config-environment/5000-settings.rst Normal file
View File

@@ -0,0 +1,27 @@
.. raw:: pdf
PageBreak
.. _settings-ug:
Settings tab
------------
* Modify access permissions for Horizon
* Modify OpenStack Components to include
* Hypervisor type
* Scheduler driver
* Storage
.. include:: /pages/user-guide/config-environment/settings/1000-access-horizon.rst
.. include:: /pages/user-guide/config-environment/settings/1500-modify-services.rst
.. include:: /pages/user-guide/config-environment/settings/2000-vcenter-config.rst
.. include:: /pages/user-guide/config-environment/settings/2500-common-settings.rst
.. include:: /pages/user-guide/config-environment/settings/3500-vlan-splinters.rst
.. include:: /pages/user-guide/config-environment/settings/4000-settings-storage.rst

14
pages/user-guide/config-environment/settings/1000-access-horizon.rst Normal file
View File

@@ -0,0 +1,14 @@
.. _access-horizon-ug:
Access permissions for Horizon
++++++++++++++++++++++++++++++
.. image:: /_images/user_screen_shots/settings-access.png
:width: 80%
This section of the Settings screen allows you to modify
the user name, password, and tenant used
to access the Horizon dashboard.

18
pages/user-guide/config-environment/settings/1500-modify-services.rst Normal file
View File

@@ -0,0 +1,18 @@
.. raw:: pdf
PageBreak
.. _modify-services-ug:
Services included in the environment
+++++++++++++++++++++++++++++++++++++++++++
.. image:: /_images/user_screen_shots/settings-mod-services.png
:width: 50%
Use this screen to modify the services
you chose on the :ref:`platform-services-ug` screen
when you first created your environment.

17
pages/user-guide/config-environment/settings/2000-vcenter-config.rst Normal file
View File

@@ -0,0 +1,17 @@
.. raw:: pdf
PageBreak
.. _vcenter-config-ug:
vCenter
+++++++
If you selected vCenter as your :ref:`hypervisor<hypervisor-ug>`,
you must fill in this section
to configure communication with vCenter:
.. image:: /_images/user_screen_shots/settings-vcenter.png
:width: 50%

21
pages/user-guide/config-environment/settings/2500-common-settings.rst Normal file
View File

@@ -0,0 +1,21 @@
.. raw:: pdf
PageBreak
.. _common-settings-ug:
Common settings
+++++++++++++++
This section of the screen enables you to:
- Turn debug logging on/off
- Define Nova quotas
- Modify the Hypervisor choice you made when first creating your environment
- Choose whether to auto-assign floating IPs
- Choose the scheduler driver to use in the environment
- Select whether to use qcow format for images
- Select whether to start/restart guests when the host boots
- Set Public key for deployed nodes

44
pages/user-guide/config-environment/settings/3500-vlan-splinters.rst Normal file
View File

@@ -0,0 +1,44 @@
.. raw:: pdf
PageBreak
.. _vlan-splinters-ug:
VLAN splinters
++++++++++++++
VLAN splinters are provided so that CentOS deployments
can support Neutron VLANS or GRE
(with VLAN tags on the management, storage, or public networks).
The kernel used for the CentOS version used with OpenStack
is based on a pre-3.3 kernel
and so has poor support for VLAN tagged packets
moving through :ref:`ovs-term` bridges.
Without VLAN splinters,
CentOS deployments may experience poor performance issues,
intermittent connectivity problems,
situations where one VLAN is working but others are not,
or a total failure to pass traffic.
Ubuntu deployments use a kernel that includes strong VLAN support
and so are not affected by these issues.
.. image:: /_images/user_screen_shots/settings-vlan-splinters.png
:width: 50%
You can select either the soft trunks or hard trunks mode:
* The **soft trunks mode** configures OVS to enable splinters
and attempts to automatically detect in-use VLANs.
This provides the least amount of performance overhead
but the traffic may not be passed onto the OVS bridge in some edge cases.
* The **hard trunks mode** also configures OVS to enable splinters
but uses an explicitly defined list of all VLANs across all interfaces.
This should prevent the occasional failures associated with the soft mode
but requires that corresponding tags be created on all of the interfaces.
This introduces additional performance overhead.
You should use fewer than 50 VLANs
if you run the Neutron VLAN mode and use the hard trunks mode.

22
pages/user-guide/config-environment/settings/4000-settings-storage.rst Normal file
View File

@@ -0,0 +1,22 @@
.. raw:: pdf
PageBreak
.. _settings-storage-ug:
Storage
+++++++
.. image:: /_images/user_screen_shots/settings-storage.png
You can use this screen to modify the choices made
on the :ref:`cinder-glance-backend-ug` screen.
Be sure that you have assigned the appropriate roles
on the :ref:`assign-roles-ug` screen
to support the storage backends you select here.
For example, if you configure any Ceph storage options here,
you must configure an appropriate number of Ceph OSD nodes;
if you configure a Cinder LVM over iSCSI role here,
you must configure a Cinder LVM node.

22
pages/user-guide/create-environment/1000-start-create-env.rst Normal file
View File

@@ -0,0 +1,22 @@
.. _start-create-env-ug:
Launch Wizard to Create New Environment
---------------------------------------
Follow the instructions in :ref:`boot-fuel-master-ug`
to log into the Fuel UI if you have not already done so.
The Fuel UI screen appears:
.. image:: /_images/user_screen_shots/create_new_environ.png
:width: 50%
Click on the "New OpenStack environment" icon
to launch the wizard that creates a new OpenStack environment.
If you are deploying a Mirantis OpenStack environment
that is integrated with VMware vSphere,
follow the instructions in :ref:`vcenter-deploy`.

18
pages/user-guide/create-environment/1500-name-distro.rst Normal file
View File

@@ -0,0 +1,18 @@
.. _name-distro-ug:
Name Environment and Choose Distribution
----------------------------------------
When you click on the "New OpenStack Environment" icon
on the Fuel UI, the following screen is displayed:
.. image:: /_images/user_screen_shots/name_environ.png
:width: 50%
Give the environment a name
and select the Linux distribution from the drop-down list;
see :ref:`linux-distro-plan`.
This is the operating system that will be installed
on the Controller, Compute, and Storage nodes in the environment.

16
pages/user-guide/create-environment/2000-mode-ha.rst Normal file
View File

@@ -0,0 +1,16 @@
.. raw:: pdf
PageBreak
.. _mode-ha-ug:
High-availability (HA) or non-HA mode
-------------------------------------
.. image:: /_images/user_screen_shots/choose_deploy_mode.png
:width: 50%
All new deployments should use the Multi-node :ref:`ha-term` mode.

26
pages/user-guide/create-environment/2500-hypervisor.rst Normal file
View File

@@ -0,0 +1,26 @@
.. raw:: pdf
PageBreak
.. _hypervisor-ug:
Hypervisor
----------
.. image:: /_images/user_screen_shots/choose-hypervisor-ug.png
:width: 50%
Choose one of the following:
- :ref:`kvm-term` -- Choose this option for bare-metal installations.
- :ref:`qemu-term` -- Choose this option for VirtualBox installations.
- :ref:`vcenter-term` -- Choose this option if you have a vCenter environment
with ESXi servers to be used as hypervisors.
You must also :ref:`configure communication<vcenter-config-ug>`
with vCenter.

21
pages/user-guide/create-environment/3000-choose-network.rst Normal file
View File

@@ -0,0 +1,21 @@
.. raw:: pdf
PageBreak
.. _choose-network-ug:
Network service
---------------
.. image:: /_images/user_screen_shots/network-services.png
:width: 50%
Four network topologies are supported;
see :ref:`net-topology-plan`.
You can choose either of the Neutron topologies on this screen.
If you choose Nova-network here,
you can choose between the FlatDHCP and VLAN topologies
on the Network Settings page.

42
pages/user-guide/create-environment/3500-cinder-glance-backend.rst Normal file
View File

@@ -0,0 +1,42 @@
.. raw:: pdf
PageBreak
.. _cinder-glance-backend-ug:
Storage backend for Cinder and Glance
----------------------------------------
.. image:: /_images/user_screen_shots/cinder-storage-backend.png
:width: 50%
Select the storage backend for :ref:`cinder-term`:
- If you select "Default" here,
then the Local Volumes over iSCSI are used as the backend for Cinder.
You must configure at least one node with the "cinder" role
on the :ref:`assign-roles-ug` screen.
Disk space for Cinder will be allocated automatically.
- If you select "Ceph",
you must assign at least two nodes as Ceph-OSD nodes
on the :ref:`assign-roles-ug` screen.
Select the storage backend for :ref:`glance-term`:
- If you select "Default" and are using the Multi-node HA mode,
Swift is used as a backend for Cinder
and is automatically installed on the Controller nodes.
- If you select "Default" and are using the Multi-node (no HA) mode,
local storage is used as the backend for Glance.
- If you select Ceph,
you must assign the Ceph-OSD role on at least two nodes
on the :ref:`assign-roles-ug` screen.
You can later change these settings
on the :ref:`settings-storage-ug` screen,
where you can also set the Ceph replication factor.
See :ref:`Storage-Architecture-arch` for more information
about Cinder, Glance, and Ceph.

25
pages/user-guide/create-environment/4000-platform-services.rst Normal file
View File

@@ -0,0 +1,25 @@
.. raw:: pdf
PageBreak
.. _platform-services-ug:
Related projects
----------------
.. image:: /_images/user_screen_shots/platform_services.png
:width: 50%
Choose additional related projects
that should be included in your environment:
- For additional information about deploying :ref:`ceilometer-term`,
see :ref:`ceilometer-deployment-notes`.
- For additional information about deploying :ref:`sahara-term`,
see :ref:`sahara-install`.
- For additional information about deploying :ref:`murano-term`,
see :ref:`Murano-deployment-notes`.
Note that you can modify these choices later
on the :ref:`modify-services-ug` screen.

16
pages/user-guide/create-environment/5000-deploy.rst Normal file
View File

@@ -0,0 +1,16 @@
.. raw:: pdf
PageBreak
.. _deploy-ug:
Complete the creation of your environment
-----------------------------------------
.. image:: /_images/user_screen_shots/deploy_env.png
:width: 50%
Select "Create" and click on the icon for your named environment.