starlingx/docs
Code Issues Proposed changes

Add NVMe info to R2 and R3 install guides

Browse Source 
- Add NVMe config info (same as R1) as common info for R2 and R3
- Clarify example command to add OSD for ceph (to clarify command is example,
  drive may be different for user depending on setup)

Closes-Bug: 1853639

Change-Id: I9250842c9a0739016054746dce45b1f17d46172f
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
Kristal Dale 2019-11-22 15:19:24 -08:00
parent 33e5ad0462
commit ebc686a137
18 changed files with 123 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/deploy_install_guides/index.rst
View File

@ -47,6 +47,7 @@ Archived releases
:hidden:
bootable_usb
nvme_config
.. Making a new release

26
doc/source/deploy_install_guides/nvme_config.rst Normal file
View File

@ -0,0 +1,26 @@
====================================
Configure NVMe Drive as Primary Disk
====================================
To use a :abbr:`Non-Volatile Memory Express (NVMe)` drive as the primary disk for
any of your nodes, you must configure your host and adjust kernel parameters
during installation:
#. Configure the host to be in UEFI mode.
#. Edit the kernel boot parameter.
After you are presented with the StarlingX ISO boot options and have selected
the preferred installation option (for example Standard Configuration or
All-in-One Controller Configuration), press the TAB key to edit the kernel
boot parameters.
Modify the **boot_device** and **rootfs_device** from the default **sda** so
that it is the correct device name for the NVMe drive (for example "nvme0n1").
::
vmlinuz rootwait console=tty0 inst.text inst.stage2=hd:LABEL=oe_iso_boot
inst.ks=hd:LABEL=oe_iso_boot:/smallsystem_ks.cfg boot_device=nvme0n1
rootfs_device=nvme0n1 biosdevname=0 usbcore.autosuspend=-1 inst.gpt
security_profile=standard user_namespace.enable=1 initrd=initrd.img

2
doc/source/deploy_install_guides/r2_release/bare_metal/aio_duplex_hardware.rst
View File

