Code Review / fuel.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
docs: AArch64: Jumpserver min libvirt version
[fuel.git] / docs / release / installation / installation.instruction.rst
diff --git a/docs/release/installation/installation.instruction.rst b/docs/release/installation/installation.instruction.rst
index 6d508bc..cad1b10 100644 (file)
--- a/docs/release/installation/installation.instruction.rst
+++ b/docs/release/installation/installation.instruction.rst
@@ -132,14 +132,14 @@ installation of Euphrates using Fuel:
 
 **NOTE:** For aarch64 deployments an UEFI compatible firmware with PXE support is needed (e.g. EDK2).
 
 
 **NOTE:** For aarch64 deployments an UEFI compatible firmware with PXE support is needed (e.g. EDK2).
 
-
 ===============================
 Help with Hardware Requirements
 ===============================
 
 Calculate hardware requirements:
 
 ===============================
 Help with Hardware Requirements
 ===============================
 
 Calculate hardware requirements:
 
-For information on compatible hardware types available for use, please see `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/software/hardware-compatibility/>`_.
+For information on compatible hardware types available for use,
+please see `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/software/hardware-compatibility/>`_
 
 When choosing the hardware on which you will deploy your OpenStack
 environment, you should think about:
 
 When choosing the hardware on which you will deploy your OpenStack
 environment, you should think about:
@@ -183,7 +183,48 @@ OPNFV Software Prerequisites
 
 The Jumpserver node should be pre-provisioned with an operating system,
 according to the Pharos specification. Relevant network bridges should
 
 The Jumpserver node should be pre-provisioned with an operating system,
 according to the Pharos specification. Relevant network bridges should
-also be pre-configured (e.g. admin, management, public).
+also be pre-configured (e.g. admin_br, mgmt_br, public_br).
+
+   - The admin bridge (admin_br) is mandatory for the baremetal nodes PXE booting during fuel installation.
+   - The management bridge (mgmt_br) is required for testing suites (e.g. functest/yardstick), it is
+     suggested to pre-configure it for debugging purposes.
+   - The public bridge (public_br) is also nice to have for debugging purposes, but not mandatory.
+
+The user running the deploy script on the Jumpserver should belong to "sudo" and "libvirt" groups,
+and have passwordless sudo access.
+
+The following example adds the groups to the user "jenkins"
+
+.. code-block:: bash
+
+    $ sudo usermod -aG sudo jenkins
+    $ sudo usermod -aG libvirt jenkins
+    $ reboot
+    $ groups
+    jenkins sudo libvirt
+
+    $ sudo visudo
+    ...
+    %jenkins ALL=(ALL) NOPASSWD:ALL
+
+For an AArch64 Jumpserver, the "libvirt" minimum required version is 3.x, 3.5 or newer highly recommended.
+While not mandatory, upgrading the kernel and QEMU on the Jumpserver is also highly recommended
+(especially on AArch64 Jumpservers).
+
+For CentOS 7.4 (AArch64), distro provided packages are already new enough.
+For Ubuntu 16.04 (arm64), distro packages are too old and 3rd party repositories should be used.
+For convenience, Armband provides a DEB repository holding all the required packages.
+
+To add and enable the Armband repository on an Ubuntu 16.04 system,
+create a new sources list file `/apt/sources.list.d/armband.list` with the following contents:
+
+.. code-block:: bash
+
+    $ cat /etc/apt/sources.list.d/armband.list
+    //for OpenStack Pike release
+    deb http://linux.enea.com/mcp-repos/pike/xenial pike-armband main
+
+    $ apt-get update
 
 Fuel@OPNFV has been validated by CI using the following distributions
 installed on the Jumpserver:
 
 Fuel@OPNFV has been validated by CI using the following distributions
 installed on the Jumpserver:
@@ -191,6 +232,22 @@ installed on the Jumpserver:
    - CentOS 7 (recommended by Pharos specification);
    - Ubuntu Xenial;
 
    - CentOS 7 (recommended by Pharos specification);
    - Ubuntu Xenial;
 
