starlingx/docs
Code Issues Proposed changes

General clean up of presentation; migrate release notes from wiki

Browse Source 
- Landing page:
	- General clean up (org of page, improve wording, markdown clean up)
	- Replace Abstract with welcome text, move link to project spec to welcome.
	- Include ref to contribute guide in Contribute section
	- Remove "Contents" caption from toctree (so it wont render in side nav)
- Release notes page:
	- Remove "StarlingX" from page title.
	- Integrate wiki content from https://wiki.openstack.org/wiki/StarlingX/stx.2018.10_Release_Notes
        - Improve wording, link text
- API ref page: Update page title to "REST API Reference"
- All pages:
	- Capitalization corrections
	- Clean up section heading markdown for consistency
- libvert installation page:
	- corrected heading levels (I believe section headings got swapped so they weren't in the correct hierarchy)

Change-Id: I8b7a8cd143e335dd27cd2dc6241fd25a6374bd5d
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
Kristal Dale 2018-11-12 15:37:24 -08:00
parent f1cb8d026b
commit c92b00d074
11 changed files with 302 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/api-ref/index.rst
View File

@ -1,8 +1,8 @@
====================== ==================
stx-docs API Reference REST API Reference
====================== ==================
StarlingX Project API References: StarlingX project REST API references:
* `Bare Metal <stx-metal/index.html>`__ * `Bare Metal <stx-metal/index.html>`__
* `Configuration <stx-config/index.html>`__ * `Configuration <stx-config/index.html>`__
@ -11,7 +11,7 @@ StarlingX Project API References:
* `High Availability <stx-ha/index.html>`__ * `High Availability <stx-ha/index.html>`__
* `NFV <stx-nfv/index.html>`__ * `NFV <stx-nfv/index.html>`__
StarlingX also has API References for the modified OpenStack APIs: StarlingX also has API references for the modified OpenStack APIs:
* `Block Storage v2 <stx-docs/api-ref-blockstorage-v2-cgcs-ext.html>`__ * `Block Storage v2 <stx-docs/api-ref-blockstorage-v2-cgcs-ext.html>`__
* `Compute v2 <stx-docs/api-ref-compute-v2-cgcs-ext.html>`__ * `Compute v2 <stx-docs/api-ref-compute-v2-cgcs-ext.html>`__

7
doc/source/contributor/index.rst
View File

@ -1,8 +1,15 @@
.. _contribute:
========== ==========
Contribute Contribute
========== ==========
Please use the following guides when contributing to the StarlingX
documentation. Additional information about contributing to
OpenStack documentation can be found in the
`OpenStack API documentation guide`_.
.. _`OpenStack API documentation guide`: https://docs.openstack.org/doc-contrib-guide/api-guides.html
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

38
doc/source/developer_guide/index.rst
View File

@ -13,6 +13,7 @@ Requirements
The recommended minimum requirements include: The recommended minimum requirements include:
*********************
Hardware Requirements Hardware Requirements
********************* *********************
@ -23,6 +24,7 @@ A workstation computer with:
- Hard Disk: 500GB HDD - Hard Disk: 500GB HDD
- Network: Network adapter with active Internet connection - Network: Network adapter with active Internet connection
*********************
Software Requirements Software Requirements
********************* *********************
@ -49,6 +51,7 @@ build a StarlingX ISO image on the following Linux distribution:
- Ubuntu 16.04 LTS 64-bit - Ubuntu 16.04 LTS 64-bit
****************************
Update Your Operating System Update Your Operating System
**************************** ****************************
@ -59,9 +62,11 @@ first need to update the local database list of available packages:
$ sudo apt-get update $ sudo apt-get update
******************************************
Installation Requirements and Dependencies Installation Requirements and Dependencies
****************************************** ******************************************
^^^
Git Git
^^^ ^^^
@ -78,6 +83,7 @@ Git
$ git config --global user.name "Name LastName" $ git config --global user.name "Name LastName"
$ git config --global user.email "Email Address" $ git config --global user.email "Email Address"
^^^^^^^^^
Docker CE Docker CE
^^^^^^^^^ ^^^^^^^^^
@ -86,6 +92,7 @@ Docker CE
Ubuntu <https://docs.docker.com/install/linux/docker-ce/ubuntu/#os-requirements>`__ Ubuntu <https://docs.docker.com/install/linux/docker-ce/ubuntu/#os-requirements>`__
for more information. for more information.
^^^^^^^^^^^^^^^^^
Android Repo Tool Android Repo Tool
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^
@ -94,6 +101,7 @@ Android Repo Tool
Repo <https://source.android.com/setup/build/downloading#installing-repo>`__ Repo <https://source.android.com/setup/build/downloading#installing-repo>`__
to have Andriod Repo Tool installed. to have Andriod Repo Tool installed.
**********************
Install Public SSH Key Install Public SSH Key
********************** **********************
@ -107,7 +115,8 @@ Install Public SSH Key
- `Upload to - `Upload to
Gerrit <https://review.openstack.org/#/settings/ssh-keys>`__ Gerrit <https://review.openstack.org/#/settings/ssh-keys>`__
Install stx-tools project *************************
Install stx-tools Project
************************* *************************
#. Under your $HOME directory, clone the <stx-tools> project #. Under your $HOME directory, clone the <stx-tools> project
@ -117,6 +126,7 @@ Install stx-tools project
$ cd $HOME $ cd $HOME
$ git clone https://git.starlingx.io/stx-tools $ git clone https://git.starlingx.io/stx-tools
****************************
Create a Workspace Directory Create a Workspace Directory
**************************** ****************************
@ -128,17 +138,17 @@ Create a Workspace Directory
$ mkdir -p $HOME/starlingx/ $ mkdir -p $HOME/starlingx/
---------------------------------- ----------------------------------
Build the CentOS Mirror Repository Build the CentOS Mirror Repository
---------------------------------- ----------------------------------
This section describes how to build the CentOS Mirror Repository. This section describes how to build the CentOS Mirror Repository.
*********************************
Setup Repository Docker Container Setup Repository Docker Container
********************************* *********************************
| Run the following commands under a terminal identified as "One". Run the following commands under a terminal identified as "One".
#. Navigate to the *<$HOME/stx-tools>/centos-mirror-tool* project #. Navigate to the *<$HOME/stx-tools>/centos-mirror-tool* project
directory: directory:
@ -180,6 +190,7 @@ Setup Repository Docker Container
this mean that you need to attach it manually. The advantage of this this mean that you need to attach it manually. The advantage of this
is that you can enter/exit from the container many times as you want. is that you can enter/exit from the container many times as you want.
*****************
Download Packages Download Packages
***************** *****************
@ -210,6 +221,7 @@ Download Packages
- out/stx-r1/CentOS/pike/Binary/images/pxeboot/initrd.img - out/stx-r1/CentOS/pike/Binary/images/pxeboot/initrd.img
- out/stx-r1/CentOS/pike/Binary/images/pxeboot/vmlinuz - out/stx-r1/CentOS/pike/Binary/images/pxeboot/vmlinuz
***************
Verify Packages Verify Packages
*************** ***************
@ -225,6 +237,7 @@ Verify Packages
all RPMs listed in all RPMs listed in
**rpms_3rdparties.lst**/**rpms_centos.lst**/**rpms_centos3rdparties.lst**. **rpms_3rdparties.lst**/**rpms_centos.lst**/**rpms_centos3rdparties.lst**.
******************
Packages Structure Packages Structure
****************** ******************
@ -249,7 +262,7 @@ will have after having downloaded the packages
│   └── puppet │   └── puppet
└── Source └── Source
*******************************
Create CentOS Mirror Repository Create CentOS Mirror Repository
******************************* *******************************
@ -276,6 +289,7 @@ as "**Two**", run the following commands:
Create StarlingX Packages Create StarlingX Packages
------------------------- -------------------------
*******************************
Setup Building Docker Container Setup Building Docker Container
******************************* *******************************
@ -357,6 +371,7 @@ Setup Building Docker Container
$ bash tb.sh exec $ bash tb.sh exec
*********************************
Download Source Code Repositories Download Source Code Repositories
********************************* *********************************
@ -405,6 +420,7 @@ Download Source Code Repositories
$ cp $HOME/starlingx/mirror/CentOS/stx-r1/CentOS/pike/Binary/images/pxeboot/vmlinuz $HOME/starlingx/mirror/CentOS/tis-installer/vmlinuz-stx-0.2 $ cp $HOME/starlingx/mirror/CentOS/stx-r1/CentOS/pike/Binary/images/pxeboot/vmlinuz $HOME/starlingx/mirror/CentOS/tis-installer/vmlinuz-stx-0.2
$ cp $HOME/starlingx/mirror/CentOS/stx-r1/CentOS/pike/Binary/LiveOS/squashfs.img $HOME/starlingx/mirror/CentOS/tis-installer/squashfs.img-stx-0.2 $ cp $HOME/starlingx/mirror/CentOS/stx-r1/CentOS/pike/Binary/LiveOS/squashfs.img $HOME/starlingx/mirror/CentOS/tis-installer/squashfs.img-stx-0.2
**************
Build Packages Build Packages
************** **************
@ -449,7 +465,7 @@ Build StarlingX ISO
$ build-iso $ build-iso
--------------- ---------------
Build installer Build Installer
--------------- ---------------
To get your StarlingX ISO ready to use, you will need to create the init To get your StarlingX ISO ready to use, you will need to create the init
@ -507,7 +523,8 @@ ISO regenerated.
Now your ISO should be able to boot. Now your ISO should be able to boot.
Additional notes ****************
Additional Notes
**************** ****************
- In order to get the first boot working this complete procedure needs - In order to get the first boot working this complete procedure needs
@ -522,6 +539,7 @@ Additional notes
Build Avoidance Build Avoidance
--------------- ---------------
*******
Purpose Purpose
******* *******
@ -530,6 +548,7 @@ within a regional office. Starting from a new workspace, build-pkgs
typically requires 3+ hours. Build avoidance typically reduces this step typically requires 3+ hours. Build avoidance typically reduces this step
to ~20min to ~20min
***********
Limitations Limitations
*********** ***********
@ -543,6 +562,7 @@ Limitations
artifacts from a reference build, and WAN speeds are generally to artifacts from a reference build, and WAN speeds are generally to
slow. slow.
*****************
Method (in brief) Method (in brief)
***************** *****************
@ -639,7 +659,8 @@ Method (in brief)
- What if no valid reference build is found? Then build-pkgs will fall - What if no valid reference build is found? Then build-pkgs will fall
back to a regular build. back to a regular build.
Reference builds ****************
Reference Builds
**************** ****************
- The regional office implements an automated build that pulls the - The regional office implements an automated build that pulls the
@ -666,7 +687,8 @@ Reference builds
protocols that can efficiently share/copy/transfer large directories protocols that can efficiently share/copy/transfer large directories
of content can be added as needed. of content can be added as needed.
Advanced usage ^^^^^^^^^^^^^^
Advanced Usage
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
Can the reference build itself use build avoidance? Yes Can the reference build itself use build avoidance? Yes

67
doc/source/index.rst
View File

@ -2,16 +2,39 @@
StarlingX Documentation StarlingX Documentation
======================= =======================
Abstract Welcome to the StarlingX documentation. This is the documentation
======== for release stx.2018.10.
This is the general documentation for the StarlingX project. Additional information about this release is available in the
:ref:`release-notes`.
.. Add the additional version info here e.g.
The following documentation versions are available:
StarlingX stx.2019.09 | StarlingX stx.2019.04
For more information about the project, consult the
`Project Specifications <specs/index.html>`__.
--------
Sections
--------
.. toctree::
:maxdepth: 1
installation_guide/index
developer_guide/index
Project Specifications <https://docs.starlingx.io/specs/>
api-ref/index
releasenotes/index
contributor/index
--------
Projects Projects
======== --------
StarlingX contains a number of sub-projects that include additional StarlingX contains a number of sub-projects that include additional
Edge Cloud support services and clients. Edge Cloud support services and clients:
* `Bare Metal <stx-metal/index.html>`__ * `Bare Metal <stx-metal/index.html>`__
* `Clients <stx-clients/index.html>`__ * `Clients <stx-clients/index.html>`__
@ -25,35 +48,19 @@ Edge Cloud support services and clients.
* `NFV <stx-nfv/index.html>`__ * `NFV <stx-nfv/index.html>`__
* `Upstream <stx-upstream/index.html>`__ * `Upstream <stx-upstream/index.html>`__
There are also a number of supporting projects and repositories: There are several supporting projects and repositories:
* `Tools <stx-tools/index.html>`__ * `Tools <stx-tools/index.html>`__
Specs ----------
===== Contribute
----------
`Project Specifications <specs/index.html>`__ StarlingX utilizes tooling and CI/CD environments from the OpenStack
Foundation. The source is hosted on `OpenStack's Gerrit server`_.
Contents
--------
.. toctree::
:maxdepth: 1
:caption: Contents:
installation_guide/index
developer_guide/index
Project Specifications <https://docs.starlingx.io/specs/>
api-ref/index
releasenotes/index
contributor/index
Contributing
============
StarlingX utilized tooling and CI/CD environments from the OpenStack Foundation.
The source is hosted on `OpenStack's Gerrit server`_.
.. _`OpenStack's Gerrit server`: https://git.starlingx.io .. _`OpenStack's Gerrit server`: https://git.starlingx.io
Additional information regarding contributing to the project can be
found in the :ref:`StarlingX contributor guides <contribute>`.

26
doc/source/installation_guide/controller_storage.rst
View File

@ -8,6 +8,7 @@ StarlingX/Installation Guide Virtual Environment/Controller Storage
Preparing Servers Preparing Servers
----------------- -----------------
**********
Bare Metal Bare Metal
********** **********
@ -16,6 +17,7 @@ Required Servers:
- Controllers: 2 - Controllers: 2
- Computes: 2 - 100 - Computes: 2 - 100
^^^^^^^^^^^^^^^^^^^^^
Hardware Requirements Hardware Requirements
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
@ -55,6 +57,7 @@ StarlingX Controller Storage will be deployed, include:
- OAM: 10GE Controller - OAM: 10GE Controller
- Data: n x 10GE Compute - Data: n x 10GE Compute
*******************
Virtual Environment Virtual Environment
******************* *******************
@ -80,6 +83,7 @@ The xml server definitions that are created by the previous script are:
- compute-0 - compute-0
- compute-1 - compute-1
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Powering Up a Virtual Server Powering Up a Virtual Server
^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -97,6 +101,7 @@ e.g.
$ sudo virsh start controller-0 $ sudo virsh start controller-0
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Accessing Virtual Server Consoles Accessing Virtual Server Consoles
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -135,6 +140,7 @@ Procedure:
on a USB in a bootable USB slot. on a USB in a bootable USB slot.
#. Configure the controller using the config_controller script. #. Configure the controller using the config_controller script.
*************************
Initializing Controller-0 Initializing Controller-0
************************* *************************
@ -193,6 +199,7 @@ Enter the new password again to confirm it:
Controller-0 is initialized with StarlingX, and is ready for Controller-0 is initialized with StarlingX, and is ready for
configuration. configuration.
************************
Configuring Controller-0 Configuring Controller-0
************************ ************************
@ -259,6 +266,7 @@ On Controller-0, acquire Keystone administrative privileges:
controller-0:~$ source /etc/nova/openrc controller-0:~$ source /etc/nova/openrc
*********************************************
Configuring Provider Networks at Installation Configuring Provider Networks at Installation
********************************************* *********************************************
@ -273,6 +281,7 @@ Set up one provider network of the vlan type, named providernet-a:
[wrsroot@controller-0 ~(keystone_admin)]$ neutron providernet-range-create --name providernet-a-range1 --range 100-400 providernet-a [wrsroot@controller-0 ~(keystone_admin)]$ neutron providernet-range-create --name providernet-a-range1 --range 100-400 providernet-a
*************************************
Configuring Cinder on Controller Disk Configuring Cinder on Controller Disk
************************************* *************************************
@ -404,6 +413,7 @@ Backend storage is configured:
+--------------------------------------+------------+---------+------------+------+----------+... +--------------------------------------+------------+---------+------------+------+----------+...
**********************
Unlocking Controller-0 Unlocking Controller-0
********************** **********************
@ -420,6 +430,7 @@ The host is rebooted. During the reboot, the command line is
unavailable, and any ssh connections are dropped. To monitor the unavailable, and any ssh connections are dropped. To monitor the
progress of the reboot, use the controller-0 console. progress of the reboot, use the controller-0 console.
****************************************
Verifying the Controller-0 Configuration Verifying the Controller-0 Configuration
**************************************** ****************************************
@ -465,6 +476,7 @@ After initializing and configuring an active controller, you can add and
configure a backup controller and additional compute hosts. For each configure a backup controller and additional compute hosts. For each
host do the following: host do the following:
*****************
Initializing Host Initializing Host
***************** *****************
@ -478,6 +490,7 @@ Power on Host. In host console you will see:
controller node in order to proceed. controller node in order to proceed.
***************************************
Updating Host Host Name and Personality Updating Host Host Name and Personality
*************************************** ***************************************
@ -525,6 +538,7 @@ if the entire cluster has its virtual disks hosted on the host's root
disk which happens to be a single rotational type hard disk, then the disk which happens to be a single rotational type hard disk, then the
host cannot (reliably) support parallel node installation. host cannot (reliably) support parallel node installation.
***************
Monitoring Host Monitoring Host
*************** ***************
@ -544,6 +558,7 @@ Wait while the host is configured and rebooted. Up to 20 minutes may be
required for a reboot, depending on hardware. When the reboot is required for a reboot, depending on hardware. When the reboot is
complete, the host is reported as Locked, Disabled, and Online. complete, the host is reported as Locked, Disabled, and Online.
*************
Listing Hosts Listing Hosts
************* *************
@ -581,6 +596,7 @@ On Controller-0, list hosts
+----+--------------+-------------+----------------+-------------+--------------+ +----+--------------+-------------+----------------+-------------+--------------+
***********************************************
Provisioning Network Interfaces on Controller-1 Provisioning Network Interfaces on Controller-1
*********************************************** ***********************************************
@ -599,6 +615,7 @@ Provision the oam interface for Controller-1:
[wrsroot@controller-0 ~(keystone_admin)]$ system host-if-modify -n <oam interface> -c platform --networks oam controller-1 <oam interface> [wrsroot@controller-0 ~(keystone_admin)]$ system host-if-modify -n <oam interface> -c platform --networks oam controller-1 <oam interface>
************************************
Provisioning Storage on Controller-1 Provisioning Storage on Controller-1
************************************ ************************************
@ -710,6 +727,7 @@ Add the partition to the volume group
+--------------------------+--------------------------------------------------+ +--------------------------+--------------------------------------------------+
**********************
Unlocking Controller-1 Unlocking Controller-1
********************** **********************
@ -756,6 +774,7 @@ On Controller-0, acquire Keystone administrative privileges:
controller-0:~$ source /etc/nova/openrc controller-0:~$ source /etc/nova/openrc
*************************************************
Provisioning Network Interfaces on a Compute Host Provisioning Network Interfaces on a Compute Host
************************************************* *************************************************
@ -779,6 +798,7 @@ Provision the data interface for Compute:
[wrsroot@controller-0 ~(keystone_admin)]$ system host-if-modify -p providernet-a -c data compute-0 eth1000 [wrsroot@controller-0 ~(keystone_admin)]$ system host-if-modify -p providernet-a -c data compute-0 eth1000
***************************
VSwitch Virtual Environment VSwitch Virtual Environment
*************************** ***************************
@ -802,6 +822,7 @@ vswitch cores to 1:
+--------------------------------------+-------+-----------+-------+--------+... +--------------------------------------+-------+-----------+-------+--------+...
**************************************
Provisioning Storage on a Compute Host Provisioning Storage on a Compute Host
************************************** **************************************
@ -899,7 +920,7 @@ nova-local:
| parameters | {u'concurrent_disk_operations': 2, u'instance_backing': u'image'} | | parameters | {u'concurrent_disk_operations': 2, u'instance_backing': u'image'} |
+-----------------+-------------------------------------------------------------------+ +-----------------+-------------------------------------------------------------------+
************************
Unlocking a Compute Host Unlocking a Compute Host
************************ ************************
@ -920,6 +941,7 @@ unlocked/enabled.
System Health Check System Health Check
------------------- -------------------
***********************
Listing StarlingX Nodes Listing StarlingX Nodes
*********************** ***********************
@ -938,7 +960,7 @@ Unlocked, Enabled, and Available:
| 4 | compute-1 | compute | unlocked | enabled | available | | 4 | compute-1 | compute | unlocked | enabled | available |
+----+--------------+-------------+----------------+-------------+--------------+ +----+--------------+-------------+----------------+-------------+--------------+
*****************
System Alarm List System Alarm List
***************** *****************

27
doc/source/installation_guide/dedicated_storage.rst
View File

@ -8,6 +8,7 @@ StarlingX/Installation Guide Virtual Environment/Dedicated Storage
Preparing Servers Preparing Servers
----------------- -----------------
**********
Bare Metal Bare Metal
********** **********
@ -21,6 +22,7 @@ Required Servers:
- Computes: 2 - 100 - Computes: 2 - 100
^^^^^^^^^^^^^^^^^^^^^
Hardware Requirements Hardware Requirements
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
@ -60,6 +62,7 @@ StarlingX Dedicated Storage will be deployed, include:
- OAM: 10GE Controller - OAM: 10GE Controller
- Data: n x 10GE Compute - Data: n x 10GE Compute
*******************
Virtual Environment Virtual Environment
******************* *******************
@ -87,6 +90,7 @@ The xml server definitions that are created by the previous script are:
- storage-0 - storage-0
- storage-1 - storage-1
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Powering Up a Virtual Server Powering Up a Virtual Server
^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -104,6 +108,7 @@ e.g.
$ sudo virsh start controller-0 $ sudo virsh start controller-0
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Accessing Virtual Server Consoles Accessing Virtual Server Consoles
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -142,6 +147,7 @@ Procedure:
on a USB in a bootable USB slot. on a USB in a bootable USB slot.
#. Configure the controller using the config_controller script. #. Configure the controller using the config_controller script.
*************************
Initializing Controller-0 Initializing Controller-0
************************* *************************
@ -200,6 +206,7 @@ Enter the new password again to confirm it:
Controller-0 is initialized with StarlingX, and is ready for Controller-0 is initialized with StarlingX, and is ready for
configuration. configuration.
************************
Configuring Controller-0 Configuring Controller-0
************************ ************************
@ -266,6 +273,7 @@ On Controller-0, acquire Keystone administrative privileges:
controller-0:~$ source /etc/nova/openrc controller-0:~$ source /etc/nova/openrc
*********************************************
Configuring Provider Networks at Installation Configuring Provider Networks at Installation
********************************************* *********************************************
@ -280,6 +288,7 @@ Set up one provider network of the vlan type, named providernet-a:
[wrsroot@controller-0 ~(keystone_admin)]$ neutron providernet-range-create --name providernet-a-range1 --range 100-400 providernet-a [wrsroot@controller-0 ~(keystone_admin)]$ neutron providernet-range-create --name providernet-a-range1 --range 100-400 providernet-a
*********************************************
Adding a Ceph Storage Backend at Installation Adding a Ceph Storage Backend at Installation
********************************************* *********************************************
@ -332,6 +341,7 @@ Confirm CEPH storage is configured
+--------------------------------------+------------+---------+------------+-------------------+-----------+... +--------------------------------------+------------+---------+------------+-------------------+-----------+...
**********************
Unlocking Controller-0 Unlocking Controller-0
********************** **********************
@ -347,6 +357,8 @@ The host is rebooted. During the reboot, the command line is
unavailable, and any ssh connections are dropped. To monitor the unavailable, and any ssh connections are dropped. To monitor the
progress of the reboot, use the controller-0 console. progress of the reboot, use the controller-0 console.
****************************************
Verifying the Controller-0 Configuration Verifying the Controller-0 Configuration
**************************************** ****************************************
@ -384,6 +396,7 @@ Verify that controller-0 is unlocked, enabled, and available:
+----+--------------+-------------+----------------+-------------+--------------+ +----+--------------+-------------+----------------+-------------+--------------+
*******************************
Provisioning Filesystem Storage Provisioning Filesystem Storage
******************************* *******************************
@ -422,6 +435,7 @@ After initializing and configuring an active controller, you can add and
configure a backup controller and additional compute or storage hosts. configure a backup controller and additional compute or storage hosts.
For each host do the following: For each host do the following:
*****************
Initializing Host Initializing Host
***************** *****************
@ -435,6 +449,7 @@ Power on Host. In host console you will see:
controller node in order to proceed. controller node in order to proceed.
**********************************
Updating Host Name and Personality Updating Host Name and Personality
********************************** **********************************
@ -474,6 +489,7 @@ Check the **NIC** MAC Address from "Virtual Manager GUI" under *"Show
virtual hardware details -*\ **i**\ *" Main Banner --> NIC: --> specific virtual hardware details -*\ **i**\ *" Main Banner --> NIC: --> specific
"Bridge name:" under MAC Address text field.* "Bridge name:" under MAC Address text field.*
***************
Monitoring Host Monitoring Host
*************** ***************
@ -493,6 +509,7 @@ Wait while the host is configured and rebooted. Up to 20 minutes may be
required for a reboot, depending on hardware. When the reboot is required for a reboot, depending on hardware. When the reboot is
complete, the host is reported as Locked, Disabled, and Online. complete, the host is reported as Locked, Disabled, and Online.
*************
Listing Hosts Listing Hosts
************* *************
@ -532,6 +549,7 @@ On Controller-0, list hosts
+----+--------------+-------------+----------------+-------------+--------------+ +----+--------------+-------------+----------------+-------------+--------------+
***********************************************
Provisioning Network Interfaces on Controller-1 Provisioning Network Interfaces on Controller-1
*********************************************** ***********************************************
@ -550,6 +568,7 @@ Provision the oam interface for Controller-1:
[wrsroot@controller-0 ~(keystone_admin)]$ system host-if-modify -n <oam interface> -c platform --networks oam controller-1 <oam interface> [wrsroot@controller-0 ~(keystone_admin)]$ system host-if-modify -n <oam interface> -c platform --networks oam controller-1 <oam interface>
**********************
Unlocking Controller-1 Unlocking Controller-1
********************** **********************
@ -586,6 +605,7 @@ confirm status.
Storage Host Provisioning Storage Host Provisioning
------------------------- -------------------------
**************************************
Provisioning Storage on a Storage Host Provisioning Storage on a Storage Host
************************************** **************************************
@ -685,6 +705,7 @@ On Controller-0, acquire Keystone administrative privileges:
controller-0:~$ source /etc/nova/openrc controller-0:~$ source /etc/nova/openrc
*************************************************
Provisioning Network Interfaces on a Compute Host Provisioning Network Interfaces on a Compute Host
************************************************* *************************************************
@ -708,6 +729,7 @@ Provision the data interface for Compute:
[wrsroot@controller-0 ~(keystone_admin)]$ system host-if-modify -p providernet-a -c data compute-0 eth1000 [wrsroot@controller-0 ~(keystone_admin)]$ system host-if-modify -p providernet-a -c data compute-0 eth1000
***************************
VSwitch Virtual Environment VSwitch Virtual Environment
*************************** ***************************
@ -731,6 +753,7 @@ vswitch cores to 1:
+--------------------------------------+-------+-----------+-------+--------+... +--------------------------------------+-------+-----------+-------+--------+...
**************************************
Provisioning Storage on a Compute Host Provisioning Storage on a Compute Host
************************************** **************************************
@ -810,6 +833,7 @@ volumes:
[wrsroot@controller-0 ~(keystone_admin)]$ system host-lvg-modify -b remote compute-0 nova-local [wrsroot@controller-0 ~(keystone_admin)]$ system host-lvg-modify -b remote compute-0 nova-local
************************
Unlocking a Compute Host Unlocking a Compute Host
************************ ************************
@ -829,6 +853,7 @@ Availability State is reported as In-Test, followed by unlocked/enabled.
System Health Check System Health Check
------------------- -------------------
***********************
Listing StarlingX Nodes Listing StarlingX Nodes
*********************** ***********************
@ -851,6 +876,7 @@ Unlocked, Enabled, and Available:
[wrsroot@controller-0 ~(keystone_admin)]$ [wrsroot@controller-0 ~(keystone_admin)]$
******************************
Checking StarlingX CEPH Health Checking StarlingX CEPH Health
****************************** ******************************
@ -869,6 +895,7 @@ Checking StarlingX CEPH Health
controller-0:~$ controller-0:~$
*****************
System Alarm List System Alarm List
***************** *****************

25
doc/source/installation_guide/duplex.rst
View File

@ -8,6 +8,7 @@ StarlingX/Installation Guide Virtual Environment/Duplex
Preparing Servers Preparing Servers
----------------- -----------------
**********
Bare Metal Bare Metal
********** **********
@ -15,6 +16,7 @@ Required Servers:
- Combined Servers (Controller + Compute): 2 - Combined Servers (Controller + Compute): 2
^^^^^^^^^^^^^^^^^^^^^
Hardware Requirements Hardware Requirements
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
@ -49,6 +51,7 @@ StarlingX Duplex will be deployed, include:
- OAM: 10GE - OAM: 10GE
- Data: n x 10GE - Data: n x 10GE
*******************
Virtual Environment Virtual Environment
******************* *******************
@ -72,6 +75,7 @@ The xml server definitions that are created by the previous script are:
- controller-0 - controller-0
- controller-1 - controller-1
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Powering Up a Virtual Server Powering Up a Virtual Server
^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -89,6 +93,7 @@ e.g.
$ sudo virsh start controller-0 $ sudo virsh start controller-0
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Accessing Virtual Server Consoles Accessing Virtual Server Consoles
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -127,6 +132,7 @@ Procedure:
on a USB in a bootable USB slot. on a USB in a bootable USB slot.
#. Configure the controller using the config_controller script. #. Configure the controller using the config_controller script.
*************************
Initializing Controller-0 Initializing Controller-0
************************* *************************
@ -184,6 +190,7 @@ Enter the new password again to confirm it:
Controller-0 is initialized with StarlingX, and is ready for Controller-0 is initialized with StarlingX, and is ready for
configuration. configuration.
************************
Configuring Controller-0 Configuring Controller-0
************************ ************************
@ -271,6 +278,7 @@ On Controller-0, acquire Keystone administrative privileges:
controller-0:~$ source /etc/nova/openrc controller-0:~$ source /etc/nova/openrc
*********************************************
Configuring Provider Networks at Installation Configuring Provider Networks at Installation
********************************************* *********************************************
@ -282,6 +290,7 @@ Set up one provider network of the vlan type, named providernet-a:
[wrsroot@controller-0 ~(keystone_admin)]$ neutron providernet-range-create --name providernet-a-range1 --range 100-400 providernet-a [wrsroot@controller-0 ~(keystone_admin)]$ neutron providernet-range-create --name providernet-a-range1 --range 100-400 providernet-a
*****************************************
Providing Data Interfaces on Controller-0 Providing Data Interfaces on Controller-0
***************************************** *****************************************
@ -333,6 +342,7 @@ Configure the data interfaces
+------------------+--------------------------------------+ +------------------+--------------------------------------+
*************************************
Configuring Cinder on Controller Disk Configuring Cinder on Controller Disk
************************************* *************************************
@ -448,6 +458,7 @@ Add the partition to the volume group
+--------------------------+--------------------------------------------------+ +--------------------------+--------------------------------------------------+
*********************************************
Adding an LVM Storage Backend at Installation Adding an LVM Storage Backend at Installation
********************************************* *********************************************
@ -497,6 +508,8 @@ state=Configured)
+--------------------------------------+------------+---------+------------+------+----------+--------------+ +--------------------------------------+------------+---------+------------+------+----------+--------------+
***********************************************
Configuring VM Local Storage on Controller Disk Configuring VM Local Storage on Controller Disk
*********************************************** ***********************************************
@ -615,6 +628,7 @@ Add the partition to the volume group
[wrsroot@controller-0 ~(keystone_admin)]$ [wrsroot@controller-0 ~(keystone_admin)]$
**********************
Unlocking Controller-0 Unlocking Controller-0
********************** **********************
@ -630,6 +644,7 @@ The host is rebooted. During the reboot, the command line is
unavailable, and any ssh connections are dropped. To monitor the unavailable, and any ssh connections are dropped. To monitor the
progress of the reboot, use the controller-0 console. progress of the reboot, use the controller-0 console.
****************************************
Verifying the Controller-0 Configuration Verifying the Controller-0 Configuration
**************************************** ****************************************
@ -682,6 +697,7 @@ Controller-1 Host Installation
After initializing and configuring controller-0, you can add and After initializing and configuring controller-0, you can add and
configure a backup controller controller-1. configure a backup controller controller-1.
******************************
Initializing Controller-1 Host Initializing Controller-1 Host
****************************** ******************************
@ -695,6 +711,7 @@ Power on Controller-1. In Controller-1 console you will see:
controller node in order to proceed. controller node in order to proceed.
****************************************************
Updating Controller-1 Host Host Name and Personality Updating Controller-1 Host Host Name and Personality
**************************************************** ****************************************************
@ -769,6 +786,7 @@ attribute:
+---------------------+--------------------------------------+ +---------------------+--------------------------------------+
****************************
Monitoring Controller-1 Host Monitoring Controller-1 Host
**************************** ****************************
@ -788,6 +806,7 @@ Wait while the Controller-1 is configured and rebooted. Up to 20 minutes
may be required for a reboot, depending on hardware. When the reboot is may be required for a reboot, depending on hardware. When the reboot is
complete, the Controller-1 is reported as Locked, Disabled, and Online. complete, the Controller-1 is reported as Locked, Disabled, and Online.
*************************
Listing Controller-1 Host Listing Controller-1 Host
************************* *************************
@ -822,6 +841,7 @@ On Controller-0, list hosts
+----+--------------+-------------+----------------+-------------+--------------+ +----+--------------+-------------+----------------+-------------+--------------+
***********************************************
Provisioning Network Interfaces on Controller-1 Provisioning Network Interfaces on Controller-1
*********************************************** ***********************************************
@ -865,6 +885,7 @@ Provision the Controller-1 oam interface
+------------------+--------------------------------------+ +------------------+--------------------------------------+
*****************************************
Providing Data Interfaces on Controller-1 Providing Data Interfaces on Controller-1
***************************************** *****************************************
@ -917,6 +938,7 @@ Configure the data interfaces
+------------------+--------------------------------------+ +------------------+--------------------------------------+
************************************
Provisioning Storage on Controller-1 Provisioning Storage on Controller-1
************************************ ************************************
@ -1027,6 +1049,7 @@ Add the partition to the volume group
.. _configuring-vm-local-storage-on-controller-disk-1: .. _configuring-vm-local-storage-on-controller-disk-1:
***********************************************
Configuring VM Local Storage on Controller Disk Configuring VM Local Storage on Controller Disk
*********************************************** ***********************************************
@ -1138,6 +1161,7 @@ Add the partition to the volume group
+--------------------------+--------------------------------------------------+ +--------------------------+--------------------------------------------------+
**********************
Unlocking Controller-1 Unlocking Controller-1
********************** **********************
@ -1169,6 +1193,7 @@ excessive data-sync time). Use 'fm alarm-list' to confirm status.
+----+--------------+-------------+----------------+-------------+--------------+ +----+--------------+-------------+----------------+-------------+--------------+
*****************
System Alarm List System Alarm List
***************** *****************

