StarlingX/Docs and Infra/InstallationGuides/virtual-AIO-Simplex

DEPRECATED - Please do not edit.

= Description = The All-In-One Simplex (AIO-SX) deployment option provides all three cloud functions (controller, compute, and storage) on a single server. Use the virtual installation to install one or many virtual servers (VMs) on a single physical host machine.

TODO: any addition info bits needed in intro?



= Physical host requirements = This section describes the recommended minimum system requirements for the workstation hosting the virtual machine(s) where StarlingX will be deployed and basic host setup.

Hardware requirements
The host system should have at least:
 * Processor: x86_64 only supported architecture with BIOS enabled hardware virtualization extensions
 * Cores: 8
 * Memory: 32GB RAM
 * Hard Disk: 500GB HDD
 * Network: One network adapter with active Internet connection

Software requirements
The host system should have at least:
 * A workstation computer with Ubuntu 16.04 LTS 64-bit.

All other required packages will be installed by scripts in StarlingX tools repo.

Host setup
Set up the host with the following steps:

apt-get update apt-get install -y git cd $HOME git clone https://opendev.org/starlingx/tools cd $HOME/tools/deployment/libvirt/ bash install_packages.sh apt install -y apparmor-profiles apt-get install -y ufw ufw disable ufw status
 * 1) Update OS:
 * 1) Clone the StarlingX tools repository:
 * 1) Install required packages:
 * 1) Get the StarlingX ISO.

This can be from a private StarlingX build or, as shown below, from the public Cengen StarlingX build off 'master' branch: wget http://mirror.starlingx.cengn.ca/mirror/starlingx/master/centos/latest_build/outputs/iso/bootimage.iso

= Prepare the virtual environment and virtual servers = Prepare the virtual environment and virtual servers with the following steps:

bash setup_network.sh
 * 1) Setup virtual platform networks for virtual deployment:
 * 1) 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

bash setup_configuration.sh -c simplex -i ./bootimage.iso

= StarlingX Kubernetes = TODO: sentence to intro this section

Install software on controller-0
In the last step of "Prepare the virtual environment and virtual servers" the controller-0 virtual server 'simplex-controller-0' was started by the 'setup_configuration.sh' command.

Attach to the console of virtual controller-0 and select the appropriate installer menu options in order to start the non-interactive install of StarlingX software on controller-0.

virsh console simplex-controller-0 Make the following menu selections in the installer:


 * 1) First menu: Select 'All-in-one Controller Configuration'
 * 2) Second menu: Select 'Graphical Console'
 * 3) Third menu: Select 'Standard Security Profile'

Wait for the non-interactive install of software to complete and for the server to reboot.

This can take 5-10 minutes depending on performance of the host machine.

Bootstrap system on controller-0

 * 1) Login using the username / password of "sysadmin" / "sysadmin".

When logging in for the first time, you will be forced to change the password. Login: sysadmin Password: Changing password for sysadmin. (current) UNIX Password: sysadmin New Password: (repeat) New Password:
 * 1) External connectivity is required to run the Ansible bootstrap playbook.

export CONTROLLER0_OAM_CIDR=10.10.10.3/24 export DEFAULT_OAM_GATEWAY=10.10.10.1 sudo ip address add $CONTROLLER0_OAM_CIDR dev enp7s1 sudo ip link set up dev enp7s1 sudo ip route add default via $DEFAULT_OAM_GATEWAY dev enp7s1 * The default Ansible inventory file, /etc/ansible/hosts, contains a single host: localhost. * The Ansible bootstrap playbook is at /usr/share/ansible/stx-ansible/playbooks/bootstrap/bootstrap.yml. * The default configuration values for the bootstrap playbook are in /usr/share/ansible/stx-ansible/playbooks/bootstrap/host_vars/default.yml. * By default Ansible looks for and imports user configuration override files for hosts in the sysadmin home directory ($HOME), e.g. $HOME/ .yml.
 * 1) Ansible is used to bootstrap StarlingX on Controller-0:

Specify the user configuration override file for the ansible bootstrap playbook, by either # copying the default.yml file listed above to $HOME/localhost.yml and edit the configurable values as desired, based on the commented instructions in the file, or  # creating the minimal user configuration override file as shown below: cd ~ cat < localhost.yml system_mode: simplex

dns_servers: - 8.8.8.8     - 8.8.4.4

external_oam_subnet: 10.10.10.0/24 external_oam_gateway_address: 10.10.10.1 external_oam_floating_address: 10.10.10.2

admin_username: admin admin_password:  ansible_become_pass:  EOF

ansible-playbook /usr/share/ansible/stx-ansible/playbooks/bootstrap/bootstrap.yml Wait for Ansible bootstrap playbook to complete.
 * 1) Run the Ansible bootstrap playbook:

This can take 5-10 mins depending on performance of HOST machine.

Configure controller-0
TODO: make this a numbered list

Acquire admin credentials: source /etc/platform/openrc

Configure the OAM interface of controller-0: OAM_IF=enp7s1 system host-if-modify controller-0 $OAM_IF -c platform system interface-network-assign controller-0 $OAM_IF oam

Configure NTP Servers for network time synchronization:

system ntp-modify ntpservers=0.pool.ntp.org,1.pool.ntp.org

