Support flattened install

File location changes to support DS flattend Install TOC
Add minitocs and remove duplicate include directive
Convert images to figures and add captions
Incorporate server prep. steps
Add links to post-install steps.
Inline overview and HW topics in procs.
Patchset 1 review updates.
Rework to reuse some StX install content in partner context
and some partner install content in StX context.
Conditionalize ipv6_note
Share aio_duplex_extend
Conditionalize Openstack prod name
Add HW requirement includes for worker and storage nodes.
Link worker and stor reqs to DX, StD and Dedicated install
topics.
Fix comment notation
Correct for duplicate strings in output
Updates and additions based on GW review
Make ansible_install_time_only note available DS.
Move link target from r6 > r7
Temporarily restore alarms to satisfy build
Migrate DX flattening to new layout
Additional HW requirements to DX, Std and Dedicated tables.
Migrate Standard flattening to new layout
Roll this-ver forward to r7
Migrate Dedicated Storage flattening to new layout
Address review comments.
Standardize HW requirement tables
Support horizontally conditionalized inline content
Address additional review comments

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I14c8a1e51f6b6ceff69be063a654b4aadb7d3b8c
This commit is contained in:
Ron Stone
2022-10-14 08:09:58 -04:00
parent 3774dbf685
commit bc8e3704db
60 changed files with 2051 additions and 300 deletions

View File

@@ -1,7 +0,0 @@
.. important::
Some Ansible bootstrap parameters cannot be changed or are very difficult to change after installation is complete.
Review the set of install-time-only parameters before installation and confirm that your values for these parameters are correct for the desired installation.
Refer to :ref:`Ansible install-time-only parameters <install-time-only-params-r6>` for details.

View File

@@ -0,0 +1,3 @@
.. begin-vdr-additional-prereqs
.. end-vdr-additional-prereqs

View File

@@ -0,0 +1,3 @@
.. begin-install-ctl-0
.. end-install-ctl-0

View File

@@ -0,0 +1,3 @@
* Refer to :ref:`stx_ipv6_deployment` for details on how to deploy a
NAT64/DNS64 gateway to use StarlingX with IPv6.

View File

@@ -0,0 +1,63 @@
--------
Overview
--------
Ironic is an OpenStack project that provisions bare metal machines. For
information about the Ironic project, see
`Ironic Documentation <https://docs.openstack.org/ironic>`__.
End user applications can be deployed on bare metal servers (instead of
virtual machines) by configuring OpenStack Ironic and deploying a pool of 1 or
more bare metal servers.
.. note::
If you are behind a corporate firewall or proxy, you need to set proxy
settings. Refer to :ref:`docker_proxy_config` for
details.
.. figure:: /deploy_install_guides/r7_release/figures/starlingx-deployment-options-ironic.png
:scale: 50%
:alt: Standard with Ironic deployment configuration
*Figure 1: Standard with Ironic deployment configuration*
Bare metal servers must be connected to:
* IPMI for OpenStack Ironic control
* ironic-provisioning-net tenant network via their untagged physical interface,
which supports PXE booting
As part of configuring OpenStack Ironic in StarlingX:
* An ironic-provisioning-net tenant network must be identified as the boot
network for bare metal nodes.
* An additional untagged physical interface must be configured on controller
nodes and connected to the ironic-provisioning-net tenant network. The
OpenStack Ironic tftpboot server will PXE boot the bare metal servers over
this interface.
.. note::
Bare metal servers are NOT:
* Running any OpenStack / StarlingX software; they are running end user
applications (for example, Glance Images).
* To be connected to the internal management network.
------------
Installation
------------
StarlingX currently supports only a bare metal installation of Ironic with a
standard configuration, either:
* :doc:`controller_storage_install_kubernetes`
* :doc:`dedicated_storage_install_kubernetes`
This guide assumes that you have a standard deployment installed and configured
with 2x controllers and at least 1x compute-labeled worker node, with the
StarlingX OpenStack application (|prefix|-openstack) applied.

View File

@@ -0,0 +1,51 @@
---------------------
Hardware Requirements
---------------------
This section describes the hardware requirements and server preparation for a
**StarlingX R7.0 bare metal Ironic** deployment configuration.
.. contents::
:local:
:depth: 1
*****************************
Minimum hardware requirements
*****************************
* One or more bare metal hosts as Ironic nodes as well as tenant instance node.
* BMC support on bare metal host and controller node connectivity to the BMC IP
address of bare metal hosts.
For controller nodes:
* Additional NIC port on both controller nodes for connecting to the
ironic-provisioning-net.
For worker nodes:
* If using a flat data network for the Ironic provisioning network, an additional
NIC port on one of the worker nodes is required.
* Alternatively, use a VLAN data network for the Ironic provisioning network and
simply add the new data network to an existing interface on the worker node.
* Additional switch ports / configuration for new ports on controller, worker,
and Ironic nodes, for connectivity to the Ironic provisioning network.
***********************************
BMC configuration of Ironic node(s)
***********************************
Enable BMC and allocate a static IP, username, and password in the BIOS settings.
For example, set:
IP address
10.10.10.126
username
root
password
test123

