docs/installation-guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2019 Wind River Systems, Inc.
   4
   5
   6 Installation Guide
   7 ==================
   8
   9 .. contents::
  10    :depth: 3
  11    :local:
  12
  13 Abstract
  14 --------
  15
  16 This document describes how to install O-RAN INF image, example configuration for better
  17 real time performance, and example deployment of Kubernetes cluster and plugins.
  18
  19 The audience of this document is assumed to have basic knowledge in Yocto/Open-Embedded Linux
  20 and container technology.
  21
  22 Version history
  23
  24 +--------------------+--------------------+--------------------+--------------------+
  25 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  26 |                    |                    |                    |                    |
  27 +--------------------+--------------------+--------------------+--------------------+
  28 | 2019-11-02         | 1.0.0              | Jackie Huang       | Initail version    |
  29 |                    |                    |                    |                    |
  30 +--------------------+--------------------+--------------------+--------------------+
  31 | 2020-06-03         | 2.0.0 (Bronze)     | Xiaohua Zhang      | Bronze version     |
  32 |                    |                    |                    |                    |
  33 +--------------------+--------------------+--------------------+--------------------+
  34 |                    |                    |                    |                    |
  35 |                    |                    |                    |                    |
  36 +--------------------+--------------------+--------------------+--------------------+
  37
  38
  39 Preface
  40 -------
  41
  42 Before starting the installation and deployment of O-RAN INF, you need to download the ISO image or build from source as described in developer-guide.
  43
  44
  45 Hardware Requirements
  46 ---------------------
  47
  48 Following minimum hardware requirements must be met for installation of O-RAN INF image:
  49
  50 +--------------------+----------------------------------------------------+
  51 | **HW Aspect**      | **Requirement**                                    |
  52 |                    |                                                    |
  53 +--------------------+----------------------------------------------------+
  54 | **# of servers**   | 1                                                  |
  55 +--------------------+----------------------------------------------------+
  56 | **CPU**            | 2                                                  |
  57 |                    |                                                    |
  58 +--------------------+----------------------------------------------------+
  59 | **RAM**            | 16G                                                |
  60 |                    |                                                    |
  61 +--------------------+----------------------------------------------------+
  62 | **Disk**           | 500G * 2                                           |
  63 |                    |                                                    |
  64 +--------------------+----------------------------------------------------+
  65 | **NICs**           | 2                                                  |
  66 |                    |                                                    |
  67 +--------------------+----------------------------------------------------+
  68
  69
  70
  71 Software Installation and Deployment
  72 ------------------------------------
  73
  74 1. Installation from the O-RAN INF ISO image
  75 ````````````````````````````````````````````
  76
  77 - Please see the README.md file for how to build the image.
  78 - The Image is a live ISO image with CLI installer: inf-image-aio-installer-intel-corei7-64.iso
  79
  80 1.1 Burn the image to the USB device
  81 ''''''''''''''''''''''''''''''''''''
  82
  83 - Assume the the usb device is /dev/sdX here
  84
  85 ::
  86
  87   $ sudo dd if=/path/to/inf-image-aio-installer-intel-corei7-64.iso of=/dev/sdX bs=1M
  88
  89 1.2 Install the server
  90 ''''''''''''''''''''''
  91
  92 - Reboot the target from the USB device.
  93
  94 - Select "Graphics console install" or "Serial console install" and press ENTER
  95
  96 - Remove the USB device and press ENTER to reboot
  97
  98
  99 2. Configuration and initialize the bootstrap
 100 `````````````````````````````````````````````
 101
 102 2.1 First Login
 103 ```````````````
 104 Example:
 105
 106 ::
 107
 108     ifconfig eno1 128.224.180.14/24 up
 109
 110     ip route add default via 128.224.180.1
 111
 112     ping 8.8.8.8
 113
 114 2.3 Login the server through SSH
 115 ````````````````````````````````
 116
 117 2.4 Prepare the localhost.yml for bootstrap
 118 ```````````````````````````````````````````
 119
 120 Example:
 121
 122 ::
 123
 124     system_mode: simplex
 125
 126     external_oam_subnet: 128.224.180.0/24
 127
 128     external_oam_gateway_address: 128.224.180.1
 129
 130     external_oam_floating_address: 128.224.180.14
 131
 132     admin_username: admin
 133
 134     admin_password: Wind123!
 135
 136     ansible_become_pass: Wind123!
 137
 138     docker_http_proxy: http://xxx.xxx.xxx.xxx:8080
 139
 140     docker_https_proxy: https://xxx.xxx.xxx.xxx:8080
 141
 142 2.5 Run the bootstrap
 143 `````````````````````
 144
 145 Use the following command:
 146
 147 ::
 148
 149     ansible-playbook /usr/share/ansible/stx-ansible/playbooks/bootstrap.yml -vvv
 150
 151 After the bootstrap successfully finish, it will show as following:
 152
 153 ::
 154
 155     PLAY RECAP ******************************************************************************************************************************************
 156     localhost                  : ok=256  changed=135  unreachable=0    failed=0    skipped=220  rescued=0    ignored=0
 157
 158 2.6 Configure the OAM network
 159 `````````````````````````````
 160
 161 Example:
 162
 163 ::
 164
 165   controller-0:~$ source /etc/platform/openrc
 166
 167   [sysadmin@controller-0 ~(keystone_admin)]$ OAM_IF=eno1
 168
 169   [sysadmin@controller-0 ~(keystone_admin)]$ system host-if-modify controller-0 $OAM_IF -c platform
 170
 171   +-----------------+--------------------------------------+
 172   | Property        | Value                                |
 173   +-----------------+--------------------------------------+
 174   | ifname          | eno1                                 |
 175   +-----------------+--------------------------------------+
 176   | iftype          | ethernet                             |
 177   +-----------------+--------------------------------------+
 178   | ports           | [u'eno1']                            |
 179   +-----------------+--------------------------------------+
 180   | imac            | 3c:a8:2a:1d:31:d0                    |
 181   +-----------------+--------------------------------------+
 182   | imtu            | 1500                                 |
 183   +-----------------+--------------------------------------+
 184   | ifclass         | platform                             |
 185   +-----------------+--------------------------------------+
 186   | aemode          | None                                 |
 187   +-----------------+--------------------------------------+
 188   | schedpolicy     | None                                 |
 189   +-----------------+--------------------------------------+
 190   | txhashpolicy    | None                                 |
 191   +-----------------+--------------------------------------+
 192   | uuid            | 95a32d13-01fc-43d2-90ab-801970fb3859 |
 193   +-----------------+--------------------------------------+
 194   | ihost_uuid      | 08c23843-afa4-4b80-a285-be126365276e |
 195   +-----------------+--------------------------------------+
 196   | vlan_id         | None                                 |
 197   +-----------------+--------------------------------------+
 198   | uses            | []                                   |
 199   +-----------------+--------------------------------------+
 200   | used_by         | []                                   |
 201   +-----------------+--------------------------------------+
 202   | created_at      | 2020-06-03T08:21:17.526303+00:00     |
 203   +-----------------+--------------------------------------+
 204   | updated_at      | 2020-06-03T10:02:54.682501+00:00     |
 205   +-----------------+--------------------------------------+
 206   | sriov_numvfs    | 0                                    |
 207   +-----------------+--------------------------------------+
 208   | sriov_vf_driver | None                                 |
 209   +-----------------+--------------------------------------+
 210   | accelerated     | [False]                              |
 211   +-----------------+--------------------------------------+
 212
 213   [sysadmin@controller-0 ~(keystone_admin)]$ system interface-network-assign controller-0 $OAM_IF oam
 214
 215   +--------------+--------------------------------------+
 216   | Property     | Value                                |
 217   +--------------+--------------------------------------+
 218   | hostname     | controller-0                         |
 219   +--------------+--------------------------------------+
 220   | uuid         | 32592cc3-9d66-4961-a51e-23686da00290 |
 221   +--------------+--------------------------------------+
 222   | ifname       | eno1                                 |
 223   +--------------+--------------------------------------+
 224   | network_name | oam                                  |
 225   +--------------+--------------------------------------+
 226
 227
 228   [sysadmin@controller-0 ~(keystone_admin)]$
 229   [sysadmin@controller-0 ~(keystone_admin)]$ system interface-network-list controller-0
 230
 231   +--------------+--------------------------------------+--------+--------------+
 232   | hostname     | uuid                                 | ifname | network_name |
 233   +--------------+--------------------------------------+--------+--------------+
 234   | controller-0 | 2478f4c0-a7b4-4656-aa2a-97a0e8891955 | lo     | mgmt         |
 235   +--------------+--------------------------------------+--------+--------------+
 236   | controller-0 | 32592cc3-9d66-4961-a51e-23686da00290 | eno1   | oam          |
 237   +--------------+--------------------------------------+--------+--------------+
 238   | controller-0 | 43721e4d-4f52-4b4b-bd02-0efa00ef2124 | lo     | cluster-host |
 239   +--------------+--------------------------------------+--------+--------------+
 240
 241 2.7 Configure the NTP server
 242 ````````````````````````````
 243
 244 Example:
 245
 246 ::
 247
 248   [sysadmin@controller-0 ~(keystone_admin)]$
 249   [sysadmin@controller-0 ~(keystone_admin)]$ system ntp-modify ntpservers=0.pool.ntp.org,1.pool.ntp.org
 250
 251   +--------------+--------------------------------------+
 252   | Property     | Value                                |
 253   +--------------+--------------------------------------+
 254   | uuid         | 8fbe5712-6ba0-4e61-b174-ed60f152f616 |
 255   +--------------+--------------------------------------+
 256   | ntpservers   | 0.pool.ntp.org,1.pool.ntp.org        |
 257   +--------------+--------------------------------------+
 258   | isystem_uuid | 802ee0be-3728-4df4-b9f7-1533c67fd960 |
 259   +--------------+--------------------------------------+
 260   | created_at   | 2020-06-03T08:19:47.812249+00:00     |
 261   +--------------+--------------------------------------+
 262   | updated_at   | None                                 |
 263   +--------------+--------------------------------------+
 264
 265 2.8 Configure the Storage by using the second hard drive as ceph backend
 266 ````````````````````````````````````````````````````````````````````````
 267
 268 Example:
 269
 270 ::
 271
 272   [sysadmin@controller-0 ~(keystone_admin)]$
 273
 274   [sysadmin@controller-0 ~(keystone_admin)]$ system host-disk-list controller-0
 275
 276   +--------------------------------------+-----------+---------+---------+-------+------------+--------------+---------+-----------------------------+
 277   | uuid                                 | device_no | device_ | device_ | size_ | available_ | rpm          | serial_ | device_path                 |
 278   |                                      | de        | num     | type    | gib   | gib        |              | id      |                             |
 279   +--------------------------------------+-----------+---------+---------+-------+------------+--------------+---------+-----------------------------+
 280   | 3884f906-cb9b-4052-bcb8-8be70e599b9f | /dev/sda  | 2048    | HDD     | 1117. | 868.759    | Undetermined | PDNLH0B | /dev/disk/by-path/pci-0000: |
 281   +--------------------------------------+-----------+---------+---------+-------+------------+--------------+---------+-----------------------------+
 282   |                                      |           |         |         | 782   |            |              | RH8W4QQ | 03:00.0-scsi-0:1:0:0        |
 283   +--------------------------------------+-----------+---------+---------+-------+------------+--------------+---------+-----------------------------+
 284   |                                      |           |         |         |       |            |              |         |                             |
 285   | 4e6c4b16-11e6-40b7-a2ff-751b14b8f0e9 | /dev/sdb  | 2064    | HDD     | 1117. | 0.0        | Undetermined | PDNLH0B | /dev/disk/by-path/pci-0000: |
 286   +--------------------------------------+-----------+---------+---------+-------+------------+--------------+---------+-----------------------------+
 287   |                                      |           |         |         | 782   |            |              | RH8W4QQ | 03:00.0-scsi-0:1:0:1        |
 288   +--------------------------------------+-----------+---------+---------+-------+------------+--------------+---------+-----------------------------+
 289   |                                      |           |         |         |       |            |              |         |                             |
 290   +--------------------------------------+-----------+---------+---------+-------+------------+--------------+---------+-----------------------------+
 291
 292   [sysadmin@controller-0 ~(keystone_admin)]$ system host-disk-list controller-0 | awk '/\/dev\/sdb/{print $2}' | xargs -i system host-stor-add controller-0 {}
 293
 294   +------------------+-------------------------------------------------------+
 295   | Property         | Value                                                 |
 296   +------------------+-------------------------------------------------------+
 297   | osdid            | 0                                                     |
 298   +------------------+-------------------------------------------------------+
 299   | function         | osd                                                   |
 300   +------------------+-------------------------------------------------------+
 301   | state            | configuring-on-unlock                                 |
 302   +------------------+-------------------------------------------------------+
 303   | journal_location | 71a9d508-06f6-4f5a-84f2-4723e70b1ecf                  |
 304   +------------------+-------------------------------------------------------+
 305   | journal_size_gib | 1024                                                  |
 306   +------------------+-------------------------------------------------------+
 307   | journal_path     | /dev/disk/by-path/pci-0000:03:00.0-scsi-0:1:0:1-part2 |
 308   +------------------+-------------------------------------------------------+
 309   | journal_node     | /dev/sdb2                                             |
 310   +------------------+-------------------------------------------------------+
 311   | uuid             | 71a9d508-06f6-4f5a-84f2-4723e70b1ecf                  |
 312   +------------------+-------------------------------------------------------+
 313   | ihost_uuid       | 08c23843-afa4-4b80-a285-be126365276e                  |
 314   +------------------+-------------------------------------------------------+
 315   | idisk_uuid       | 4e6c4b16-11e6-40b7-a2ff-751b14b8f0e9                  |
 316   +------------------+-------------------------------------------------------+
 317   | tier_uuid        | db6eabf9-9922-4d8e-9740-c0f9878e692d                  |
 318   +------------------+-------------------------------------------------------+
 319   | tier_name        | storage                                               |
 320   +------------------+-------------------------------------------------------+
 321   | created_at       | 2020-06-03T10:03:55.645744+00:00                      |
 322   +------------------+-------------------------------------------------------+
 323   | updated_at       | None                                                  |
 324   +------------------+-------------------------------------------------------+
 325
 326   [sysadmin@controller-0 ~(keystone_admin)]$ system host-stor-list controller-0
 327
 328   +--------------------------------------+----------+-------+-----------------------+--------------------------------------+-------------------------------------------------------+--------------+------------------+-----------+
 329   | uuid                                 | function | osdid | state                 | idisk_uuid                           | journal_path                                          | journal_node | journal_size_gib | tier_name |
 330   +--------------------------------------+----------+-------+-----------------------+--------------------------------------+-------------------------------------------------------+--------------+------------------+-----------+
 331   | 71a9d508-06f6-4f5a-84f2-4723e70b1ecf | osd      | 0     | configuring-on-unlock | 4e6c4b16-11e6-40b7-a2ff-751b14b8f0e9 | /dev/disk/by-path/pci-0000:03:00.0-scsi-0:1:0:1-part2 | /dev/sdb2    | 1                | storage   |
 332   +--------------------------------------+----------+-------+-----------------------+--------------------------------------+-------------------------------------------------------+--------------+------------------+-----------+
 333
 334 2.9 Configure the SR-IOV enabled network
 335 ````````````````````````````````````````
 336 It need :
 337   - assign the label of SR-IOV
 338   - change the CPU policy to static
 339   - change the hugepage setting
 340   - create the data network
 341   - assign the SR-IOV interface to data network
 342
 343 Example:
 344
 345 ::
 346
 347   [sysadmin@controller-0 ~(keystone_admin)]$ WORKER=controller-0
 348
 349   [sysadmin@controller-0 ~(keystone_admin)]$
 350
 351   [sysadmin@controller-0 ~(keystone_admin)]$ system host-label-assign $WORKER sriovdp=enabled
 352
 353   +-------------+--------------------------------------+
 354   | Property    | Value                                |
 355   +-------------+--------------------------------------+
 356   | uuid        | 7101010d-1897-4cc8-8c87-7dffaebf848b |
 357   +-------------+--------------------------------------+
 358   | host_uuid   | 08c23843-afa4-4b80-a285-be126365276e |
 359   +-------------+--------------------------------------+
 360   | label_key   | sriovdp                              |
 361   +-------------+--------------------------------------+
 362   | label_value | enabled                              |
 363   +-------------+--------------------------------------+
 364
 365   [sysadmin@controller-0 ~(keystone_admin)]$ system host-label-assign $WORKER kube-cpu-mgr-policy=static
 366
 367   +-------------+--------------------------------------+
 368   | Property    | Value                                |
 369   +-------------+--------------------------------------+
 370   | uuid        | 4936f32b-6939-4115-b643-846bd50e7738 |
 371   +-------------+--------------------------------------+
 372   | host_uuid   | 08c23843-afa4-4b80-a285-be126365276e |
 373   +-------------+--------------------------------------+
 374   | label_key   | kube-cpu-mgr-policy                  |
 375   +-------------+--------------------------------------+
 376   | label_value | static                               |
 377   +-------------+--------------------------------------+
 378
 379
 380   [sysadmin@controller-0 ~(keystone_admin)]$ system host-memory-modify $WORKER -1G 7  0
 381
 382   +-------------------------------------+--------------------------------------+
 383   | Property                            | Value                                |
 384   +-------------------------------------+--------------------------------------+
 385   | Memory: Usable Total (MiB)          | 0                                    |
 386   +-------------------------------------+--------------------------------------+
 387   |         Platform     (MiB)          | 7000                                 |
 388   +-------------------------------------+--------------------------------------+
 389   |         Available    (MiB)          | 0                                    |
 390   +-------------------------------------+--------------------------------------+
 391   | Huge Pages Configured               | True                                 |
 392   +-------------------------------------+--------------------------------------+
 393   | vSwitch Huge Pages: Size (MiB)      | 1024                                 |
 394   +-------------------------------------+--------------------------------------+
 395   |                     Total           | 0                                    |
 396   +-------------------------------------+--------------------------------------+
 397   |                     Available       | 0                                    |
 398   +-------------------------------------+--------------------------------------+
 399   |                     Required        | None                                 |
 400   +-------------------------------------+--------------------------------------+
 401   | Application  Pages (4K): Total      | None                                 |
 402   +-------------------------------------+--------------------------------------+
 403   | Application  Huge Pages (2M): Total | 0                                    |
 404   +-------------------------------------+--------------------------------------+
 405   |                 Available           | 0                                    |
 406   +-------------------------------------+--------------------------------------+
 407   | Application  Huge Pages (1G): Total | 0                                    |
 408   +-------------------------------------+--------------------------------------+
 409   |                 Total Pending       | 7                                    |
 410   +-------------------------------------+--------------------------------------+
 411   |                 Available           | 0                                    |
 412   +-------------------------------------+--------------------------------------+
 413   | uuid                                | 15702f44-2281-41f3-8c83-a1e9a300ad01 |
 414   +-------------------------------------+--------------------------------------+
 415   | ihost_uuid                          | 08c23843-afa4-4b80-a285-be126365276e |
 416   +-------------------------------------+--------------------------------------+
 417   | inode_uuid                          | d52648bc-dfa6-4214-afa3-5d2148ee4180 |
 418   +-------------------------------------+--------------------------------------+
 419   | created_at                          | 2020-06-03T08:21:27.468357+00:00     |
 420   +-------------------------------------+--------------------------------------+
 421   | updated_at                          | 2020-06-03T10:10:49.159080+00:00     |
 422   +-------------------------------------+--------------------------------------+
 423
 424
 425   [sysadmin@controller-0 ~(keystone_admin)]$ system host-memory-modify $WORKER -1G 7 1
 426
 427   +-------------------------------------+--------------------------------------+
 428   | Property                            | Value                                |
 429   +-------------------------------------+--------------------------------------+
 430   | Memory: Usable Total (MiB)          | 0                                    |
 431   +-------------------------------------+--------------------------------------+
 432   |         Platform     (MiB)          | 1000                                 |
 433   +-------------------------------------+--------------------------------------+
 434   |         Available    (MiB)          | 0                                    |
 435   +-------------------------------------+--------------------------------------+
 436   | Huge Pages Configured               | True                                 |
 437   +-------------------------------------+--------------------------------------+
 438   | vSwitch Huge Pages: Size (MiB)      | 1024                                 |
 439   +-------------------------------------+--------------------------------------+
 440   |                     Total           | 0                                    |
 441   +-------------------------------------+--------------------------------------+
 442   |                     Available       | 0                                    |
 443   +-------------------------------------+--------------------------------------+
 444   |                     Required        | None                                 |
 445   +-------------------------------------+--------------------------------------+
 446   | Application  Pages (4K): Total      | None                                 |
 447   +-------------------------------------+--------------------------------------+
 448   | Application  Huge Pages (2M): Total | 0                                    |
 449   +-------------------------------------+--------------------------------------+
 450   |                 Available           | 0                                    |
 451   +-------------------------------------+--------------------------------------+
 452   | Application  Huge Pages (1G): Total | 0                                    |
 453   +-------------------------------------+--------------------------------------+
 454   |                 Total Pending       | 7                                    |
 455   +-------------------------------------+--------------------------------------+
 456   |                 Available           | 0                                    |
 457   +-------------------------------------+--------------------------------------+
 458   | uuid                                | 544580b9-0f2a-41a1-b4e3-90fdf5c8f7e0 |
 459   +-------------------------------------+--------------------------------------+
 460   | ihost_uuid                          | 08c23843-afa4-4b80-a285-be126365276e |
 461   +-------------------------------------+--------------------------------------+
 462   | inode_uuid                          | e02c3c41-03b7-4f49-8244-bca851fa2d2f |
 463   +-------------------------------------+--------------------------------------+
 464   | created_at                          | 2020-06-03T08:21:27.566279+00:00     |
 465   +-------------------------------------+--------------------------------------+
 466   | updated_at                          | 2020-06-03T10:10:49.220907+00:00     |
 467   +-------------------------------------+--------------------------------------+
 468
 469
 470   [sysadmin@controller-0 ~(keystone_admin)]$ PHYSNET0='physnet0'
 471
 472   [sysadmin@controller-0 ~(keystone_admin)]$ PHYSNET1='physnet1'
 473
 474   [sysadmin@controller-0 ~(keystone_admin)]$ WORKER=controller-0
 475
 476   [sysadmin@controller-0 ~(keystone_admin)]$
 477
 478   [sysadmin@controller-0 ~(keystone_admin)]$ system datanetwork-add ${PHYSNET0} flat
 479
 480   +--------------+--------------------------------------+
 481   | Property     | Value                                |
 482   +--------------+--------------------------------------+
 483   | id           | 1                                    |
 484   +--------------+--------------------------------------+
 485   | uuid         | 0ffe0b0a-35ff-45b2-9a62-63a494d2d18b |
 486   +--------------+--------------------------------------+
 487   | name         | physnet0                             |
 488   +--------------+--------------------------------------+
 489   | network_type | flat                                 |
 490   +--------------+--------------------------------------+
 491   | mtu          | 1500                                 |
 492   +--------------+--------------------------------------+
 493   | description  | None                                 |
 494   +--------------+--------------------------------------+
 495
 496   [sysadmin@controller-0 ~(keystone_admin)]$ system datanetwork-add ${PHYSNET1} flat
 497
 498   +--------------+--------------------------------------+
 499   | Property     | Value                                |
 500   +--------------+--------------------------------------+
 501   | id           | 2                                    |
 502   +--------------+--------------------------------------+
 503   | uuid         | 899ca8ba-6800-4d62-aed4-3770878da738 |
 504   +--------------+--------------------------------------+
 505   | name         | physnet1                             |
 506   +--------------+--------------------------------------+
 507   | network_type | flat                                 |
 508   +--------------+--------------------------------------+
 509   | mtu          | 1500                                 |
 510   +--------------+--------------------------------------+
 511   | description  | None                                 |
 512   +--------------+--------------------------------------+
 513
 514
 515   [sysadmin@controller-0 ~(keystone_admin)]$ system host-port-list controller-0
 516
 517   +--------------------------------------+--------+----------+--------------+--------+-----------+-------------+-------------------------------------------------------+
 518   | uuid                                 | name   | type     | pci address  | device | processor | accelerated | device type                                           |
 519   +--------------------------------------+--------+----------+--------------+--------+-----------+-------------+-------------------------------------------------------+
 520   | 7007dfb1-ea55-4355-9d27-3ed4c6696283 | eno1   | ethernet | 0000:02:00.0 | 0      | 0         | False       | NetXtreme BCM5719 Gigabit Ethernet PCIe [1657]        |
 521   +--------------------------------------+--------+----------+--------------+--------+-----------+-------------+-------------------------------------------------------+
 522   | 51f62ecf-7897-43e3-beb8-46ae5550ef05 | eno2   | ethernet | 0000:02:00.1 | 0      | 0         | False       | NetXtreme BCM5719 Gigabit Ethernet PCIe [1657]        |
 523   +--------------------------------------+--------+----------+--------------+--------+-----------+-------------+-------------------------------------------------------+
 524   | e987725e-ab45-4151-b53d-94ba21706eb4 | eno3   | ethernet | 0000:02:00.2 | 0      | 0         | False       | NetXtreme BCM5719 Gigabit Ethernet PCIe [1657]        |
 525   +--------------------------------------+--------+----------+--------------+--------+-----------+-------------+-------------------------------------------------------+
 526   | f4a8115a-ca0b-4336-a634-2cad77c5a88c | eno4   | ethernet | 0000:02:00.3 | 0      | 0         | False       | NetXtreme BCM5719 Gigabit Ethernet PCIe [1657]        |
 527   +--------------------------------------+--------+----------+--------------+--------+-----------+-------------+-------------------------------------------------------+
 528   | 88965882-c816-42e8-ba0e-d3ff6f9f553e | eno49  | ethernet | 0000:04:00.0 | 0      | 0         | False       | OneConnect NIC (Skyhawk) [0720]                       |
 529   +--------------------------------------+--------+----------+--------------+--------+-----------+-------------+-------------------------------------------------------+
 530   | 98e2cedc-9ef8-4ca0-b3e0-db3a2bd0273a | eno50  | ethernet | 0000:04:00.1 | 0      | 0         | False       | OneConnect NIC (Skyhawk) [0720]                       |
 531   +--------------------------------------+--------+----------+--------------+--------+-----------+-------------+-------------------------------------------------------+
 532   | e75d7aa6-7832-4ec4-9dd4-ea8300773fd8 | ens2f0 | ethernet | 0000:05:00.0 | 0      | 0         | True        | 82599ES 10-Gigabit SFI/SFP+ Network Connection [10fb] |
 533   +--------------------------------------+--------+----------+--------------+--------+-----------+-------------+-------------------------------------------------------+
 534   | 8ac4ffca-4a61-4b47-8e17-171f2e6cea66 | ens2f1 | ethernet | 0000:05:00.1 | 0      | 0         | True        | 82599ES 10-Gigabit SFI/SFP+ Network Connection [10fb] |
 535   +--------------------------------------+--------+----------+--------------+--------+-----------+-------------+-------------------------------------------------------+
 536
 537
 538   [sysadmin@controller-0 ~(keystone_admin)]$ INTL_IF=ens2f0
 539
 540   [sysadmin@controller-0 ~(keystone_admin)]$ system host-if-modify -m 1500 -n sriov0 -c pci-sriov -N 6 --vf-driver=vfio $WORKER $INTL_IF
 541
 542   +-----------------+--------------------------------------+
 543   | Property        | Value                                |
 544   +-----------------+--------------------------------------+
 545   | ifname          | sriov0                               |
 546   +-----------------+--------------------------------------+
 547   | iftype          | ethernet                             |
 548   +-----------------+--------------------------------------+
 549   | ports           | [u'ens2f0']                          |
 550   +-----------------+--------------------------------------+
 551   | imac            | 00:1b:21:b3:46:2c                    |
 552   +-----------------+--------------------------------------+
 553   | imtu            | 1500                                 |
 554   +-----------------+--------------------------------------+
 555   | ifclass         | pci-sriov                            |
 556   +-----------------+--------------------------------------+
 557   | aemode          | None                                 |
 558   +-----------------+--------------------------------------+
 559   | schedpolicy     | None                                 |
 560   +-----------------+--------------------------------------+
 561   | txhashpolicy    | None                                 |
 562   +-----------------+--------------------------------------+
 563   | uuid            | 9450b1ae-d1a1-4ecb-811a-fa3cb1cdf362 |
 564   +-----------------+--------------------------------------+
 565   | ihost_uuid      | 08c23843-afa4-4b80-a285-be126365276e |
 566   +-----------------+--------------------------------------+
 567   | vlan_id         | None                                 |
 568   +-----------------+--------------------------------------+
 569   | uses            | []                                   |
 570   +-----------------+--------------------------------------+
 571   | used_by         | []                                   |
 572   +-----------------+--------------------------------------+
 573   | created_at      | 2020-06-03T12:34:11.633254+00:00     |
 574   +-----------------+--------------------------------------+
 575   | updated_at      | 2020-06-04T02:01:28.168127+00:00     |
 576   +-----------------+--------------------------------------+
 577   | sriov_numvfs    | 6                                    |
 578   +-----------------+--------------------------------------+
 579   | sriov_vf_driver | vfio                                 |
 580   +-----------------+--------------------------------------+
 581   | accelerated     | [True]                               |
 582   +-----------------+--------------------------------------+
 583
 584   [sysadmin@controller-0 ~(keystone_admin)]$ system interface-datanetwork-assign ${WORKER} sriov0 ${PHYSNET0}
 585
 586   +------------------+--------------------------------------+
 587   | Property         | Value                                |
 588   +------------------+--------------------------------------+
 589   | hostname         | controller-0                         |
 590   +------------------+--------------------------------------+
 591   | uuid             | 1d35219d-3258-42e7-8f0e-41d865710d58 |
 592   +------------------+--------------------------------------+
 593   | ifname           | sriov0                               |
 594   +------------------+--------------------------------------+
 595   | datanetwork_name | physnet0                             |
 596   +------------------+--------------------------------------+
 597
 598
 599
 600   [sysadmin@controller-0 ~(keystone_admin)]$ INTL_IF=ens2f1
 601
 602   [sysadmin@controller-0 ~(keystone_admin)]$ system host-if-modify -m 1500 -n sriov1 -c pci-sriov -N 6 --vf-driver=vfio $WORKER $INTL_IF
 603
 604   +-----------------+--------------------------------------+
 605   | Property        | Value                                |
 606   +-----------------+--------------------------------------+
 607   | ifname          | sriov1                               |
 608   +-----------------+--------------------------------------+
 609   | iftype          | ethernet                             |
 610   +-----------------+--------------------------------------+
 611   | ports           | [u'ens2f1']                          |
 612   +-----------------+--------------------------------------+
 613   | imac            | 00:1b:21:b3:46:2d                    |
 614   +-----------------+--------------------------------------+
 615   | imtu            | 1500                                 |
 616   +-----------------+--------------------------------------+
 617   | ifclass         | pci-sriov                            |
 618   +-----------------+--------------------------------------+
 619   | aemode          | None                                 |
 620   +-----------------+--------------------------------------+
 621   | schedpolicy     | None                                 |
 622   +-----------------+--------------------------------------+
 623   | txhashpolicy    | None                                 |
 624   +-----------------+--------------------------------------+
 625   | uuid            | 13d5ee99-0399-4b6b-a359-0f96660afdc4 |
 626   | ihost_uuid      | 08c23843-afa4-4b80-a285-be126365276e |
 627   | vlan_id         | None                                 |
 628   | uses            | []                                   |
 629   | used_by         | []                                   |
 630   | created_at      | 2020-06-03T12:34:12.072624+00:00     |
 631   | updated_at      | 2020-06-04T02:03:51.405322+00:00     |
 632   | sriov_numvfs    | 6                                    |
 633   | sriov_vf_driver | vfio                                 |
 634   | accelerated     | [True]                               |
 635   +-----------------+--------------------------------------+
 636
 637   [sysadmin@controller-0 ~(keystone_admin)]$ system interface-datanetwork-assign ${WORKER} sriov1 ${PHYSNET1}
 638
 639   +------------------+--------------------------------------+
 640   | Property         | Value                                |
 641   +------------------+--------------------------------------+
 642   | hostname         | controller-0                         |
 643   +------------------+--------------------------------------+
 644   | uuid             | a87c6a5f-0c53-4ebf-9a32-38366700426f |
 645   +------------------+--------------------------------------+
 646   | ifname           | sriov1                               |
 647   +------------------+--------------------------------------+
 648   | datanetwork_name | physnet1                             |
 649   +------------------+--------------------------------------+
 650
 651 2.10 Unlock the server
 652 ``````````````````````
 653
 654 Example:
 655
 656 ::
 657
 658   [sysadmin@controller-0 ~(keystone_admin)]$ system host-unlock controller-0
 659
 660   +-----------------------+-------------------------------------------------+
 661   | Property              | Value                                           |
 662   +-----------------------+-------------------------------------------------+
 663   | action                | none                                            |
 664   +-----------------------+-------------------------------------------------+
 665   | administrative        | locked                                          |
 666   +-----------------------+-------------------------------------------------+
 667   | availability          | online                                          |
 668   +-----------------------+-------------------------------------------------+
 669   | bm_ip                 | None                                            |
 670   +-----------------------+-------------------------------------------------+
 671   | bm_type               | none                                            |
 672   +-----------------------+-------------------------------------------------+
 673   | bm_username           | None                                            |
 674   +-----------------------+-------------------------------------------------+
 675   | boot_device           | /dev/disk/by-path/pci-0000:03:00.0-scsi-0:1:0:0 |
 676   +-----------------------+-------------------------------------------------+
 677   | capabilities          | {u'stor_function': u'monitor'}                  |
 678   +-----------------------+-------------------------------------------------+
 679   | clock_synchronization | ntp                                             |
 680   +-----------------------+-------------------------------------------------+
 681   | config_applied        | 3daf20c7-c032-4aa2-839d-93da92051bea            |
 682   +-----------------------+-------------------------------------------------+
 683   | config_status         | Config out-of-date                              |
 684   +-----------------------+-------------------------------------------------+
 685   | config_target         | bdaf20c7-c032-4aa2-839d-93da92051bea            |
 686   +-----------------------+-------------------------------------------------+
 687   | console               | tty0                                            |
 688   +-----------------------+-------------------------------------------------+
 689   | created_at            | 2020-06-03T08:20:59.372602+00:00                |
 690   +-----------------------+-------------------------------------------------+
 691   | hostname              | controller-0                                    |
 692   +-----------------------+-------------------------------------------------+
 693   | id                    | 1                                               |
 694   +-----------------------+-------------------------------------------------+
 695   | install_output        | graphical                                       |
 696   +-----------------------+-------------------------------------------------+
 697   | install_state         | None                                            |
 698   +-----------------------+-------------------------------------------------+
 699   | install_state_info    | None                                            |
 700   +-----------------------+-------------------------------------------------+
 701   | inv_state             | inventoried                                     |
 702   +-----------------------+-------------------------------------------------+
 703   | invprovision          | provisioning                                    |
 704   +-----------------------+-------------------------------------------------+
 705   | location              | {}                                              |
 706   +-----------------------+-------------------------------------------------+
 707   | mgmt_ip               | 192.168.204.2                                   |
 708   +-----------------------+-------------------------------------------------+
 709   | mgmt_mac              | 00:00:00:00:00:00                               |
 710   +-----------------------+-------------------------------------------------+
 711   | operational           | disabled                                        |
 712   +-----------------------+-------------------------------------------------+
 713   | personality           | controller                                      |
 714   +-----------------------+-------------------------------------------------+
 715   | reserved              | False                                           |
 716   +-----------------------+-------------------------------------------------+
 717   | rootfs_device         | /dev/disk/by-path/pci-0000:03:00.0-scsi-0:1:0:0 |
 718   +-----------------------+-------------------------------------------------+
 719   | serialid              | None                                            |
 720   +-----------------------+-------------------------------------------------+
 721   | software_load         | 19.12                                           |
 722   +-----------------------+-------------------------------------------------+
 723   | subfunction_avail     | online                                          |
 724   +-----------------------+-------------------------------------------------+
 725   | subfunction_oper      | disabled                                        |
 726   +-----------------------+-------------------------------------------------+
 727   | subfunctions          | controller,worker                               |
 728   +-----------------------+-------------------------------------------------+
 729   | task                  | Unlocking                                       |
 730   +-----------------------+-------------------------------------------------+
 731   | tboot                 | false                                           |
 732   +-----------------------+-------------------------------------------------+
 733   | ttys_dcd              | None                                            |
 734   +-----------------------+-------------------------------------------------+
 735   | updated_at            | 2020-06-04T02:04:59.514854+00:00                |
 736   +-----------------------+-------------------------------------------------+
 737   | uptime                | 49475                                           |
 738   +-----------------------+-------------------------------------------------+
 739   | uuid                  | 08c23843-afa4-4b80-a285-be126365276e            |
 740   +-----------------------+-------------------------------------------------+
 741   | vim_progress_status   | None                                            |
 742   +-----------------------+-------------------------------------------------+
 743
 744
 745
 746
 747 References
 748 ----------
 749
 750 - `StarlingX`_
 751
 752 .. _`StarlingX`: https://docs.starlingx.io/
 753