starlingx
/
docs
Code Issues Proposed changes

Installation Guides: General edit. 

Edits to try and conform to OpenStack writing standards.
I corrected all areas of the files.

Change-Id: Ibf360d19d25ee91cb0071e14dbec719ce4a50ec1
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
This commit is contained in:
Scott Rifenbark 2019-03-26 15:41:02 -07:00 committed by Abraham Arce
parent c0d8d13557
commit b0e41814a2
7 changed files with 2265 additions and 2150 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

958
doc/source/deployment_guides/current/controller_storage.rst
View File

File diff suppressed because it is too large Load Diff

2
doc/source/deployment_guides/current/deployment_terminology.rst
View File

@ -64,7 +64,7 @@
and become the VM tenant networks.
Only compute type and all-in-one type nodes are required to be connected
to the data network(s); these node types require one or more interface(s)
to the data network(s). These node types require one or more interface(s)
on the data network(s).
**IPMI network**

1727
doc/source/deployment_guides/current/duplex.rst
View File

File diff suppressed because it is too large Load Diff

785
doc/source/deployment_guides/current/simplex.rst
View File

File diff suppressed because it is too large Load Diff

794
doc/source/deployment_guides/latest/dedicated_storage/index.rst
View File

File diff suppressed because it is too large Load Diff

76
doc/source/installation_guide/latest/index.rst
View File