View File

@@ -0,0 +1,466 @@
=====================
Hardware Requirements
=====================
.. begin-min-hw-reqs-common-intro
-----------------------------
Minimum hardware requirements
-----------------------------
This section describes the hardware requirements and server preparation for a
**StarlingX R7.0 bare metal All-in-one Simplex** deployment configuration.
.. contents::
:local:
:depth: 1
The recommended minimum hardware requirements for bare metal servers for various
host types are:
.. end-min-hw-reqs-common-intro
..
.. Simplex
..
.. begin-prepare-servers
.. begin-min-hw-reqs-sx
.. list-table::
:header-rows: 1
* - Minimum Requirements
- All-in-one Controller Node
* - Number of servers
- 1
* - Minimum processor class
- Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8 cores/socket
or
Single-CPU Intel® Xeon® D-15xx family, 8 cores (low-power/low-cost option)
.. only:: starlingx
Platform: 2x physical cores (4x logical cores if hyper-threading), (by
default, configurable)
Application: Remaining cores
* - Minimum memory
- 64 GB
.. only:: starlingx
* Platform:
- Socket 0: 7GB (by default, configurable)
- Socket 1: 1GB (by default, configurable)
* Application:
- Socket 0: Remaining memory
- Socket 1: Remaining memory
* - Primary disk
- 500 GB SSD or |NVMe| (see :ref:`nvme_config`)
* - Additional disks
- * 1 or more 500 GB (min. 10K RPM) for Ceph |OSD|
* Recommended, but not required: 1 or more |SSDs| or |NVMe| drives for
Ceph journals (min. 1024 MiB per |OSD| journal)
.. only:: starlingx
* Recommended, but not required: 1 or more 500G HDs (min. 10K RPM),
SSDs or | drives for Container ephemeral disk storage
.. only:: openstack
* For OpenStack, recommend 1 or more 500 GB (min. 10K RPM) for |VM|
local ephemeral storage
* - Minimum network ports
.. only:: starlingx
* MGMT: 1x1GE ( Recommended: MGMT 2x10GE LAG ). Only required if
Subcloud in |prod-dc|.
- * |OAM|: 1x1GE |oam-hw-recommended|
* Data: 1 or more x 10GE |data-hw-recommended|
.. only:: starlingx
* - USB Interface
- 1 (Only required if used for initial installation of controller-0)
* - Boot Order
- HD, PXE, USB
* - BIOS mode
- BIOS or |UEFI|
.. note::
|UEFI Secure Boot and |UEFI| |PXE| boot over IPv6 are not
supported. On systems with an IPv6 management network, you can use
a separate IPv4 network for PXE boot. For more information, see
:ref:`the-pxe-boot-network>`.
* - Bios settings
- * Hyper-Threading technology enabled
* Virtualization technology enabled
* VT for directed I/O enabled
* CPU power and performance policy set to performance
* |min-proc-idle-power| CPU C state control disabled
* Plug & play |BMC| detection disabled
.. end-min-hw-reqs-sx
--------------------------
Prepare bare metal servers
--------------------------
.. include:: prep_servers.txt
* Cabled for networking
* Far-end switch ports should be properly configured to realize the networking
shown in the following diagram.
.. figure:: /deploy_install_guides/r7_release/figures/starlingx-deployment-options-simplex.png
:scale: 50%
:alt: All-in-one Simplex deployment configuration
*All-in-one Simplex deployment configuration*
.. end-prepare-servers
..
.. Duplex
..
.. begin-prepare-servers-dx
.. begin-min-hw-reqs-dx
This section describes the hardware requirements and server preparation for a
**StarlingX R7.0 bare metal All-in-one Duplex** deployment configuration.
.. contents::
:local:
:depth: 1
-----------------------------
Minimum hardware requirements
-----------------------------
The recommended minimum hardware requirements for bare metal servers for various
host types are:
.. list-table::
:header-rows: 1
* - Minimum Requirements
- All-in-one Controller Node
* - Number of servers
- 2
* - Minimum processor class
- * Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8 cores/socket
or
* Single-CPU Intel® Xeon® D-15xx family, 8 cores (low-power/low-cost option)
* - Minimum memory
- 64 GB
* - Primary disk
- 500 GB SSD or |NVMe| (see :ref:`nvme_config`)
* - Additional disks
- * 1 or more 500 GB (min. 10K RPM) for Ceph |OSD|
* Recommended, but not required: 1 or more |SSDs| or |NVMe| drives for
Ceph journals (min. 1024 MiB per |OSD| journal)
* For OpenStack, recommend 1 or more 500 GB (min. 10K RPM) for |VM| local
ephemeral storage
* - Minimum network ports
- * Mgmt/Cluster: 1x10GE
* |OAM|: 1x1GE
* Data: 1 or more x 10GE
* - Bios settings
- * Hyper-Threading technology enabled
* Virtualization technology enabled
* VT for directed I/O enabled
* CPU power and performance policy set to performance
* CPU C state control disabled
* Plug & play |BMC| detection disabled
.. end-min-hw-reqs-dx
--------------------------
Prepare bare metal servers
--------------------------
.. include:: prep_servers.txt
* Cabled for networking
* Far-end switch ports should be properly configured to realize the networking
shown in the diagram above.
.. end-prepare-servers-dx
..
.. Standard with storage
..
.. begin-prepare-servers-std
.. begin-min-hw-reqs-std
=====================
Hardware Requirements
=====================
This section describes the hardware requirements and server preparation for a
**StarlingX R7.0 bare metal Standard with Controller Storage** deployment
configuration.
.. contents::
:local:
:depth: 1
-----------------------------
Minimum hardware requirements
-----------------------------
The recommended minimum hardware requirements for bare metal servers for various
host types are:
.. list-table::
:header-rows: 1
* - Minimum Requirements
- Controller Node
- Worker Node
* - Number of servers
- 2
- 2-10
* - Minimum processor class
- Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8 cores/socket
- (Same as controller node)
* - Minimum memory
- 64 GB
- 32 GB
* - Primary disk
- 500 GB SSD or |NVMe| (see Configure |NVMe| Drive as Primary Disk)
- 120 GB (Minimum 10k RPM)
* - Additional disks
- * 1 or more 500 GB (min. 10K RPM) for Ceph |OSD|
* Recommended, but not required: 1 or more |SSDs| or |NVMe| drives for
Ceph journals (min. 1024 MiB per |OSD| journal)
- For OpenStack, recommend 1 or more 500 GB (min. 10K RPM) for |VM| local
ephemeral storage
* - Minimum network ports
- * Mgmt/Cluster: 1x10GE
* |OAM|: 1x1GE
- * Mgmt/Cluster: 1x10GE
* Data: 1 or more x 10GE
* - Bios settings
- * Hyper-Threading technology enabled
* Virtualization technology enabled
* VT for directed I/O enabled
* CPU power and performance policy set to performance
* CPU C state control disabled
* Plug & play |BMC| detection disabled
- (Same as controller node)
.. end-min-hw-reqs-std
--------------------------
Prepare bare metal servers
--------------------------
.. include:: prep_servers.txt
* Cabled for networking
* Far-end switch ports should be properly configured to realize the networking
shown in the diagram above.
.. end-prepare-servers-std
..
.. Dedicated storage
..
.. begin-prepare-servers-ded
.. begin-min-hw-reqs-ded
=====================
Hardware Requirements
=====================
This section describes the hardware requirements and server preparation for a
**StarlingX R7.0 bare metal Standard with Dedicated Storage** deployment
configuration.
.. contents::
:local:
:depth: 1
-----------------------------
Minimum hardware requirements
-----------------------------
The recommended minimum hardware requirements for bare metal servers for various
host types are:
.. list-table::
:header-rows: 1
* - Minimum Requirements
- Controller Node
- Storage Node
- Worker Node
* - Number of servers
- 2
- 2-9
- 2-100
* - Minimum processor class
- Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8 cores/socket
- (Same as controller node)
- (Same as controller node)
* - Minimum memory
- 64 GB
- 64 GB
- 32 GB
* - Primary disk
- 500 GB SSD or |NVMe| (see :ref:`nvme_config`)
- 120 GB (min. 10k RPM)
- 120 GB (min. 10k RPM)
* - Additional disks
- None
- * 1 or more 500 GB (min. 10K RPM) for Ceph |OSD|
* Recommended, but not required: 1 or more |SSDs| or |NVMe| drives for
Ceph journals (min. 1024 MiB per |OSD| journal)
- For OpenStack, recommend 1 or more 500 GB (min. 10K RPM) for |VM| ephemeral
storage
* - Minimum network ports
- * Mgmt/Cluster: 1x10GE
* |OAM|: 1x1GE
- Mgmt/Cluster: 1x10GE
- * Mgmt/Cluster: 1x10GE
* Data: 1 or more x 10GE
* - Bios settings
- * Hyper-Threading technology enabled
* Virtualization technology enabled
* VT for directed I/O enabled
* CPU power and performance policy set to performance
* CPU C state control disabled
* Plug & play |BMC| detection disabled
- (Same as controller node)
- (Same as controller node)
.. end-min-hw-reqs-ded
--------------------------
Prepare bare metal servers
--------------------------
.. include:: prep_servers.txt
* Cabled for networking
* Far-end switch ports should be properly configured to realize the networking
shown in the diagram above.
.. end-prepare-servers-ded
.. start-prepare-servers-common
Preparing servers is the first step of the |prod| installation procedure.
.. rubric:: |proc|
- Prior to starting the |prod| installation, ensure that the bare metal
servers are in the following state:
- Physically installed.
- Cabled for power.
- Cabled for networking.
Far-end switch ports should be properly configured to realize the
networking shown in :ref:`deployment-options` for the particular
deployment configuration you are installing.
- All disks are wiped.
This ensures that servers will boot from either the network or USB
storage, if present.
.. note::
The disks and disk partitions need to be wiped before the install.
Installing a Debian ISO may fail with a message that the system is
in emergency mode if the disks and disk partitions are not
completely wiped before the install, especially if the server was
previously running a CentOS ISO.
.. only:: partner
.. include:: /_includes/debian-rn-link-a90a7e432679.rest
- BIOS configured with Intel Virtualization (VTD, VTX)
- Disabled for controller-only servers and storage servers.
- Enabled for controller+worker servers and worker servers.
- The servers are powered off.
.. end-prepare-servers-common

