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

@ -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

@ -1,7 +1,3 @@
====================================
Bare metal Standard with Ironic R7.0
====================================
-------- --------
Overview Overview
-------- --------
@ -56,17 +52,12 @@ Installation
StarlingX currently supports only a bare metal installation of Ironic with a StarlingX currently supports only a bare metal installation of Ironic with a
standard configuration, either: standard configuration, either:
* :doc:`controller_storage` * :doc:`controller_storage_install_kubernetes`
* :doc:`dedicated_storage` * :doc:`dedicated_storage_install_kubernetes`
This guide assumes that you have a standard deployment installed and configured 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 with 2x controllers and at least 1x compute-labeled worker node, with the
StarlingX OpenStack application (|prefix|-openstack) applied. StarlingX OpenStack application (|prefix|-openstack) applied.
.. toctree::
:maxdepth: 1
ironic_hardware
ironic_install

View File

@ -1,6 +1,6 @@
===================== ---------------------
Hardware Requirements Hardware Requirements
===================== ---------------------
This section describes the hardware requirements and server preparation for a This section describes the hardware requirements and server preparation for a
**StarlingX R7.0 bare metal Ironic** deployment configuration. **StarlingX R7.0 bare metal Ironic** deployment configuration.
@ -9,9 +9,9 @@ This section describes the hardware requirements and server preparation for a
:local: :local:
:depth: 1 :depth: 1
----------------------------- *****************************
Minimum hardware requirements Minimum hardware requirements
----------------------------- *****************************
* One or more bare metal hosts as Ironic nodes as well as tenant instance node. * One or more bare metal hosts as Ironic nodes as well as tenant instance node.
@ -34,9 +34,9 @@ For worker nodes:
* Additional switch ports / configuration for new ports on controller, worker, * Additional switch ports / configuration for new ports on controller, worker,
and Ironic nodes, for connectivity to the Ironic provisioning network. and Ironic nodes, for connectivity to the Ironic provisioning network.
----------------------------------- ***********************************
BMC configuration of Ironic node(s) BMC configuration of Ironic node(s)
----------------------------------- ***********************************
Enable BMC and allocate a static IP, username, and password in the BIOS settings. Enable BMC and allocate a static IP, username, and password in the BIOS settings.
For example, set: For example, set:

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

@ -1,6 +1,6 @@
===================== ---------------------
Hardware Requirements Hardware requirements
===================== ---------------------
This section describes the hardware requirements and server preparation for a This section describes the hardware requirements and server preparation for a
**StarlingX R7.0 bare metal Standard with Rook Storage** deployment **StarlingX R7.0 bare metal Standard with Rook Storage** deployment
@ -64,10 +64,4 @@ Prepare bare metal servers
* Cabled for networking * Cabled for networking
* Far-end switch ports should be properly configured to realize the networking * Far-end switch ports should be properly configured to realize the networking
shown in the following diagram. shown in the diagram above.
.. figure:: /deploy_install_guides/r7_release/figures/starlingx-deployment-options-controller-storage.png
:scale: 50%
:alt: Standard with Rook Storage deployment configuration
*Standard with Rook Storage deployment configuration*

View File

@ -1,3 +1,3 @@
.. |this-prod| replace:: |prod-long| .. |this-prod| replace:: |prod-long|
.. |this-ver| replace:: r6.0 .. |this-ver| replace:: r7.0

View File

@ -66,7 +66,7 @@
.. StarlingX (|prod|) .. StarlingX (|prod|)
.. |prod-ver| replace:: 6.0 .. |prod-ver| replace:: |this-ver|
.. Version at which we cut over to Deb. .. Version at which we cut over to Deb.
.. |deb-release-ver| replace:: release 8.0 .. |deb-release-ver| replace:: release 8.0
@ -97,6 +97,14 @@
.. |only-target| replace:: StarlingX .. |only-target| replace:: StarlingX
.. |bare-metal| replace:: bare metal
.. |reg-string| replace:: public open source registries
..
.. Custom refs
..
.. Used in installing-a-subcloud-without-redfish-platform-management-service.rst .. Used in installing-a-subcloud-without-redfish-platform-management-service.rst
because target lable differs here/partner contexts. because target lable differs here/partner contexts.

View File

@ -10,7 +10,7 @@ Standard Configuration with Controller Storage
back-end for Kubernetes |PVCs| deployed on the back-end for Kubernetes |PVCs| deployed on the
controller nodes instead of using dedicated storage nodes. controller nodes instead of using dedicated storage nodes.
.. image:: /deploy_install_guides/r6_release/figures/starlingx-deployment-options-controller-storage.png .. image:: /shared/figures/deploy_install_guides/starlingx-deployment-options-controller-storage.png
:width: 800 :width: 800
See :ref:`Common Components <common-components>` for a description of common See :ref:`Common Components <common-components>` for a description of common

View File

@ -14,7 +14,7 @@ redundant pair of hosts.
:local: :local:
:depth: 1 :depth: 1
.. image:: /deploy_install_guides/r6_release/figures/starlingx-deployment-options-duplex.png .. image:: /shared/figures/deploy_install_guides/starlingx-deployment-options-duplex.png
:width: 800 :width: 800
See :ref:`Common Components <common-components>` for a description of common See :ref:`Common Components <common-components>` for a description of common

View File

@ -10,7 +10,7 @@ The AIO Simplex deployment configuration provides a scaled-down |prod| that
combines controller, storage, and worker functionality on a single combines controller, storage, and worker functionality on a single
non-redundant host. non-redundant host.
.. image:: /deploy_install_guides/r6_release/figures/starlingx-deployment-options-simplex.png .. image:: /shared/figures/deploy_install_guides/starlingx-deployment-options-simplex.png
:width: 800 :width: 800
.. note:: .. note::

View File

@ -9,7 +9,7 @@ Standard Configuration with Dedicated Storage
Deployment of |prod| with dedicated storage nodes provides the highest capacity Deployment of |prod| with dedicated storage nodes provides the highest capacity
\(single region\), performance, and scalability. \(single region\), performance, and scalability.
.. image:: /deploy_install_guides/r6_release/figures/starlingx-deployment-options-dedicated-storage.png .. image:: /shared/figures/deploy_install_guides/starlingx-deployment-options-dedicated-storage.png
:width: 800 :width: 800
See :ref:`Common Components <common-components>` for a description of common See :ref:`Common Components <common-components>` for a description of common

View File

@ -91,7 +91,7 @@ Bootstrap system on controller-0
.. only:: starlingx .. only:: starlingx
.. include:: /_includes/ansible_install_time_only.txt .. include:: /shared/_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods: playbook using one of the following methods:

View File

@ -91,7 +91,7 @@ Bootstrap system on controller-0
.. only:: starlingx .. only:: starlingx
.. include:: /_includes/ansible_install_time_only.txt .. include:: /shared/_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods: playbook using one of the following methods:

View File

@ -90,7 +90,7 @@ Bootstrap system on controller-0
.. only:: starlingx .. only:: starlingx
.. include:: /_includes/ansible_install_time_only.txt .. include:: /shared/_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods: playbook using one of the following methods:

View File

@ -98,7 +98,7 @@ Bootstrap system on controller-0
The default location where Ansible looks for and imports user The default location where Ansible looks for and imports user
configuration override files for hosts. For example: ``$HOME/<hostname>.yml``. configuration override files for hosts. For example: ``$HOME/<hostname>.yml``.
.. include:: /_includes/ansible_install_time_only.txt .. include:: /shared/_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods: playbook using one of the following methods:

View File

@ -84,7 +84,7 @@ On virtual controller-0:
The default location where Ansible looks for and imports user The default location where Ansible looks for and imports user
configuration override files for hosts. For example: ``$HOME/<hostname>.yml``. configuration override files for hosts. For example: ``$HOME/<hostname>.yml``.
.. include:: /_includes/ansible_install_time_only.txt .. include:: /shared/_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods: playbook using one of the following methods:

View File

@ -85,7 +85,7 @@ On virtual controller-0:
The default location where Ansible looks for and imports user The default location where Ansible looks for and imports user
configuration override files for hosts. For example: ``$HOME/<hostname>.yml``. configuration override files for hosts. For example: ``$HOME/<hostname>.yml``.
.. include:: /_includes/ansible_install_time_only.txt .. include:: /shared/_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods: playbook using one of the following methods:

View File

@ -89,7 +89,7 @@ On virtual controller-0:
The default location where Ansible looks for and imports user The default location where Ansible looks for and imports user
configuration override files for hosts. For example: ``$HOME/<hostname>.yml``. configuration override files for hosts. For example: ``$HOME/<hostname>.yml``.
.. include:: /_includes/ansible_install_time_only.txt .. include:: /shared/_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods: playbook using one of the following methods:

View File