@ -31,7 +31,7 @@ host types are:
+-------------------------+-----------------------------------------------------------+
| Minimum memory | 64 GB |
+-------------------------+-----------------------------------------------------------+
| Primary disk | 500 GB SDD or NVMe |
| Primary disk | 500 GB SDD or NVMe (see :doc:`../../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 |

3
doc/source/deploy_install_guides/r2_release/bare_metal/aio_duplex_install_kubernetes.rst
View File

@ -220,7 +220,8 @@ Configure controller-0
system interface-datanetwork-assign ${COMPUTE} ${DATA0IFUUID} ${PHYSNET0}
system interface-datanetwork-assign ${COMPUTE} ${DATA1IFUUID} ${PHYSNET1}
#. Add an OSD on controller-0 for ceph:
#. Add an OSD on controller-0 for ceph. The following example adds an OSD
to the `sdb` disk:
::

2
doc/source/deploy_install_guides/r2_release/bare_metal/aio_simplex_hardware.rst
View File

@ -31,7 +31,7 @@ host types are:
+-------------------------+-----------------------------------------------------------+
| Minimum memory | 64 GB |
+-------------------------+-----------------------------------------------------------+
| Primary disk | 500 GB SDD or NVMe |
| Primary disk | 500 GB SDD or NVMe (see :doc:`../../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 |

3
doc/source/deploy_install_guides/r2_release/bare_metal/aio_simplex_install_kubernetes.rst
View File

@ -227,7 +227,8 @@ Configure controller-0
system interface-datanetwork-assign ${COMPUTE} ${DATA0IFUUID} ${PHYSNET0}
system interface-datanetwork-assign ${COMPUTE} ${DATA1IFUUID} ${PHYSNET1}
#. Add an OSD on controller-0 for ceph:
#. Add an OSD on controller-0 for ceph. The following example adds an OSD
to the `sdb` disk:
::

3
doc/source/deploy_install_guides/r2_release/bare_metal/controller_storage_hardware.rst
View File

@ -27,7 +27,8 @@ host types are:
+-------------------------+-----------------------------+-----------------------------+
| Minimum memory | 64 GB | 32 GB |
+-------------------------+-----------------------------+-----------------------------+
| Primary disk | 500 GB SDD or NVMe | 120 GB (Minimum 10k RPM) |
| Primary disk | 500 GB SDD or NVMe (see | 120 GB (Minimum 10k RPM) |
| | :doc:`../../nvme_config`) | |
+-------------------------+-----------------------------+-----------------------------+
| Additional disks | - 1 or more 500 GB (min. | - For OpenStack, recommend |
| | 10K RPM) for Ceph OSD | 1 or more 500 GB (min. |

4
doc/source/deploy_install_guides/r2_release/bare_metal/controller_storage_install_kubernetes.rst
View File

@ -549,7 +549,7 @@ service. This can take 5-10 minutes, depending on the performance of the host ma
Add Ceph OSDs to controllers
----------------------------
#. Add OSDs to controller-0:
#. Add OSDs to controller-0. The following example adds OSDs to the `sdb` disk:
::
@ -564,7 +564,7 @@ Add Ceph OSDs to controllers
system host-stor-list $HOST
#. Add OSDs to controller-1:
#. Add OSDs to controller-1. The following example adds OSDs to the `sdb` disk:
::

71
doc/source/deploy_install_guides/r2_release/bare_metal/dedicated_storage_hardware.rst
View File

@ -17,41 +17,42 @@ Minimum hardware requirements
The recommended minimum hardware requirements for bare metal servers for various
host types are:
+---------------------+-----------------------+-----------------------+-----------------------+
| Minimum Requirement | Controller Node | Storage Node | Compute Node |
+=====================+=======================+=======================+=======================+
| Number of servers | 2 | 2-9 | 2-100 |
+---------------------+-----------------------+-----------------------+-----------------------+
| Minimum processor | Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8 cores/socket |
| class | |
+---------------------+-----------------------+-----------------------+-----------------------+
| Minimum memory | 64 GB | 64 GB | 32 GB |
+---------------------+-----------------------+-----------------------+-----------------------+
| Primary disk | 500 GB SDD or NVM | 120 GB (min. 10k RPM) | 120 GB (min. 10k RPM) |
+---------------------+-----------------------+-----------------------+-----------------------+
| Additional disks | None | - 1 or more 500 GB | - For OpenStack, |
| | | (min. 10K RPM) for | recommend 1 or more |
| | | Ceph OSD | 500 GB (min. 10K |
| | | - Recommended, but | RPM) for VM |
| | | not required: 1 or | ephemeral storage |
| | | more SSDs or NVMe | |
| | | drives for Ceph | |
| | | journals (min. 1024 | |
| | | MiB per OSD | |
| | | journal) | |
+---------------------+-----------------------+-----------------------+-----------------------+
| Minimum network | - Mgmt/Cluster: | - Mgmt/Cluster: | - Mgmt/Cluster: |
| ports | 1x10GE | 1x10GE | 1x10GE |
| | - OAM: 1x1GE | | - Data: 1 or more |
| | | | x 10GE |
+---------------------+-----------------------+-----------------------+-----------------------+
| BIOS settings | - Hyper-Threading technology enabled |
| | - Virtualization technology enabled |
| | - VT for directed I/O enabled |
| | - CPU power and performance policy set to performance |
| | - CPU C state control disabled |
| | - Plug & play BMC detection disabled |
+---------------------+-----------------------+-----------------------+-----------------------+
+---------------------+---------------------------+-----------------------+-----------------------+
| Minimum Requirement | Controller Node | Storage Node | Compute Node |
+=====================+===========================+=======================+=======================+
| Number of servers | 2 | 2-9 | 2-100 |
+---------------------+---------------------------+-----------------------+-----------------------+
| Minimum processor | Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8 cores/socket |
| class | |
+---------------------+---------------------------+-----------------------+-----------------------+
| Minimum memory | 64 GB | 64 GB | 32 GB |
+---------------------+---------------------------+-----------------------+-----------------------+
| Primary disk | 500 GB SDD or NVMe ( see | 120 GB (min. 10k RPM) | 120 GB (min. 10k RPM) |
| | :doc:`../../nvme_config`) | | |
+---------------------+---------------------------+-----------------------+-----------------------+
| Additional disks | None | - 1 or more 500 GB | - For OpenStack, |
| | | (min. 10K RPM) for | recommend 1 or more |
| | | Ceph OSD | 500 GB (min. 10K |
| | | - Recommended, but | RPM) for VM |
| | | not required: 1 or | ephemeral storage |
| | | more SSDs or NVMe | |
| | | drives for Ceph | |
| | | journals (min. 1024 | |
| | | MiB per OSD | |
| | | journal) | |
+---------------------+---------------------------+-----------------------+-----------------------+
| Minimum network | - Mgmt/Cluster: | - Mgmt/Cluster: | - Mgmt/Cluster: |
| ports | 1x10GE | 1x10GE | 1x10GE |
| | - OAM: 1x1GE | | - Data: 1 or more |
| | | | x 10GE |
+---------------------+---------------------------+-----------------------+-----------------------+
| BIOS settings | - Hyper-Threading technology enabled |
| | - Virtualization technology enabled |
| | - VT for directed I/O enabled |
| | - CPU power and performance policy set to performance |
| | - CPU C state control disabled |
| | - Plug & play BMC detection disabled |
+---------------------+---------------------------+-----------------------+-----------------------+
--------------------------
Prepare bare metal servers

4
doc/source/deploy_install_guides/r2_release/bare_metal/dedicated_storage_install_kubernetes.rst
View File

@ -176,7 +176,7 @@ Configure storage nodes
system interface-network-assign $COMPUTE mgmt0 cluster-host
done
#. Add OSDs to storage-0:
#. Add OSDs to storage-0. The following example adds OSDs to the `sdb` disk:
::
@ -191,7 +191,7 @@ Configure storage nodes
system host-stor-list $HOST
#. Add OSDs to storage-1:
#. Add OSDs to storage-1. The following example adds OSDs to the `sdb` disk:
::

2
doc/source/deploy_install_guides/r3_release/bare_metal/aio_duplex_hardware.rst
View File

@ -31,7 +31,7 @@ host types are:
+-------------------------+-----------------------------------------------------------+
| Minimum memory | 64 GB |
+-------------------------+-----------------------------------------------------------+
| Primary disk | 500 GB SDD or NVMe |
| Primary disk | 500 GB SDD or NVMe (see :doc:`../../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 |

3
doc/source/deploy_install_guides/r3_release/bare_metal/aio_duplex_install_kubernetes.rst
View File

@ -220,7 +220,8 @@ Configure controller-0
system interface-datanetwork-assign ${COMPUTE} ${DATA0IFUUID} ${PHYSNET0}
system interface-datanetwork-assign ${COMPUTE} ${DATA1IFUUID} ${PHYSNET1}
#. Add an OSD on controller-0 for ceph:
#. Add an OSD on controller-0 for ceph. The following example adds an OSD
to the `sdb` disk:
::

2
doc/source/deploy_install_guides/r3_release/bare_metal/aio_simplex_hardware.rst
View File

@ -31,7 +31,7 @@ host types are:
+-------------------------+-----------------------------------------------------------+
| Minimum memory | 64 GB |
+-------------------------+-----------------------------------------------------------+
| Primary disk | 500 GB SDD or NVMe |
| Primary disk | 500 GB SDD or NVMe (see :doc:`../../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 |

3
doc/source/deploy_install_guides/r3_release/bare_metal/aio_simplex_install_kubernetes.rst
View File

@ -227,7 +227,8 @@ Configure controller-0
system interface-datanetwork-assign ${COMPUTE} ${DATA0IFUUID} ${PHYSNET0}
system interface-datanetwork-assign ${COMPUTE} ${DATA1IFUUID} ${PHYSNET1}
#. Add an OSD on controller-0 for ceph:
#. Add an OSD on controller-0 for ceph. The following example adds an OSD
to the `sdb` disk:
::

3
doc/source/deploy_install_guides/r3_release/bare_metal/controller_storage_hardware.rst
View File

@ -27,7 +27,8 @@ host types are:
+-------------------------+-----------------------------+-----------------------------+
| Minimum memory | 64 GB | 32 GB |
+-------------------------+-----------------------------+-----------------------------+
| Primary disk | 500 GB SDD or NVMe | 120 GB (Minimum 10k RPM) |
| Primary disk | 500 GB SDD or NVMe (see | 120 GB (Minimum 10k RPM) |
| | :doc:`../../nvme_config`) | |
+-------------------------+-----------------------------+-----------------------------+
| Additional disks | - 1 or more 500 GB (min. | - For OpenStack, recommend |
| | 10K RPM) for Ceph OSD | 1 or more 500 GB (min. |

4
doc/source/deploy_install_guides/r3_release/bare_metal/controller_storage_install_kubernetes.rst
View File

@ -549,7 +549,7 @@ service. This can take 5-10 minutes, depending on the performance of the host ma
Add Ceph OSDs to controllers
----------------------------
#. Add OSDs to controller-0:
#. Add OSDs to controller-0. The following example adds OSDs to the `sdb` disk:
::
@ -564,7 +564,7 @@ Add Ceph OSDs to controllers
system host-stor-list $HOST
#. Add OSDs to controller-1:
#. Add OSDs to controller-1. The following example adds OSDs to the `sdb` disk:
::

71
doc/source/deploy_install_guides/r3_release/bare_metal/dedicated_storage_hardware.rst
View File

@ -17,41 +17,42 @@ Minimum hardware requirements
The recommended minimum hardware requirements for bare metal servers for various
host types are:
+---------------------+-----------------------+-----------------------+-----------------------+
| Minimum Requirement | Controller Node | Storage Node | Compute Node |
+=====================+=======================+=======================+=======================+
| Number of servers | 2 | 2-9 | 2-100 |
+---------------------+-----------------------+-----------------------+-----------------------+
| Minimum processor | Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8 cores/socket |
| class | |
+---------------------+-----------------------+-----------------------+-----------------------+
| Minimum memory | 64 GB | 64 GB | 32 GB |
+---------------------+-----------------------+-----------------------+-----------------------+
| Primary disk | 500 GB SDD or NVM | 120 GB (min. 10k RPM) | 120 GB (min. 10k RPM) |
+---------------------+-----------------------+-----------------------+-----------------------+
| Additional disks | None | - 1 or more 500 GB | - For OpenStack, |
| | | (min. 10K RPM) for | recommend 1 or more |
| | | Ceph OSD | 500 GB (min. 10K |
| | | - Recommended, but | RPM) for VM |
| | | not required: 1 or | ephemeral storage |
| | | more SSDs or NVMe | |
| | | drives for Ceph | |
| | | journals (min. 1024 | |
| | | MiB per OSD | |
| | | journal) | |
+---------------------+-----------------------+-----------------------+-----------------------+
| Minimum network | - Mgmt/Cluster: | - Mgmt/Cluster: | - Mgmt/Cluster: |
| ports | 1x10GE | 1x10GE | 1x10GE |
| | - OAM: 1x1GE | | - Data: 1 or more |
| | | | x 10GE |
+---------------------+-----------------------+-----------------------+-----------------------+
| BIOS settings | - Hyper-Threading technology enabled |
| | - Virtualization technology enabled |
| | - VT for directed I/O enabled |
| | - CPU power and performance policy set to performance |
| | - CPU C state control disabled |
| | - Plug & play BMC detection disabled |
+---------------------+-----------------------+-----------------------+-----------------------+
+---------------------+---------------------------+-----------------------+-----------------------+
| Minimum Requirement | Controller Node | Storage Node | Compute Node |
+=====================+===========================+=======================+=======================+
| Number of servers | 2 | 2-9 | 2-100 |
+---------------------+---------------------------+-----------------------+-----------------------+
| Minimum processor | Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8 cores/socket |
| class | |
+---------------------+---------------------------+-----------------------+-----------------------+
| Minimum memory | 64 GB | 64 GB | 32 GB |
+---------------------+---------------------------+-----------------------+-----------------------+
| Primary disk | 500 GB SDD or NVMe (see | 120 GB (min. 10k RPM) | 120 GB (min. 10k RPM) |
| | :doc:`../../nvme_config`) | | |
+---------------------+---------------------------+-----------------------+-----------------------+
| Additional disks | None | - 1 or more 500 GB | - For OpenStack, |
| | | (min. 10K RPM) for | recommend 1 or more |
| | | Ceph OSD | 500 GB (min. 10K |
| | | - Recommended, but | RPM) for VM |
| | | not required: 1 or | ephemeral storage |
| | | more SSDs or NVMe | |
| | | drives for Ceph | |
| | | journals (min. 1024 | |
| | | MiB per OSD | |
| | | journal) | |
+---------------------+---------------------------+-----------------------+-----------------------+
| Minimum network | - Mgmt/Cluster: | - Mgmt/Cluster: | - Mgmt/Cluster: |
| ports | 1x10GE | 1x10GE | 1x10GE |
| | - OAM: 1x1GE | | - Data: 1 or more |
| | | | x 10GE |
+---------------------+---------------------------+-----------------------+-----------------------+
| BIOS settings | - Hyper-Threading technology enabled |
| | - Virtualization technology enabled |
| | - VT for directed I/O enabled |
| | - CPU power and performance policy set to performance |
| | - CPU C state control disabled |
| | - Plug & play BMC detection disabled |
+---------------------+---------------------------+-----------------------+-----------------------+
--------------------------
Prepare bare metal servers

4
doc/source/deploy_install_guides/r3_release/bare_metal/dedicated_storage_install_kubernetes.rst
View File

@ -176,7 +176,7 @@ Configure storage nodes
system interface-network-assign $COMPUTE mgmt0 cluster-host
done
#. Add OSDs to storage-0:
#. Add OSDs to storage-0. The following example adds OSDs to the `sdb` disk:
::
@ -191,7 +191,7 @@ Configure storage nodes
system host-stor-list $HOST
#. Add OSDs to storage-1:
#. Add OSDs to storage-1. The following example adds OSDs to the `sdb` disk:
::