+**NOTE**: The install script expects 'libvirt' to be already running on the Jumpserver.In case libvirt
+packages are missing, the script will install them; but depending on the OS distribution, the user
+might have to start the 'libvirtd' service manually, then run the deploy script again. Therefore, it
+is recommened to install libvirt-bin explicitly on the Jumpserver before the deployment.
+
+**NOTE**: It is also recommened to install the newer kernel on the Jumpserver before the deployment.
+
+**NOTE**: The install script will automatically install the rest of required distro package
+dependencies on the Jumpserver, unless explicitly asked not to (via -P deploy arg). This includes
+Python, QEMU, libvirt etc.
+
+.. code-block:: bash
+
+    $ apt-get install linux-image-generic-hwe-16.04-edge libvirt-bin
+
+
 ==========================================
 OPNFV Software Installation and Deployment
 ==========================================
 ==========================================
 OPNFV Software Installation and Deployment
 ==========================================
@@ -204,9 +261,9 @@ automatic based on deployment scenario.
 The reclass model covers:
 
    - Infrastucture node definition: Salt Master node (cfg01) and MaaS node (mas01)
 The reclass model covers:
 
    - Infrastucture node definition: Salt Master node (cfg01) and MaaS node (mas01)
-   - Openstack node defition: Controler nodes (ctl01, ctl02, ctl03) and Compute nodes (cmp001, cmp002)
+   - OpenStack node definition: Controller nodes (ctl01, ctl02, ctl03) and Compute nodes (cmp001, cmp002)
    - Infrastructure components to install (software packages, services etc.)
    - Infrastructure components to install (software packages, services etc.)
-   - Openstack components and services (rabbitmq, galera etc.), as well as all configuration for them
+   - OpenStack components and services (rabbitmq, galera etc.), as well as all configuration for them
 
 
 Automatic Installation of a Virtual POD
 
 
 Automatic Installation of a Virtual POD
@@ -215,9 +272,9 @@ Automatic Installation of a Virtual POD
 For virtual deploys all the targets are VMs on the Jumpserver. The deploy script will:
 
    - Create a Salt Master VM on the Jumpserver which will drive the installation
 For virtual deploys all the targets are VMs on the Jumpserver. The deploy script will:
 
    - Create a Salt Master VM on the Jumpserver which will drive the installation
-   - Create the bridges for networking with virsh (only if a real bridge does not already exists for a given network)
-   - Install Openstack on the targets
-      - Leverage Salt to install & configure Openstack services
+   - Create the bridges for networking with virsh (only if a real bridge does not already exist for a given network)
+   - Install OpenStack on the targets
+      - Leverage Salt to install & configure OpenStack services
 
 .. figure:: img/fuel_virtual.png
    :align: center
 
 .. figure:: img/fuel_virtual.png
    :align: center
@@ -225,12 +282,33 @@ For virtual deploys all the targets are VMs on the Jumpserver. The deploy script
 
    Fuel@OPNFV Virtual POD Network Layout Examples
 
 
    Fuel@OPNFV Virtual POD Network Layout Examples
 
+   +-----------------------+------------------------------------------------------------------------+
+   | cfg01                 | Salt Master VM                                                         |
+   +-----------------------+------------------------------------------------------------------------+
+   | ctl01                 | Controller VM                                                          |
+   +-----------------------+------------------------------------------------------------------------+
+   | cmp01/cmp02           | Compute VMs                                                            |
+   +-----------------------+------------------------------------------------------------------------+
+   | gtw01                 | Gateway VM with neutron services (dhcp agent, L3 agent, metadata, etc) |
+   +-----------------------+------------------------------------------------------------------------+
+   | odl01                 | VM on which ODL runs (for scenarios deployed with ODL)                 |
+   +-----------------------+------------------------------------------------------------------------+
+
+
+In this figure there are examples of two virtual deploys:
+   - Jumphost 1 has only virsh bridges, created by the deploy script
+   - Jumphost 2 has a mix of Linux and virsh bridges; When Linux bridge exists for a specified network,
+     the deploy script will skip creating a virsh bridge for it
+
+**Note**: A virtual network "mcpcontrol" is always created. For virtual deploys, "mcpcontrol" is also
+ used for Admin, leaving the PXE/Admin bridge unused.
+
 
 Automatic Installation of a Baremetal POD
 =========================================
 
 The baremetal installation process can be done by editing the information about
 
 Automatic Installation of a Baremetal POD
 =========================================
 
 The baremetal installation process can be done by editing the information about