@ -5,35 +5,161 @@
Install Kubernetes Platform on All-in-one Duplex Install Kubernetes Platform on All-in-one Duplex
================================================ ================================================
.. only:: partner .. only:: partner
.. include:: /_includes/install-kubernetes-null-labels.rest .. include:: /_includes/install-kubernetes-null-labels.rest
.. only:: starlingx .. contents:: |minitoc|
This section describes the steps to install the StarlingX Kubernetes
platform on a **StarlingX R7.0 All-in-one Duplex** deployment
configuration.
.. contents::
:local: :local:
:depth: 1 :depth: 1
--------------------- --------
Create a bootable USB Overview
--------------------- --------
Refer to :ref:`Bootable USB <bootable_usb>` for instructions on how .. _aiodx-installation-prereqs:
to create a bootable USB with the StarlingX ISO on your system.
-------------------------------- .. include:: /shared/_includes/desc_aio_duplex.txt
Install software on controller-0
--------------------------------
.. include:: /shared/_includes/inc-install-software-on-controller.rest .. _installation-prereqs-dx:
-----------------------------
Minimum hardware requirements
-----------------------------
.. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
:start-after: begin-min-hw-reqs-dx
:end-before: end-min-hw-reqs-dx
--------------------------
Installation Prerequisites
--------------------------
.. include:: /shared/_includes/installation-prereqs.rest
:start-after: begin-install-prereqs
:end-before: end-install-prereqs
--------------------------------
Prepare Servers for Installation
--------------------------------
.. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
:start-after: start-prepare-servers-common
:end-before: end-prepare-servers-common
--------------------------------
Install Software on Controller-0
--------------------------------
.. include:: /shared/_includes/inc-install-software-on-controller.rest
:start-after: incl-install-software-controller-0-aio-start :start-after: incl-install-software-controller-0-aio-start
:end-before: incl-install-software-controller-0-aio-end :end-before: incl-install-software-controller-0-aio-end
.. .. figure:: /shared/figures/deploy_install_guides/starlingx-deployment-options-duplex.png
.. :width: 800
.. All-in-one Duplex deployment configuration
.. _installation-prereqs-duplex:
.. --------------------------
.. Installation Prerequisites
.. --------------------------
.. .. include:: /_includes/installation-prereqs.rest
.. :start-after: begin-install-prereqs
.. :end-before: end-install-prereqs
.. --------------------------------
.. Prepare Servers for Installation
.. --------------------------------
.. .. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
.. :start-after: begin-min-hw-reqs-common-intro
.. :end-before: end-min-hw-reqs-common-intro
.. .. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
.. :start-after: begin-min-hw-reqs-dx
.. :end-before: end-min-hw-reqs-dx
.. The following requirements must be met if :ref:`extending a Duplex
.. installation <extend-dx-with-workers>`.
.. .. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
.. :start-after: begin-worker-hw-reqs
.. :end-before: end-worker-hw-reqs
.. --------------------------------
.. Install Software on Controller-0
.. --------------------------------
.. .. include:: /_includes/installing-software-on-controller-0.rest
.. :start-after: begin-install-ctl-0
.. :end-before: end-install-ctl-0
.. .. only:: starlingx
.. .. contents:: |minitoc|
.. :local:
.. :depth: 1
.. .. --------
.. .. Overview
.. .. --------
.. .. .. include:: /shared/_includes/installation-prereqs.rest
.. .. :start-after: begin-install-prereqs-dx
.. .. :end-before: end-install-prereqs-dx
.. ---------------------
.. Hardware Requirements
.. ---------------------
.. .. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
.. :start-after: begin-min-hw-reqs-common-intro
.. :end-before: end-min-hw-reqs-common-intro
.. .. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
.. :start-after: begin-min-hw-reqs-dx
.. :end-before: end-min-hw-reqs-dx
.. The following requirements must be met if :ref:`extending a Duplex
.. installation <extend-dx-with-workers>`.
.. .. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
.. :start-after: begin-worker-hw-reqs
.. :end-before: end-worker-hw-reqs
.. .. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
.. :start-after: start-prepare-servers-common
.. :end-before: end-prepare-servers-common
.. This section describes the steps to install the StarlingX Kubernetes
.. platform on a **StarlingX R7.0 All-in-one Duplex** deployment
.. configuration.
.. .. contents::
.. :local:
.. :depth: 1
.. ---------------------
.. Create a bootable USB
.. ---------------------
.. Refer to :ref:`Bootable USB <bootable_usb>` for instructions on how
.. to create a bootable USB with the StarlingX ISO on your system.
.. --------------------------------
.. Install software on controller-0
.. --------------------------------
.. .. include:: /shared/_includes/inc-install-software-on-controller.rest
.. :start-after: incl-install-software-controller-0-aio-start
.. :end-before: incl-install-software-controller-0-aio-end
-------------------------------- --------------------------------
Bootstrap system on controller-0 Bootstrap system on controller-0
-------------------------------- --------------------------------
@ -91,7 +217,7 @@ Bootstrap system on controller-0
.. only:: starlingx .. only:: starlingx
.. include:: /_includes/ansible_install_time_only.txt .. include:: /shared/_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods: playbook using one of the following methods:
@ -1155,6 +1281,16 @@ machine.
.. include:: /_includes/bootstrapping-and-deploying-starlingx.rest .. include:: /_includes/bootstrapping-and-deploying-starlingx.rest
.. _extend-dx-with-workers:
--------------------------------------------
Optionally Extend Capacity with Worker Nodes
--------------------------------------------
.. include:: /shared/_includes/aio_duplex_extend.rest
:start-after: start-aio-duplex-extend
:end-before: end-aio-duplex-extend
.. only:: starlingx .. only:: starlingx
---------- ----------
@ -1167,3 +1303,9 @@ machine.
.. only:: partner .. only:: partner
.. include:: /_includes/72hr-to-license.rest .. include:: /_includes/72hr-to-license.rest
Complete system configuration by reviewing procedures in:
- :ref:`index-security-84d0d8aa401b`
- :ref:`index-sysconf-d511820651f0`
- :ref:`index-admintasks-768a6e9aaeff`

View File

@ -62,10 +62,10 @@ Prepare bare metal servers
* Cabled for networking * Cabled for networking
* Far-end switch ports should be properly configured to realize the networking * Far-end switch ports should be properly configured to realize the networking
shown in the following diagram. shown in the diagram above.
.. figure:: /deploy_install_guides/r7_release/figures/starlingx-deployment-options-simplex.png .. .. figure:: /deploy_install_guides/r7_release/figures/starlingx-deployment-options-simplex.png
:scale: 50% .. :scale: 50%
:alt: All-in-one Simplex deployment configuration .. :alt: All-in-one Simplex deployment configuration
*All-in-one Simplex deployment configuration* .. *All-in-one Simplex deployment configuration*

View File