OPTIONALLY for Kubernetes, i.e. if planning on using SRIOV network attachments in application containers, or

REQUIRED for OpenStack,

configure data interfaces for controller-0:
 * 1) For Kubernetes SRIOV network attachments

system host-label-assign controller-0 sriovdp=enabled system host-memory-modify controller-0 0 -1G 100 system host-memory-modify controller-0 1 -1G 100
 * 1) configure SRIOV device plugin
 * 1) If planning on running DPDK in containers on this hosts, configure number of 1G Huge pages required on both NUMA nodes


 * 1) For both Kubernetes and OpenStack

DATA0IF=eth1000 DATA1IF=eth1001 export COMPUTE=controller-0 PHYSNET0='physnet0' PHYSNET1='physnet1' SPL=/tmp/tmp-system-port-list SPIL=/tmp/tmp-system-host-if-list system host-port-list ${COMPUTE} --nowrap > ${SPL} system host-if-list -a ${COMPUTE} --nowrap > ${SPIL} DATA0PCIADDR=$(cat $SPL | grep $DATA0IF |awk '{print $8}') DATA1PCIADDR=$(cat $SPL | grep $DATA1IF |awk '{print $8}') DATA0PORTUUID=$(cat $SPL | grep ${DATA0PCIADDR} | awk '{print $2}') DATA1PORTUUID=$(cat $SPL | grep ${DATA1PCIADDR} | awk '{print $2}') DATA0PORTNAME=$(cat $SPL | grep ${DATA0PCIADDR} | awk '{print $4}') DATA1PORTNAME=$(cat $SPL | grep ${DATA1PCIADDR} | awk '{print $4}') DATA0IFUUID=$(cat $SPIL | awk -v DATA0PORTNAME=$DATA0PORTNAME '($12 ~ DATA0PORTNAME) {print $2}') DATA1IFUUID=$(cat $SPIL | awk -v DATA1PORTNAME=$DATA1PORTNAME '($12 ~ DATA1PORTNAME) {print $2}')

system datanetwork-add ${PHYSNET0} vlan system datanetwork-add ${PHYSNET1} vlan

system host-if-modify -m 1500 -n data0 -c data ${COMPUTE} ${DATA0IFUUID} system host-if-modify -m 1500 -n data1 -c data ${COMPUTE} ${DATA1IFUUID} system interface-datanetwork-assign ${COMPUTE} ${DATA0IFUUID} ${PHYSNET0} system interface-datanetwork-assign ${COMPUTE} ${DATA1IFUUID} ${PHYSNET1} Add an OSD on controller-0 for ceph: echo ">>> Add OSDs to primary tier" system host-disk-list 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

OpenStack-specific host configuration
For OpenStack ONLY, assign OpenStack host labels to controller-0 in support of installing the stx-openstack manifest/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, a vSwitch is required.


 * The default vSwitch is containerized OVS that is packaged with the stx-openstack manifest/helm-charts. StarlingX provides the option to use OVS-DPDK on the host, however in the virtual environment OVS-DPDK is NOT supported, only OVS is supported.  Therefore simply use the default OVS vSwitch here.

For OpenStack Only, setup disk partition for nova-local volume group, needed for stx-openstack nova ephemeral disks.  export COMPUTE=controller-0

echo ">>> Getting root disk info" ROOT_DISK=$(system host-show ${COMPUTE} | grep rootfs | awk '{print $4}') ROOT_DISK_UUID=$(system host-disk-list ${COMPUTE} --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 ${COMPUTE} ${ROOT_DISK_UUID} ${NOVA_SIZE}) NOVA_PARTITION_UUID=$(echo ${NOVA_PARTITION} | grep -ow "| uuid | [a-z0-9\-]* |" | awk '{print $4}') system host-lvg-add ${COMPUTE} nova-local system host-pv-add ${COMPUTE} nova-local ${NOVA_PARTITION_UUID} sleep 2

echo ">>> Wait for partition $NOVA_PARTITION_UUID to be ready." while true; do system host-disk-partition-list $COMPUTE --nowrap | grep $NOVA_PARTITION_UUID | grep Ready; if [ $? -eq 0 ]; then break; fi; sleep 1; done

Unlock controller-0
Unlock controller-0 in order to bring it into service: system host-unlock controller-0 Controller-0 will reboot in order to apply configuration change and come into service.

This can take 5-10 mins depending on performance of HOST machine.

When it completes, your Kubernetes Cluster is up and running.

Access StarlingX Kubernetes
Use Local/Remote CLIs, GUIs and/or REST APIs to access and manage StarlingX Kubernetes and hosted containerized applications. See details on accessing the StarlingX Kubernetes Cluster here.

= StarlingX OpenStack = TODO: sentence to intro this section

Install StarlingX OpenStack
With the exception of the OpenStack-specific configurations required in the underlying StarlingX/Kubernetes infrastructure (described in the installation steps for the Starlingx Kubernetes platform above), the installation of containerized OpenStack for StarlingX is independent of deployment configuration. See the installation guide for OpenStack for installation instructions.

Access StarlingX OpenStack
Use Local/Remote CLIs, GUIs and/or REST APIs to access and manage StarlingX OpenStack and hosted virtualized applications. See details on accessing StarlingX OpenStack here.