-hardware and enviroment in the reclass files, or by using a Pod Descriptor File (PDF).
+hardware and environment in the reclass files, or by using a Pod Descriptor File (PDF).
 This file contains all the information about the hardware and network of the deployment
 the will be fed to the reclass model during deployment.
 
 This file contains all the information about the hardware and network of the deployment
 the will be fed to the reclass model during deployment.
 
@@ -238,10 +316,10 @@ The installation is done automatically with the deploy script, which will:
 
    - Create a Salt Master VM on the Jumpserver which will drive the installation
    - Create a MaaS Node VM on the Jumpserver which will provision the targets
 
    - Create a Salt Master VM on the Jumpserver which will drive the installation
    - Create a MaaS Node VM on the Jumpserver which will provision the targets
-   - Install Openstack on the targets
+   - Install OpenStack on the targets
       - Leverage MaaS to provision baremetal nodes with the operating system
       - Leverage MaaS to provision baremetal nodes with the operating system
-      - Leverage Salt to configure the operatign system on the baremetal nodes
-      - Leverage Salt to install & configure Openstack services
+      - Leverage Salt to configure the operating system on the baremetal nodes
+      - Leverage Salt to install & configure OpenStack services
 
 .. figure:: img/fuel_baremetal.png
    :align: center
 
 .. figure:: img/fuel_baremetal.png
    :align: center
@@ -249,6 +327,35 @@ The installation is done automatically with the deploy script, which will:
 
    Fuel@OPNFV Baremetal POD Network Layout Example
 
 
    Fuel@OPNFV Baremetal POD Network Layout Example
 
+   +-----------------------+---------------------------------------------------------+
+   | cfg01                 | Salt Master VM                                          |
+   +-----------------------+---------------------------------------------------------+
+   | mas01                 | MaaS Node VM                                            |
+   +-----------------------+---------------------------------------------------------+
+   | kvm01..03             | Baremetals which hold the VMs with controller functions |
+   +-----------------------+---------------------------------------------------------+
+   | cmp001/cmp002         | Baremetal compute nodes                                 |
+   +-----------------------+---------------------------------------------------------+
+   | prx01/prx02           | Proxy VMs for Nginx                                     |
+   +-----------------------+---------------------------------------------------------+
+   | msg01..03             | RabbitMQ Service VMs                                    |
+   +-----------------------+---------------------------------------------------------+
+   | dbs01..03             | MySQL service VMs                                       |
+   +-----------------------+---------------------------------------------------------+
+   | mdb01..03             | Telemetry VMs                                           |
+   +-----------------------+---------------------------------------------------------+
+   | odl01                 | VM on which ODL runs (for scenarios deployed with ODL)  |
+   +-----------------------+---------------------------------------------------------+
+   | Tenant VM             | VM running in the cloud                                 |
+   +-----------------------+---------------------------------------------------------+
+
+In the baremetal deploy all bridges but "mcpcontrol" are Linux bridges. For the Jumpserver, it is
+required to pre-configure at least the admin_br bridge for the PXE/Admin.
+For the targets, the bridges are created by the deploy script.
+
+**Note**: A virtual network "mcpcontrol" is always created. For baremetal deploys, PXE bridge is used
+for baremetal node provisioning, while "mcpcontrol" is used to provision the infrastructure VMs only.
+
 
 Steps to Start the Automatic Deploy
 ===================================
 
 Steps to Start the Automatic Deploy
 ===================================
@@ -279,13 +386,22 @@ These steps are common both for virtual and baremetal deploys.
 
 #. Start the deploy script
 
 
 #. Start the deploy script
 