@ -5,32 +5,54 @@
Install Kubernetes Platform on All-in-one Simplex Install Kubernetes Platform on All-in-one Simplex
================================================= =================================================
.. only:: partner .. only:: partner
.. include:: /_includes/install-kubernetes-null-labels.rest .. include:: /_includes/install-kubernetes-null-labels.rest
.. only:: starlingx .. contents:: |minitoc|
This section describes the steps to install the StarlingX Kubernetes
platform on a **StarlingX R7.0 All-in-one Simplex** deployment
configuration.
.. contents::
:local: :local:
:depth: 1 :depth: 1
--------------------- --------
Create a bootable USB Overview
--------------------- --------
Refer to :ref:`Bootable USB <bootable_usb>` for instructions on how .. _aiosx-installation-prereqs:
to create a bootable USB with the StarlingX ISO on your system.
-------------------------------- .. include:: /shared/_includes/desc_aio_simplex.txt
Install software on controller-0
--------------------------------
.. include:: /shared/_includes/inc-install-software-on-controller.rest .. _installation-prereqs:
-----------------------------
Minimum hardware requirements
-----------------------------
.. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
:start-after: begin-min-hw-reqs-sx
:end-before: end-min-hw-reqs-sx
--------------------------
Installation Prerequisites
--------------------------
.. include:: /shared/_includes/installation-prereqs.rest
:start-after: begin-install-prereqs
:end-before: end-install-prereqs
--------------------------------
Prepare Servers for Installation
--------------------------------
.. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
:start-after: start-prepare-servers-common
:end-before: end-prepare-servers-common
--------------------------------
Install Software on Controller-0
--------------------------------
.. include:: /shared/_includes/inc-install-software-on-controller.rest
:start-after: incl-install-software-controller-0-aio-start :start-after: incl-install-software-controller-0-aio-start
:end-before: incl-install-software-controller-0-aio-end :end-before: incl-install-software-controller-0-aio-end
@ -89,9 +111,8 @@ Bootstrap system on controller-0
configuration override files for hosts. For example: configuration override files for hosts. For example:
``$HOME/<hostname>.yml``. ``$HOME/<hostname>.yml``.
.. only:: starlingx
.. include:: /_includes/ansible_install_time_only.txt .. include:: /shared/_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods: playbook using one of the following methods:
@ -214,9 +235,9 @@ The newly installed controller needs to be configured.
:: ::
OAM_IF=<OAM-PORT> ~(keystone_admin)$ OAM_IF=<OAM-PORT>
system host-if-modify controller-0 $OAM_IF -c platform ~(keystone_admin)$ system host-if-modify controller-0 $OAM_IF -c platform
system interface-network-assign controller-0 $OAM_IF oam ~(keystone_admin)$ system interface-network-assign controller-0 $OAM_IF oam
To configure a vlan or aggregated ethernet interface, see :ref:`Node To configure a vlan or aggregated ethernet interface, see :ref:`Node
Interfaces <node-interfaces-index>`. Interfaces <node-interfaces-index>`.
@ -225,7 +246,7 @@ The newly installed controller needs to be configured.
:: ::
system ntp-modify ntpservers=0.pool.ntp.org,1.pool.ntp.org ~(keystone_admin)$ system ntp-modify ntpservers=0.pool.ntp.org,1.pool.ntp.org
To configure |PTP| instead of |NTP|, see :ref:`PTP Server Configuration To configure |PTP| instead of |NTP|, see :ref:`PTP Server Configuration
<ptp-server-config-index>`. <ptp-server-config-index>`.
@ -250,9 +271,9 @@ The newly installed controller needs to be configured.
.. parsed-literal:: .. parsed-literal::
system host-label-assign controller-0 openstack-control-plane=enabled ~(keystone_admin)$ system host-label-assign controller-0 openstack-control-plane=enabled
system host-label-assign controller-0 openstack-compute-node=enabled ~(keystone_admin)$ system host-label-assign controller-0 openstack-compute-node=enabled
system host-label-assign controller-0 |vswitch-label| ~(keystone_admin)$ system host-label-assign controller-0 |vswitch-label|
.. note:: .. note::
@ -261,7 +282,7 @@ The newly installed controller needs to be configured.
.. code-block:: none .. code-block:: none
system host-label-assign controller-0 sriov=enabled ~(keystone_admin)$ system host-label-assign controller-0 sriov=enabled
.. only:: partner .. only:: partner
@ -275,10 +296,10 @@ The newly installed controller needs to be configured.
Increase the number of platform cores with the following commands: Increase the number of platform cores with the following commands:
.. code-block:: .. code-block:: bash
# Assign 6 cores on processor/numa-node 0 on controller-0 to platform # Assign 6 cores on processor/numa-node 0 on controller-0 to platform
system host-cpu-modify -f platform -p0 6 controller-0 ~(keystone_admin)$ system host-cpu-modify -f platform -p0 6 controller-0
#. Due to the additional OpenStack services' containers running on the #. Due to the additional OpenStack services' containers running on the
controller host, the size of the Docker filesystem needs to be controller host, the size of the Docker filesystem needs to be
@ -287,9 +308,9 @@ The newly installed controller needs to be configured.
.. code-block:: bash .. code-block:: bash
# check existing size of docker fs # check existing size of docker fs
system host-fs-list controller-0 ~(keystone_admin)$ system host-fs-list controller-0
# check available space (Avail Size (GiB)) in cgts-vg LVG where docker fs is located # check available space (Avail Size (GiB)) in cgts-vg LVG where docker fs is located
system host-lvg-list controller-0 ~(keystone_admin)$ system host-lvg-list controller-0
# if existing docker fs size + cgts-vg available space is less than # if existing docker fs size + cgts-vg available space is less than
# 80G, you will need to add a new disk partition to cgts-vg. # 80G, you will need to add a new disk partition to cgts-vg.
# There must be at least 20GB of available space after the docker # There must be at least 20GB of available space after the docker
@ -299,22 +320,22 @@ The newly installed controller needs to be configured.
# ( if not use another unused disk ) # ( if not use another unused disk )
# Get device path of ROOT DISK # Get device path of ROOT DISK
system host-show controller-0 | fgrep rootfs ~(keystone_admin)$ system host-show controller-0 | fgrep rootfs
# Get UUID of ROOT DISK by listing disks # Get UUID of ROOT DISK by listing disks
system host-disk-list controller-0 ~(keystone_admin)$ system host-disk-list controller-0
# Create new PARTITION on ROOT DISK, and take note of new partition's 'uuid' in response # Create new PARTITION on ROOT DISK, and take note of new partition's 'uuid' in response
# Use a partition size such that youll be able to increase docker fs size from 30G to 60G # Use a partition size such that youll be able to increase docker fs size from 30G to 60G
PARTITION_SIZE=30 ~(keystone_admin)$ PARTITION_SIZE=30
system host-disk-partition-add -t lvm_phys_vol controller-0 <root-disk-uuid> ${PARTITION_SIZE} ~(keystone_admin)$ system host-disk-partition-add -t lvm_phys_vol controller-0 <root-disk-uuid> ${PARTITION_SIZE}
# Add new partition to cgts-vg local volume group # Add new partition to cgts-vg local volume group
system host-pv-add controller-0 cgts-vg <NEW_PARTITION_UUID> ~(keystone_admin)$ system host-pv-add controller-0 cgts-vg <NEW_PARTITION_UUID>
sleep 2 # wait for partition to be added ~(keystone_admin)$ sleep 2 # wait for partition to be added
# Increase docker filesystem to 60G # Increase docker filesystem to 60G
system host-fs-modify controller-0 docker=60 ~(keystone_admin)$ system host-fs-modify controller-0 docker=60
#. **For OpenStack only:** Configure the system setting for the vSwitch. #. **For OpenStack only:** Configure the system setting for the vSwitch.
@ -338,7 +359,7 @@ The newly installed controller needs to be configured.
:: ::
system modify --vswitch_type none ~(keystone_admin)$ system modify --vswitch_type none
This does not run any vSwitch directly on the host, instead, it uses This does not run any vSwitch directly on the host, instead, it uses
the containerized |OVS| defined in the helm charts of the containerized |OVS| defined in the helm charts of
@ -348,7 +369,7 @@ The newly installed controller needs to be configured.
.. parsed-literal:: .. parsed-literal::
system modify --vswitch_type |ovs-dpdk| ~(keystone_admin)$ system modify --vswitch_type |ovs-dpdk|
Default recommendation for an |AIO|-controller is to use a single core Default recommendation for an |AIO|-controller is to use a single core
for |OVS-DPDK| vSwitch. for |OVS-DPDK| vSwitch.
@ -356,7 +377,7 @@ The newly installed controller needs to be configured.
.. code-block:: bash .. code-block:: bash
# assign 1 core on processor/numa-node 0 on controller-0 to vswitch # assign 1 core on processor/numa-node 0 on controller-0 to vswitch
system host-cpu-modify -f vswitch -p0 1 controller-0 ~(keystone_admin)$ system host-cpu-modify -f vswitch -p0 1 controller-0
When using |OVS-DPDK|, configure 1G of huge pages for vSwitch memory on When using |OVS-DPDK|, configure 1G of huge pages for vSwitch memory on
each |NUMA| node on the host. It is recommended each |NUMA| node on the host. It is recommended
@ -372,10 +393,10 @@ The newly installed controller needs to be configured.
.. code-block:: .. code-block::
# Assign 1x 1G huge page on processor/numa-node 0 on controller-0 to vswitch # Assign 1x 1G huge page on processor/numa-node 0 on controller-0 to vswitch
system host-memory-modify -f vswitch -1G 1 controller-0 0 ~(keystone_admin)$ system host-memory-modify -f vswitch -1G 1 controller-0 0
# Assign 1x 1G huge page on processor/numa-node 1 on controller-0 to vswitch # Assign 1x 1G huge page on processor/numa-node 1 on controller-0 to vswitch
system host-memory-modify -f vswitch -1G 1 controller-0 1 ~(keystone_admin)$ system host-memory-modify -f vswitch -1G 1 controller-0 1
.. important:: .. important::
@ -390,10 +411,10 @@ The newly installed controller needs to be configured.
.. code-block:: bash .. code-block:: bash
# assign 1x 1G huge page on processor/numa-node 0 on controller-0 to applications # assign 1x 1G huge page on processor/numa-node 0 on controller-0 to applications
system host-memory-modify -f application -1G 10 controller-0 0 ~(keystone_admin)$ system host-memory-modify -f application -1G 10 controller-0 0
# assign 1x 1G huge page on processor/numa-node 1 on controller-0 to applications # assign 1x 1G huge page on processor/numa-node 1 on controller-0 to applications
system host-memory-modify -f application -1G 10 controller-0 1 ~(keystone_admin)$ system host-memory-modify -f application -1G 10 controller-0 1
.. note:: .. note::
@ -405,19 +426,19 @@ The newly installed controller needs to be configured.
.. code-block:: bash .. code-block:: bash
export NODE=controller-0 ~(keystone_admin)$ export NODE=controller-0
# Create nova-local local volume group # Create nova-local local volume group
system host-lvg-add ${NODE} nova-local ~(keystone_admin)$ system host-lvg-add ${NODE} nova-local
# Get UUID of DISK to create PARTITION to be added to nova-local local volume group # Get UUID of DISK to create PARTITION to be added to nova-local local volume group
# CEPH OSD Disks can NOT be used # CEPH OSD Disks can NOT be used
# For best performance, do NOT use system/root disk, use a separate physical disk. # For best performance, do NOT use system/root disk, use a separate physical disk.
# List hosts disks and take note of UUID of disk to be used # List hosts disks and take note of UUID of disk to be used
system host-disk-list ${NODE} ~(keystone_admin)$ system host-disk-list ${NODE}
# ( if using ROOT DISK, select disk with device_path of # ( if using ROOT DISK, select disk with device_path of
# system host-show ${NODE} | fgrep rootfs ) # host-show ${NODE} | fgrep rootfs )
# Create new PARTITION on selected disk, and take note of new partitions uuid in response # Create new PARTITION on selected disk, and take note of new partitions uuid in response
# The size of the PARTITION needs to be large enough to hold the aggregate size of # The size of the PARTITION needs to be large enough to hold the aggregate size of
@ -426,13 +447,13 @@ The newly installed controller needs to be configured.
# The following example uses a small PARTITION size such that you can fit it on the # The following example uses a small PARTITION size such that you can fit it on the
# root disk, if that is what you chose above. # root disk, if that is what you chose above.
# Additional PARTITION(s) from additional disks can be added later if required. # Additional PARTITION(s) from additional disks can be added later if required.
PARTITION_SIZE=30 ~(keystone_admin)$ PARTITION_SIZE=30
system host-disk-partition-add -t lvm_phys_vol ${NODE} <disk-uuid> ${PARTITION_SIZE} ~(keystone_admin)$ system host-disk-partition-add -t lvm_phys_vol ${NODE} <disk-uuid> ${PARTITION_SIZE}
# Add new partition to nova-local local volume group # Add new partition to nova-local local volume group
system host-pv-add ${NODE} nova-local <NEW_PARTITION_UUID> ~(keystone_admin)$ system host-pv-add ${NODE} nova-local <NEW_PARTITION_UUID>
sleep 2 ~(keystone_admin)$ sleep 2
#. **For OpenStack only:** Configure data interfaces for controller-0. #. **For OpenStack only:** Configure data interfaces for controller-0.
@ -449,31 +470,31 @@ The newly installed controller needs to be configured.
.. code-block:: bash .. code-block:: bash
export NODE=controller-0 ~(keystone_admin)$ NODE=controller-0
# List inventoried hosts ports and identify ports to be used as data interfaces, # List inventoried hosts ports and identify ports to be used as data interfaces,
# based on displayed linux port name, pci address and device type. # based on displayed linux port name, pci address and device type.
system host-port-list ${NODE} ~(keystone_admin)$ system host-port-list ${NODE}
# List hosts auto-configured ethernet interfaces, # List hosts auto-configured ethernet interfaces,
# find the interfaces corresponding to the ports identified in previous step, and # find the interfaces corresponding to the ports identified in previous step, and
# take note of their UUID # take note of their UUID
system host-if-list -a ${NODE} ~(keystone_admin)$ system host-if-list -a ${NODE}
# Modify configuration for these interfaces # Modify configuration for these interfaces
# Configuring them as data class interfaces, MTU of 1500 and named data# # Configuring them as data class interfaces, MTU of 1500 and named data#
system host-if-modify -m 1500 -n data0 -c data ${NODE} <data0-if-uuid> ~(keystone_admin)$ system host-if-modify -m 1500 -n data0 -c data ${NODE} <data0-if-uuid>
system host-if-modify -m 1500 -n data1 -c data ${NODE} <data1-if-uuid> ~(keystone_admin)$ system host-if-modify -m 1500 -n data1 -c data ${NODE} <data1-if-uuid>
# Create Data Networks that vswitch 'data' interfaces will be connected to # Create Data Networks that vswitch 'data' interfaces will be connected to
DATANET0='datanet0' ~(keystone_admin)$ DATANET0='datanet0'
DATANET1='datanet1' ~(keystone_admin)$ DATANET1='datanet1'
system datanetwork-add ${DATANET0} vlan ~(keystone_admin)$ system datanetwork-add ${DATANET0} vlan
system datanetwork-add ${DATANET1} vlan ~(keystone_admin)$ system datanetwork-add ${DATANET1} vlan
# Assign Data Networks to Data Interfaces # Assign Data Networks to Data Interfaces
system interface-datanetwork-assign ${NODE} <data0-if-uuid> ${DATANET0} ~(keystone_admin)$ system interface-datanetwork-assign ${NODE} <data0-if-uuid> ${DATANET0}
system interface-datanetwork-assign ${NODE} <data1-if-uuid> ${DATANET1} ~(keystone_admin)$ system interface-datanetwork-assign ${NODE} <data1-if-uuid> ${DATANET1}
***************************************** *****************************************
@ -496,32 +517,32 @@ Optionally Configure PCI-SRIOV Interfaces
.. code-block:: bash .. code-block:: bash
export NODE=controller-0 ~(keystone_admin)$ export NODE=controller-0
# List inventoried hosts ports and identify ports to be used as pci-sriov interfaces, # List inventoried hosts ports and identify ports to be used as pci-sriov interfaces,
# based on displayed linux port name, pci address and device type. # based on displayed linux port name, pci address and device type.
system host-port-list ${NODE} ~(keystone_admin)$ system host-port-list ${NODE}
# List hosts auto-configured ethernet interfaces, # List hosts auto-configured ethernet interfaces,
# find the interfaces corresponding to the ports identified in previous step, and # find the interfaces corresponding to the ports identified in previous step, and
# take note of their UUID # take note of their UUID
system host-if-list -a ${NODE} ~(keystone_admin)$ system host-if-list -a ${NODE}
# Modify configuration for these interfaces # Modify configuration for these interfaces
# Configuring them as pci-sriov class interfaces, MTU of 1500 and named sriov# # Configuring them as pci-sriov class interfaces, MTU of 1500 and named sriov#
system host-if-modify -m 1500 -n sriov0 -c pci-sriov ${NODE} <sriov0-if-uuid> -N <num_vfs> ~(keystone_admin)$ system host-if-modify -m 1500 -n sriov0 -c pci-sriov ${NODE} <sriov0-if-uuid> -N <num_vfs>
system host-if-modify -m 1500 -n sriov1 -c pci-sriov ${NODE} <sriov1-if-uuid> -N <num_vfs> ~(keystone_admin)$ system host-if-modify -m 1500 -n sriov1 -c pci-sriov ${NODE} <sriov1-if-uuid> -N <num_vfs>
# If not already created, create Data Networks that the 'pci-sriov' interfaces will # If not already created, create Data Networks that the 'pci-sriov' interfaces will
# be connected to # be connected to
DATANET0='datanet0' ~(keystone_admin)$ DATANET0='datanet0'
DATANET1='datanet1' ~(keystone_admin)$ DATANET1='datanet1'
system datanetwork-add ${DATANET0} vlan ~(keystone_admin)$ system datanetwork-add ${DATANET0} vlan
system datanetwork-add ${DATANET1} vlan ~(keystone_admin)$ system datanetwork-add ${DATANET1} vlan
# Assign Data Networks to PCI-SRIOV Interfaces # Assign Data Networks to PCI-SRIOV Interfaces
system interface-datanetwork-assign ${NODE} <sriov0-if-uuid> ${DATANET0} ~(keystone_admin)$ system interface-datanetwork-assign ${NODE} <sriov0-if-uuid> ${DATANET0}
system interface-datanetwork-assign ${NODE} <sriov1-if-uuid> ${DATANET1} ~(keystone_admin)$ system interface-datanetwork-assign ${NODE} <sriov1-if-uuid> ${DATANET1}
* **For Kubernetes Only:** To enable using |SRIOV| network attachments for * **For Kubernetes Only:** To enable using |SRIOV| network attachments for
@ -531,19 +552,19 @@ Optionally Configure PCI-SRIOV Interfaces
:: ::
system host-label-assign controller-0 sriovdp=enabled ~(keystone_admin)$ system host-label-assign controller-0 sriovdp=enabled
* If planning on running |DPDK| in Kubernetes hosted application * If you are planning on running |DPDK| in Kubernetes hosted application
containers on this host, configure the number of 1G Huge pages required containers on this host, configure the number of 1G Huge pages required
on both |NUMA| nodes. on both |NUMA| nodes.
.. code-block:: bash .. code-block:: bash
# assign 10x 1G huge page on processor/numa-node 0 on controller-0 to applications # assign 10x 1G huge page on processor/numa-node 0 on controller-0 to applications
system host-memory-modify -f application controller-0 0 -1G 10 ~(keystone_admin)$ system host-memory-modify -f application controller-0 0 -1G 10
# assign 10x 1G huge page on processor/numa-node 1 on controller-0 to applications # assign 10x 1G huge page on processor/numa-node 1 on controller-0 to applications
system host-memory-modify -f application controller-0 1 -1G 10 ~(keystone_admin)$ system host-memory-modify -f application controller-0 1 -1G 10
*************************************************************** ***************************************************************
@ -570,7 +591,7 @@ For host-based Ceph:
:: ::
system storage-backend-add ceph --confirmed ~(keystone_admin)$ system storage-backend-add ceph --confirmed
#. Add an |OSD| on controller-0 for host-based Ceph: #. Add an |OSD| on controller-0 for host-based Ceph:
@ -578,13 +599,13 @@ For host-based Ceph:
# List hosts disks and identify disks you want to use for CEPH OSDs, taking note of their UUID # List hosts disks and identify disks you want to use for CEPH OSDs, taking note of their UUID
# By default, /dev/sda is being used as system disk and can not be used for OSD. # By default, /dev/sda is being used as system disk and can not be used for OSD.
system host-disk-list controller-0 ~(keystone_admin)$ system host-disk-list controller-0
# Add disk as an OSD storage # Add disk as an OSD storage
system host-stor-add controller-0 osd <disk-uuid> ~(keystone_admin)$ system host-stor-add controller-0 osd <disk-uuid>
# List OSD storage devices # List OSD storage devices
system host-stor-list controller-0 ~(keystone_admin)$ system host-stor-list controller-0
.. only:: starlingx .. only:: starlingx
@ -595,15 +616,15 @@ For host-based Ceph:
:: ::
system storage-backend-add ceph-rook --confirmed ~(keystone_admin)$ system storage-backend-add ceph-rook --confirmed
#. Assign Rook host labels to controller-0 in support of installing the #. Assign Rook host labels to controller-0 in support of installing the
rook-ceph-apps manifest/helm-charts later: rook-ceph-apps manifest/helm-charts later:
:: ::
system host-label-assign controller-0 ceph-mon-placement=enabled ~(keystone_admin)$ system host-label-assign controller-0 ceph-mon-placement=enabled
system host-label-assign controller-0 ceph-mgr-placement=enabled ~(keystone_admin)$ system host-label-assign controller-0 ceph-mgr-placement=enabled
.. incl-config-controller-0-openstack-specific-aio-simplex-end: .. incl-config-controller-0-openstack-specific-aio-simplex-end:
@ -619,7 +640,7 @@ Unlock controller-0 to bring it into service:
:: ::
system host-unlock controller-0 ~(keystone_admin)$ system host-unlock controller-0
Controller-0 will reboot in order to apply configuration changes and come into Controller-0 will reboot in order to apply configuration changes and come into
service. This can take 5-10 minutes, depending on the performance of the host service. This can take 5-10 minutes, depending on the performance of the host
@ -640,7 +661,7 @@ machine.
:: ::
$ source /etc/platform/openrc $ source /etc/platform/openrc
$ system application-list ~(keystone_admin)$ system application-list
+---------------------+---------+-------------------------------+---------------+----------+-----------+ +---------------------+---------+-------------------------------+---------------+----------+-----------+
| application | version | manifest name | manifest file | status | progress | | application | version | manifest name | manifest file | status | progress |
+---------------------+---------+-------------------------------+---------------+----------+-----------+ +---------------------+---------+-------------------------------+---------------+----------+-----------+
@ -653,9 +674,9 @@ machine.
:: ::
system host-disk-wipe -s --confirm controller-0 /dev/sdb ~(keystone_admin)$ system host-disk-wipe -s --confirm controller-0 /dev/sdb
values.yaml for rook-ceph-apps. ``values.yaml`` for rook-ceph-apps.
.. code-block:: yaml .. code-block:: yaml
@ -668,19 +689,19 @@ machine.
:: ::
system helm-override-update rook-ceph-apps rook-ceph kube-system --values values.yaml ~(keystone_admin)$ system helm-override-update rook-ceph-apps rook-ceph kube-system --values values.yaml
#. Apply the rook-ceph-apps application. #. Apply the rook-ceph-apps application.
:: ::
system application-apply rook-ceph-apps ~(keystone_admin)$ system application-apply rook-ceph-apps
#. Wait for |OSDs| pod to be ready. #. Wait for |OSDs| pod to be ready.
:: ::
kubectl get pods -n kube-system ~(keystone_admin)$ kubectl get pods -n kube-system
rook--ceph-crashcollector-controller-0-764c7f9c8-bh5c7 1/1 Running 0 62m rook--ceph-crashcollector-controller-0-764c7f9c8-bh5c7 1/1 Running 0 62m
rook--ceph-mgr-a-69df96f57-9l28p 1/1 Running 0 63m rook--ceph-mgr-a-69df96f57-9l28p 1/1 Running 0 63m
rook--ceph-mon-a-55fff49dcf-ljfnx 1/1 Running 0 63m rook--ceph-mon-a-55fff49dcf-ljfnx 1/1 Running 0 63m
@ -702,3 +723,9 @@ machine.
.. only:: partner .. only:: partner
.. include:: /_includes/72hr-to-license.rest .. include:: /_includes/72hr-to-license.rest
Complete system configuration by reviewing procedures in:
- :ref:`index-security-84d0d8aa401b`
- :ref:`index-sysconf-d511820651f0`
- :ref:`index-admintasks-768a6e9aaeff`

View File

@ -1,3 +1,4 @@
|hideable|
.. _controller_storage_install_kubernetes_r7: .. _controller_storage_install_kubernetes_r7:
@ -5,31 +6,117 @@
Install Kubernetes Platform on Standard with Controller Storage Install Kubernetes Platform on Standard with Controller Storage
=============================================================== ===============================================================
.. contents:: .. contents:: |minitoc|
:local: :local:
:depth: 1 :depth: 1
.. only:: starlingx .. only:: partner
This section describes the steps to install the StarlingX Kubernetes .. include:: /_includes/install-kubernetes-null-labels.rest
platform on a **StarlingX R7.0 Standard with Controller Storage**
deployment configuration.
------------------- --------
Create bootable USB Overview
------------------- --------
Refer to :ref:`Bootable USB <bootable_usb>` for instructions on how to .. _std-installation-prereqs:
create a bootable USB with the StarlingX ISO on your system.
-------------------------------- .. include:: /shared/_includes/desc_controller_storage.txt
Install software on controller-0
--------------------------------
.. include:: /shared/_includes/inc-install-software-on-controller.rest .. _installation-prereqs-std:
-----------------------------
Minimum hardware requirements
-----------------------------
.. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
:start-after: begin-min-hw-reqs-std
:end-before: end-min-hw-reqs-std
.. .. figure:: /shared/figures/deploy_install_guides/starlingx-deployment-options-controller-storage.png
.. :width: 800
.. Controller storage deployment configuration
.. _installation-prereqs-standard:
--------------------------
Installation Prerequisites
--------------------------
.. include:: /shared/_includes/installation-prereqs.rest
:start-after: begin-install-prereqs
:end-before: end-install-prereqs
--------------------------------
Prepare Servers for Installation
--------------------------------
.. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
:start-after: start-prepare-servers-common
:end-before: end-prepare-servers-common
--------------------------------
Install Software on Controller-0
--------------------------------
.. include:: /shared/_includes/inc-install-software-on-controller.rest
:start-after: incl-install-software-controller-0-standard-start :start-after: incl-install-software-controller-0-standard-start
:end-before: incl-install-software-controller-0-standard-end :end-before: incl-install-software-controller-0-standard-end
.. .. only:: starlingx
..
.. .. --------
.. .. Overview
.. .. --------
..
.. .. .. include:: /shared/_includes/installation-prereqs.rest
.. .. :start-after: begin-install-prereqs-std
.. .. :end-before: end-install-prereqs-std
..
.. ---------------------
.. Hardware Requirements
.. ---------------------
..
.. .. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
.. :start-after: begin-min-hw-reqs-common-intro
.. :end-before: end-min-hw-reqs-common-intro
..
.. .. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
.. :start-after: begin-min-hw-reqs-std
.. :end-before: end-min-hw-reqs-std
..
.. The following requirements must be met for worker nodes.
..
.. .. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
.. :start-after: begin-worker-hw-reqs
.. :end-before: end-worker-hw-reqs
..
.. .. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
.. :start-after: start-prepare-servers-common
.. :end-before: end-prepare-servers-common
..
.. This section describes the steps to install the StarlingX Kubernetes
.. platform on a **StarlingX R7.0 Standard with Controller Storage**
.. deployment configuration.
..
.. -------------------
.. Create bootable USB
.. -------------------
..
.. Refer to :ref:`Bootable USB <bootable_usb>` for instructions on how to
.. create a bootable USB with the StarlingX ISO on your system.
..
.. --------------------------------
.. Install software on controller-0
.. --------------------------------
..
.. .. include:: /shared/_includes/inc-install-software-on-controller.rest
.. :start-after: incl-install-software-controller-0-standard-start
.. :end-before: incl-install-software-controller-0-standard-end
-------------------------------- --------------------------------
Bootstrap system on controller-0 Bootstrap system on controller-0
-------------------------------- --------------------------------
@ -90,7 +177,7 @@ Bootstrap system on controller-0
.. only:: starlingx .. only:: starlingx
.. include:: /_includes/ansible_install_time_only.txt .. include:: /shared/_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods: playbook using one of the following methods:
@ -926,3 +1013,9 @@ If configuring Ceph Storage Backend, Add Ceph OSDs to controllers
.. only:: partner .. only:: partner
.. include:: /_includes/72hr-to-license.rest .. include:: /_includes/72hr-to-license.rest
Complete system configuration by reviewing procedures in:
- :ref:`index-security-84d0d8aa401b`
- :ref:`index-sysconf-d511820651f0`
- :ref:`index-admintasks-768a6e9aaeff`

View File

@ -1,39 +1,125 @@
|hideable|
.. _dedicated_storage_install_kubernetes_r7: .. _dedicated_storage_install_kubernetes_r7:
.. only:: partner
.. include:: /_includes/install-kubernetes-null-labels.rest
============================================================== ==============================================================
Install Kubernetes Platform on Standard with Dedicated Storage Install Kubernetes Platform on Standard with Dedicated Storage
============================================================== ==============================================================
This section describes the steps to install the |prod| Kubernetes platform on a
**Standard with Dedicated Storage** deployment configuration.
.. contents:: .. contents::
:local: :local:
:depth: 1 :depth: 1
.. only:: starlingx .. only:: partner
------------------- .. include:: /_includes/install-kubernetes-null-labels.rest
Create bootable USB
-------------------
Refer to :ref:`Bootable USB <bootable_usb>` for instructions on how to --------
create a bootable USB with the StarlingX ISO on your system. Overview
--------
-------------------------------- .. _ded-installation-prereqs:
Install software on controller-0
--------------------------------
.. include:: /shared/_includes/inc-install-software-on-controller.rest .. include:: /shared/_includes/desc_dedicated_storage.txt
-----------------------------
Minimum hardware requirements
-----------------------------
.. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
:start-after: begin-min-hw-reqs-ded
:end-before: end-min-hw-reqs-ded
.. _installation-prereqs-dedicated:
--------------------------
Installation Prerequisites
--------------------------
.. include:: /shared/_includes/installation-prereqs.rest
:start-after: begin-install-prereqs
:end-before: end-install-prereqs
--------------------------------
Prepare Servers for Installation
--------------------------------
.. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
:start-after: start-prepare-servers-common
:end-before: end-prepare-servers-common
--------------------------------
Install Software on Controller-0
--------------------------------
.. include:: /shared/_includes/inc-install-software-on-controller.rest
:start-after: incl-install-software-controller-0-standard-start :start-after: incl-install-software-controller-0-standard-start
:end-before: incl-install-software-controller-0-standard-end :end-before: incl-install-software-controller-0-standard-end
.. --------------------------------
.. Install Software on Controller-0
.. --------------------------------
.. .. include:: /_includes/installing-software-on-controller-0.rest
.. :start-after: begin-install-ctl-0
.. :end-before: end-install-ctl-0
.. .. only:: starlingx
..
.. .. --------
.. .. Overview
.. .. --------
..
.. .. .. include:: /shared/_includes/installation-prereqs.rest
.. .. :start-after: begin-install-prereqs-ded
.. .. :end-before: end-install-prereqs-ded
..
.. ---------------------
.. Hardware Requirements
.. ---------------------
..
.. .. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
.. :start-after: begin-min-hw-reqs-common-intro
.. :end-before: end-min-hw-reqs-common-intro
..
.. .. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
.. :start-after: begin-min-hw-reqs-sx
.. :end-before: end-min-hw-reqs-sx
..
.. The following requirements must be met for worker nodes.
..
.. .. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
.. :start-after: begin-worker-hw-reqs
.. :end-before: end-worker-hw-reqs
..
.. The following requirements must be met for storage nodes.
..
.. .. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
.. :start-after: begin-storage-hw-reqs
.. :end-before: end-storage-hw-reqs
..
.. .. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
.. :start-after: start-prepare-servers-common
.. :end-before: end-prepare-servers-common
..
.. -------------------
.. Create bootable USB
.. -------------------
..
.. Refer to :ref:`Bootable USB <bootable_usb>` for instructions on how to
.. create a bootable USB with the StarlingX ISO on your system.
..
.. --------------------------------
.. Install software on controller-0
.. --------------------------------
..
.. .. include:: /shared/_includes/inc-install-software-on-controller.rest
.. :start-after: incl-install-software-controller-0-standard-start
.. :end-before: incl-install-software-controller-0-standard-end
-------------------------------- --------------------------------
Bootstrap system on controller-0 Bootstrap system on controller-0
-------------------------------- --------------------------------
@ -533,3 +619,9 @@ host machine.
.. only:: partner .. only:: partner
.. include:: /_includes/72hr-to-license.rest .. include:: /_includes/72hr-to-license.rest
Complete system configuration by reviewing procedures in:
- :ref:`index-security-84d0d8aa401b`
- :ref:`index-sysconf-d511820651f0`
- :ref:`index-admintasks-768a6e9aaeff`

View File

@ -2,6 +2,10 @@
Install Ironic on StarlingX R7.0 Install Ironic on StarlingX R7.0
================================ ================================
.. include:: /_includes/ironic.rest
.. include:: /_includes/ironic_hardware.rest
This section describes the steps to install Ironic on a standard configuration, This section describes the steps to install Ironic on a standard configuration,
either: either:

View File

@ -1,22 +0,0 @@
=======================================================
Bare metal Standard with Rook Storage Installation R7.0
=======================================================
--------
Overview
--------
.. include:: /shared/_includes/desc_rook_storage.txt
.. include:: /shared/_includes/ipv6_note.txt
------------
Installation
------------
.. toctree::
:maxdepth: 1
rook_storage_hardware
rook_storage_install_kubernetes

View File

@ -1,6 +1,14 @@
===================================================================== .. _install-rook-storage-on-bare-metal:
Install StarlingX Kubernetes on Bare Metal Standard with Rook Storage
===================================================================== ====================================================================
Install Kubernetes Platform on Bare Metal Standard with Rook Storage
====================================================================
.. include:: /_includes/rook_storage.rest
.. include:: /_includes/rook_storage_hardware.rest
This section describes the steps to install the StarlingX Kubernetes platform This section describes the steps to install the StarlingX Kubernetes platform
on a **StarlingX R7.0 bare metal Standard with Rook Storage** deployment on a **StarlingX R7.0 bare metal Standard with Rook Storage** deployment
@ -98,7 +106,7 @@ Bootstrap system on controller-0
The default location where Ansible looks for and imports user The default location where Ansible looks for and imports user
configuration override files for hosts. For example: ``$HOME/<hostname>.yml``. configuration override files for hosts. For example: ``$HOME/<hostname>.yml``.
.. include:: /_includes/ansible_install_time_only.txt .. include:: /shared/_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods: playbook using one of the following methods:
@ -213,9 +221,9 @@ Configure controller-0
#. Refer to :ref:`docker_proxy_config` for #. Refer to :ref:`docker_proxy_config` for
details about Docker proxy settings. details about Docker proxy settings.
*************************************
OpenStack-specific host configuration OpenStack-specific host configuration
************************************* -------------------------------------
.. important:: .. important::
@ -303,9 +311,9 @@ OpenStack-specific host configuration
.. incl-config-controller-0-storage-end: .. incl-config-controller-0-storage-end:
********************************
Rook-specific host configuration Rook-specific host configuration
******************************** --------------------------------
.. important:: .. important::
@ -443,9 +451,9 @@ install procedure.)
system interface-network-assign controller-1 $OAM_IF oam system interface-network-assign controller-1 $OAM_IF oam
system interface-network-assign controller-1 $MGMT_IF cluster-host system interface-network-assign controller-1 $MGMT_IF cluster-host
*************************************
OpenStack-specific host configuration OpenStack-specific host configuration
************************************* -------------------------------------
.. important:: .. important::
@ -461,9 +469,9 @@ of installing the |prefix|-openstack manifest and helm-charts later.
.. incl-config-controller-1-end: .. incl-config-controller-1-end:
********************************
Rook-specific host configuration Rook-specific host configuration
******************************** --------------------------------
.. important:: .. important::
@ -577,9 +585,9 @@ Configure worker nodes
set +ex set +ex
done done
*************************************
OpenStack-specific host configuration OpenStack-specific host configuration
************************************* -------------------------------------
.. important:: .. important::

View File

@ -1,5 +1,7 @@
.. _index-install-r7-distcloud-46f4880ec78b: .. _index-install-r7-distcloud-46f4880ec78b:
.. 11/21/2022 - deprecated in favor of DC guide instructions.
=================================== ===================================
Distributed Cloud Installation R7.0 Distributed Cloud Installation R7.0
=================================== ===================================

View File

@ -6,8 +6,8 @@ Development StarlingX Installation
.. note:: .. note::
This Installation guide is for the upcoming release of This installation guide is for the upcoming release of |prod|, and may not
|prod|, and is not supported. work due to pre-release inconsistencies between documentation and code.
To install the most recent released verion of |prod|, see: To install the most recent released verion of |prod|, see:
https://docs.starlingx.io/r/stx.7.0/deploy_install_guides/r7_release/index-install-r7-8966076f0e81.html https://docs.starlingx.io/r/stx.7.0/deploy_install_guides/r7_release/index-install-r7-8966076f0e81.html
@ -42,12 +42,40 @@ Install StarlingX Kubernetes on bare metal
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
bare_metal/aio_simplex bare_metal/aio_simplex_install_kubernetes
bare_metal/aio_duplex bare_metal/aio_duplex_install_kubernetes
bare_metal/controller_storage bare_metal/controller_storage_install_kubernetes
bare_metal/dedicated_storage bare_metal/rook_storage_install_kubernetes
bare_metal/ironic bare_metal/dedicated_storage_install_kubernetes
bare_metal/rook_storage bare_metal/ironic_install
-----------------
Access Kubernetes
-----------------
.. toctree::
:maxdepth: 1
kubernetes_access
--------------------------------------
Install and Access StarlingX OpenStack
--------------------------------------
.. toctree::
:maxdepth: 1
openstack/index-install-r7-os-adc44604968c
---------------------------------------
Install Distributed Cloud on Bare metal
---------------------------------------
.. toctree::
:maxdepth: 1
/dist_cloud/index-dist-cloud-f5dbeb16b976
********** **********
Appendixes Appendixes
@ -101,7 +129,6 @@ Add hosts in bulk
bare_metal/adding-hosts-in-bulk bare_metal/adding-hosts-in-bulk
bare_metal/bulk-host-xml-file-format bare_metal/bulk-host-xml-file-format
Reinstall a system or a host Reinstall a system or a host
,,,,,,,,,,,,,,,,,,,,,,,,,,,, ,,,,,,,,,,,,,,,,,,,,,,,,,,,,
@ -117,30 +144,3 @@ Reinstall a system or a host
ansible_bootstrap_configs ansible_bootstrap_configs
-------------------------------------------------
Install StarlingX Distributed Cloud on bare metal
-------------------------------------------------
.. toctree::
:maxdepth: 1
distributed_cloud/index-install-r7-distcloud-46f4880ec78b
-----------------
Access Kubernetes
-----------------
.. toctree::
:maxdepth: 1
kubernetes_access
--------------------------
Access StarlingX OpenStack
--------------------------
.. toctree::
:maxdepth: 1
openstack/index-install-r7-os-adc44604968c

View File

@ -84,7 +84,7 @@ On virtual controller-0:
The default location where Ansible looks for and imports user The default location where Ansible looks for and imports user
configuration override files for hosts. For example: ``$HOME/<hostname>.yml``. configuration override files for hosts. For example: ``$HOME/<hostname>.yml``.
.. include:: /_includes/ansible_install_time_only.txt .. include:: /shared/_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods: playbook using one of the following methods:

View File

@ -85,7 +85,7 @@ On virtual controller-0:
The default location where Ansible looks for and imports user The default location where Ansible looks for and imports user
configuration override files for hosts. For example: ``$HOME/<hostname>.yml``. configuration override files for hosts. For example: ``$HOME/<hostname>.yml``.
.. include:: /_includes/ansible_install_time_only.txt .. include:: /shared/_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods: playbook using one of the following methods:

View File

@ -89,7 +89,7 @@ On virtual controller-0:
The default location where Ansible looks for and imports user The default location where Ansible looks for and imports user
configuration override files for hosts. For example: ``$HOME/<hostname>.yml``. configuration override files for hosts. For example: ``$HOME/<hostname>.yml``.
.. include:: /_includes/ansible_install_time_only.txt .. include:: /shared/_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods: playbook using one of the following methods:

View File

@ -2,6 +2,8 @@
Extend Capacity with Worker Nodes Extend Capacity with Worker Nodes
================================= =================================
.. start-aio-duplex-extend
This section describes the steps to extend capacity with worker nodes on a This section describes the steps to extend capacity with worker nodes on a
|prod| All-in-one Duplex deployment configuration. |prod| All-in-one Duplex deployment configuration.
@ -338,3 +340,5 @@ Unlock worker nodes in order to bring them into service:
The worker nodes will reboot to apply configuration changes and come into The worker nodes will reboot to apply configuration changes and come into
service. This can take 5-10 minutes, depending on the performance of the host service. This can take 5-10 minutes, depending on the performance of the host
machine. machine.
.. end-aio-duplex-extend

View File

@ -4,4 +4,4 @@
Review the set of install-time-only parameters before installation and confirm that your values for these parameters are correct for the desired installation. 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. Refer to :ref:`Ansible install-time-only parameters <install-time-only-params-r7>` for details.

View File

@ -13,8 +13,9 @@ An AIO-DX configuration provides the following benefits:
* Containers or virtual machines scheduled on both worker functions * Containers or virtual machines scheduled on both worker functions
* Protection against overall server hardware fault, where * Protection against overall server hardware fault, where
* All controller HA services go active on the remaining healthy server * All controller |HA| services go active on the remaining healthy server
* All virtual machines are recovered on the remaining healthy server * All containers and/or virtual machines are recovered on the remaining healthy
server
.. note:: .. note::
@ -27,3 +28,6 @@ An AIO-DX configuration provides the following benefits:
:alt: All-in-one Duplex deployment configuration :alt: All-in-one Duplex deployment configuration
*Figure 1: All-in-one Duplex deployment configuration* *Figure 1: All-in-one Duplex deployment configuration*
.. include:: /shared/_includes/ipv6_note.txt

View File

@ -4,7 +4,7 @@ following benefits:
* Requires only a small amount of cloud processing and storage power * Requires only a small amount of cloud processing and storage power
* Application consolidation using multiple containers or virtual machines on a * Application consolidation using multiple containers or virtual machines on a
single pair of physical servers single physical server
* A storage backend solution using a single-node CEPH deployment * A storage backend solution using a single-node CEPH deployment
.. note:: .. note::
@ -12,12 +12,15 @@ following benefits:
If you are behind a corporate firewall or proxy, you need to set proxy If you are behind a corporate firewall or proxy, you need to set proxy
settings. Refer to :ref:`docker_proxy_config` for details. settings. Refer to :ref:`docker_proxy_config` for details.
.. figure:: /deploy_install_guides/r6_release/figures/starlingx-deployment-options-simplex.png .. figure:: /deploy_install_guides/r7_release/figures/starlingx-deployment-options-simplex.png
:scale: 50% :scale: 50%
:alt: All-in-one Simplex deployment configuration :alt: All-in-one Simplex deployment configuration
*Figure 1: All-in-one Simplex deployment configuration* *Figure 1: All-in-one Simplex deployment configuration*
An AIO-SX deployment gives no protection against overall server hardware fault. An |AIO-SX| deployment gives no protection against overall server hardware fault.
Hardware component protection can be enabled with, for example, a hardware RAID Hardware component protection can be enabled with, for example, a hardware RAID
or 2x Port LAG in the deployment. or 2x Port |LAG| in the deployment.
.. include:: /shared/_includes/ipv6_note.txt

View File

@ -25,3 +25,6 @@ A Standard with Controller Storage configuration provides the following benefits
:alt: Standard with Controller Storage deployment configuration :alt: Standard with Controller Storage deployment configuration
*Figure 1: Standard with Controller Storage deployment configuration* *Figure 1: Standard with Controller Storage deployment configuration*
.. include:: /shared/_includes/ipv6_note.txt

View File

@ -4,11 +4,14 @@ with independent controller, worker, and storage nodes.
A Standard with Dedicated Storage configuration provides the following benefits: A Standard with Dedicated Storage configuration provides the following benefits:
* A pool of up to 200 worker nodes * A pool of up to 200 worker nodes
* A 2x node high availability (HA) controller cluster with HA services running * A 2x node high availability (HA) controller cluster with HA services running
across the controller nodes in either active/active or active/standby mode across the controller nodes in either active/active or active/standby mode
* A storage back end solution using a two-to-9x node HA CEPH storage cluster
* A storage back end solution using a two-to-9x node |HA| CEPH storage cluster
that supports a replication factor of two or three that supports a replication factor of two or three
* Up to four groups of 2x storage nodes, or up to three groups of 3x storage
* Up to four groups of 2x storage nodes, or up to three groups of 3x storage
nodes nodes
.. note:: .. note::
@ -21,3 +24,6 @@ A Standard with Dedicated Storage configuration provides the following benefits:
:alt: Standard with Dedicated Storage deployment configuration :alt: Standard with Dedicated Storage deployment configuration
*Figure 1: Standard with Dedicated Storage deployment configuration* *Figure 1: Standard with Dedicated Storage deployment configuration*
.. include:: /shared/_includes/ipv6_note.txt

View File

@ -1,22 +1,74 @@
.. incl-install-software-controller-0-aio-start .. incl-install-software-controller-0-aio-start
Installing software on controller-0 is the second step in the |prod|
installation procedure.
.. 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
#. Insert the bootable USB into a bootable USB port on the host you are #. Insert the bootable USB into a bootable USB port on the host you are
configuring as controller-0. configuring as controller-0.
.. note::
Refer to :ref:`bootable_usb` for instructions on how
to create a bootable USB with the |prod| ISO.
.. note::
Alternatively one can PXEBOOT controller-0. See
:ref:`configuring-a-pxe-boot-server-r7` for details on how to setup a
PXEBOOT Server and pxe-boot the |prod| load on controller-0
#. Power on the host. #. Power on the host.
#. Attach to a console, ensure the host boots from the USB, and wait for the #. Attach to a console, ensure the host boots from the USB, and wait for the
StarlingX Installer Menus. |prod| Installer Menus.
#. Make the following menu selections in the installer: #. Wait for the Install menus, and when prompted, make the following menu
selections in the installer:
#. First menu: Select 'All-in-one Controller Configuration' .. note::
#. Second menu: Select 'Graphical Console' or 'Textual Console' depending on If you configured the default menu options into the ISO with the
your terminal access to the console port ``update-iso.sh`` script (using the ``-d`` option) in
:ref:`Installation Prerequisites <aiosx-installation-prereqs>`,
then the **Install** menu will not appear.
#. Wait for non-interactive install of software to complete and server to reboot. #. Select the appropriate deployment option for your scenario.
This can take 5-10 minutes, depending on the performance of the server.
For All-in-one deployments, choose one of the All-in-One Configurations,
either standard kernel or real-time/low-latency kernel.
**Standard Controller Configuration**
For a standard configuration with controller or dedicated storage.
**All-in-one Controller Configuration**
For an |AIO| Simplex or Duplex configuration.
**All-in-one Controller Configuration (Low Latency)**
For an AIO Simplex or Duplex configuration with Low Latency Kernel.
#. Choose **Graphical Console** or **Serial Console** depending on your
terminal access to the console port.
Wait for non-interactive install of software to complete and server to
reboot. This can take 5-10 minutes, depending on the performance of the
server.
Wait for the non-interactive software installation to complete and for
the server to reboot. This can take 5-10 minutes, depending on the performance
of the server.
.. include:: /_includes/install-patch-ctl-0.rest
.. incl-install-software-controller-0-aio-end .. incl-install-software-controller-0-aio-end
@ -28,14 +80,14 @@
#. Power on the host. #. Power on the host.
#. Attach to a console, ensure the host boots from the USB, and wait for the #. Attach to a console, ensure the host boots from the USB, and wait for the
StarlingX Installer Menus. |prod| Installer Menus.
#. Make the following menu selections in the installer: #. Make the following menu selections in the installer:
#. First menu: Select 'Standard Controller Configuration' #. First menu: Select **Standard Controller Configuration**.
#. Second menu: Select 'Graphical Console' or 'Textual Console' depending on #. Second menu: Select **Graphical Console** or **Textual Console** depending
your terminal access to the console port. on your terminal access to the console port.
#. Wait for non-interactive install of software to complete and server to reboot. #. Wait for non-interactive install of software to complete and server to reboot.
This can take 5-10 minutes, depending on the performance of the server. This can take 5-10 minutes, depending on the performance of the server.

View File

@ -0,0 +1,139 @@
.. _installation-prereqs:
==========================
Installation Prerequisites
==========================
.. begin-install-prereqs
Several pre-requisites must be completed prior to starting the |prod|
installation.
Before attempting to install |prod|, ensure that you have the following:
.. _installation-pre-requisites-ul-uzl-rny-q3b:
- The |prod-long| host installer ISO image file.
- The ``update-iso.sh`` script.
.. include:: /_includes/installation-prereqs.rest
:start-after: begin-vdr-additional-prereqs
:end-before: end-vdr-additional-prereqs
- *Optionally*, if required, update the ISO image to modify installation boot
parameters, automatically select boot menu options and/or add a kickstart
file to automatically perform configurations such as configuring the initial
IP Interface for bootstrapping.
Use the ``update-iso.sh`` script from |dnload-loc|. The script syntax and
options are:
.. code-block::
update-iso.sh -i <input bootimage.iso> -o <output bootimage.iso>
[ -a <ks-addon.cfg> ] [ -p param=value ]
[ -d <default menu option> ] [ -t <menu timeout> ]
-i <file>: Specify input ISO file
-o <file>: Specify output ISO file
-a <file>: Specify ks-addon.cfg file
-p <p=v>: Specify boot parameter
Examples:
-p rootfs_device=nvme0n1
-p boot_device=nvme0n1
-p rootfs_device=/dev/disk/by-path/pci-0000:00:0d.0-ata-1.0
-p boot_device=/dev/disk/by-path/pci-0000:00:0d.0-ata-1.0
-d <default menu option>:
Specify default boot menu option:
0 - Standard Controller, Serial Console
1 - Standard Controller, Graphical Console
2 - AIO, Serial Console
3 - AIO, Graphical Console
4 - AIO Low-latency, Serial Console
5 - AIO Low-latency, Graphical Console
NULL - Clear default selection
-t <menu timeout>:
Specify boot menu timeout, in seconds
The following example ks-addon.cfg file, used with the -a option, sets up
an initial IP interface at boot time by defining a VLAN on an Ethernet
interface and has it use DHCP to request an IP address:
.. code-block::
#### start ks-addon.cfg
OAM_DEV=enp0s3
OAM_VLAN=1234
cat << EOF > /etc/sysconfig/network-scripts/ifcfg-$OAM_DEV
DEVICE=$OAM_DEV
BOOTPROTO=none
ONBOOT=yes
LINKDELAY=20
EOF
cat << EOF > /etc/sysconfig/network-scripts/ifcfg-$OAM_DEV.$OAM_VLAN
DEVICE=$OAM_DEV.$OAM_VLAN
BOOTPROTO=dhcp
ONBOOT=yes
VLAN=yes
LINKDELAY=20
EOF
#### end ks-addon.cfg
After updating the ISO image, create a bootable USB with the ISO or put the
ISO on a PXEBOOT server. See the next bullet for details.
- A mechanism for boot installation of the |prod-long| host installer ISO
downloaded from |dnload-loc|. This can be either:
- a bootable USB drive with the |prod-long| host installer ISO.
Refer to :ref:`bootable_usb` for instructions on how to create a
bootable USB with the StarlingX ISO on your system.
- the ISO image on a |PXE| boot server on the same network as the server
that will be used as the initial controller-0. See Appendix
:ref:`Installing Controller-0 from a PXE Boot Server
<configuring-a-pxe-boot-server-r7>` for details
- For all controller or AIO controller servers, |OAM| Network connectivity to:
- the |BMC| ports of all nodes
- An external DNS Server. This is required for accessing |org| Docker
Registry as discussed below.
- A Docker Registry(s) containing the Docker images for the |prod| load
accessible via the |OAM| Network.
You can use one of the following options:
.. only:: partner
- The |org| Docker Registry. This is the default option.
.. only:: starlingx
- The public open source registries (i.e. docker.io, k8s.gcr.io,
ghcr.io, gcr.io, quay.io). This is the default option.
- A private Docker Registry populated with the docker images from the
|reg-string|.
.. only:: partner
.. include:: /_includes/bootstrapping-from-a-private-docker-registry.rest
- A record of the IP addresses allocated for the public interfaces for your
deployment \(that is IP addresses for the |OAM| Network and |SRIOV| Data
Networks\).
.. end-install-prereqs

View File

@ -1,13 +1,15 @@
.. note:: .. note::
By default, StarlingX uses IPv4. To use StarlingX with IPv6: By default, |prod| uses IPv4. To use |prod| with IPv6:
* The entire infrastructure and cluster configuration must be IPv6, with the * The entire infrastructure and cluster configuration must be IPv6, with the
exception of the PXE boot network. exception of the |PXE| boot network.
* Not all external servers are reachable via IPv6 addresses (for example * Not all external servers are reachable via IPv6 addresses (for example
Docker registries). Depending on your infrastructure, it may be necessary Docker registries). Depending on your infrastructure, it may be necessary
to deploy a NAT64/DNS64 gateway to translate the IPv4 addresses to IPv6. to deploy a NAT64/DNS64 gateway to translate the IPv4 addresses to IPv6.
* Refer to :ref:`stx_ipv6_deployment` for details on how to deploy a .. only:: starlingx
NAT64/DNS64 gateway to use StarlingX with IPv6.
.. include:: /_includes/ipv6_note_bullet.rest

View File

@ -0,0 +1,700 @@
=====================
Hardware Requirements
=====================
.. begin-min-hw-reqs-common-intro
.. ........
.. Preamble common to all deployments
.. ........
-----------------------------
Minimum hardware requirements
-----------------------------
This section describes the hardware requirements and server preparation for a
|prod-long| |this-ver| |bare-metal| deployment.
.. 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
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
- 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)
.. note::
* Platform: 2x physical cores (4x logical cores if hyper-threading), (by
default, configurable)
* Application: Remaining cores
* - Minimum memory
- 64 GB
* 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)
* Recommended, but not required: 1 or more 500G HDs (min. 10K RPM), |SSDs|
or |NVMe| drives for Container ephemeral disk storage.
.. only:: openstack
* For |prod-os|, we recommend 1 or more 500 GB (min. 10K RPM) for |VM| local
ephemeral storage
* - Minimum network ports
- * MGMT: 1x1GE ( Recommended: MGMT 2x10GE LAG ) *Only required if subcloud is
in Distributed Cloud*.
* |OAM|: 1x1GE (Recommended: |OAM|: 2x1GE LAG)
* Data: 1 or more x 10GE (Recommended: Data: 2x10GE |LAG|)
* - USB
- 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:`configuring-a-pxe-boot-server-r7`.
* - BIOS settings
- * Hyper-Threading technology enabled
* Virtualization technology enabled
* VT for directed I/O enabled
* CPU power and performance policy set to performance
* Minimum Processor 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 diagram below.
.. 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
|prod-long| |this-ver| |bare-metal| Duplex deployment configuration.
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
- Worker Node
* - Number of servers
- 2
- 2-|max-workers|
* - 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)
.. note::
* Platform: 2x physical cores (4x logical cores if hyper-threading), (by
default, configurable)
* Application: Remaining cores
- (Same as controller node)
* - Minimum memory
- 64 GB
* Platform:
- Socket 0: 7GB (by default, configurable)
- Socket 1: 1GB (by default, configurable)
* Application:
- Socket 0: Remaining memory
- Socket 1: Remaining memory
- 32 GB
* - Primary disk
- 500 GB SSD or |NVMe| (see :ref:`nvme_config`)
- 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)
* Recommended, but not required: 1 or more 500G HDs (min. 10K RPM), |SSDs|
or |NVMe| drives for Container ephemeral disk storage.
* For |prod-os|, we recommend 1 or more 500 GB (min. 10K RPM) for |VM| local
ephemeral storage
- For |prod-os|, we recommend 1 or more 500 GB (min. 10K RPM) for |VM| local
ephemeral storage
* - Minimum network ports
- * MGMT: 1x1GE ( Recommended: MGMT 2x10GE LAG ).
* |OAM|: 1x1GE (Recommended: |OAM|: 2x1GE LAG)
* Data: 1 or more x 10GE (Recommended: Data: 2x10GE |LAG|)
- * Mgmt/Cluster: 1x10GE (Recommended: MGMT 2x10GE LAG)
* Data: 1 or more x 10GE (Recommended: Data 2x10GE LAG)
* - USB
- 1 (Only required if used for initial installation of controller-0).
-
* - Board Management
-
- 1 |BMC|
* - Boot order
- HD, PXE, USB
- HD, PXE
* - 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:`configuring-a-pxe-boot-server-r7`.
- BIOS or UEFI
* - 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-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
This section describes the hardware requirements and server preparation for a
|prod-long| |this-ver| |bare-metal| Standard with Controller Storage deployment
configuration.
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-|max-workers|
* - Minimum processor class
- Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8 cores/socket
.. note:: All cores are used by the platform.
- Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8 cores/socket
.. note::
* Platform: 1x physical cores (2x logical cores if hyper-threading),
(by default, configurable)
* Application: Remaining cores
* - Minimum memory
- 64 GB
- 32 GB
* - Primary disk
- 500 GB SSD or |NVMe| (see :ref:`nvme_config`)
- 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 |prod-os|, we recommend 1 or more 500 GB (min. 10K RPM) for |VM| local
ephemeral storage
Recommended but not required: 1 or more 500G HDs (min. 10K RPM), |SSDs| or
|NVMe| drives for Container ephemeral disk storage.
* - Minimum network ports
- * MGMT: 1x1GE (Recommended: MGMT 2x10GE LAG)
* |OAM|: 1x1GE (Recommended: |OAM|: 2x1GE LAG)
* Data: 1 or more x 10GE (Recommended: Data: 2x10GE |LAG|)
- * Mgmt/Cluster: 1x10GE (Recommended: MGMT 2x10GE LAG)
* Data: 1 or more x 10GE (Recommended: Data: 2x10GE |LAG|)
* - USB
- 1 (Only required if used for initial installation of controller-0).
-
* - Board Management
-
- 1 |BMC|
* - Boot order
- HD, PXE, USB
- HD, PXE
* - 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:`configuring-a-pxe-boot-server-r7`.
- BIOS or UEFI
* - Bios settings
- * Hyper-Threading technology enabled
* Virtualization technology (VTD, VTX) 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
This section describes the hardware requirements and server preparation for a
|prod-long| |this-ver| |bare-metal| Standard with Dedicated Storage deployment
configuration.
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-|max-workers|
* - Minimum processor class
- Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8 cores/socket
.. note:: All cores are used by the platform.
- Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8 cores/socket
.. note:: All cores are used for Ceph Storage Cluster.
- Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8 cores/socket
.. note::
* Platform: 1x physical cores (2x logical cores if hyper-threading),
(by default, configurable)
* Application: Remaining cores
* - 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 |prod-os|, we recommend 1 or more 500 GB (min. 10K RPM) for |VM| ephemeral
storage
Recommended, but not required: 1 or more 500G HDs (min. 10K RPM), |SSDs|
or |NVMe| drives for Container ephemeral disk storage.
* - Minimum network ports
- * MGMT: 1x1GE ( Recommended: MGMT 2x10GE LAG ).
* |OAM|: 1x1GE (Recommended: |OAM|: 2x1GE LAG)
* Data: 1 or more x 10GE (Recommended: Data: 2x10GE |LAG|)
- Mgmt: 1x10GE
- * Mgmt/Cluster: 1x10GE 1x10GE (Recommended: MGMT 2x10GE LAG)
* Data: 1 or more x 10GE (Recommended: Data 2x10GE LAG)
* - USB
- 1 (Only required if used for initial installation of controller-0).
-
-
* - Board Management
-
-
- 1 |BMC|
* - Boot order
- HD, PXE, USB
-
- HD, PXE
* - 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:`configuring-a-pxe-boot-server-r7`.
- BIOS or UEFI
- BIOS or UEFI
* - Bios settings
- * Hyper-Threading technology enabled
* Virtualization technology (VTD, VTX) 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.
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 the diagram earlier in this topic.
- 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 :hideable:`controller+worker (All-in-one) servers and` worker servers.
- The servers are powered off.
.. end-prepare-servers-common
.. ........
.. HW requirments for Worker nodes
.. ........
.. begin-worker-hw-reqs
.. list-table:: Worker Hardware Requirements
:widths: 6 25
:header-rows: 0
* - Minimum number of workers
- 2
* - Maximum number of workers
- |max-workers|
* - Minimum processor class
- Same as for controllers
* - Minimum memory
- 32 GB
* - Minimum Primary Disk (two-disk hardware RAID suggested)
- 120 GB (min. 10K RPM)
.. note:: Installation on software RAID is not supported.
* - Additional disks
- 500 GB (min. 10K RPM) - 1 or more
.. note::
Single-disk hosts are supported, but must not be used for local
ephemeral storage.
* - Network ports
(Typical deployment)
- * Mgmt and Cluster Host: 2 x 10GE LAG (shared interface)
* **Optional** external network ports 2 x 10GE LAG
* - Board Management Controller (BMC)
- 1 (required)
* - Bios settings
- * Boot order: HD, PXE
* 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.
* Hyperthreading: Same as for controllers
* Power profile: Same as for controllers
* Intel Virtualization (VTD, VTX): Enabled
.. end-worker-hw-reqs
.. ........
.. HW requirments for Storage nodes
.. ........
.. begin-storage-hw-reqs
.. list-table:: Storage Hardware Requirements
:widths: 6 25
:header-rows: 0
* - Minimum number of nodes
(If Ceph storage is used)
- * 2 - 8 (for replication factor 2)
* 3 - 9 (for replication factor 3)
* - Minimum processor class
- Same as for controllers
* - Minimum memory
- Same as for controllers
* - Minimum Primary Disk (two-disk hardware RAID suggested)
- 120 GB (min. 10K RPM)
.. note:: Installation on software RAID is not supported.
* - Additional disks
- * 500 GB (min. 10K RPM) for OSD storage
* One or more |SSDs| or |NVMe| drives (recommended for Ceph journals);
min. 1024 MiB per journal.
* - Network ports
(Typical deployment)
- * Mgmt and Cluster Host: 2 x 10GE LAG (shared interface)
* - Board Management Controller (BMC)
- 1 (required)
* - Bios settings
- * Boot order: HD, PXE
* 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.
* Hyperthreading: Same as for controllers
* Power profile: Same as for controllers
* Intel Virtualization (VTD, VTX): Disabled
.. end-storage-hw-reqs
.. ........
.. Prepare Servers for Installation
.. ........
.. begin-prep-servers-common
.. begin-prepare-servers
Prior to starting the |prod| installation, the servers must be 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 (All-in-one) servers and worker servers.
- The servers are powered off.
.. end-prepare-servers
.. end-prep-servers-common

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 109 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 101 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

View File

@ -0,0 +1 @@
.. role:: hideable

View File

@ -13,6 +13,8 @@
.. Load scoped product information .. Load scoped product information
.. include:: /_this.txt .. include:: /_this.txt
.. Load custom roles
.. include:: /shared/roles.txt
.. Task-oriented headings that should not appear in TOC .. Task-oriented headings that should not appear in TOC
.. These are used with the .. rubric:: directive. For example: .. These are used with the .. rubric:: directive. For example:
@ -51,4 +53,16 @@
&#124; &#124;
.. Supress substring on per-page basis. Use in conjuction with
.. :hideable:`don't show this` text.
.. |hideable| raw:: html
<style>
.hideable {
display:none;
}
</style>
.. |optional| replace:: **Optional step:** .. |optional| replace:: **Optional step:**