diff options
| -rw-r--r-- | docs/index.rst | 5 | ||||
| -rw-r--r-- | docs/release/installation/index.rst | 7 | ||||
| -rw-r--r-- | docs/release/installation/installation.instruction.rst | 99 | ||||
| -rw-r--r-- | docs/release/scenarios/index.rst | 2 | ||||
| -rw-r--r-- | docs/release/scenarios/os-ovn-nofeature-ha/os-ovn-nofeature-ha.rst | 1 | ||||
| -rw-r--r-- | docs/release/userguide/userguide.rst | 44 |
6 files changed, 92 insertions, 66 deletions
diff --git a/docs/index.rst b/docs/index.rst index 744b47cee..842853a6d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,15 +3,14 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. (c) Open Platform for NFV Project, Inc. and its contributors + ==== FUEL ==== .. toctree:: - :numbered: - :maxdepth: 2 release/release-notes/index release/installation/index release/userguide/index - scenarios/index + release/scenarios/index diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst index 784eec252..00332262f 100644 --- a/docs/release/installation/index.rst +++ b/docs/release/installation/index.rst @@ -10,8 +10,15 @@ Installation instruction for Fuel\@OPNFV **************************************** +Contents: + .. toctree:: :numbered: :maxdepth: 2 installation.instruction.rst + +Indices and tables +================== + +* :ref:`search` diff --git a/docs/release/installation/installation.instruction.rst b/docs/release/installation/installation.instruction.rst index 1961b25f0..b7b4f6d23 100644 --- a/docs/release/installation/installation.instruction.rst +++ b/docs/release/installation/installation.instruction.rst @@ -128,9 +128,13 @@ installation of Fraser using Fuel: | | order (e.g. IPMI) | +-------------------------+------------------------------------------------------+ -**NOTE:** All nodes including the Jumpserver must have the same architecture (either x86_64 or aarch64). +.. NOTE:: -**NOTE:** For aarch64 deployments an UEFI compatible firmware with PXE support is needed (e.g. EDK2). + All nodes including the Jumpserver must have the same architecture (either x86_64 or aarch64). + +.. NOTE:: + + For aarch64 deployments an UEFI compatible firmware with PXE support is needed (e.g. EDK2). =============================== Help with Hardware Requirements @@ -190,10 +194,10 @@ also be pre-configured (e.g. admin_br, mgmt_br, public_br). 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, +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" +The following example adds the groups to the user ``jenkins`` .. code-block:: bash @@ -207,14 +211,14 @@ The following example adds the groups to the user "jenkins" ... %jenkins ALL=(ALL) NOPASSWD:ALL -The folder containing the temporary deploy artifacts (/home/jenkins/tmpdir in the examples below) +The folder containing the temporary deploy artifacts (``/home/jenkins/tmpdir`` in the examples below) needs to have mask 777 in order for libvirt to be able to use them. .. code-block:: bash $ mkdir -p -m 777 /home/jenkins/tmpdir -For an AArch64 Jumpserver, the "libvirt" minimum required version is 3.x, 3.5 or newer highly recommended. +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). @@ -223,7 +227,7 @@ For Ubuntu 16.04 (arm64), distro packages are too old and 3rd party repositories 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: +create a new sources list file ``/apt/sources.list.d/armband.list`` with the following contents: .. code-block:: bash @@ -239,18 +243,27 @@ installed on the Jumpserver: - 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 recommended to install libvirt-bin explicitly on the Jumpserver before the deployment. +.. WARNING:: + + 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 recommended to install libvirt-bin explicitly on the Jumpserver before the deployment. + +.. NOTE:: + + It is also recommended to install the newer kernel on the Jumpserver before the deployment. -**NOTE**: It is also recommended to install the newer kernel on the Jumpserver before the deployment. +.. WARNING:: -**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. + 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. -**NOTE**: The install script will alter Jumpserver sysconf and disable `net.bridge.bridge-nf-call`. +.. WARNING:: + + The install script will alter Jumpserver sysconf and disable ``net.bridge.bridge-nf-call``. .. code-block:: bash @@ -309,8 +322,9 @@ In this figure there are examples of two virtual deploys: - 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 initial connection -of the VMs on Jumphost. +.. NOTE:: + + A virtual network ``mcpcontrol`` is always created for initial connection of the VMs on Jumphost. Automatic Installation of a Baremetal POD @@ -363,8 +377,9 @@ In the baremetal deploy all bridges but "mcpcontrol" are Linux bridges. For the 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 initial connection -of the VMs on Jumphost. +.. NOTE:: + + A virtual network ``mcpcontrol`` is always created for initial connection of the VMs on Jumphost. Steps to Start the Automatic Deploy @@ -398,10 +413,10 @@ These steps are common both for virtual and baremetal deploys. 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 + - 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 + - use ``|& tee`` to save the deploy log to a file .. code-block:: bash @@ -412,16 +427,18 @@ These steps are common both for virtual and baremetal deploys. -D \ -S <Storage directory for disk images> |& tee deploy.log - **NOTE**: The deployment uses the OPNFV Pharos project as input (PDF and IDF files) - for hardware and network configuration of all current OPNFV PODs. - When deploying a new POD, one can pass the `-b` flag to the deploy script to override - the path for the labconfig directory structure containing the PDF and IDF (see below). +.. NOTE:: + + The deployment uses the OPNFV Pharos project as input (PDF and IDF files) + for hardware and network configuration of all current OPNFV PODs. + When deploying a new POD, one can pass the ``-b`` flag to the deploy script to override + the path for the labconfig directory structure containing the PDF and IDF (see below). Examples -------- #. Virtual deploy - To start a virtual deployment, it is required to have the `virtual` keyword + To start a virtual deployment, it is required to have the **virtual** keyword while specifying the pod name to the installer script. It will create the required bridges and networks, configure Salt Master and @@ -436,11 +453,11 @@ Examples -S /home/jenkins/tmpdir |& tee deploy.log Once the deployment is complete, the OpenStack Dashboard, Horizon, is - available at http://<controller VIP>:8078 + available at ``http://<controller VIP>:8078`` The administrator credentials are **admin** / **opnfv_secret**. A simple (and generic) sample PDF/IDF set of configuration files may - be used for virtual deployments by setting lab/POD name to 'local-virtual1'. + be used for virtual deployments by setting lab/POD name to ``local-virtual1``. This sample configuration is x86_64 specific and hardcodes certain parameters, like public network address space, so a dedicated PDF/IDF is highly recommended. @@ -487,9 +504,9 @@ Examples Fuel@OPNFV ARM POD5 Network Layout Once the deployment is complete, the SaltStack Deployment Documentation is - available at http://<proxy public VIP>:8090 + available at ``http://<proxy public VIP>:8090``. - When deploying a new POD, one can pass the `-b` flag to the deploy script to override + When deploying a new POD, one can pass the ``-b`` flag to the deploy script to override the path for the labconfig directory structure containing the PDF and IDF. .. code-block:: bash @@ -502,9 +519,9 @@ Examples -S <tmp_folder> |& tee deploy.log - <absolute_path_to_labconfig> is the absolute path to a local directory, populated - similar to Pharos, i.e. PDF/IDF reside in <absolute_path_to_labconfig>/labs/<lab_name> + similar to Pharos, i.e. PDF/IDF reside in ``<absolute_path_to_labconfig>/labs/<lab_name>`` - <lab_name> is the same as the directory in the path above - - <pod_name> is the name used for the PDF (<pod_name>.yaml) and IDF (idf-<pod_name>.yaml) files + - <pod_name> is the name used for the PDF (``<pod_name>.yaml``) and IDF (``idf-<pod_name>.yaml``) files @@ -519,7 +536,7 @@ Pod Descriptor File (PDF) and Installer Descriptor File (IDF). The Pod Descriptor File is a hardware description of the pod infrastructure. The information is modeled under a yaml structure. A reference file with the expected yaml structure is available at -*mcp/config/labs/local/pod1.yaml* +``mcp/config/labs/local/pod1.yaml``. The hardware description is arranged into a main "jumphost" node and a "nodes" set for all target boards. For each node the following characteristics @@ -530,14 +547,16 @@ are defined: - Remote management parameters. - Network interfaces list including mac address, speed, advanced features and name. -**Note**: The fixed IPs are ignored by the MCP installer script and it will instead -assign based on the network ranges defined in IDF. +.. NOTE:: + + The fixed IPs are ignored by the MCP installer script and it will instead + assign based on the network ranges defined in IDF. The Installer Descriptor File extends the PDF with pod related parameters required by the installer. This information may differ per each installer type and it is not considered part of the pod infrastructure. The IDF file must be named after the PDF with the prefix "idf-". A reference file with the expected -structure is available at *mcp/config/labs/local/idf-pod1.yaml* +structure is available at ``mcp/config/labs/local/idf-pod1.yaml``. The file follows a yaml structure and two sections "net_config" and "fuel" are expected. @@ -577,8 +596,8 @@ The full description of the PDF and IDF file structure are available as yaml sch The schemas are defined as a git submodule in Fuel repository. Input files provided to the installer will be validated against the schemas. -- *mcp/scripts/pharos/config/pdf/pod1.schema.yaml* -- *mcp/scripts/pharos/config/pdf/idf-pod1.schema.yaml* +- ``mcp/scripts/pharos/config/pdf/pod1.schema.yaml`` +- ``mcp/scripts/pharos/config/pdf/idf-pod1.schema.yaml`` ============= Release Notes diff --git a/docs/release/scenarios/index.rst b/docs/release/scenarios/index.rst index 20bab6be6..dc12fd05a 100644 --- a/docs/release/scenarios/index.rst +++ b/docs/release/scenarios/index.rst @@ -9,8 +9,6 @@ Scenarios for Fuel\@OPNFV ************************* .. toctree:: - :numbered: - :maxdepth: 2 os-nosdn-ovs-noha/index.rst os-nosdn-ovs-ha/index.rst diff --git a/docs/release/scenarios/os-ovn-nofeature-ha/os-ovn-nofeature-ha.rst b/docs/release/scenarios/os-ovn-nofeature-ha/os-ovn-nofeature-ha.rst index 5abda9e88..4e2e4169f 100644 --- a/docs/release/scenarios/os-ovn-nofeature-ha/os-ovn-nofeature-ha.rst +++ b/docs/release/scenarios/os-ovn-nofeature-ha/os-ovn-nofeature-ha.rst @@ -23,7 +23,6 @@ All services are in HA, meaning that there are multiple cloned instances of each service, and they are balanced by HA Proxy using a Virtual IP Address per service. - Scenario usage overview ======================= diff --git a/docs/release/userguide/userguide.rst b/docs/release/userguide/userguide.rst index 584948f15..61c30bb7e 100644 --- a/docs/release/userguide/userguide.rst +++ b/docs/release/userguide/userguide.rst @@ -57,13 +57,15 @@ Accessing the Cloud =================== Access to any component of the deployed cloud is done from Jumpserver to user *ubuntu* with -ssh key */var/lib/opnfv/mcp.rsa*. The example below is a connection to Salt master. +ssh key ``/var/lib/opnfv/mcp.rsa``. The example below is a connection to Salt master. .. code-block:: bash - $ ssh -o StrictHostKeyChecking=no -i /var/lib/opnfv/mcp.rsa -l ubuntu 10.20.0.2 + $ ssh -o StrictHostKeyChecking=no -i /var/lib/opnfv/mcp.rsa -l ubuntu 10.20.0.2 -**Note**: The Salt master IP is not hard set, it is configurable via INSTALLER_IP during deployment +.. NOTE:: + + The Salt master IP is not hard set, it is configurable via ``INSTALLER_IP`` during deployment Logging in to cluster nodes is possible from the Jumpserver and from Salt master. On the Salt master cluster hostnames can be used instead of IP addresses: @@ -84,7 +86,7 @@ To gather information about the cloud, the salt commands can be used. It is base around a master-minion idea where the salt-master pushes config to the minions to execute actions. -For example tell salt to execute a ping to 8.8.8.8 on all the nodes. +For example tell salt to execute a ping to ``8.8.8.8`` on all the nodes. .. figure:: img/saltstack.png @@ -152,7 +154,7 @@ as *root* user. ......................... -#. Execute any linux command on all nodes (list the content of */var/log* in this example) +#. Execute any linux command on all nodes (list the content of ``/var/log`` in this example) .. code-block:: bash @@ -208,7 +210,7 @@ Accessing Openstack =================== Once the deployment is complete, Openstack CLI is accessible from controller VMs (ctl01..03). -Openstack credentials are at */root/keystonercv3*. +Openstack credentials are at ``/root/keystonercv3``. .. code-block:: bash @@ -222,13 +224,13 @@ Openstack credentials are at */root/keystonercv3*. +--------------------------------------+-----------------------------------------------+--------+ -The OpenStack Dashboard, Horizon, is available at http://<proxy public VIP> -The administrator credentials are *admin*/*opnfv_secret*. +The OpenStack Dashboard, Horizon, is available at ``http://<proxy public VIP>``. +The administrator credentials are **admin**/**opnfv_secret**. .. figure:: img/horizon_login.png -A full list of IPs/services is available at <proxy public VIP>:8090 for baremetal deploys. +A full list of IPs/services is available at ``<proxy public VIP>:8090`` for baremetal deploys. .. figure:: img/salt_services_ip.png @@ -282,12 +284,12 @@ to be spawned as SCSI drives. To do this, add the properties below to the server .. code-block:: bash - openstack image set --property hw_disk_bus='scsi' --property hw_scsi_model='virtio-scsi' <image> + $ openstack image set --property hw_disk_bus='scsi' --property hw_scsi_model='virtio-scsi' <image> The choice regarding which bus to use for the storage drives is an important one. Virtio-blk is the default -choice for Fuel@OPNFV which attaches the drives in /dev/vdX. However, since we want to be able to attach a +choice for Fuel@OPNFV which attaches the drives in ``/dev/vdX``. However, since we want to be able to attach a larger number of volumes to the virtual machines, we recommend the switch to SCSI drives which are attached -in /dev/sdX instead. Virtio-scsi is a little worse in terms of performance but the ability to add a larger +in ``/dev/sdX`` instead. Virtio-scsi is a little worse in terms of performance but the ability to add a larger number of drives combined with added features like ZFS, Ceph et al, leads us to suggest the use of virtio-scsi in Fuel@OPNFV for both architectures. More details regarding the differences and performance of virtio-blk vs virtio-scsi are beyond the scope @@ -295,7 +297,7 @@ of this manual but can be easily found in other sources online like `4`_ or `5`_ .. _4: https://mpolednik.github.io/2017/01/23/virtio-blk-vs-virtio-scsi/ -.. _5 : https://www.ovirt.org/develop/release-management/features/storage/virtio-scsi/ +.. _5: https://www.ovirt.org/develop/release-management/features/storage/virtio-scsi/ Additional configuration for configuring images in openstack can be found in the OpenStack Glance documentation. @@ -305,7 +307,7 @@ Additional configuration for configuring images in openstack can be found in the Openstack Endpoints =================== -For each Openstack service three endpoints are created: admin, internal and public. +For each Openstack service three endpoints are created: ``admin``, ``internal`` and ``public``. .. code-block:: bash @@ -325,16 +327,16 @@ at the VCP proxy VMs. To access the public endpoints an SSL certificate has to be provided. For convenience, the installation script will copy the required certificate into -to the cfg01 node at /etc/ssl/certs/os_cacert. +to the cfg01 node at ``/etc/ssl/certs/os_cacert``. Copy the certificate from the cfg01 node to the client that will access the https -endpoints and place it under /etc/ssl/certs. The SSL connection will be established +endpoints and place it under ``/etc/ssl/certs/``. The SSL connection will be established automatically after. .. code-block:: bash - $ ssh -o StrictHostKeyChecking=no -i /var/lib/opnfv/mcp.rsa -l ubuntu 10.20.0.2 \ - "cat /etc/ssl/certs/os_cacert" | sudo tee /etc/ssl/certs/os_cacert + $ ssh -o StrictHostKeyChecking=no -i /var/lib/opnfv/mcp.rsa -l ubuntu 10.20.0.2 \ + "cat /etc/ssl/certs/os_cacert" | sudo tee /etc/ssl/certs/os_cacert ============================= @@ -348,8 +350,10 @@ A simplified installation can be done with the use of a docker ubuntu container. approach will avoid installing packages on the host, which might collide with other packages. After the installation is done, a webbrowser on the host can be used to view the results. -**NOTE**: The host can be any device with Docker package already installed. - The user which runs the docker needs to have root priviledges. +.. NOTE:: + + The host can be any device with Docker package already installed. + The user which runs the docker needs to have root priviledges. **Instructions** |