docs/doc/source/node_management/kubernetes/node_interfaces/interface-ip-address-provisioning-using-the-cli.rst
Ron Stone 688f8eb410 Backport r5 fix to master
Backporting some typos and formatting issues fixed during cherrypick.
See: https://review.opendev.org/c/starlingx/docs/+/816651

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I670bb29ade8f146af1bd68b13e3db6e2b9a75481
2021-11-04 13:49:05 +00:00

3.2 KiB

Interface IP Address Provisioning Using the CLI

On a network that uses static addressing, you must assign an IP address to the interface using the system host-addr-add command.

The procedure for adding an IP address depends on the interface type.

supports the following types of interfaces:

Ethernet interfaces

These are created automatically for each port on the host. You must configure Ethernet interfaces by specifying the interface class.

Aggregated Ethernet interfaces

For link protection, you can create an aggregated Ethernet interface with two or more ports, and configure it with the interface class.

~(keystone_admin)$ system host-if-add <hostname> -m mtu -a aemode -x txhashpolicy ifname ae <ethname1> <ethname2>
VLAN interfaces

To support multiple interfaces on the same physical Ethernet or aggregated Ethernet interface, you can create interfaces and configure them with the interface class.

~(keystone_admin)$ systemhost-if-add <hostname> -V --vlan_id -c --ifclass <interfacename> <ethname>
Virtual Function interfaces

You can create an interface on top of an existing interface in order to configure a subset of virtual functions with different drivers. For example, if the ethernet interface is configured with the kernel VF driver, you can create a interface to configure a subset of virtual functions with the vfio driver that can be used with userspace libraries such as .

~(keystone_admin)$ system host-if-add -c pci-sriov <hostname> <interfacename> vf <parentinterfacename> -N numvfs --vf-driver=drivername

Logical interfaces of network types oam and mgmt cannot be deleted. They can only be modified to use different physical ports when required.

Note

On the second worker and storage nodes, the Ethernet interface for the internal management network is attached automatically to support installation using booting.

On the initial controller node, the interface for the internal management network is attached according to the settings specified during the Ansible bootstrapping of the system.

  1. Lock the node.

  2. Add the IP address to the interface using the system host-addr-add command.

    ~(keystone_admin)$ system host-addr-add <node> <ifname> <ip_address> <prefix>

    where the following options are available:

    node

    The name or of the worker node.

    ifname

    The name of the interface.

    ip_address

    An IPv4 or IPv6 address.

    prefix

    The netmask length for the address.

  3. Unlock the node and wait for it to become available.