14
doc/source/installation_guide/index.rst
View File

@ -25,6 +25,7 @@ Requirements
Different use cases require different configurations. Different use cases require different configurations.
**********
Bare Metal Bare Metal
********** **********
@ -85,12 +86,14 @@ be deployed, include:
The recommended minimum requirements for the physical servers are The recommended minimum requirements for the physical servers are
described later in each StarlingX Deployment Options guide. described later in each StarlingX Deployment Options guide.
*******************
Virtual Environment Virtual Environment
******************* *******************
The recommended minimum requirements for the workstation, hosting the The recommended minimum requirements for the workstation, hosting the
Virtual Machine(s) where StarlingX will be deployed, include: Virtual Machine(s) where StarlingX will be deployed, include:
^^^^^^^^^^^^^^^^^^^^^
Hardware Requirements Hardware Requirements
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
@ -103,6 +106,7 @@ A workstation computer with:
- Hard Disk: 500GB HDD - Hard Disk: 500GB HDD
- Network: Two network adapters with active Internet connection - Network: Two network adapters with active Internet connection
^^^^^^^^^^^^^^^^^^^^^
Software Requirements Software Requirements
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
@ -117,12 +121,14 @@ A workstation computer with:
- project - project
- StarlingX ISO Image - StarlingX ISO Image
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Deployment Environment Setup Deployment Environment Setup
^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This section describes how to set up the workstation computer which will This section describes how to set up the workstation computer which will
host the Virtual Machine(s) where StarlingX will be deployed. host the Virtual Machine(s) where StarlingX will be deployed.
''''''''''''''''''''''''''''''
Updating Your Operating System Updating Your Operating System
'''''''''''''''''''''''''''''' ''''''''''''''''''''''''''''''
@ -133,7 +139,7 @@ first need to update the local database list of available packages:
$ sudo apt-get update $ sudo apt-get update
'''''''''''''''''''''''''
Install stx-tools project Install stx-tools project
''''''''''''''''''''''''' '''''''''''''''''''''''''
@ -146,6 +152,7 @@ user’s home directory.
$ git clone https://git.starlingx.io/stx-tools $ git clone https://git.starlingx.io/stx-tools
''''''''''''''''''''''''''''''''''''''''
Installing Requirements and Dependencies Installing Requirements and Dependencies
'''''''''''''''''''''''''''''''''''''''' ''''''''''''''''''''''''''''''''''''''''
@ -163,6 +170,7 @@ Install the required packages:
$ bash install_packages.sh $ bash install_packages.sh
''''''''''''''''''
Disabling Firewall Disabling Firewall
'''''''''''''''''' ''''''''''''''''''
@ -184,14 +192,14 @@ Follow the instructions from the :ref:`developer-guide` to build a
StarlingX ISO image. StarlingX ISO image.
**********
Bare Metal Bare Metal
********** **********
A bootable USB flash drive containing StarlingX ISO image. A bootable USB flash drive containing StarlingX ISO image.
*******************
Virtual Environment Virtual Environment
******************* *******************

32
doc/source/installation_guide/installation_libvirt_qemu.rst
View File

@ -35,12 +35,13 @@ A workstation computer with:
- project - project
- StarlingX ISO Image - StarlingX ISO Image
----------------------------
Deployment Environment Setup Deployment Environment Setup
**************************** ----------------------------
------------- *************
Configuration Configuration
------------- *************
These scripts are configured using environment variables that all have These scripts are configured using environment variables that all have
built-in defaults. On shared systems you probably do not want to use the built-in defaults. On shared systems you probably do not want to use the
@ -72,9 +73,9 @@ This rc file shows the defaults baked into the scripts:
export EXTERNAL_IP=192.168.204.1/24 export EXTERNAL_IP=192.168.204.1/24
------------------------- *************************
Install stx-tools project Install stx-tools Project
------------------------- *************************
Clone the stx-tools project into a working directory. Clone the stx-tools project into a working directory.
@ -98,9 +99,9 @@ Load the configuration (if you created one) from madcloud.rc:
source madcloud.rc source madcloud.rc
---------------------------------------- ****************************************
Installing Requirements and Dependencies Installing Requirements and Dependencies
---------------------------------------- ****************************************
Install the required packages and configure QEMU. This only needs to be 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 done once per host. (NOTE: this script only knows about Ubuntu at this
@ -111,9 +112,9 @@ time):
$SCRIPTS/install_packages.sh $SCRIPTS/install_packages.sh
------------------ ******************
Disabling Firewall Disabling Firewall
------------------ ******************
Unload firewall and disable firewall on boot: Unload firewall and disable firewall on boot:
@ -123,9 +124,9 @@ Unload firewall and disable firewall on boot:
sudo ufw status sudo ufw status
------------------ ******************
Configure Networks Configure Networks
------------------ ******************
Configure the network bridges using setup_network.sh before doing Configure the network bridges using setup_network.sh before doing
anything else. It will create 4 bridges named stxbr1, stxbr2, stxbr3 and anything else. It will create 4 bridges named stxbr1, stxbr2, stxbr3 and
@ -144,9 +145,9 @@ have been destroyed.
There is also a script cleanup_network.sh that will remove networking There is also a script cleanup_network.sh that will remove networking
configuration from libvirt. configuration from libvirt.
--------------------- *********************
Configure Controllers Configure Controllers
--------------------- *********************
There are two scripts for creating the controllers: setup_allinone.sh There are two scripts for creating the controllers: setup_allinone.sh
and setup_standard_controller.sh. They are operated in the same manner and setup_standard_controller.sh. They are operated in the same manner
@ -176,8 +177,9 @@ Continue the usual StarlingX installation from this point forward.
Tear down the VMs using destroy_allinone.sh and Tear down the VMs using destroy_allinone.sh and
destroy_standard_controller.sh. destroy_standard_controller.sh.
--------
Continue Continue
******** --------
Pick up the installation in one of the existing guides at the Pick up the installation in one of the existing guides at the
'Initializing Controller-0 step. 'Initializing Controller-0 step.

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

@ -8,6 +8,7 @@ StarlingX/Installation Guide Virtual Environment/Simplex
Preparing Servers Preparing Servers
----------------- -----------------
**********
Bare Metal Bare Metal
********** **********
@ -15,6 +16,7 @@ Required Server:
- Combined Server (Controller + Compute): 1 - Combined Server (Controller + Compute): 1
^^^^^^^^^^^^^^^^^^^^^
Hardware Requirements Hardware Requirements
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
@ -48,6 +50,7 @@ StarlingX Simplex will be deployed, include:
- Management: 10GE - Management: 10GE
- OAM: 10GE - OAM: 10GE
*******************
Virtual Environment Virtual Environment
******************* *******************
@ -73,6 +76,7 @@ The xml server definitions that are created by the previous script are:
Only controller-0 will be provisioned. Only controller-0 will be provisioned.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Powering Up a Virtual Server Powering Up a Virtual Server
^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -88,6 +92,7 @@ e.g.
$ sudo virsh start controller-0 $ sudo virsh start controller-0
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Accessing Virtual Server Consoles Accessing Virtual Server Consoles
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -126,6 +131,7 @@ Procedure:
on a USB in a bootable USB slot. on a USB in a bootable USB slot.
#. Configure the controller using the config_controller script. #. Configure the controller using the config_controller script.
*************************
Initializing Controller-0 Initializing Controller-0
************************* *************************
@ -183,6 +189,7 @@ Enter the new password again to confirm it:
Controller-0 is initialized with StarlingX, and is ready for Controller-0 is initialized with StarlingX, and is ready for
configuration. configuration.
************************
Configuring Controller-0 Configuring Controller-0
************************ ************************
@ -271,6 +278,7 @@ On Controller-0, acquire Keystone administrative privileges:
controller-0:~$ source /etc/nova/openrc controller-0:~$ source /etc/nova/openrc
*********************************************
Configuring Provider Networks at Installation Configuring Provider Networks at Installation
********************************************* *********************************************
@ -282,6 +290,7 @@ Set up one provider network of the vlan type, named providernet-a:
[wrsroot@controller-0 ~(keystone_admin)]$ neutron providernet-range-create --name providernet-a-range1 --range 100-400 providernet-a [wrsroot@controller-0 ~(keystone_admin)]$ neutron providernet-range-create --name providernet-a-range1 --range 100-400 providernet-a
*****************************************
Providing Data Interfaces on Controller-0 Providing Data Interfaces on Controller-0
***************************************** *****************************************
@ -333,6 +342,7 @@ Configure the data interfaces
+------------------+--------------------------------------+ +------------------+--------------------------------------+
*************************************
Configuring Cinder on Controller Disk Configuring Cinder on Controller Disk
************************************* *************************************
@ -448,6 +458,7 @@ Add the partition to the volume group
+--------------------------+--------------------------------------------------+ +--------------------------+--------------------------------------------------+
*********************************************
Adding an LVM Storage Backend at Installation Adding an LVM Storage Backend at Installation
********************************************* *********************************************
@ -497,6 +508,7 @@ state=Configured)
+--------------------------------------+------------+---------+------------+------+----------+--------------+ +--------------------------------------+------------+---------+------------+------+----------+--------------+
***********************************************
Configuring VM Local Storage on Controller Disk Configuring VM Local Storage on Controller Disk
*********************************************** ***********************************************
@ -615,6 +627,7 @@ Add the partition to the volume group
[wrsroot@controller-0 ~(keystone_admin)]$ [wrsroot@controller-0 ~(keystone_admin)]$
**********************
Unlocking Controller-0 Unlocking Controller-0
********************** **********************
@ -630,6 +643,7 @@ The host is rebooted. During the reboot, the command line is
unavailable, and any ssh connections are dropped. To monitor the unavailable, and any ssh connections are dropped. To monitor the
progress of the reboot, use the controller-0 console. progress of the reboot, use the controller-0 console.
****************************************
Verifying the Controller-0 Configuration Verifying the Controller-0 Configuration
**************************************** ****************************************
@ -675,6 +689,7 @@ Verify that controller-0 is unlocked, enabled, and available:
+----+--------------+-------------+----------------+-------------+--------------+ +----+--------------+-------------+----------------+-------------+--------------+
*****************
System Alarm List System Alarm List
***************** *****************

108
doc/source/releasenotes/index.rst
View File

@ -1,8 +1,108 @@
======================= .. _release-notes:
StarlingX Release Notes
=======================
Project-specific Release Notes: =============
Release Notes
=============
These are the release notes for StarlingX release stx.2018.10.
**Note:** StarlingX uses a "year.month" pattern for release version
numbers, indicating the year and month of release.
------------
New Features
------------
+-----------------------------------+-----------------------------------+
| StoryBoard ID | Feature |
+===================================+===================================+
| N/A | ovs-dpdk integration |
+-----------------------------------+-----------------------------------+
| 2002820 | Support for external Ceph backend |
+-----------------------------------+-----------------------------------+
| 2202821 | Support for adding compute nodes |
| | to all-in-one duplex deployments |
+-----------------------------------+-----------------------------------+
| 2002822 | Support remote client for Windows |
| | and Mac OS |
+-----------------------------------+-----------------------------------+
| 2003115 | Deprecate proprietary Cinder |
| | volume backup and restore |
+-----------------------------------+-----------------------------------+
| 2002825 | Support Gnocchi storage backend |
| | for OpenStack telemetry |
+-----------------------------------+-----------------------------------+
| 2002847 | Add ntfs-3g packages |
+-----------------------------------+-----------------------------------+
| 2002826 | Memcached integration |
+-----------------------------------+-----------------------------------+
| 2002935 | Support for Precision Time |
| | Protocol (PTP) |
+-----------------------------------+-----------------------------------+
| 2003087 | Generalized interface and network |
| | configuration |
+-----------------------------------+-----------------------------------+
| 2003518 | Enable Swift on controllers |
+-----------------------------------+-----------------------------------+
| 2002712 | StarlingX API documentation |
+-----------------------------------+-----------------------------------+
-------------
Other changes
-------------
+-----------------------------------+-----------------------------------+
| StoryBoard ID | Change |
+===================================+===================================+
| 2002827 | Decouple Service Management REST |
| | API from sysinv |
+-----------------------------------+-----------------------------------+
| 2002828 | Decouple Fault Management from |
| | stx-config |
+-----------------------------------+-----------------------------------+
| 2002829 | Decouple Guest-server/agent from |
| | stx-metal |
+-----------------------------------+-----------------------------------+
| 2002832 | Replace compute-huge init script |
+-----------------------------------+-----------------------------------+
| 2002834 | Add distributed cloud repos to |
| | StarlingX |
+-----------------------------------+-----------------------------------+
| 2002846 | Python Optimization |
+-----------------------------------+-----------------------------------+
| 2003389, 2003596 | Upgrade kernel and srpm/rpms to |
| | CentOS 7.5 |
+-----------------------------------+-----------------------------------+
| 3003396, 2003339 | Upgrade libvirt to 4.7.0 |
+-----------------------------------+-----------------------------------+
| 3002891 | Stx-gui plug-in for Horizon |
+-----------------------------------+-----------------------------------+
| Many | Build enhancements, cleanups and |
| | optimizations |
+-----------------------------------+-----------------------------------+
| Many | Enable basic zuul checks and |
| | linters |
+-----------------------------------+-----------------------------------+
| Many | Python 2 to 3 upgrade for |
| | stx-update, stx-metal, stx-fault, |
| | stx-integ |
+-----------------------------------+-----------------------------------+
-------
Testing
-------
Please take a look at our
`test plan <https://wiki.openstack.org/wiki/StarlingX/stx.2018.10_Testplan>`__
for the list of tests executed on this release.
View the
`testing summary <https://wiki.openstack.org/wiki/StarlingX/stx.2018.10_TestingSummary>`__
to see the status of testing for this release.
------------------------------
Project-specific release notes
------------------------------
* `Bare Metal <stx-metal/index.html>`__ * `Bare Metal <stx-metal/index.html>`__
* `Clients <stx-clients/index.html>`__ * `Clients <stx-clients/index.html>`__