@ -11,11 +11,11 @@ If this is not the installation guide you want to use, see the
Introduction
------------
StarlingX may be installed in:
You can install StarlingX in the following:
- **Bare metal**: Real deployments of StarlingX are only supported on
physical servers.
- **Virtual environment**: It should only be used for evaluation or
- **Virtual environment**: Only used for evaluation or
development purposes.
StarlingX installed in virtual environments has two options:
@ -34,11 +34,11 @@ Bare metal
**********
The minimum requirements for the physical servers where StarlingX might
be deployed, include:
be deployed include:
- **Controller hosts**
- Minimum processor is:
- Minimum processor:
- Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8
cores/socket
@ -46,16 +46,16 @@ be deployed, include:
- Minimum memory: 64 GB
- Hard drives:
- Primary hard drive, minimum 500 GB for OS and system databases.
- Secondary hard drive, minimum 500 GB for persistent VM storage.
- Primary hard drive with a minimum 500 GB for OS and system databases.
- Secondary hard drive with a minimum 500 GB for persistent VM storage.
- 2 physical Ethernet interfaces: OAM and MGMT network.
- Two physical Ethernet interfaces: OAM and MGMT network.
- USB boot support.
- PXE boot support.
- **Storage hosts**
- Minimum processor is:
- Minimum processor:
- Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8
cores/socket.
@ -63,16 +63,16 @@ be deployed, include:
- Minimum memory: 64 GB.
- Hard drives:
- Primary hard drive, minimum 500 GB for OS.
- 1 or more additional hard drives for CEPH OSD storage, and
- Optionally 1 or more SSD or NVMe drives for CEPH journals.
- Primary hard drive with a minimum 500 GB for OS.
- One or more additional hard drives for CEPH OSD storage.
- Optionally, one or more SSD or NVMe drives for CEPH journals.
- 1 physical Ethernet interface: MGMT network
- One physical Ethernet interface: MGMT network
- PXE boot support.
- **Compute hosts**
- Minimum processor is:
- Minimum processor:
- Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8
cores/socket.
@ -80,16 +80,16 @@ be deployed, include:
- Minimum memory: 32 GB.
- Hard drives:
- Primary hard drive, minimum 500 GB for OS.
- 1 or more additional hard drives for ephemeral VM storage.
- Primary hard drive with a minimum 500 GB for OS.
- One or more additional hard drives for ephemeral VM storage.
- 2 or more physical Ethernet interfaces: MGMT network and 1 or more
- Two or more physical Ethernet interfaces: MGMT network and one or more
provider networks.
- PXE boot support.
- **All-In-One Simplex or Duplex, controller + compute hosts**
- Minimum processor is:
- Minimum processor:
- Typical hardware form factor:
@ -101,8 +101,8 @@ be deployed, include:
- Minimum memory: 64 GB.
- Hard drives:
- Primary hard drive, minimum 500 GB SDD or NVMe.
- 0 or more 500 GB disks (min. 10K RPM).
- Primary hard drive with a minimum 500 GB SDD or NVMe.
- Zero or more 500 GB disks (min. 10K RPM).
- Network ports:
@ -145,8 +145,8 @@ installation:
Virtual environment
*******************
The recommended minimum requirements for the workstation, hosting the
virtual machine(s) where StarlingX will be deployed, include:
The recommended minimum requirements for the workstation that hosts the
virtual machine(s) where StarlingX is deployed includes the following:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Virtual machine requirements
@ -184,23 +184,27 @@ have a working proof of concept virtual machine environment.
Hardware requirements
^^^^^^^^^^^^^^^^^^^^^
<<<<<<< HEAD
Suggested workstation resources are a computer with:
=======
A workstation computer with the following:
>>>>>>> 88a4c36... Installation Guides: General edit.
- Processor: x86_64 only supported architecture with BIOS enabled
hardware virtualization extensions
- Cores: 8 (4 with careful monitoring of cpu load)
- Memory: At least 32GB RAM
- Hard Disk: 500GB HDD
- Cores: 8 (4 with careful monitoring of CPU load)
- Memory: Minimum 32 GB RAM
- Hard Disk: 500 GB HDD
- Network: Two network adapters with active Internet connection
^^^^^^^^^^^^^^^^^^^^^
Software requirements
^^^^^^^^^^^^^^^^^^^^^
A workstation computer with:
A workstation computer with the following:
- Operating System: Freshly installed Ubuntu 16.04 LTS 64-bit
- Proxy settings configured (if applies)
- Newly installed Ubuntu 16.04 LTS 64-bit operating system
- If applicable, proxy settings
- Git
- KVM/VirtManager
- Libvirt library
@ -212,14 +216,14 @@ A workstation computer with:
Deployment environment setup
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This section describes how to set up the workstation computer which will
host the virtual machine(s) where StarlingX will be deployed.
This section describes how to set up the workstation computer that
hosts the virtual machine or machine where StarlingX is deployed.
''''''''''''''''''''''''''''''
Updating your operating system
''''''''''''''''''''''''''''''
Before proceeding with the build, ensure your OS is up to date. You’ll
Before proceeding with the build, ensure your OS is current. You will
first need to update the local database list of available packages:
::
@ -230,8 +234,8 @@ first need to update the local database list of available packages:
Install stx-tools project
'''''''''''''''''''''''''
Clone the stx-tools project. Usually you’ll want to clone it under your
user’s home directory.
Clone the stx-tools project. Usually, you want to clone the
stx-tools repository under your user’s home directory.
::
@ -257,11 +261,11 @@ Install the required packages:
$ bash install_packages.sh
''''''''''''''''''
Disabling firewall
''''''''''''''''''
''''''''''''''''''''''
Disabling the firewall
''''''''''''''''''''''
Unload firewall and disable firewall on boot:
Unload the firewall and disable it during boot:
::

73
doc/source/installation_guide/latest/installation_libvirt_qemu.rst
View File