View File

@@ -0,0 +1,9 @@
--------
Overview
--------
.. include:: /shared/_includes/desc_rook_storage.txt
.. include:: /shared/_includes/ipv6_note.txt

View File

@@ -0,0 +1,67 @@
---------------------
Hardware requirements
---------------------
This section describes the hardware requirements and server preparation for a
**StarlingX R7.0 bare metal Standard with Rook Storage** deployment
configuration.
.. contents::
:local:
:depth: 1
-----------------------------
Minimum hardware requirements
-----------------------------
The recommended minimum hardware requirements for bare metal servers for various
host types are:
+---------------------+---------------------------+-----------------------+-----------------------+
| Minimum Requirement | Controller Node | Worker Node for rook | Worker Node for |
| | | storage | application |
+=====================+===========================+=======================+=======================+
| Number of servers | 2 | 2-9 | 2-100 |
+---------------------+---------------------------+-----------------------+-----------------------+
| Minimum processor | Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8 cores/socket |
| class | |
+---------------------+---------------------------+-----------------------+-----------------------+
| Minimum memory | 64 GB | 64 GB | 32 GB |
+---------------------+---------------------------+-----------------------+-----------------------+
| Primary disk | 500 GB SSD or NVMe (see | 120 GB (min. 10k RPM) | 120 GB (min. 10k RPM) |
| | :ref:`nvme_config`) | | |
+---------------------+---------------------------+-----------------------+-----------------------+
| Additional disks | None | - 1 or more 500 GB | - For OpenStack, |
| | | (min. 10K RPM) for | recommend 1 or more |
| | | Ceph OSD | 500 GB (min. 10K |
| | | - Recommended, but | RPM) for VM |
| | | not required: 1 or | ephemeral storage |
| | | more SSDs or NVMe | |
| | | drives for Ceph | |
| | | journals (min. 1024 | |
| | | MiB per OSD | |
| | | journal) | |
+---------------------+---------------------------+-----------------------+-----------------------+
| Minimum network | - Mgmt/Cluster: | - Mgmt/Cluster: | - Mgmt/Cluster: |
| ports | 1x10GE | 1x10GE | 1x10GE |
| | - OAM: 1x1GE | | - Data: 1 or more |
| | | | x 10GE |
+---------------------+---------------------------+-----------------------+-----------------------+
| BIOS settings | - Hyper-Threading technology enabled |
| | - Virtualization technology enabled |
| | - VT for directed I/O enabled |
| | - CPU power and performance policy set to performance |
| | - CPU C state control disabled |
| | - Plug & play BMC detection disabled |
+---------------------+---------------------------+-----------------------+-----------------------+
--------------------------
Prepare bare metal servers
--------------------------
.. include:: prep_servers.txt
* Cabled for networking
* Far-end switch ports should be properly configured to realize the networking
shown in the diagram above.