[StarlingX 4.0] - Documentation needs to be updated for LAG and VLAN type interfaces

[ANIRUDH GUPTA]

Brief Description
-----------------
We are trying to install StarlingX 4.0 in a dedicated storage Model and facing issue in Configuring Worker Nodes in case we need to go with LAG type Data Interface.

Severity
--------
Critical

Steps to Reproduce
------------------

STEP 1:
We have created bonds for Data Network on Worker Node(reference document: https://docs.starlingx.io/configuration/host_interface_network_config.html#:~:text=When%20a%20host%20is%20added,system%20host%2Dif%2Dadd.)

     * system host-if-add worker-1 -m 1500 -a active_standby data1bond ae eth1 eth2
     * system host-if-add worker-1 -m 1500 -a active_standby data2bond ae eth3 eth4

STEP 2:
Then further as per the main documents when Configuring data interfaces for worker nodes ( reference document: https://docs.starlingx.io/deploy_install_guides/r4_release/bare_metal/dedicated_storage_install_kubernetes.html)

  * SPL=/tmp/tmp-system-port-list
  * SPIL=/tmp/tmp-system-host-if-list

Above files does not have the information of the created Bond interfaces for data Nodes,

Further in order to get the the value of ${DATA0IFUUID} and ${DATA1IFUUID} below mentioned commands are executed:

DATA0IF=<DATA-0-PORT>
DATA1IF=<DATA-1-PORT>
PHYSNET0='physnet0'
PHYSNET1='physnet1'
SPL=/tmp/tmp-system-port-list
SPIL=/tmp/tmp-system-host-if-list

# configure the datanetworks in sysinv, prior to referencing it
# in the ``system host-if-modify`` command'.
system datanetwork-add ${PHYSNET0} vlan
system datanetwork-add ${PHYSNET1} vlan

for NODE in worker-0 worker-1; do
  echo "Configuring interface for: $NODE"
  set -ex
  system host-port-list ${NODE} --nowrap > ${SPL}
  system host-if-list -a ${NODE} --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 host-if-modify -m 1500 -n data0 -c data ${NODE} ${DATA0IFUUID}
  system host-if-modify -m 1500 -n data1 -c data ${NODE} ${DATA1IFUUID}
  system interface-datanetwork-assign ${NODE} ${DATA0IFUUID} ${PHYSNET0}
  system interface-datanetwork-assign ${NODE} ${DATA1IFUUID} ${PHYSNET1}
  set +ex
done

But in our case these values in the variable(${DATA0IFUUID} and ${DATA1IFUUID}) were not getting populated, therefore we have used the UUID received from command :
              System host-if-list worker-0
              System host-if-list worker-1

We observed that UUID of any ethernet interface mentioned in the file (SPIL=/tmp/tmp-system-host-if-list
) matches with the UUID obtained by running the above command(System host-if-list worker-0 ) , so as we did not get the UUID from the file in case LAG Bonds we passed the Values of UUID directly.

Expected Behavior
------------------
Documentation should include the use of LAG and VLAN type data Interfaces

Actual Behavior
----------------

SPL=/tmp/tmp-system-port-list
SPIL=/tmp/tmp-system-host-if-list

There is no entry of LAG and VLAN interfaces in the above files.

Reproducibility
100%

[M Camp (mcamp859)]

In the time that has passed since this LP was opened, the StarlingX documentation has been significantly updated with info about VLAN and LAG interfaces.

Please refer to these guides for details:
https://docs.starlingx.io/node_management/kubernetes/index.html#node-interfaces-index
https://docs.starlingx.io/deploy_install_guides/r5_release/bare_metal/dedicated_storage_install_kubernetes.html

Changing status to Fixed.