diff --git a/doc/source/deploy_install_guides/release/bare_metal/aio_simplex_install_kubernetes.rst b/doc/source/deploy_install_guides/release/bare_metal/aio_simplex_install_kubernetes.rst index d5f7713ca..4a30395da 100644 --- a/doc/source/deploy_install_guides/release/bare_metal/aio_simplex_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/release/bare_metal/aio_simplex_install_kubernetes.rst @@ -162,38 +162,38 @@ Prepare Servers for Installation .. group-tab:: Virtual .. note:: - + The following commands for host, virtual environment setup, and host power-on use KVM / virsh for virtual machine and VM management technology. For an alternative virtualization environment, see: :ref:`Install StarlingX in VirtualBox `. - + #. Prepare virtual environment. - + Set up the virtual platform networks for virtual deployment: - + :: - + bash setup_network.sh - + #. Prepare virtual servers. - + Create the XML definitions for the virtual servers required by this configuration option. This will create the XML virtual server definition for: - + * simplex-controller-0 - + The following command will start/virtually power on: - + * The 'simplex-controller-0' virtual server * The X-based graphical virt-manager application - + :: - + bash setup_configuration.sh -c simplex -i ./bootimage.iso - + If there is no X-server present errors will occur and the X-based GUI for the virt-manager application will not start. The virt-manager GUI is not absolutely required and you can safely @@ -224,26 +224,26 @@ Install Software on Controller-0 In the last step of :ref:`aio_simplex_environ`, the controller-0 virtual server 'simplex-controller-0' was started by the :command:`setup_configuration.sh` command. - + On the host, attach to the console of virtual controller-0 and select the appropriate installer menu options to start the non-interactive install of StarlingX software on controller-0. - + .. note:: - + When entering the console, it is very easy to miss the first installer menu selection. Use ESC to navigate to previous menus, to ensure you are at the first installer menu. - + :: - + virsh console simplex-controller-0 - + Make the following menu selections in the installer: - + #. First menu: Select 'All-in-one Controller Configuration' #. Second menu: Select 'Serial Console' - + Wait for the non-interactive install of software to complete and for the server to reboot. This can take 5-10 minutes, depending on the performance of the host machine. @@ -285,10 +285,12 @@ Bootstrap system on controller-0 .. group-tab:: Virtual - Not applicable. + .. include:: /shared/_includes/aio_simplex_install_kubernetes.rest + :start-after: begin-aio-sx-install-verify-ip-connectivity + :end-before: end-aio-sx-install-verify-ip-connectivity .. only:: partner - + .. include:: /shared/_includes/aio_simplex_install_kubernetes.rest :start-after: begin-aio-sx-install-verify-ip-connectivity :end-before: end-aio-sx-install-verify-ip-connectivity @@ -448,8 +450,8 @@ The newly installed controller needs to be configured. source /etc/platform/openrc #. Configure the |OAM| interface of controller-0 and specify the attached - network as "oam". - + network as "oam". + .. only:: starlingx .. tabs:: @@ -463,7 +465,7 @@ The newly installed controller needs to be configured. .. group-tab:: Virtual :: - + OAM_IF=enp7s1 system host-if-modify controller-0 $OAM_IF -c platform system interface-network-assign controller-0 $OAM_IF oam @@ -620,26 +622,26 @@ The newly installed controller needs to be configured. .. group-tab:: Bare Metal StarlingX has |OVS| (kernel-based) vSwitch configured as default: - + * Runs in a container; defined within the helm charts of |prefix|-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|: - + :: - + ~(keystone_admin)$ system modify --vswitch_type none - + This does not run any vSwitch directly on the host, instead, it uses the containerized |OVS| defined in the helm charts of |prefix|-openstack manifest. @@ -736,10 +738,10 @@ The newly installed controller needs to be configured. ~(keystone_admin)$ DATA1PORTNAME=$(cat $SPL | grep ${DATA1PCIADDR} | awk '{print $4}') ~(keystone_admin)$ DATA0IFUUID=$(cat $SPIL | awk -v DATA0PORTNAME=$DATA0PORTNAME '($12 ~ DATA0PORTNAME) {print $2}') ~(keystone_admin)$ DATA1IFUUID=$(cat $SPIL | awk -v DATA1PORTNAME=$DATA1PORTNAME '($12 ~ DATA1PORTNAME) {print $2}') - + ~(keystone_admin)$ system datanetwork-add ${PHYSNET0} vlan ~(keystone_admin)$ system datanetwork-add ${PHYSNET1} vlan - + ~(keystone_admin)$ system host-if-modify -m 1500 -n data0 -c data ${NODE} ${DATA0IFUUID} ~(keystone_admin)$ system host-if-modify -m 1500 -n data1 -c data ${NODE} ${DATA1IFUUID} ~(keystone_admin)$ system interface-datanetwork-assign ${NODE} ${DATA0IFUUID} ${PHYSNET0} @@ -771,30 +773,30 @@ Optionally Configure PCI-SRIOV Interfaces #. Configure the |PCI|-SRIOV interfaces for controller-0. .. code-block:: bash - + ~(keystone_admin)$ export NODE=controller-0 - + # List inventoried host’s ports and identify ports to be used as ‘pci-sriov’ interfaces, # based on displayed linux port name, pci address and device type. ~(keystone_admin)$ system host-port-list ${NODE} - + # List host’s auto-configured ‘ethernet’ interfaces, # find the interfaces corresponding to the ports identified in previous step, and # take note of their UUID ~(keystone_admin)$ system host-if-list -a ${NODE} - + # Modify configuration for these interfaces # Configuring them as ‘pci-sriov’ class interfaces, MTU of 1500 and named sriov# ~(keystone_admin)$ system host-if-modify -m 1500 -n sriov0 -c pci-sriov ${NODE} -N ~(keystone_admin)$ system host-if-modify -m 1500 -n sriov1 -c pci-sriov ${NODE} -N - + # If not already created, create Data Networks that the 'pci-sriov' interfaces will # be connected to ~(keystone_admin)$ DATANET0='datanet0' ~(keystone_admin)$ DATANET1='datanet1' ~(keystone_admin)$ system datanetwork-add ${DATANET0} vlan ~(keystone_admin)$ system datanetwork-add ${DATANET1} vlan - + # Assign Data Networks to PCI-SRIOV Interfaces ~(keystone_admin)$ system interface-datanetwork-assign ${NODE} ${DATANET0} ~(keystone_admin)$ system interface-datanetwork-assign ${NODE} ${DATANET1} @@ -802,27 +804,27 @@ Optionally Configure PCI-SRIOV Interfaces #. **For Kubernetes Only:** To enable using |SRIOV| network attachments for the above interfaces in Kubernetes hosted application containers: - + .. only:: starlingx - + .. tabs:: - + .. group-tab:: Bare Metal - + .. include:: /shared/_includes/aio_simplex_install_kubernetes.rest :start-after: begin-config-controller-0-OS-k8s-sriov-sx :end-before: end-config-controller-0-OS-k8s-sriov-sx - + .. group-tab:: Virtual - + Configure the Kubernetes |SRIOV| device plugin. - + .. code-block:: none - + ~(keystone_admin)$ system host-label-assign controller-0 sriovdp=enabled .. only:: partner - + .. include:: /shared/_includes/aio_simplex_install_kubernetes.rest :start-after: begin-config-controller-0-OS-k8s-sriov-sx :end-before: end-config-controller-0-OS-k8s-sriov-sx