diff --git a/doc/source/api-ref/index.rst b/doc/source/api-ref/index.rst index 77d6683e0..67e925428 100644 --- a/doc/source/api-ref/index.rst +++ b/doc/source/api-ref/index.rst @@ -1,8 +1,8 @@ -====================== -stx-docs API Reference -====================== +================== +REST API Reference +================== -StarlingX Project API References: +StarlingX project REST API references: * `Bare Metal `__ * `Configuration `__ @@ -11,7 +11,7 @@ StarlingX Project API References: * `High Availability `__ * `NFV `__ -StarlingX also has API References for the modified OpenStack APIs: +StarlingX also has API references for the modified OpenStack APIs: * `Block Storage v2 `__ * `Compute v2 `__ diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 84078c87d..1891640a1 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -1,8 +1,15 @@ +.. _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:: :maxdepth: 1 diff --git a/doc/source/developer_guide/index.rst b/doc/source/developer_guide/index.rst index 2c865b88f..c0073bfc6 100644 --- a/doc/source/developer_guide/index.rst +++ b/doc/source/developer_guide/index.rst @@ -13,6 +13,7 @@ Requirements The recommended minimum requirements include: +********************* Hardware Requirements ********************* @@ -23,6 +24,7 @@ A workstation computer with: - Hard Disk: 500GB HDD - Network: Network adapter with active Internet connection +********************* Software Requirements ********************* @@ -49,6 +51,7 @@ build a StarlingX ISO image on the following Linux distribution: - Ubuntu 16.04 LTS 64-bit +**************************** Update Your Operating System **************************** @@ -59,9 +62,11 @@ first need to update the local database list of available packages: $ sudo apt-get update +****************************************** Installation Requirements and Dependencies ****************************************** +^^^ Git ^^^ @@ -78,6 +83,7 @@ Git $ git config --global user.name "Name LastName" $ git config --global user.email "Email Address" +^^^^^^^^^ Docker CE ^^^^^^^^^ @@ -86,6 +92,7 @@ Docker CE Ubuntu `__ for more information. +^^^^^^^^^^^^^^^^^ Android Repo Tool ^^^^^^^^^^^^^^^^^ @@ -94,6 +101,7 @@ Android Repo Tool Repo `__ to have Andriod Repo Tool installed. +********************** Install Public SSH Key ********************** @@ -107,7 +115,8 @@ Install Public SSH Key - `Upload to Gerrit `__ -Install stx-tools project +************************* +Install stx-tools Project ************************* #. Under your $HOME directory, clone the project @@ -117,6 +126,7 @@ Install stx-tools project $ cd $HOME $ git clone https://git.starlingx.io/stx-tools +**************************** Create a Workspace Directory **************************** @@ -128,17 +138,17 @@ Create a Workspace Directory $ mkdir -p $HOME/starlingx/ - ---------------------------------- Build the CentOS Mirror Repository ---------------------------------- This section describes how to build the CentOS Mirror Repository. +********************************* 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 directory: @@ -180,6 +190,7 @@ Setup Repository Docker Container 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. +***************** 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/vmlinuz +*************** Verify Packages *************** @@ -225,6 +237,7 @@ Verify Packages all RPMs listed in **rpms_3rdparties.lst**/**rpms_centos.lst**/**rpms_centos3rdparties.lst**. +****************** Packages Structure ****************** @@ -249,7 +262,7 @@ will have after having downloaded the packages │   └── puppet └── Source - +******************************* Create CentOS Mirror Repository ******************************* @@ -276,6 +289,7 @@ as "**Two**", run the following commands: Create StarlingX Packages ------------------------- +******************************* Setup Building Docker Container ******************************* @@ -357,6 +371,7 @@ Setup Building Docker Container $ bash tb.sh exec +********************************* 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/LiveOS/squashfs.img $HOME/starlingx/mirror/CentOS/tis-installer/squashfs.img-stx-0.2 +************** Build Packages ************** @@ -449,7 +465,7 @@ Build StarlingX ISO $ build-iso --------------- -Build installer +Build Installer --------------- 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. -Additional notes +**************** +Additional Notes **************** - In order to get the first boot working this complete procedure needs @@ -522,6 +539,7 @@ Additional notes Build Avoidance --------------- +******* 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 to ~20min +*********** Limitations *********** @@ -543,6 +562,7 @@ Limitations artifacts from a reference build, and WAN speeds are generally to slow. +***************** Method (in brief) ***************** @@ -639,7 +659,8 @@ Method (in brief) - What if no valid reference build is found? Then build-pkgs will fall back to a regular build. -Reference builds +**************** +Reference Builds **************** - 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 of content can be added as needed. -Advanced usage +^^^^^^^^^^^^^^ +Advanced Usage ^^^^^^^^^^^^^^ Can the reference build itself use build avoidance? Yes diff --git a/doc/source/index.rst b/doc/source/index.rst index 06625931d..d14e75bab 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -2,16 +2,39 @@ 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 `__. + +-------- +Sections +-------- + +.. toctree:: + :maxdepth: 1 + + installation_guide/index + developer_guide/index + Project Specifications + api-ref/index + releasenotes/index + contributor/index + +-------- Projects -======== +-------- StarlingX contains a number of sub-projects that include additional -Edge Cloud support services and clients. +Edge Cloud support services and clients: * `Bare Metal `__ * `Clients `__ @@ -25,35 +48,19 @@ Edge Cloud support services and clients. * `NFV `__ * `Upstream `__ -There are also a number of supporting projects and repositories: +There are several supporting projects and repositories: * `Tools `__ -Specs -===== +---------- +Contribute +---------- - `Project Specifications `__ - -Contents --------- - -.. toctree:: - :maxdepth: 1 - :caption: Contents: - - installation_guide/index - developer_guide/index - Project Specifications - 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`_. +StarlingX utilizes 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 +Additional information regarding contributing to the project can be +found in the :ref:`StarlingX contributor guides `. + diff --git a/doc/source/installation_guide/controller_storage.rst b/doc/source/installation_guide/controller_storage.rst index 05b1eacce..61ca60566 100644 --- a/doc/source/installation_guide/controller_storage.rst +++ b/doc/source/installation_guide/controller_storage.rst @@ -8,6 +8,7 @@ StarlingX/Installation Guide Virtual Environment/Controller Storage Preparing Servers ----------------- +********** Bare Metal ********** @@ -16,6 +17,7 @@ Required Servers: - Controllers: 2 - Computes: 2 - 100 +^^^^^^^^^^^^^^^^^^^^^ Hardware Requirements ^^^^^^^^^^^^^^^^^^^^^ @@ -55,6 +57,7 @@ StarlingX Controller Storage will be deployed, include: - OAM: 10GE Controller - Data: n x 10GE Compute +******************* Virtual Environment ******************* @@ -80,6 +83,7 @@ The xml server definitions that are created by the previous script are: - compute-0 - compute-1 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Powering Up a Virtual Server ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -97,6 +101,7 @@ e.g. $ sudo virsh start controller-0 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Accessing Virtual Server Consoles ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -135,6 +140,7 @@ Procedure: on a USB in a bootable USB slot. #. Configure the controller using the config_controller script. +************************* 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 configuration. +************************ Configuring Controller-0 ************************ @@ -259,6 +266,7 @@ On Controller-0, acquire Keystone administrative privileges: controller-0:~$ source /etc/nova/openrc +********************************************* 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 +************************************* Configuring Cinder on Controller Disk ************************************* @@ -404,6 +413,7 @@ Backend storage is configured: +--------------------------------------+------------+---------+------------+------+----------+... +********************** 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 progress of the reboot, use the controller-0 console. +**************************************** 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 host do the following: +***************** Initializing Host ***************** @@ -478,6 +490,7 @@ Power on Host. In host console you will see: controller node in order to proceed. +*************************************** 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 host cannot (reliably) support parallel node installation. +*************** 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 complete, the host is reported as Locked, Disabled, and Online. +************* Listing Hosts ************* @@ -581,6 +596,7 @@ On Controller-0, list hosts +----+--------------+-------------+----------------+-------------+--------------+ +*********************************************** 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 -c platform --networks oam controller-1 +************************************ Provisioning Storage on Controller-1 ************************************ @@ -710,6 +727,7 @@ Add the partition to the volume group +--------------------------+--------------------------------------------------+ +********************** Unlocking Controller-1 ********************** @@ -756,6 +774,7 @@ On Controller-0, acquire Keystone administrative privileges: controller-0:~$ source /etc/nova/openrc +************************************************* 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 +*************************** VSwitch Virtual Environment *************************** @@ -802,6 +822,7 @@ vswitch cores to 1: +--------------------------------------+-------+-----------+-------+--------+... +************************************** Provisioning Storage on a Compute Host ************************************** @@ -899,7 +920,7 @@ nova-local: | parameters | {u'concurrent_disk_operations': 2, u'instance_backing': u'image'} | +-----------------+-------------------------------------------------------------------+ - +************************ Unlocking a Compute Host ************************ @@ -920,6 +941,7 @@ unlocked/enabled. System Health Check ------------------- +*********************** Listing StarlingX Nodes *********************** @@ -938,7 +960,7 @@ Unlocked, Enabled, and Available: | 4 | compute-1 | compute | unlocked | enabled | available | +----+--------------+-------------+----------------+-------------+--------------+ - +***************** System Alarm List ***************** diff --git a/doc/source/installation_guide/dedicated_storage.rst b/doc/source/installation_guide/dedicated_storage.rst index 3f60fd02e..129427a7a 100644 --- a/doc/source/installation_guide/dedicated_storage.rst +++ b/doc/source/installation_guide/dedicated_storage.rst @@ -8,6 +8,7 @@ StarlingX/Installation Guide Virtual Environment/Dedicated Storage Preparing Servers ----------------- +********** Bare Metal ********** @@ -21,6 +22,7 @@ Required Servers: - Computes: 2 - 100 +^^^^^^^^^^^^^^^^^^^^^ Hardware Requirements ^^^^^^^^^^^^^^^^^^^^^ @@ -60,6 +62,7 @@ StarlingX Dedicated Storage will be deployed, include: - OAM: 10GE Controller - Data: n x 10GE Compute +******************* Virtual Environment ******************* @@ -87,6 +90,7 @@ The xml server definitions that are created by the previous script are: - storage-0 - storage-1 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Powering Up a Virtual Server ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -104,6 +108,7 @@ e.g. $ sudo virsh start controller-0 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Accessing Virtual Server Consoles ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -142,6 +147,7 @@ Procedure: on a USB in a bootable USB slot. #. Configure the controller using the config_controller script. +************************* 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 configuration. +************************ Configuring Controller-0 ************************ @@ -266,6 +273,7 @@ On Controller-0, acquire Keystone administrative privileges: controller-0:~$ source /etc/nova/openrc +********************************************* 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 +********************************************* Adding a Ceph Storage Backend at Installation ********************************************* @@ -332,6 +341,7 @@ Confirm CEPH storage is configured +--------------------------------------+------------+---------+------------+-------------------+-----------+... +********************** 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 progress of the reboot, use the controller-0 console. + +**************************************** Verifying the Controller-0 Configuration **************************************** @@ -384,6 +396,7 @@ Verify that controller-0 is unlocked, enabled, and available: +----+--------------+-------------+----------------+-------------+--------------+ +******************************* 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. For each host do the following: +***************** Initializing Host ***************** @@ -435,6 +449,7 @@ Power on Host. In host console you will see: controller node in order to proceed. +********************************** 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 "Bridge name:" under MAC Address text field.* +*************** 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 complete, the host is reported as Locked, Disabled, and Online. +************* Listing Hosts ************* @@ -532,6 +549,7 @@ On Controller-0, list hosts +----+--------------+-------------+----------------+-------------+--------------+ +*********************************************** 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 -c platform --networks oam controller-1 +********************** Unlocking Controller-1 ********************** @@ -586,6 +605,7 @@ confirm status. Storage Host Provisioning ------------------------- +************************************** Provisioning Storage on a Storage Host ************************************** @@ -685,6 +705,7 @@ On Controller-0, acquire Keystone administrative privileges: controller-0:~$ source /etc/nova/openrc +************************************************* 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 +*************************** VSwitch Virtual Environment *************************** @@ -731,6 +753,7 @@ vswitch cores to 1: +--------------------------------------+-------+-----------+-------+--------+... +************************************** 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 +************************ Unlocking a Compute Host ************************ @@ -829,6 +853,7 @@ Availability State is reported as In-Test, followed by unlocked/enabled. System Health Check ------------------- +*********************** Listing StarlingX Nodes *********************** @@ -851,6 +876,7 @@ Unlocked, Enabled, and Available: [wrsroot@controller-0 ~(keystone_admin)]$ +****************************** Checking StarlingX CEPH Health ****************************** @@ -869,6 +895,7 @@ Checking StarlingX CEPH Health controller-0:~$ +***************** System Alarm List ***************** diff --git a/doc/source/installation_guide/duplex.rst b/doc/source/installation_guide/duplex.rst index d795616c0..a4d213858 100644 --- a/doc/source/installation_guide/duplex.rst +++ b/doc/source/installation_guide/duplex.rst @@ -8,6 +8,7 @@ StarlingX/Installation Guide Virtual Environment/Duplex Preparing Servers ----------------- +********** Bare Metal ********** @@ -15,6 +16,7 @@ Required Servers: - Combined Servers (Controller + Compute): 2 +^^^^^^^^^^^^^^^^^^^^^ Hardware Requirements ^^^^^^^^^^^^^^^^^^^^^ @@ -49,6 +51,7 @@ StarlingX Duplex will be deployed, include: - OAM: 10GE - Data: n x 10GE +******************* Virtual Environment ******************* @@ -72,6 +75,7 @@ The xml server definitions that are created by the previous script are: - controller-0 - controller-1 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Powering Up a Virtual Server ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -89,6 +93,7 @@ e.g. $ sudo virsh start controller-0 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Accessing Virtual Server Consoles ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -127,6 +132,7 @@ Procedure: on a USB in a bootable USB slot. #. Configure the controller using the config_controller script. +************************* 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 configuration. +************************ Configuring Controller-0 ************************ @@ -271,6 +278,7 @@ On Controller-0, acquire Keystone administrative privileges: controller-0:~$ source /etc/nova/openrc +********************************************* 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 +***************************************** Providing Data Interfaces on Controller-0 ***************************************** @@ -333,6 +342,7 @@ Configure the data interfaces +------------------+--------------------------------------+ +************************************* Configuring Cinder on Controller Disk ************************************* @@ -448,6 +458,7 @@ Add the partition to the volume group +--------------------------+--------------------------------------------------+ +********************************************* Adding an LVM Storage Backend at Installation ********************************************* @@ -497,6 +508,8 @@ state=Configured) +--------------------------------------+------------+---------+------------+------+----------+--------------+ + +*********************************************** Configuring VM Local Storage on Controller Disk *********************************************** @@ -615,6 +628,7 @@ Add the partition to the volume group [wrsroot@controller-0 ~(keystone_admin)]$ +********************** 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 progress of the reboot, use the controller-0 console. +**************************************** Verifying the Controller-0 Configuration **************************************** @@ -682,6 +697,7 @@ Controller-1 Host Installation After initializing and configuring controller-0, you can add and configure a backup controller controller-1. +****************************** 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. +**************************************************** Updating Controller-1 Host Host Name and Personality **************************************************** @@ -769,6 +786,7 @@ attribute: +---------------------+--------------------------------------+ +**************************** 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 complete, the Controller-1 is reported as Locked, Disabled, and Online. +************************* Listing Controller-1 Host ************************* @@ -822,6 +841,7 @@ On Controller-0, list hosts +----+--------------+-------------+----------------+-------------+--------------+ +*********************************************** Provisioning Network Interfaces on Controller-1 *********************************************** @@ -865,6 +885,7 @@ Provision the Controller-1 oam interface +------------------+--------------------------------------+ +***************************************** Providing Data Interfaces on Controller-1 ***************************************** @@ -917,6 +938,7 @@ Configure the data interfaces +------------------+--------------------------------------+ +************************************ 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 *********************************************** @@ -1138,6 +1161,7 @@ Add the partition to the volume group +--------------------------+--------------------------------------------------+ +********************** Unlocking Controller-1 ********************** @@ -1169,6 +1193,7 @@ excessive data-sync time). Use 'fm alarm-list' to confirm status. +----+--------------+-------------+----------------+-------------+--------------+ +***************** System Alarm List ***************** diff --git a/doc/source/installation_guide/index.rst b/doc/source/installation_guide/index.rst index 100c6b2a4..d2b31af3a 100644 --- a/doc/source/installation_guide/index.rst +++ b/doc/source/installation_guide/index.rst @@ -25,6 +25,7 @@ Requirements Different use cases require different configurations. +********** Bare Metal ********** @@ -85,12 +86,14 @@ be deployed, include: The recommended minimum requirements for the physical servers are described later in each StarlingX Deployment Options guide. +******************* Virtual Environment ******************* The recommended minimum requirements for the workstation, hosting the Virtual Machine(s) where StarlingX will be deployed, include: +^^^^^^^^^^^^^^^^^^^^^ Hardware Requirements ^^^^^^^^^^^^^^^^^^^^^ @@ -103,6 +106,7 @@ A workstation computer with: - Hard Disk: 500GB HDD - Network: Two network adapters with active Internet connection +^^^^^^^^^^^^^^^^^^^^^ Software Requirements ^^^^^^^^^^^^^^^^^^^^^ @@ -117,12 +121,14 @@ A workstation computer with: - project - StarlingX ISO Image +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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. +'''''''''''''''''''''''''''''' Updating Your Operating System '''''''''''''''''''''''''''''' @@ -133,7 +139,7 @@ first need to update the local database list of available packages: $ sudo apt-get update - +''''''''''''''''''''''''' Install stx-tools project ''''''''''''''''''''''''' @@ -146,6 +152,7 @@ user’s home directory. $ git clone https://git.starlingx.io/stx-tools +'''''''''''''''''''''''''''''''''''''''' Installing Requirements and Dependencies '''''''''''''''''''''''''''''''''''''''' @@ -163,6 +170,7 @@ Install the required packages: $ bash install_packages.sh +'''''''''''''''''' Disabling Firewall '''''''''''''''''' @@ -184,14 +192,14 @@ Follow the instructions from the :ref:`developer-guide` to build a StarlingX ISO image. - +********** Bare Metal ********** A bootable USB flash drive containing StarlingX ISO image. - +******************* Virtual Environment ******************* diff --git a/doc/source/installation_guide/installation_libvirt_qemu.rst b/doc/source/installation_guide/installation_libvirt_qemu.rst index 731b158ce..05b31e196 100644 --- a/doc/source/installation_guide/installation_libvirt_qemu.rst +++ b/doc/source/installation_guide/installation_libvirt_qemu.rst @@ -35,12 +35,13 @@ A workstation computer with: - project - StarlingX ISO Image +---------------------------- Deployment Environment Setup -**************************** +---------------------------- -------------- +************* 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 @@ -72,9 +73,9 @@ This rc file shows the defaults baked into the scripts: 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. @@ -98,9 +99,9 @@ Load the configuration (if you created one) from madcloud.rc: source madcloud.rc ----------------------------------------- +**************************************** 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 @@ -111,9 +112,9 @@ time): $SCRIPTS/install_packages.sh ------------------- +****************** Disabling Firewall ------------------- +****************** Unload firewall and disable firewall on boot: @@ -123,9 +124,9 @@ Unload firewall and disable firewall on boot: sudo ufw status ------------------- +****************** Configure Networks ------------------- +****************** Configure the network bridges using setup_network.sh before doing 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 configuration from libvirt. ---------------------- +********************* Configure Controllers ---------------------- +********************* There are two scripts for creating the controllers: setup_allinone.sh 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 destroy_standard_controller.sh. +-------- Continue -******** +-------- Pick up the installation in one of the existing guides at the 'Initializing Controller-0 step. diff --git a/doc/source/installation_guide/simplex.rst b/doc/source/installation_guide/simplex.rst index cd847fc72..19e21dc04 100644 --- a/doc/source/installation_guide/simplex.rst +++ b/doc/source/installation_guide/simplex.rst @@ -8,6 +8,7 @@ StarlingX/Installation Guide Virtual Environment/Simplex Preparing Servers ----------------- +********** Bare Metal ********** @@ -15,6 +16,7 @@ Required Server: - Combined Server (Controller + Compute): 1 +^^^^^^^^^^^^^^^^^^^^^ Hardware Requirements ^^^^^^^^^^^^^^^^^^^^^ @@ -48,6 +50,7 @@ StarlingX Simplex will be deployed, include: - Management: 10GE - OAM: 10GE +******************* Virtual Environment ******************* @@ -73,6 +76,7 @@ The xml server definitions that are created by the previous script are: Only controller-0 will be provisioned. +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Powering Up a Virtual Server ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -88,6 +92,7 @@ e.g. $ sudo virsh start controller-0 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Accessing Virtual Server Consoles ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -126,6 +131,7 @@ Procedure: on a USB in a bootable USB slot. #. Configure the controller using the config_controller script. +************************* 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 configuration. +************************ Configuring Controller-0 ************************ @@ -271,6 +278,7 @@ On Controller-0, acquire Keystone administrative privileges: controller-0:~$ source /etc/nova/openrc +********************************************* 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 +***************************************** Providing Data Interfaces on Controller-0 ***************************************** @@ -333,6 +342,7 @@ Configure the data interfaces +------------------+--------------------------------------+ +************************************* Configuring Cinder on Controller Disk ************************************* @@ -448,6 +458,7 @@ Add the partition to the volume group +--------------------------+--------------------------------------------------+ +********************************************* Adding an LVM Storage Backend at Installation ********************************************* @@ -497,6 +508,7 @@ state=Configured) +--------------------------------------+------------+---------+------------+------+----------+--------------+ +*********************************************** Configuring VM Local Storage on Controller Disk *********************************************** @@ -615,6 +627,7 @@ Add the partition to the volume group [wrsroot@controller-0 ~(keystone_admin)]$ +********************** 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 progress of the reboot, use the controller-0 console. +**************************************** Verifying the Controller-0 Configuration **************************************** @@ -675,6 +689,7 @@ Verify that controller-0 is unlocked, enabled, and available: +----+--------------+-------------+----------------+-------------+--------------+ +***************** System Alarm List ***************** diff --git a/doc/source/releasenotes/index.rst b/doc/source/releasenotes/index.rst index a225033d8..a244fe628 100644 --- a/doc/source/releasenotes/index.rst +++ b/doc/source/releasenotes/index.rst @@ -1,8 +1,108 @@ -======================= -StarlingX Release Notes -======================= +.. _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 `__ +for the list of tests executed on this release. + +View the +`testing summary `__ +to see the status of testing for this release. + +------------------------------ +Project-specific release notes +------------------------------ * `Bare Metal `__ * `Clients `__