starlingx
/
docs
Code Issues Proposed changes

Installation: Diagram Description Simplex 

We need a diagram, description of major components and
why-I-would-use-this for each Deployment option:

  - Simplex Deployment Diagram
  - Simplex Deployment Description

Story: 2004780
Task: 29219

Depends-On: https://review.openstack.org/#/c/634080

Change-Id: Ib1076f904150ce5cec054e2b187c7f9224eb1909
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
Greg Waines 2019-01-31 04:04:32 -06:00 committed by Abraham Arce
parent a2b57191d4
commit 6a1eea39c3
2 changed files with 64 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/source/installation_guide/figures/starlingx-deployment-options-simplex.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 79 KiB

123
doc/source/installation_guide/simplex.rst
View File

@ -1,28 +1,47 @@
.. _simplex:
========================================================
StarlingX/Installation Guide Virtual Environment/Simplex
========================================================
===================================
All-In-One Simplex Deployment Guide
===================================
.. contents::
:local:
:depth: 1
----------------------
Deployment Terminology
Deployment Description
----------------------
.. include:: deployment_terminology.rst
:start-after: incl-simplex-deployment-terminology:
:end-before: incl-simplex-deployment-terminology-end:
The All-In-One Simplex deployment option provides all three Cloud Functions
(Controller, Compute, and Storage) on a single physical server. With these Cloud
Functions, multiple application types can be deployed and consolidated onto a
single physical server. For example, with a All-In-One Simplex deployment you
can:
.. include:: deployment_terminology.rst
:start-after: incl-standard-controller-deployment-terminology:
:end-before: incl-standard-controller-deployment-terminology-end:
- Consolidate legacy applications that must run standalone on a server by using
multiple virtual machines on a single physical server.
- Consolidate legacy applications that run on different operating systems or
different distributions of operating systems by using multiple virtual
machines on a single physical server.
.. include:: deployment_terminology.rst
:start-after: incl-common-deployment-terminology:
:end-before: incl-common-deployment-terminology-end:
Only a small amount of Cloud Processing / Storage power is required with an
All-In-One Simplex deployment.
-----------------
Preparing Servers
-----------------
.. figure:: figures/starlingx-deployment-options-simplex.png
:scale: 50%
:alt: All-In-One Simplex Deployment Configuration
*All-In-One Simplex Deployment Configuration*
An All-In-One Simplex deployment provides no protection against an overall
server hardware fault. Protection against overall server hardware fault is
either not required, or done at a higher level. Hardware component protection
could be enabled if, for example, an HW RAID or 2x Port LAG is used in the
deployment.
--------------------------------------
Preparing an All-In-One Simplex Server
--------------------------------------
**********
Bare Metal
@ -37,9 +56,9 @@ Hardware Requirements
^^^^^^^^^^^^^^^^^^^^^
The recommended minimum requirements for the physical servers where
StarlingX Simplex will be deployed, include:
All-In-One Simplex will be deployed are:
- ‘Minimum’ Processor:
- Minimum Processor:
- Typical Hardware Form Factor:
@ -68,7 +87,7 @@ StarlingX Simplex will be deployed, include:
- Network Ports
**NOTE:** Simplex configuration requires one or more data ports.
**NOTE:** All-In-One Simplex configuration requires one or more data ports.
This configuration does not require a management port.
- OAM: 10GE
@ -85,21 +104,19 @@ Management networks:
$ bash setup_network.sh
Building XML for definition of virtual servers:
::
$ bash setup_configuration.sh -c simplex -i <starlingx iso image>
The default XML server definition created by the previous script is:
- simplex-controller-0
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Powering Up a Virtual Server
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^
Power Up a Virtual Server
^^^^^^^^^^^^^^^^^^^^^^^^^
To power up the virtual server, run the following command:
@ -113,9 +130,9 @@ e.g.
$ sudo virsh start simplex-controller-0
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Accessing Virtual Server Consoles
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Access a Virtual Server Console
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The XML for virtual servers in stx-tools repo, deployment/libvirt,
provides both graphical and text consoles.
@ -139,7 +156,7 @@ sequence which follows the boot device selection. One has a few seconds
to do this.
------------------------------
Controller-0 Host Installation
Installing the Controller Host
------------------------------
Installing controller-0 involves initializing a host with software and
@ -199,14 +216,12 @@ Enter a new password for the wrsroot account:
New password:
Enter the new password again to confirm it:
::
Retype new password:
Controller-0 is initialized with StarlingX, and is ready for
configuration.
@ -240,7 +255,6 @@ with no parameters:
Enter ! at any prompt to abort...
...
Select [y] for System Date and Time:
::
@ -250,7 +264,6 @@ Select [y] for System Date and Time:
Is the current date and time correct? [y/N]: y
For System mode choose "simplex":
::
@ -262,7 +275,6 @@ For System mode choose "simplex":
3) simplex - single node non-redundant configuration
System mode [duplex-direct]: 3
After System Date / Time and System mode:
::
@ -283,14 +295,13 @@ After System Date / Time and System mode:
Please complete any out of service commissioning steps with system
commands and unlock controller to proceed.
After config_controller bootstrap configuration, REST API, CLI and
Horizon interfaces are enabled on the controller-0 OAM IP Address. The
remaining installation instructions will use the CLI.
---------------------------
Controller-0 Host Provision
---------------------------
--------------------------------
Provisioning the Controller Host
--------------------------------
On Controller-0, acquire Keystone administrative privileges:
@ -298,7 +309,6 @@ On Controller-0, acquire Keystone administrative privileges:
controller-0:~$ source /etc/nova/openrc
*********************************************
Configuring Provider Networks at Installation
*********************************************
@ -310,7 +320,6 @@ Set up one provider network of the vlan type, named providernet-a:
[wrsroot@controller-0 ~(keystone_admin)]$ neutron providernet-create providernet-a --type=vlan
[wrsroot@controller-0 ~(keystone_admin)]$ neutron providernet-range-create --name providernet-a-range1 --range 100-400 providernet-a
*****************************************
Providing Data Interfaces on Controller-0
*****************************************
@ -330,7 +339,6 @@ List all interfaces
| f59b9469-7702-4b46-bad5-683b95f0a1cb | enp0s8 | platform |...| None | [u'enp0s8'] | [] | [] | MTU=1500 |..
+--------------------------------------+---------+----------+...+------+--------------+------+---------+------------+..
Configure the data interfaces
::
@ -362,7 +370,6 @@ Configure the data interfaces
| accelerated | [True] |
+------------------+--------------------------------------+
*************************************
Configuring Cinder on Controller Disk
*************************************
@ -388,7 +395,6 @@ physical disk
| | | | | | |...
+--------------------------------------+-----------+---------+---------+---------+------------+...
Create the 'cinder-volumes' local volume group
::
@ -412,7 +418,6 @@ Create the 'cinder-volumes' local volume group
| parameters | {u'lvm_type': u'thin'} |
+-----------------+--------------------------------------+
Create a disk partition to add to the volume group
::
@ -437,7 +442,6 @@ Create a disk partition to add to the volume group
| updated_at | None |
+-------------+--------------------------------------------------+
Wait for the new partition to be created (i.e. status=Ready)
::
@ -452,7 +456,6 @@ Wait for the new partition to be created (i.e. status=Ready)
| |...| |...| | | |
+--------------------------------------+...+------------+...+---------------------+----------+--------+
Add the partition to the volume group
::
@ -478,7 +481,6 @@ Add the partition to the volume group
| updated_at | None |
+--------------------------+--------------------------------------------------+
*********************************************
Adding an LVM Storage Backend at Installation
*********************************************
@ -497,7 +499,6 @@ Ensure requirements are met to add LVM storage
storage. Set the 'confirmed' field to execute this operation
for the lvm backend.
Add the LVM storage backend
::
@ -514,7 +515,6 @@ Add the LVM storage backend
| e2697426-2d79-4a83-beb7-2eafa9ceaee5 | lvm-store | lvm | configuring |...| cinder | {} |
+--------------------------------------+------------+---------+-------------+...+----------+--------------+
Wait for the LVM storage backend to be configured (i.e.
state=Configured)
@ -528,7 +528,6 @@ state=Configured)
| e2697426-2d79-4a83-beb7-2eafa9ceaee5 | lvm-store | lvm | configured | None | cinder | {} |
+--------------------------------------+------------+---------+------------+------+----------+--------------+
***********************************************
Configuring VM Local Storage on Controller Disk
***********************************************
@ -554,7 +553,6 @@ physical disk
| | | | | | |...
+--------------------------------------+-----------+---------+---------+---------+------------+...
Create the 'nova-local' volume group
::
@ -580,7 +578,6 @@ Create the 'nova-local' volume group
| parameters | {u'concurrent_disk_operations': 2, u'instance_backing': u'image'} |
+-----------------+-------------------------------------------------------------------+
Create a disk partition to add to the volume group
::
@ -605,7 +602,6 @@ Create a disk partition to add to the volume group
| updated_at | None |
+-------------+--------------------------------------------------+
Wait for the new partition to be created (i.e. status=Ready)
::
@ -620,7 +616,6 @@ Wait for the new partition to be created (i.e. status=Ready)
| |...| |...| | | |
+--------------------------------------+...+------------+...+---------------------+----------+--------+
Add the partition to the volume group
::
@ -646,7 +641,6 @@ Add the partition to the volume group
| updated_at | None |
+--------------------------+--------------------------------------------------+
**********************
Unlocking Controller-0
**********************
@ -658,7 +652,6 @@ Controller-1. Use the system host-unlock command:
[wrsroot@controller-0 ~(keystone_admin)]$ system host-unlock controller-0
The host is rebooted. During the reboot, the command line is
unavailable, and any ssh connections are dropped. To monitor the
progress of the reboot, use the controller-0 console.
@ -673,7 +666,6 @@ On Controller-0, acquire Keystone administrative privileges:
controller-0:~$ source /etc/nova/openrc
Verify that the controller-0 services are running:
::
@ -688,7 +680,6 @@ Verify that the controller-0 services are running:
...
+-----+-------------------------------+--------------+----------------+
Verify that controller-0 has controller and compute subfunctions
::
@ -696,7 +687,6 @@ Verify that controller-0 has controller and compute subfunctions
[wrsroot@controller-0 ~(keystone_admin)]$ system host-show 1 | grep subfunctions
| subfunctions | controller,compute |
Verify that controller-0 is unlocked, enabled, and available:
::
@ -708,7 +698,6 @@ Verify that controller-0 is unlocked, enabled, and available:
| 1 | controller-0 | controller | unlocked | enabled | available |
+----+--------------+-------------+----------------+-------------+--------------+
*****************
System Alarm List
*****************
@ -719,3 +708,19 @@ Your StarlingX deployment is now up and running with 1 Controller with Cinder St
and all OpenStack services up and running. You can now proceed with standard OpenStack
APIs, CLIs and/or Horizon to load Glance Images, configure Nova Flavors, configure
Neutron networks and launch Nova Virtual Machines.
----------------------
Deployment Terminology
----------------------
.. include:: deployment_terminology.rst
:start-after: incl-simplex-deployment-terminology:
:end-before: incl-simplex-deployment-terminology-end:
.. include:: deployment_terminology.rst
:start-after: incl-standard-controller-deployment-terminology:
:end-before: incl-standard-controller-deployment-terminology-end:
.. include:: deployment_terminology.rst
:start-after: incl-common-deployment-terminology:
:end-before: incl-common-deployment-terminology-end: