starlingx/docs
Code Issues Proposed changes

Install conditionalization

Browse Source 
Changed r5_release/bare_metal installation to conditionalize stx/parter specific content.
Integrated review comments from patchset 1.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ia0aeef1fabf3d33cae64a278c90b26965c55c6eb
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
This commit is contained in:
Ron Stone 2021-04-27 14:50:39 -04:00
parent aabba54f8b
commit 99995664d9
10 changed files with 881 additions and 659 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/_includes/install-kubernetes-null-labels.rest Normal file
View File

@ -0,0 +1,6 @@
.. Satisfy sphinx idiosyncrasies where link targets are conditionalized.
.. Used from deploy_install_guides/r5_release/bare_metal/*_install_kubernetes.rst
.. _ansible_bootstrap_configs:
.. _docker_proxy_config:
.. _bootable_usb:

0
doc/source/_includes/install-playbook-values-aws.rest Normal file
View File

135
doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex_install_kubernetes.rst
View File

@ -1,9 +1,19 @@
=================================================
Install StarlingX Kubernetes on Bare Metal AIO-DX
=================================================
This section describes the steps to install the StarlingX Kubernetes platform .. _aio_duplex_install_kubernetes:
on a **StarlingX R5.0 bare metal All-in-one Duplex** deployment configuration.
================================================
Install Kubernetes Platform on Bare Metal AIO-DX
================================================
.. only:: partner
.. include:: /_includes/install-kubernetes-null-labels.rest
.. only:: starlingx
This section describes the steps to install the StarlingX Kubernetes
platform on a **StarlingX R5.0 bare metal All-in-one Duplex** deployment
configuration.
.. contents:: .. contents::
:local: :local:
@ -13,16 +23,16 @@ on a **StarlingX R5.0 bare metal All-in-one Duplex** deployment configuration.
Create a bootable USB Create a bootable USB
--------------------- ---------------------
Refer to :doc:`/deploy_install_guides/bootable_usb` for instructions on how to Refer to :ref:`Bootable USB <bootable_usb>` for instructions on how
create a bootable USB with the StarlingX ISO on your system. to create a bootable USB with the StarlingX ISO on your system.
-------------------------------- --------------------------------
Install software on controller-0 Install software on controller-0
-------------------------------- --------------------------------
.. include:: aio_simplex_install_kubernetes.rst .. include:: inc-install-software-on-controller.rest
:start-after: incl-install-software-controller-0-aio-simplex-start: :start-after: incl-install-software-controller-0-aio-start
:end-before: incl-install-software-controller-0-aio-simplex-end: :end-before: incl-install-software-controller-0-aio-end
-------------------------------- --------------------------------
Bootstrap system on controller-0 Bootstrap system on controller-0
@ -43,9 +53,9 @@ Bootstrap system on controller-0
#. Verify and/or configure IP connectivity. #. Verify and/or configure IP connectivity.
External connectivity is required to run the Ansible bootstrap playbook. The External connectivity is required to run the Ansible bootstrap playbook. The
StarlingX boot image will DHCP out all interfaces so the server may have StarlingX boot image will |DHCP| out all interfaces so the server may have
obtained an IP address and have external IP connectivity if a DHCP server is obtained an IP address and have external IP connectivity if a |DHCP| server
present in your environment. Verify this using the :command:`ip addr` and is present in your environment. Verify this using the :command:`ip addr` and
:command:`ping 8.8.8.8` commands. :command:`ping 8.8.8.8` commands.
Otherwise, manually configure an IP address and default IP route. Use the Otherwise, manually configure an IP address and default IP route. Use the
@ -61,8 +71,10 @@ Bootstrap system on controller-0
#. Specify user configuration overrides for the Ansible bootstrap playbook. #. Specify user configuration overrides for the Ansible bootstrap playbook.
Ansible is used to bootstrap StarlingX on controller-0. Key files for Ansible .. only:: starlingx
configuration are:
Ansible is used to bootstrap StarlingX on controller-0. Key files for
Ansible configuration are:
``/etc/ansible/hosts`` ``/etc/ansible/hosts``
The default Ansible inventory file. Contains a single host: localhost. The default Ansible inventory file. Contains a single host: localhost.
@ -75,7 +87,8 @@ Bootstrap system on controller-0
``sysadmin home directory ($HOME)`` ``sysadmin home directory ($HOME)``
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:: ../ansible_install_time_only.txt .. include:: ../ansible_install_time_only.txt
@ -85,7 +98,8 @@ Bootstrap system on controller-0
#. Use a copy of the default.yml file listed above to provide your overrides. #. Use a copy of the default.yml file listed above to provide your overrides.
The default.yml file lists all available parameters for bootstrap The default.yml file lists all available parameters for bootstrap
configuration with a brief description for each parameter in the file comments. configuration with a brief description for each parameter in the file
comments.
To use this method, copy the default.yml file listed above to To use this method, copy the default.yml file listed above to
``$HOME/localhost.yml`` and edit the configurable values as desired. ``$HOME/localhost.yml`` and edit the configurable values as desired.
@ -125,11 +139,18 @@ Bootstrap system on controller-0
EOF EOF
Refer to :doc:`/deploy_install_guides/r5_release/ansible_bootstrap_configs` .. only:: partner
for information on additional Ansible bootstrap configurations for advanced
Ansible bootstrap scenarios, such as Docker proxies when deploying behind a .. include:: ../../../_includes/install-playbook-values-aws.rest
firewall, etc. Refer to :doc:`/../../configuration/docker_proxy_config` for
details about Docker proxy settings. .. only:: starlingx
Refer to :ref:`Ansible Bootstrap Configurations
<ansible_bootstrap_configs>` for information on additional Ansible
bootstrap configurations for advanced Ansible bootstrap scenarios, such
as Docker proxies when deploying behind a firewall, etc. Refer to
:ref:`Docker Proxy Configurations <docker_proxy_config>` for details
about Docker proxy settings.
#. Run the Ansible bootstrap playbook: #. Run the Ansible bootstrap playbook:
@ -137,8 +158,8 @@ Bootstrap system on controller-0
ansible-playbook /usr/share/ansible/stx-ansible/playbooks/bootstrap.yml ansible-playbook /usr/share/ansible/stx-ansible/playbooks/bootstrap.yml
Wait for Ansible bootstrap playbook to complete. Wait for Ansible bootstrap playbook to complete. This can take 5-10 minutes,
This can take 5-10 minutes, depending on the performance of the host machine. depending on the performance of the host machine.
---------------------- ----------------------
Configure controller-0 Configure controller-0
@ -150,9 +171,9 @@ Configure controller-0
source /etc/platform/openrc source /etc/platform/openrc
#. Configure the OAM and MGMT interfaces of controller-0 and specify the #. Configure the |OAM| and MGMT interfaces of controller-0 and specify the
attached networks. Use the OAM and MGMT port names, for example eth0, that are attached networks. Use the |OAM| and MGMT port names, for example eth0, that
applicable to your deployment environment. are applicable to your deployment environment.
:: ::
@ -169,7 +190,7 @@ Configure controller-0
system interface-network-assign controller-0 $MGMT_IF mgmt system interface-network-assign controller-0 $MGMT_IF mgmt
system interface-network-assign controller-0 $MGMT_IF cluster-host system interface-network-assign controller-0 $MGMT_IF cluster-host
#. Configure NTP servers for network time synchronization: #. Configure |NTP| servers for network time synchronization:
:: ::
@ -183,18 +204,20 @@ Optionally, initialize a Ceph-based Persistent Storage Backend
A persistent storage backend is required if your application requires A persistent storage backend is required if your application requires
Persistent Volume Claims (PVCs). The StarlingX OpenStack application Persistent Volume Claims (PVCs). The StarlingX OpenStack application
(stx-openstack) requires PVCs, therefore if you plan on using the (stx-openstack) requires |PVCs|, therefore if you plan on using the
stx-openstack application, then you must configure a persistent storage stx-openstack application, then you must configure a persistent storage
backend. backend.
.. only:: starlingx
There are two options for persistent storage backend: There are two options for persistent storage backend:
1) the host-based Ceph solution and 1) the host-based Ceph solution and
2) the Rook container-based Ceph solution. 2) the Rook container-based Ceph solution.
The Rook container-based Ceph backend is installed after both AIO-Controllers The Rook container-based Ceph backend is installed after both
are configured and unlocked. AIO-Controllers are configured and unlocked.
For host-based Ceph, For host-based Ceph:
#. Initialize with add ceph backend: #. Initialize with add ceph backend:
@ -202,7 +225,7 @@ For host-based Ceph,
system storage-backend-add ceph --confirmed 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:
:: ::
@ -210,6 +233,8 @@ For host-based Ceph,
system host-disk-list controller-0 | awk '/\/dev\/sdb/{print $2}' | xargs -i system host-stor-add controller-0 {} system host-disk-list controller-0 | awk '/\/dev\/sdb/{print $2}' | xargs -i system host-stor-add controller-0 {}
system host-stor-list controller-0 system host-stor-list controller-0
.. only:: starlingx
For Rook container-based Ceph: For Rook container-based Ceph:
#. Initialize with add ceph-rook backend: #. Initialize with add ceph-rook backend:
@ -233,25 +258,26 @@ For Rook container-based Ceph:
This step is **required** for OpenStack. This step is **required** for OpenStack.
This step is optional for Kubernetes: Do this step if using SRIOV network This step is optional for Kubernetes: Do this step if using |SRIOV| network
attachments in hosted application containers. attachments in hosted application containers.
For Kubernetes SRIOV network attachments: For Kubernetes |SRIOV| network attachments:
* Configure the SRIOV device plugin * Configure the |SRIOV| device plugin.
:: ::
system host-label-assign controller-0 sriovdp=enabled system host-label-assign controller-0 sriovdp=enabled
* If planning on running DPDK in containers on this host, configure the number * If planning on running |DPDK| in containers on this host, configure the number
of 1G Huge pages required on both NUMA nodes. of 1G Huge pages required on both |NUMA| nodes.
:: ::
system host-memory-modify controller-0 0 -1G 100 system host-memory-modify controller-0 0 -1G 100
system host-memory-modify controller-0 1 -1G 100 system host-memory-modify controller-0 1 -1G 100
For both Kubernetes and OpenStack: For both Kubernetes and OpenStack:
:: ::
@ -291,16 +317,17 @@ For Rook container-based Ceph:
system service-parameter-list platform docker system service-parameter-list platform docker
#. Refer to :doc:`/../../configuration/docker_proxy_config` for #. Refer to :ref:`Docker Proxy Configuration <docker_proxy_config>` for
details about Docker proxy settings. details about Docker proxy settings.
.. only:: starlingx
************************************* *************************************
OpenStack-specific host configuration OpenStack-specific host configuration
************************************* *************************************
.. include:: aio_simplex_install_kubernetes.rst .. include:: inc-openstack-specific-host-config.rest
:start-after: incl-config-controller-0-openstack-specific-aio-simplex-start:
:end-before: incl-config-controller-0-openstack-specific-aio-simplex-end:
------------------- -------------------
Unlock controller-0 Unlock controller-0
@ -358,8 +385,8 @@ Install software on controller-1 node
Configure controller-1 Configure controller-1
---------------------- ----------------------
#. Configure the OAM and MGMT interfaces of controller-1 and specify the #. Configure the |OAM| and MGMT interfaces of controller-1 and specify the
attached networks. Use the OAM and MGMT port names, for example eth0, that are attached networks. Use the |OAM| and MGMT port names, for example eth0, that are
applicable to your deployment environment: applicable to your deployment environment:
(Note that the MGMT interface is partially set up automatically by the network (Note that the MGMT interface is partially set up automatically by the network
@ -380,12 +407,12 @@ Configure controller-1
This step is **required** for OpenStack. This step is **required** for OpenStack.
This step is optional for Kubernetes: Do this step if using SRIOV network This step is optional for Kubernetes: Do this step if using |SRIOV|
attachments in hosted application containers. network attachments in hosted application containers.
For Kubernetes SRIOV network attachments: For Kubernetes |SRIOV| network attachments:
* Configure the SRIOV device plugin: * Configure the |SRIOV| device plugin:
:: ::
@ -399,6 +426,7 @@ Configure controller-1
system host-memory-modify controller-1 0 -1G 100 system host-memory-modify controller-1 0 -1G 100
system host-memory-modify controller-1 1 -1G 100 system host-memory-modify controller-1 1 -1G 100
.. only:: starlingx
For both Kubernetes and OpenStack: For both Kubernetes and OpenStack:
@ -436,7 +464,7 @@ Optionally, configure host-specific details for Ceph-based Persistent Storage Ba
For host-based Ceph: For host-based Ceph:
#. Add an OSD on controller-1 for host-based Ceph: #. Add an |OSD| on controller-1 for host-based Ceph:
:: ::
@ -444,6 +472,8 @@ For host-based Ceph:
system host-disk-list controller-1 | awk '/\/dev\/sdb/{print $2}' | xargs -i system host-stor-add controller-1 {} system host-disk-list controller-1 | awk '/\/dev\/sdb/{print $2}' | xargs -i system host-stor-add controller-1 {}
system host-stor-list controller-1 system host-stor-list controller-1
.. only:: starlingx
For Rook container-based Ceph: For Rook container-based Ceph:
#. Assign Rook host labels to controller-1 in support of installing the #. Assign Rook host labels to controller-1 in support of installing the
@ -507,6 +537,8 @@ Controller-1 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
machine. machine.
.. only:: starlingx
-------------------------------------------------------------------------- --------------------------------------------------------------------------
Optionally, finish configuration of Ceph-based Persistent Storage Backend Optionally, finish configuration of Ceph-based Persistent Storage Backend
-------------------------------------------------------------------------- --------------------------------------------------------------------------
@ -531,7 +563,8 @@ On **virtual** controller-0 and controller-1:
| rook-ceph-apps | 1.0-1 | rook-ceph-manifest | manifest.yaml | uploaded | completed | | rook-ceph-apps | 1.0-1 | rook-ceph-manifest | manifest.yaml | uploaded | completed |
+---------------------+---------+-------------------------------+---------------+----------+-----------+ +---------------------+---------+-------------------------------+---------------+----------+-----------+
#. Configure Rook to use /dev/sdb on controller-0 and controller-1 as a ceph osd #. Configure Rook to use /dev/sdb on controller-0 and controller-1 as a ceph
|OSD|.
:: ::
@ -561,7 +594,7 @@ On **virtual** controller-0 and controller-1:
system application-apply rook-ceph-apps system application-apply rook-ceph-apps
#. Wait for OSDs pod to be ready. #. Wait for |OSDs| pod to be ready.
:: ::

187
doc/source/deploy_install_guides/r5_release/bare_metal/aio_simplex_install_kubernetes.rst
View File

@ -1,9 +1,19 @@
=================================================
Install StarlingX Kubernetes on Bare Metal AIO-SX
=================================================
This section describes the steps to install the StarlingX Kubernetes platform .. _aio_simplex_install_kubernetes:
on a **StarlingX R5.0 bare metal All-in-one Simplex** deployment configuration.
================================================
Install Kubernetes Platform on Bare Metal AIO-SX
================================================
.. only:: partner
.. include:: /_includes/install-kubernetes-null-labels.rest
.. only:: starlingx
This section describes the steps to install the StarlingX Kubernetes
platform on a **StarlingX R5.0 bare metal All-in-one Simplex** deployment
configuration.
.. contents:: .. contents::
:local: :local:
@ -13,40 +23,24 @@ on a **StarlingX R5.0 bare metal All-in-one Simplex** deployment configuration.
Create a bootable USB Create a bootable USB
--------------------- ---------------------
Refer to :doc:`/deploy_install_guides/bootable_usb` for instructions on how to Refer to :ref:`Bootable USB <bootable_usb>` for instructions on how
create a bootable USB with the StarlingX ISO on your system. to create a bootable USB with the StarlingX ISO on your system.
-------------------------------- --------------------------------
Install software on controller-0 Install software on controller-0
-------------------------------- --------------------------------
.. incl-install-software-controller-0-aio-simplex-start: .. include:: inc-install-software-on-controller.rest
:start-after: incl-install-software-controller-0-aio-start
#. Insert the bootable USB into a bootable USB port on the host you are :end-before: incl-install-software-controller-0-aio-end
configuring as controller-0.
#. Power on the host.
#. Attach to a console, ensure the host boots from the USB, and wait for the
StarlingX Installer Menus.
#. Make the following menu selections in the installer:
#. First menu: Select 'All-in-one Controller Configuration'
#. Second menu: Select 'Graphical Console' or 'Textual 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.
.. incl-install-software-controller-0-aio-simplex-end:
-------------------------------- --------------------------------
Bootstrap system on controller-0 Bootstrap system on controller-0
-------------------------------- --------------------------------
#. Login using the username / password of "sysadmin" / "sysadmin". #. Login using the username / password of "sysadmin" / "sysadmin".
When logging in for the first time, you will be forced to change the password. When logging in for the first time, you will be forced to change the
password.
:: ::
@ -60,9 +54,9 @@ Bootstrap system on controller-0
#. Verify and/or configure IP connectivity. #. Verify and/or configure IP connectivity.
External connectivity is required to run the Ansible bootstrap playbook. The External connectivity is required to run the Ansible bootstrap playbook. The
StarlingX boot image will DHCP out all interfaces so the server may have StarlingX boot image will |DHCP| out all interfaces so the server may have
obtained an IP address and have external IP connectivity if a DHCP server is obtained an IP address and have external IP connectivity if a |DHCP| server
present in your environment. Verify this using the :command:`ip addr` and is present in your environment. Verify this using the :command:`ip addr` and
:command:`ping 8.8.8.8` commands. :command:`ping 8.8.8.8` commands.
Otherwise, manually configure an IP address and default IP route. Use the Otherwise, manually configure an IP address and default IP route. Use the
@ -78,8 +72,10 @@ Bootstrap system on controller-0
#. Specify user configuration overrides for the Ansible bootstrap playbook. #. Specify user configuration overrides for the Ansible bootstrap playbook.
Ansible is used to bootstrap StarlingX on controller-0. Key files for Ansible .. only:: starlingx
configuration are:
Ansible is used to bootstrap StarlingX on controller-0. Key files for
Ansible configuration are:
``/etc/ansible/hosts`` ``/etc/ansible/hosts``
The default Ansible inventory file. Contains a single host: localhost. The default Ansible inventory file. Contains a single host: localhost.
@ -92,7 +88,8 @@ Bootstrap system on controller-0
``sysadmin home directory ($HOME)`` ``sysadmin home directory ($HOME)``
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:: ../ansible_install_time_only.txt .. include:: ../ansible_install_time_only.txt
@ -102,7 +99,8 @@ Bootstrap system on controller-0
#. Use a copy of the default.yml file listed above to provide your overrides. #. Use a copy of the default.yml file listed above to provide your overrides.
The default.yml file lists all available parameters for bootstrap The default.yml file lists all available parameters for bootstrap
configuration with a brief description for each parameter in the file comments. configuration with a brief description for each parameter in the file
comments.
To use this method, copy the default.yml file listed above to To use this method, copy the default.yml file listed above to
``$HOME/localhost.yml`` and edit the configurable values as desired. ``$HOME/localhost.yml`` and edit the configurable values as desired.
@ -110,9 +108,9 @@ Bootstrap system on controller-0
#. Create a minimal user configuration override file. #. Create a minimal user configuration override file.
To use this method, create your override file at ``$HOME/localhost.yml`` To use this method, create your override file at ``$HOME/localhost.yml``
and provide the minimum required parameters for the deployment configuration and provide the minimum required parameters for the deployment
as shown in the example below. Use the OAM IP SUBNET and IP ADDRESSing configuration as shown in the example below. Use the OAM IP SUBNET and IP
applicable to your deployment environment. ADDRESSing applicable to your deployment environment.
:: ::
@ -140,11 +138,18 @@ Bootstrap system on controller-0
EOF EOF
Refer to :doc:`/deploy_install_guides/r5_release/ansible_bootstrap_configs` .. only:: partner
for information on additional Ansible bootstrap configurations for advanced
Ansible bootstrap scenarios, such as Docker proxies when deploying behind a .. include:: ../../../_includes/install-playbook-values-aws.rest
firewall, etc. Refer to :doc:`/../../configuration/docker_proxy_config` for
details about Docker proxy settings. .. only:: starlingx
Refer to :ref:`Ansible Bootstrap Configurations
<ansible_bootstrap_configs>` for information on additional Ansible
bootstrap configurations for advanced Ansible bootstrap scenarios, such
as Docker proxies when deploying behind a firewall, etc. Refer to
:ref:`Docker Proxy Configuration <docker_proxy_config>` for details about
Docker proxy settings.
#. Run the Ansible bootstrap playbook: #. Run the Ansible bootstrap playbook:
@ -152,21 +157,23 @@ Bootstrap system on controller-0
ansible-playbook /usr/share/ansible/stx-ansible/playbooks/bootstrap.yml ansible-playbook /usr/share/ansible/stx-ansible/playbooks/bootstrap.yml
Wait for Ansible bootstrap playbook to complete. Wait for Ansible bootstrap playbook to complete. This can take 5-10 minutes,
This can take 5-10 minutes, depending on the performance of the host machine. depending on the performance of the host machine.
---------------------- ----------------------
Configure controller-0 Configure controller-0
---------------------- ----------------------
The newly installed controller needs to be configured.
#. Acquire admin credentials: #. Acquire admin credentials:
:: ::
source /etc/platform/openrc source /etc/platform/openrc
#. Configure the OAM interface of controller-0 and specify the attached network #. Configure the |OAM| interface of controller-0 and specify the attached network
as "oam". Use the OAM port name that is applicable to your deployment as "oam". Use the |OAM| port name that is applicable to your deployment
environment, for example eth0: environment, for example eth0:
:: ::
@ -175,7 +182,7 @@ Configure controller-0
system host-if-modify controller-0 $OAM_IF -c platform system host-if-modify controller-0 $OAM_IF -c platform
system interface-network-assign controller-0 $OAM_IF oam system interface-network-assign controller-0 $OAM_IF oam
#. Configure NTP servers for network time synchronization: #. Configure |NTP| servers for network time synchronization:
:: ::
@ -185,22 +192,10 @@ Configure controller-0
Optionally, initialize a Ceph-based Persistent Storage Backend Optionally, initialize a Ceph-based Persistent Storage Backend
************************************************************** **************************************************************
.. important::
A persistent storage backend is required if your application requires A persistent storage backend is required if your application requires
Persistent Volume Claims (PVCs). The StarlingX OpenStack application |PVCs|.
(stx-openstack) requires PVCs, therefore if you plan on using the
stx-openstack application, then you must configure a persistent storage
backend.
There are two options for persistent storage backend: For host-based Ceph:
1) the host-based Ceph solution and
2) the Rook container-based Ceph solution.
The Rook container-based Ceph backend is installed after both AIO-Controllers
are configured and unlocked.
For host-based Ceph,
#. Initialize with add ceph backend: #. Initialize with add ceph backend:
@ -208,7 +203,7 @@ For host-based Ceph,
system storage-backend-add ceph --confirmed 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:
:: ::
@ -216,6 +211,8 @@ For host-based Ceph,
system host-disk-list controller-0 | awk '/\/dev\/sdb/{print $2}' | xargs -i system host-stor-add controller-0 {} system host-disk-list controller-0 | awk '/\/dev\/sdb/{print $2}' | xargs -i system host-stor-add controller-0 {}
system host-stor-list controller-0 system host-stor-list controller-0
.. only:: starlingx
For Rook container-based Ceph: For Rook container-based Ceph:
#. Initialize with add ceph-rook backend: #. Initialize with add ceph-rook backend:
@ -239,19 +236,19 @@ For Rook container-based Ceph:
This step is **required** for OpenStack. This step is **required** for OpenStack.
This step is optional for Kubernetes: Do this step if using SRIOV network This step is optional for Kubernetes: Do this step if using |SRIOV|
attachments in hosted application containers. network attachments in hosted application containers.
For Kubernetes SRIOV network attachments: For Kubernetes |SRIOV| network attachments:
* Configure the SRIOV device plugin * Configure the |SRIOV| device plugin.
:: ::
system host-label-assign controller-0 sriovdp=enabled system host-label-assign controller-0 sriovdp=enabled
* If planning on running DPDK in containers on this host, configure the number * If planning on running |DPDK| in containers on this host, configure the
of 1G Huge pages required on both NUMA nodes. number of 1G Huge pages required on both |NUMA| nodes.
:: ::
@ -288,7 +285,7 @@ For Rook container-based Ceph:
system interface-datanetwork-assign ${NODE} ${DATA0IFUUID} ${PHYSNET0} system interface-datanetwork-assign ${NODE} ${DATA0IFUUID} ${PHYSNET0}
system interface-datanetwork-assign ${NODE} ${DATA1IFUUID} ${PHYSNET1} system interface-datanetwork-assign ${NODE} ${DATA1IFUUID} ${PHYSNET1}
#. Add an OSD on controller-0 for Ceph. The following example adds an OSD #. Add an |OSD| on controller-0 for Ceph. The following example adds an |OSD|
to the `sdb` disk: to the `sdb` disk:
.. important:: .. important::
@ -311,9 +308,11 @@ For Rook container-based Ceph:
system service-parameter-list platform docker system service-parameter-list platform docker
#. Refer to :doc:`/../../configuration/docker_proxy_config` for Refer to :ref:`Docker Proxy Configuration <docker_proxy_config>` for
details about Docker proxy settings. details about Docker proxy settings.
.. only:: starlingx
************************************* *************************************
OpenStack-specific host configuration OpenStack-specific host configuration
************************************* *************************************
@ -337,41 +336,42 @@ OpenStack-specific host configuration
#. **For OpenStack only:** Configure the system setting for the vSwitch. #. **For OpenStack only:** Configure the system setting for the vSwitch.
StarlingX has OVS (kernel-based) vSwitch configured as default: StarlingX has |OVS| (kernel-based) vSwitch configured as default:
* Runs in a container; defined within the helm charts of stx-openstack * Runs in a container; defined within the helm charts of stx-openstack
manifest. manifest.
* Shares the core(s) assigned to the platform. * Shares the core(s) assigned to the platform.
If you require better performance, OVS-DPDK (OVS with the Data Plane If you require better performance, |OVS|-|DPDK| (|OVS| with the Data Plane
Development Kit, which is supported only on bare metal hardware) should be Development Kit, which is supported only on bare metal hardware) should be
used: used:
* Runs directly on the host (it is not containerized). * Runs directly on the host (it is not containerized).
* Requires that at least 1 core be assigned/dedicated to the vSwitch function. * Requires that at least 1 core be assigned/dedicated to the vSwitch function.
To deploy the default containerized OVS: To deploy the default containerized |OVS|:
:: ::
system modify --vswitch_type none system modify --vswitch_type none
Do not run any vSwitch directly on the host, instead, use the containerized Do not run any vSwitch directly on the host, instead, use the
OVS defined in the helm charts of stx-openstack manifest. containerized |OVS| defined in the helm charts of stx-openstack
manifest.
To deploy OVS-DPDK, run the following command: To deploy |OVS|-|DPDK|, run the following command:
:: ::
system modify --vswitch_type ovs-dpdk system modify --vswitch_type ovs-dpdk
system host-cpu-modify -f vswitch -p0 1 controller-0 system host-cpu-modify -f vswitch -p0 1 controller-0
Once vswitch_type is set to OVS-DPDK, any subsequent nodes created will Once vswitch_type is set to |OVS|-|DPDK|, any subsequent nodes created
default to automatically assigning 1 vSwitch core for AIO controllers and 2 will default to automatically assigning 1 vSwitch core for |AIO|
vSwitch cores for compute-labeled worker nodes. controllers and 2 vSwitch cores for compute-labeled worker nodes.
When using OVS-DPDK, configure vSwitch memory per NUMA node with the following When using |OVS|-|DPDK|, configure vSwitch memory per |NUMA| node with
command: the following command:
:: ::
@ -383,10 +383,12 @@ OpenStack-specific host configuration
system host-memory-modify -f vswitch -1G 1 worker-0 0 system host-memory-modify -f vswitch -1G 1 worker-0 0
VMs created in an OVS-DPDK environment must be configured to use huge pages |VMs| created in an |OVS|-|DPDK| environment must be configured to use
to enable networking and must use a flavor with property: hw:mem_page_size=large huge pages to enable networking and must use a flavor with property:
hw:mem_page_size=large
Configure the huge pages for VMs in an OVS-DPDK environment with the command: Configure the huge pages for |VMs| in an |OVS|-|DPDK| environment with
the command:
:: ::
@ -404,8 +406,8 @@ OpenStack-specific host configuration
locking and unlocking all compute-labeled worker nodes (and/or AIO locking and unlocking all compute-labeled worker nodes (and/or AIO
controllers) to apply the change. controllers) to apply the change.
#. **For OpenStack only:** Set up disk partition for nova-local volume group, #. **For OpenStack only:** Set up disk partition for nova-local volume
which is needed for stx-openstack nova ephemeral disks. group, which is needed for stx-openstack nova ephemeral disks.
:: ::
@ -432,17 +434,20 @@ Unlock controller-0
.. incl-unlock-controller-0-aio-simplex-start: .. incl-unlock-controller-0-aio-simplex-start:
Unlock controller-0 in order to bring it into service: Unlock controller-0 to bring it into service:
:: ::
system host-unlock controller-0 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 machine. service. This can take 5-10 minutes, depending on the performance of the host
machine.
.. incl-unlock-controller-0-aio-simplex-end: .. incl-unlock-controller-0-aio-simplex-end:
.. only:: starlingx
-------------------------------------------------------------------------- --------------------------------------------------------------------------
Optionally, finish configuration of Ceph-based Persistent Storage Backend Optionally, finish configuration of Ceph-based Persistent Storage Backend
-------------------------------------------------------------------------- --------------------------------------------------------------------------
@ -467,7 +472,7 @@ On **virtual** controller-0:
| rook-ceph-apps | 1.0-1 | rook-ceph-manifest | manifest.yaml | uploaded | completed | | rook-ceph-apps | 1.0-1 | rook-ceph-manifest | manifest.yaml | uploaded | completed |
+---------------------+---------+-------------------------------+---------------+----------+-----------+ +---------------------+---------+-------------------------------+---------------+----------+-----------+
#. Configure rook to use /dev/sdb disk on controller-0 as a ceph osd #. Configure rook to use /dev/sdb disk on controller-0 as a ceph |OSD|.
:: ::
@ -493,7 +498,7 @@ On **virtual** controller-0:
system application-apply rook-ceph-apps system application-apply rook-ceph-apps
#. Wait for OSDs pod ready #. Wait for |OSDs| pod ready.
:: ::

128
doc/source/deploy_install_guides/r5_release/bare_metal/controller_storage_install_kubernetes.rst
View File

@ -1,46 +1,34 @@
===========================================================================
Install StarlingX Kubernetes on Bare Metal Standard with Controller Storage
===========================================================================
This section describes the steps to install the StarlingX Kubernetes platform .. _controller_storage_install_kubernetes:
on a **StarlingX R5.0 bare metal Standard with Controller Storage** deployment
configuration. ==========================================================================
Install Kubernetes Platform on Bare Metal Standard with Controller Storage
==========================================================================
.. contents:: .. contents::
:local: :local:
:depth: 1 :depth: 1
.. only:: starlingx
This section describes the steps to install the StarlingX Kubernetes
platform on a **StarlingX R5.0 bare metal Standard with Controller Storage**
deployment configuration.
------------------- -------------------
Create bootable USB Create bootable USB
------------------- -------------------
Refer to :doc:`/deploy_install_guides/bootable_usb` for instructions on how to Refer to :ref:`Bootable USB <bootable_usb>` for instructions on how to
create a bootable USB with the StarlingX ISO on your system. create a bootable USB with the StarlingX ISO on your system.
-------------------------------- --------------------------------
Install software on controller-0 Install software on controller-0
-------------------------------- --------------------------------
.. incl-install-software-controller-0-standard-start: .. include:: inc-install-software-on-controller.rest
:start-after: incl-install-software-controller-0-standard-start
#. Insert the bootable USB into a bootable USB port on the host you are :end-before: incl-install-software-controller-0-standard-end
configuring as controller-0.
#. Power on the host.
#. Attach to a console, ensure the host boots from the USB, and wait for the
StarlingX Installer Menus.
#. Make the following menu selections in the installer:
#. First menu: Select 'Standard Controller Configuration'
#. Second menu: Select 'Graphical Console' or 'Textual 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.
.. incl-install-software-controller-0-standard-end:
-------------------------------- --------------------------------
Bootstrap system on controller-0 Bootstrap system on controller-0
@ -50,7 +38,8 @@ Bootstrap system on controller-0
#. Login using the username / password of "sysadmin" / "sysadmin". #. Login using the username / password of "sysadmin" / "sysadmin".
When logging in for the first time, you will be forced to change the password. When logging in for the first time, you will be forced to change the
password.
:: ::
@ -64,9 +53,9 @@ Bootstrap system on controller-0
#. Verify and/or configure IP connectivity. #. Verify and/or configure IP connectivity.
External connectivity is required to run the Ansible bootstrap playbook. The External connectivity is required to run the Ansible bootstrap playbook. The
StarlingX boot image will DHCP out all interfaces so the server may have StarlingX boot image will |DHCP| out all interfaces so the server may have
obtained an IP address and have external IP connectivity if a DHCP server is obtained an IP address and have external IP connectivity if a |DHCP| server
present in your environment. Verify this using the :command:`ip addr` and is present in your environment. Verify this using the :command:`ip addr` and
:command:`ping 8.8.8.8` commands. :command:`ping 8.8.8.8` commands.
Otherwise, manually configure an IP address and default IP route. Use the Otherwise, manually configure an IP address and default IP route. Use the
@ -82,8 +71,10 @@ Bootstrap system on controller-0
#. Specify user configuration overrides for the Ansible bootstrap playbook. #. Specify user configuration overrides for the Ansible bootstrap playbook.
Ansible is used to bootstrap StarlingX on controller-0. Key files for Ansible .. only:: starlingx
configuration are:
Ansible is used to bootstrap StarlingX on controller-0. Key files for
Ansible configuration are:
``/etc/ansible/hosts`` ``/etc/ansible/hosts``
The default Ansible inventory file. Contains a single host: localhost. The default Ansible inventory file. Contains a single host: localhost.
@ -96,7 +87,8 @@ Bootstrap system on controller-0
``sysadmin home directory ($HOME)`` ``sysadmin home directory ($HOME)``
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:: ../ansible_install_time_only.txt .. include:: ../ansible_install_time_only.txt
@ -106,7 +98,8 @@ Bootstrap system on controller-0
#. Use a copy of the default.yml file listed above to provide your overrides. #. Use a copy of the default.yml file listed above to provide your overrides.
The default.yml file lists all available parameters for bootstrap The default.yml file lists all available parameters for bootstrap
configuration with a brief description for each parameter in the file comments. configuration with a brief description for each parameter in the file
comments.
To use this method, copy the default.yml file listed above to To use this method, copy the default.yml file listed above to
``$HOME/localhost.yml`` and edit the configurable values as desired. ``$HOME/localhost.yml`` and edit the configurable values as desired.
@ -146,11 +139,18 @@ Bootstrap system on controller-0
EOF EOF
Refer to :doc:`/deploy_install_guides/r5_release/ansible_bootstrap_configs` .. only:: partner
for information on additional Ansible bootstrap configurations for advanced
Ansible bootstrap scenarios, such as Docker proxies when deploying behind a .. include:: ../../../_includes/install-playbook-values-aws.rest
firewall, etc. Refer to :doc:`/../../configuration/docker_proxy_config` for
details about Docker proxy settings. .. only:: starlingx
Refer to :ref:`Ansible Bootstrap Configurations
<ansible_bootstrap_configs>` for information on additional Ansible
bootstrap configurations for advanced Ansible bootstrap scenarios, such
as Docker proxies when deploying behind a firewall, etc. Refer to
:ref:`Docker Proxy configuration <docker_proxy_config>` for details about
Docker proxy settings.
#. Run the Ansible bootstrap playbook: #. Run the Ansible bootstrap playbook:
@ -201,7 +201,7 @@ Configure controller-0
system ntp-modify ntpservers=0.pool.ntp.org,1.pool.ntp.org system ntp-modify ntpservers=0.pool.ntp.org,1.pool.ntp.org
#. Configure Ceph storage backend #. Configure Ceph storage backend:
.. important:: .. important::
@ -209,7 +209,7 @@ Configure controller-0
persistent storage. persistent storage.
**If you want to install the StarlingX Openstack application **If you want to install the StarlingX Openstack application
(stx-openstack) this step is mandatory.** (stx-openstack), this step is mandatory.**
:: ::
@ -224,9 +224,12 @@ Configure controller-0
system service-parameter-list platform docker system service-parameter-list platform docker
#. Refer to :doc:`/../../configuration/docker_proxy_config` for #. Refer to :ref:`Docker Proxy Configuration <docker_proxy_config>` for
details about Docker proxy settings. details about Docker proxy settings.
.. only:: starlingx
************************************* *************************************
OpenStack-specific host configuration OpenStack-specific host configuration
************************************* *************************************
@ -267,19 +270,19 @@ OpenStack-specific host configuration
Do not run any vSwitch directly on the host, instead, use the containerized Do not run any vSwitch directly on the host, instead, use the containerized
OVS defined in the helm charts of stx-openstack manifest. OVS defined in the helm charts of stx-openstack manifest.
To deploy OVS-DPDK, run the following command: To deploy OVS-|DPDK|, run the following command:
:: ::
system modify --vswitch_type ovs-dpdk system modify --vswitch_type ovs-dpdk
system host-cpu-modify -f vswitch -p0 1 controller-0 system host-cpu-modify -f vswitch -p0 1 controller-0
Once vswitch_type is set to OVS-DPDK, any subsequent nodes created will Once vswitch_type is set to OVS-|DPDK|, any subsequent nodes created
default to automatically assigning 1 vSwitch core for AIO controllers and 2 will default to automatically assigning 1 vSwitch core for AIO
vSwitch cores for compute-labeled worker nodes. controllers and 2 vSwitch cores for compute-labeled worker nodes.
When using OVS-DPDK, configure vSwitch memory per NUMA node with the following When using OVS-|DPDK|, configure vSwitch memory per node with the
command: following command:
:: ::
@ -291,10 +294,10 @@ OpenStack-specific host configuration
system host-memory-modify -f vswitch -1G 1 worker-0 0 system host-memory-modify -f vswitch -1G 1 worker-0 0
VMs created in an OVS-DPDK environment must be configured to use huge pages |VMs| created in an OVS-|DPDK| environment must be configured to use huge pages
to enable networking and must use a flavor with property: hw:mem_page_size=large to enable networking and must use a flavor with property: hw:mem_page_size=large
Configure the huge pages for VMs in an OVS-DPDK environment with the command: Configure the huge pages for VMs in an OVS-|DPDK| environment with the command:
:: ::
@ -325,7 +328,8 @@ Unlock controller-0 in order to bring it into service:
system host-unlock controller-0 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 machine. service. This can take 5-10 minutes, depending on the performance of the host
machine.
------------------------------------------------- -------------------------------------------------
Install software on controller-1 and worker nodes Install software on controller-1 and worker nodes
@ -414,6 +418,8 @@ 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
.. only:: starlingx
************************************* *************************************
OpenStack-specific host configuration OpenStack-specific host configuration
************************************* *************************************
@ -496,12 +502,12 @@ Configure worker nodes
This step is **required** for OpenStack. This step is **required** for OpenStack.
This step is optional for Kubernetes: Do this step if using SRIOV network This step is optional for Kubernetes: Do this step if using |SRIOV| network
attachments in hosted application containers. attachments in hosted application containers.
For Kubernetes SRIOV network attachments: For Kubernetes |SRIOV| network attachments:
* Configure SRIOV device plug in: * Configure |SRIOV| device plug in:
:: ::
@ -510,7 +516,7 @@ Configure worker nodes
done done
* If planning on running DPDK in containers on this host, configure the number * If planning on running DPDK in containers on this host, configure the number
of 1G Huge pages required on both NUMA nodes: of 1G Huge pages required on both |NUMA| nodes:
:: ::
@ -555,6 +561,8 @@ Configure worker nodes
set +ex set +ex
done done
.. only:: starlingx
************************************* *************************************
OpenStack-specific host configuration OpenStack-specific host configuration
************************************* *************************************
@ -610,7 +618,7 @@ service. This can take 5-10 minutes, depending on the performance of the host ma
Add Ceph OSDs to controllers Add Ceph OSDs to controllers
---------------------------- ----------------------------
#. Add OSDs to controller-0. The following example adds OSDs to the `sdb` disk: #. Add |OSDs| to controller-0. The following example adds |OSDs| to the `sdb` disk:
.. important:: .. important::
@ -629,7 +637,7 @@ Add Ceph OSDs to controllers
system host-stor-list $HOST system host-stor-list $HOST
#. Add OSDs to controller-1. The following example adds OSDs to the `sdb` disk: #. Add |OSDs| to controller-1. The following example adds |OSDs| to the `sdb` disk:
.. important:: .. important::
@ -646,8 +654,12 @@ Add Ceph OSDs to controllers
while true; do system host-stor-list ${HOST} | grep ${OSD} | grep configuring; if [ $? -ne 0 ]; then break; fi; sleep 1; done while true; do system host-stor-list ${HOST} | grep ${OSD} | grep configuring; if [ $? -ne 0 ]; then break; fi; sleep 1; done
done done
::
system host-stor-list $HOST system host-stor-list $HOST
.. only:: starlingx
---------- ----------
Next steps Next steps
---------- ----------

24
doc/source/deploy_install_guides/r5_release/bare_metal/dedicated_storage_install_kubernetes.rst
View File

@ -1,6 +1,14 @@
==========================================================================
Install StarlingX Kubernetes on Bare Metal Standard with Dedicated Storage
========================================================================== .. _dedicated_storage_install_kubernetes:
.. only:: partner
.. include:: /_includes/install-kubernetes-null-labels.rest
=========================================================================
Install Kubernetes Platform on Bare Metal Standard with Dedicated Storage
=========================================================================
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 R5.0 bare metal Standard with Dedicated Storage** deployment on a **StarlingX R5.0 bare metal Standard with Dedicated Storage** deployment
@ -10,20 +18,22 @@ configuration.
:local: :local:
:depth: 1 :depth: 1
.. only:: starlingx
------------------- -------------------
Create bootable USB Create bootable USB
------------------- -------------------
Refer to :doc:`/deploy_install_guides/bootable_usb` for instructions on how to Refer to :ref:`Bootable USB <bootable_usb>` for instructions on how to
create a bootable USB with the StarlingX ISO on your system. create a bootable USB with the StarlingX ISO on your system.
-------------------------------- --------------------------------
Install software on controller-0 Install software on controller-0
-------------------------------- --------------------------------
.. include:: controller_storage_install_kubernetes.rst .. include:: 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
-------------------------------- --------------------------------
Bootstrap system on controller-0 Bootstrap system on controller-0

43
doc/source/deploy_install_guides/r5_release/bare_metal/inc-install-software-on-controller.rest Normal file
View File

@ -0,0 +1,43 @@
.. incl-install-software-controller-0-aio-start
#. Insert the bootable USB into a bootable USB port on the host you are
configuring as controller-0.
#. Power on the host.
#. Attach to a console, ensure the host boots from the USB, and wait for the
StarlingX Installer Menus.
#. Make the following menu selections in the installer:
#. First menu: Select 'All-in-one Controller Configuration'
#. Second menu: Select 'Graphical Console' or 'Textual 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.
.. incl-install-software-controller-0-aio-end
.. incl-install-software-controller-0-standard-start
#. Insert the bootable USB into a bootable USB port on the host you are
configuring as controller-0.
#. Power on the host.
#. Attach to a console, ensure the host boots from the USB, and wait for the
StarlingX Installer Menus.
#. Make the following menu selections in the installer:
#. First menu: Select 'Standard Controller Configuration'
#. Second menu: Select 'Graphical Console' or 'Textual 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.
.. incl-install-software-controller-0-standard-end

109
doc/source/deploy_install_guides/r5_release/bare_metal/inc-openstack-specific-host-config.rest Normal file
View File

@ -0,0 +1,109 @@
.. incl-config-controller-0-openstack-specific-aio-simplex-start:
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
#. **For OpenStack only:** Assign OpenStack host labels to controller-0 in
support of installing the stx-openstack manifest and helm-charts later.
::
system host-label-assign controller-0 openstack-control-plane=enabled
system host-label-assign controller-0 openstack-compute-node=enabled
system host-label-assign controller-0 openvswitch=enabled
system host-label-assign controller-0 sriov=enabled
#. **For OpenStack only:** Configure the system setting for the vSwitch.
StarlingX has |OVS| (kernel-based) vSwitch configured as default:
* Runs in a container; defined within the helm charts of stx-openstack
manifest.
* Shares the core(s) assigned to the platform.
If you require better performance, |OVS|-|DPDK| (|OVS| with the Data Plane
Development Kit, which is supported only on bare metal hardware) should be
used:
* Runs directly on the host (it is not containerized).
* Requires that at least 1 core be assigned/dedicated to the vSwitch function.
To deploy the default containerized |OVS|:
::
system modify --vswitch_type none
Do not run any vSwitch directly on the host, instead, use the containerized
|OVS| defined in the helm charts of stx-openstack manifest.
To deploy |OVS|-|DPDK|, run the following command:
::
system modify --vswitch_type ovs-dpdk
system host-cpu-modify -f vswitch -p0 1 controller-0
Once vswitch_type is set to |OVS|-|DPDK|, any subsequent nodes created
will default to automatically assigning 1 vSwitch core for |AIO|
controllers and 2 vSwitch cores for compute-labeled worker nodes.
When using |OVS|-|DPDK|, configure vSwitch memory per |NUMA| node with
the following command:
::
system host-memory-modify -f <function> -1G <1G hugepages number> <hostname or id> <processor>
For example:
::
system host-memory-modify -f vswitch -1G 1 worker-0 0
|VMs| created in an |OVS|-|DPDK| environment must be configured to use
huge pages to enable networking and must use a flavor with property:
hw:mem_page_size=large
Configure the huge pages for |VMs| in an |OVS|-|DPDK| environment with
the command:
::
system host-memory-modify -1G <1G hugepages number> <hostname or id> <processor>
For example:
::
system host-memory-modify worker-0 0 -1G 10
.. note::
After controller-0 is unlocked, changing vswitch_type requires
locking and unlocking all compute-labeled worker nodes (and/or AIO
controllers) to apply the change.
#. **For OpenStack only:** Set up disk partition for nova-local volume
group, which is needed for stx-openstack nova ephemeral disks.
::
export NODE=controller-0
echo ">>> Getting root disk info"
ROOT_DISK=$(system host-show ${NODE} | grep rootfs | awk '{print $4}')
ROOT_DISK_UUID=$(system host-disk-list ${NODE} --nowrap | grep ${ROOT_DISK} | awk '{print $2}')
echo "Root disk: $ROOT_DISK, UUID: $ROOT_DISK_UUID"
echo ">>>> Configuring nova-local"
NOVA_SIZE=34
NOVA_PARTITION=$(system host-disk-partition-add -t lvm_phys_vol ${NODE} ${ROOT_DISK_UUID} ${NOVA_SIZE})
NOVA_PARTITION_UUID=$(echo ${NOVA_PARTITION} | grep -ow "| uuid | [a-z0-9\-]* |" | awk '{print $4}')
system host-lvg-add ${NODE} nova-local
system host-pv-add ${NODE} nova-local ${NOVA_PARTITION_UUID}
sleep 2
.. incl-config-controller-0-openstack-specific-aio-simplex-end:

23
doc/source/deploy_install_guides/r5_release/bare_metal/rook_storage_install_kubernetes.rst
View File

@ -231,40 +231,41 @@ OpenStack-specific host configuration
#. **For OpenStack only:** Configure the system setting for the vSwitch. #. **For OpenStack only:** Configure the system setting for the vSwitch.
StarlingX has OVS (kernel-based) vSwitch configured as default: StarlingX has |OVS| (kernel-based) vSwitch configured as default:
* Runs in a container; defined within the helm charts of stx-openstack * Runs in a container; defined within the helm charts of stx-openstack
manifest. manifest.
* Shares the core(s) assigned to the platform. * Shares the core(s) assigned to the platform.
If you require better performance, OVS-DPDK (OVS with the Data Plane If you require better performance, |OVS|-|DPDK| (|OVS| with the Data Plane
Development Kit, which is supported only on bare metal hardware) should be Development Kit, which is supported only on bare metal hardware) should be
used: used:
* Runs directly on the host (it is not containerized). * Runs directly on the host (it is not containerized).
* Requires that at least 1 core be assigned/dedicated to the vSwitch function. * Requires that at least 1 core be assigned/dedicated to the vSwitch function.
To deploy the default containerized OVS: To deploy the default containerized |OVS|:
:: ::
system modify --vswitch_type none system modify --vswitch_type none
Do not run any vSwitch directly on the host, instead, use the containerized Do not run any vSwitch directly on the host, instead, use the containerized
OVS defined in the helm charts of stx-openstack manifest. |OVS| defined in the helm charts of stx-openstack manifest.
To deploy OVS-DPDK, run the following command: To deploy |OVS|-|DPDK|, run the following command:
:: ::
system modify --vswitch_type ovs-dpdk system modify --vswitch_type ovs-dpdk
system host-cpu-modify -f vswitch -p0 1 controller-0 system host-cpu-modify -f vswitch -p0 1 controller-0
Once vswitch_type is set to OVS-DPDK, any subsequent nodes created will Once vswitch_type is set to |OVS|-|DPDK|, any subsequent nodes created will
default to automatically assigning 1 vSwitch core for AIO controllers and 2 default to automatically assigning 1 vSwitch core for AIO controllers and 2
vSwitch cores for compute-labeled worker nodes. vSwitch cores for compute-labeled worker nodes.
When using OVS-DPDK, configure vSwitch memory per NUMA node with the following When using |OVS|-|DPDK|, configure vSwitch memory per NUMA node with the
following
command: command:
:: ::
@ -277,10 +278,12 @@ OpenStack-specific host configuration
system host-memory-modify -f vswitch -1G 1 worker-0 0 system host-memory-modify -f vswitch -1G 1 worker-0 0
VMs created in an OVS-DPDK environment must be configured to use huge pages |VMs| created in an |OVS|-|DPDK| environment must be configured to use huge
to enable networking and must use a flavor with property: hw:mem_page_size=large pages to enable networking and must use a flavor with property:
hw:mem_page_size=large
Configure the huge pages for VMs in an OVS-DPDK environment with the command: Configure the huge pages for VMs in an |OVS|-|DPDK| environment with the
command:
:: ::

1
doc/source/shared/abbrevs.txt
View File

@ -66,6 +66,7 @@
.. |OAM| replace:: :abbr:`OAM (Operations, administration and management)` .. |OAM| replace:: :abbr:`OAM (Operations, administration and management)`
.. |OIDC| replace:: :abbr:`OIDC (OpenID Connect)` .. |OIDC| replace:: :abbr:`OIDC (OpenID Connect)`
.. |ONAP| replace:: :abbr:`ONAP (Open Network Automation Program)` .. |ONAP| replace:: :abbr:`ONAP (Open Network Automation Program)`
.. |OVS| replace:: :abbr:`OVS (Open Virtual Switch)`
.. |OSD| replace:: :abbr:`OSD (Object Storage Device)` .. |OSD| replace:: :abbr:`OSD (Object Storage Device)`
.. |OSDs| replace:: :abbr:`OSDs (Object Storage Devices)` .. |OSDs| replace:: :abbr:`OSDs (Object Storage Devices)`
.. |PAC| replace:: :abbr:`PAC (Programmable Acceleration Card)` .. |PAC| replace:: :abbr:`PAC (Programmable Acceleration Card)`