+    Besides the basic options,  there are other recommended deploy arguments:
+
+    - use **-D** option to enable the debug info
+    - use **-S** option to point to a tmp dir where the disk images are saved. The images will be
+      re-used between deploys
+    - use **|& tee** to save the deploy log to a file
+
    .. code-block:: bash
 
        $ ci/deploy.sh -l <lab_name> \
                       -p <pod_name> \
                       -b <URI to configuration repo containing the PDF file> \
                       -s <scenario> \
    .. code-block:: bash
 
        $ ci/deploy.sh -l <lab_name> \
                       -p <pod_name> \
                       -b <URI to configuration repo containing the PDF file> \
                       -s <scenario> \
-                      -B <list of admin, management, private and public bridges>
+                      -B <list of admin, management, private and public bridges> \
+                      -D \
+                      -S <Storage directory for disk images> |& tee deploy.log
 
 Examples
 --------
 
 Examples
 --------
@@ -302,7 +418,9 @@ Examples
          $ ci/deploy.sh -b file:///home/jenkins/tmpdir/securedlab \
                         -l ericsson \
                         -p virtual_kvm \
          $ ci/deploy.sh -b file:///home/jenkins/tmpdir/securedlab \
                         -l ericsson \
                         -p virtual_kvm \
-                        -s os-nosdn-nofeature-noha
+                        -s os-nosdn-nofeature-noha \
+                        -D \
+                        -S /home/jenkins/tmpdir |& tee deploy.log
 
    Once the deployment is complete, the OpenStack Dashboard, Horizon is
    available at http://<controller VIP>:8078, e.g. http://10.16.0.101:8078.
 
    Once the deployment is complete, the OpenStack Dashboard, Horizon is
    available at http://<controller VIP>:8078, e.g. http://10.16.0.101:8078.
@@ -319,6 +437,8 @@ Examples
                          -p pod2 \
                          -s os-nosdn-nofeature-ha \
                          -B pxebr,br-ctl
                          -p pod2 \
                          -s os-nosdn-nofeature-ha \
                          -B pxebr,br-ctl
+                         -D \
+                         -S /home/jenkins/tmpdir |& tee deploy.log
 
       .. figure:: img/lf_pod2.png
          :align: center
 
       .. figure:: img/lf_pod2.png
          :align: center
@@ -326,15 +446,19 @@ Examples
 
          Fuel@OPNFV LF POD2 Network Layout
 
 
          Fuel@OPNFV LF POD2 Network Layout
 
+   Once the deployment is complete, the SaltStack Deployment Documentation is
+   available at http://<Proxy VIP>:8090, e.g. http://172.30.10.103:8090.
+
    An aarch64 deploy on pod5 from Arm lab
 
       .. code-block:: bash
 
    An aarch64 deploy on pod5 from Arm lab
 
       .. code-block:: bash
 
-         $ ci/deploy.sh -b file:///home/jenkins/tmpdir/securedlab \
-                        -l arm \
-                        -p pod5 \
-                        -s os-nosdn-nofeature-ha \
-                        -B admin7_br0,mgmt7_br0,,public7_br0
+          $ ci/deploy.sh -b file:///home/jenkins/tmpdir/securedlab \
+                         -l arm \
+                         -p pod5 \
+                         -s os-nosdn-nofeature-ha \
+                         -D \
+                         -S /home/jenkins/tmpdir |& tee deploy.log
 
       .. figure:: img/arm_pod5.png
          :align: center
 
       .. figure:: img/arm_pod5.png
          :align: center
@@ -342,7 +466,6 @@ Examples
 
          Fuel@OPNFV ARM POD5 Network Layout
 
 
          Fuel@OPNFV ARM POD5 Network Layout
 
-
 Pod Descriptor Files
 ====================
 
 Pod Descriptor Files
 ====================
 
@@ -370,7 +493,8 @@ are defined:
 - Remote management parameters.
 - Network interfaces list including mac address, speed and advanced features.
 - IP list of fixed IPs for the node
 - Remote management parameters.
 - Network interfaces list including mac address, speed and advanced features.
 - IP list of fixed IPs for the node
-Note: the fixed IPs are ignored by the MCP installer script and it will instead
+
+**Note**: the fixed IPs are ignored by the MCP installer script and it will instead
 assign based on the network ranges defined under the pod network configuration.
 
 
 assign based on the network ranges defined under the pod network configuration.