@ -8,23 +8,23 @@ Installation for StarlingX stx.2019.05 using Libvirt/QEMU virtualization.
Hardware requirements
---------------------
A workstation computer with:
A workstation computer with the following:
- Processor: x86_64 only supported architecture with BIOS enabled
- Processor: x86_64 only supported architecture with BIOS-enabled
hardware virtualization extensions
- Memory: At least 32GB RAM
- Hard disk: 500GB HDD
- Memory: Minimum 32 GB RAM
- Hard disk: 500 GB HDD
- Network: One network adapter with active Internet connection
---------------------
Software requirements
---------------------
A workstation computer with:
A workstation computer with the following:
- Operating system: This process is known to work on Ubuntu 16.04 and
is likely to work on other Linux OS's with some appropriate adjustments.
- Proxy settings configured (if applies)
is likely to work on other Linux distributions with some appropriate adjustments.
- If applicable, proxy settings
- Git
- KVM/VirtManager
- Libvirt library
@ -41,10 +41,10 @@ Configuration
*************
These scripts are configured using environment variables that all have
built-in defaults. On shared systems you probably do not want to use the
defaults. The simplest way to handle this is to keep an rc file that can
be sourced into an interactive shell that configures everything. Here's
an example called stxcloud.rc:
built-in defaults. On shared systems, you probably do not want to use the
defaults. The easiest way to handle this is to keep an rc file that can
be sourced into an interactive shell that configures everything. Following
is an example called stxcloud.rc:
::
@ -58,7 +58,7 @@ an example called stxcloud.rc:
export EXTERNAL_IP=192.168.20.1/24
This rc file shows the defaults baked into the scripts:
This rc file shows the defaults as part of the scripts:
::
@ -103,19 +103,20 @@ Installing requirements and dependencies
****************************************
Install the required packages and configure QEMU. This only needs to be
done once per host. (NOTE: this script only knows about Ubuntu at this
time):
done once per host.
**NOTE:** At this time, the script only supports the Ubuntu distribution:
::
$SCRIPTS/install_packages.sh
******************
Disabling firewall
******************
**********************
Disabling the firewall
**********************
Unload firewall and disable firewall on boot:
Unload the firewall and disable it during boot:
::
@ -127,9 +128,10 @@ Unload firewall and disable firewall on boot:
Configure networks
******************
Configure the network bridges using setup_network.sh before doing
anything else. It will create 4 bridges named stxbr1, stxbr2, stxbr3 and
stxbr4. Set the BRIDGE_INTERFACE environment variable if you need to
Before doing anything else, configure the network bridges using
setup_network.sh. Configuration creates four bridges named stxbr1,
stxbr2, stxbr3 and stxbr4.
Set the BRIDGE_INTERFACE environment variable if you need to
change stxbr to something unique.
::
@ -137,11 +139,13 @@ change stxbr to something unique.
$SCRIPTS/setup_network.sh
The destroy_network.sh script does the reverse, and should not be used
lightly. It should also only be used after all of the VMs created below
The destroy_network.sh script does the reverse.
You should only use this script after all the VMs created below
have been destroyed.
There is also a script cleanup_network.sh that will remove networking
**WARNING:** Use the destroy_network.sh script cautiously.
There is also a script cleanup_network.sh that removes networking
configuration from libvirt.
*********************
@ -158,19 +162,22 @@ The script uses the cloud configuration with the -c option:
- controllerstorage
- dedicatedstorage
You need an ISO file for the installation, the script takes a file name
with the -i option:
You need an ISO file for the installation.
The script requires a file name with the -i option:
::
$SCRIPTS/setup_configuration.sh -c <cloud configuration> -i <starlingx iso image>
And the setup will begin. The scripts create one or more VMs and start
the boot of the first controller, named oddly enough \``controller-0``.
If you have Xwindows available you will get virt-manager running. If
not, Ctrl-C out of that attempt if it doesn't return to a shell prompt.
Then connect to the serial console:
Running the script causes setup to begin.
The script creates one or more VMs and boots the first controller,
which is named \``controller-0``.
If you have Xwindows available, virt-manager starts to run.
If you do not have Xwindows available and you do not have a shell prompt,
press CTRL-C to abandon the attempt.
From the shell prompt, connect to the serial console:
::
@ -190,8 +197,8 @@ Tear down the VMs using destroy_configuration.sh.
Continue
--------
Pick up the installation in one of the existing guides at the initializing
controller-0 step.
Use the appropriate installation guide and continue the installation
process from the "initializing controller-0" step.
- Standard controller