diff options
Diffstat (limited to 'docs/release')
13 files changed, 299 insertions, 24 deletions
diff --git a/docs/release/configguide/installerconfig.rst b/docs/release/configguide/installerconfig.rst index a8ef8144..e5980dda 100644 --- a/docs/release/configguide/installerconfig.rst +++ b/docs/release/configguide/installerconfig.rst @@ -10,7 +10,7 @@ Abstract ======== -This document compiles the release notes for the E 1.0 release of +This document compiles the release notes for the Fraser release of OPNFV when using Daisy as a deployment tool. diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst index 611ecf63..3080e14b 100644 --- a/docs/release/installation/index.rst +++ b/docs/release/installation/index.rst @@ -8,7 +8,7 @@ OPNFV Daisy4nfv Installation Guide ********************************** .. toctree:: - :numbered: + :numbered: :maxdepth: 4 introduction.rst diff --git a/docs/release/installation/installation_guide.rst b/docs/release/installation/installation_guide.rst index 3017f1cd..e600443e 100644 --- a/docs/release/installation/installation_guide.rst +++ b/docs/release/installation/installation_guide.rst @@ -4,7 +4,7 @@ Daisy4nfv configuration ======================= -This document provides guidelines on how to install and configure the Euphrates +This document provides guidelines on how to install and configure the Fraser release of OPNFV when using Daisy as a deployment tool including required software and hardware configurations. @@ -17,7 +17,7 @@ networking and Unix/Linux administration. Prerequisites ------------- -Before starting the installation of the Euphrates release of OPNFV, some plannings +Before starting the installation of the Fraser release of OPNFV, some plannings must be done. @@ -33,7 +33,7 @@ The daily build iso image can be retrieved via OPNFV artifact repository: http://artifacts.opnfv.org/daisy.html -NOTE: Search the keyword "daisy/Euphrates" to locate the iso image. +NOTE: Search the keyword "daisy/Fraser" to locate the iso image. E.g. daisy/opnfv-2017-10-06_09-50-23.iso @@ -52,9 +52,9 @@ To retrieve the repository of Daisy on Jumphost use the following command: - git clone https://gerrit.opnfv.org/gerrit/daisy -To get stable Euphrates release, you can use the following command: +To get stable Fraser release, you can use the following command: -- git checkout euphrates.1.0 +- git checkout opnfv.6.0 Setup Requirements diff --git a/docs/release/installation/introduction.rst b/docs/release/installation/introduction.rst index cf7452f9..882c5d77 100644 --- a/docs/release/installation/introduction.rst +++ b/docs/release/installation/introduction.rst @@ -4,7 +4,7 @@ Abstract ======== -This document describes how to install the Euphrates release of OPNFV when using +This document describes how to install the Fraser release of OPNFV when using Daisy4nfv as a deployment tool covering it's limitations, dependencies and required resources. diff --git a/docs/release/installation/recovery.rst b/docs/release/installation/recovery.rst index 432936bf..eb9be8b2 100644 --- a/docs/release/installation/recovery.rst +++ b/docs/release/installation/recovery.rst @@ -78,3 +78,89 @@ Daisy deployment command as follows(in the Daisy VM): This basically does kolla-ansible destruction and kolla-asnible deployment. + +4. Recovery Level 3 +------------------- + +If previous deployment was failed during kolla-ansible deploy(you can confirm +it by checking /var/log/daisy/api.log) or if previous deployment was successful +but the default configration is not what you want and it is OK for you to destroy +the OPNFV software stack and re-deploy it again, then you can try recovery level 3. + +For example, in order to use external iSCSI storage, you are about to deploy +iSCSI cinder backend which is not enabled by default. First, cleanup the +previous deployment. + +ssh into daisy node, then do: + + +.. code-block:: console + + [root@daisy daisy]# source /etc/kolla/admin-openrc.sh + [root@daisy daisy]# openstack server delete <all vms you created> + + + + +Note: /etc/kolla/admin-openrc.sh may not have existed if previous +deployment was failed during kolla deploy. + + +.. code-block:: console + + [root@daisy daisy]# cd /home/kolla_install/kolla-ansible/ + [root@daisy kolla-ansible]# ./tools/kolla-ansible destroy \ + -i ./ansible/inventory/multinode --yes-i-really-really-mean-it + + + + +Then, edit /etc/kolla/globals.yml and append the follwoing line: + + +.. code-block:: console + + enable_cinder_backend_iscsi: "yes" + enable_cinder_backend_lvm: "no" + + + + +Then, re-deploy again: + + +.. code-block:: console + + + [root@daisy kolla-ansible]# ./tools/kolla-ansible prechecks -i ./ansible/inventory/multinode + [root@daisy kolla-ansible]# ./tools/kolla-ansible deploy -i ./ansible/inventory/multinode + + + + +After successfully deploying, issue the following command to generate +/etc/kolla/admin-openrc.sh file. + + +.. code-block:: console + + + [root@daisy kolla-ansible]# ./tools/kolla-ansible post-deploy -i ./ansible/inventory/multinode + + + + +Finally, issue the following command to create necessary resources, and your +environment are ready for running OPNFV functest. + + +.. code-block:: console + + + [root@daisy kolla-ansible]# cd /home/daisy + [root@daisy daisy]# ./deploy/post.sh -n /home/daisy/labs/zte/virtual1/daisy/config/network.yml + + + + +Note: "zte/virtual1" in above path may vary in your environment. diff --git a/docs/release/installation/upgrade.rst b/docs/release/installation/upgrade.rst index 65d49315..a74a4683 100644 --- a/docs/release/installation/upgrade.rst +++ b/docs/release/installation/upgrade.rst @@ -4,14 +4,14 @@ OpenStack Minor Version Update Guide ==================================== -Thanks for the Kolla's kolla-ansible upgrade function, Daisy enable to +Thanks to Kolla's kolla-ansible upgrade function, Daisy can update OpenStack minor version as the follows: 1. Get new version file only from Daisy team. Since Daisy's Kolla images are built by meeting the OPNFV requirements and have their own file packaging layout, Daisy requires user to always use Kolla image file built by Daisy team. Currently, it can be -got from http://artifacts.opnfv.org/daisy/upstream, or please +found at http://artifacts.opnfv.org/daisy/upstream, or please see :ref:`this chapter <daisy-build-kolla-image>` for how to build your own image. diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index ae6f5e7f..9937bb2a 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -10,8 +10,8 @@ Abstract ======== -This document covers features, limitations and required system resources of -OPNFV E 1.0 release when using Daisy4nfv as a deployment tool. +This document covers features, limitations and required system resources for the +OPNFV Fraser release when using Daisy4nfv as a deployment tool. Introduction ============ @@ -26,16 +26,16 @@ Release Data | **Project** | Daisy4nfv | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | Daisy4nfv/Euphrates.1.0 | +| **Repo/tag** | daisy/opnfv-6.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Euphrates.1.0 | +| **Release designation** | opnfv-6.0 | | | | +--------------------------------------+--------------------------------------+ | **Release date** | | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | OPNFV Euphrates release | +| **Purpose of the delivery** | OPNFV Fraser release | | | | +--------------------------------------+--------------------------------------+ @@ -45,16 +45,16 @@ Deliverables Software deliverables ~~~~~~~~~~~~~~~~~~~~~ - - Daisy4nfv/Euphrates.1.0 ISO, please get it from `OPNFV software download page <https://www.opnfv.org/software/>`_ + - Daisy4NFV/opnfv-6.0 ISO, please get it from `OPNFV software download page <https://www.opnfv.org/software/>`_ .. _document-label: Documentation deliverables ~~~~~~~~~~~~~~~~~~~~~~~~~~ - - OPNFV(Euphrates) Daisy4nfv installation instructions + - OPNFV(Fraser) Daisy4nfv installation instructions - - OPNFV(Euphrates) Daisy4nfv Release Notes + - OPNFV(Fraser) Daisy4nfv Release Notes Version change -------------- @@ -63,14 +63,14 @@ Version change Module version change ~~~~~~~~~~~~~~~~~~~~~ -This is the Euphrates release of Daisy4nfv as a deployment toolchain in OPNFV, the following +This is the Fraser release of Daisy4nfv as a deployment toolchain in OPNFV, the following upstream components supported with this release. - - Centos 7.3 + - Centos 7.4 - - Openstack (Ocata release) + - Openstack (Pike release) - - Opendaylight (Carbon SR1) + - Opendaylight (Carbon SR3) Reason for new version ---------------------- @@ -82,10 +82,13 @@ Feature additions | **JIRA REFERENCE** | **SLOGAN** | | | | +--------------------------------------+-----------------------------------------+ -| | Support OpenDayLight Carbon SR1 | +| | Support OpenDayLight Carbon SR3 | | | | +--------------------------------------+-----------------------------------------+ -| | Support OpenStack Ocata | +| | Support OpenStack Pike | +| | | ++--------------------------------------+-----------------------------------------+ +| | Support OVS+DPDK | | | | +--------------------------------------+-----------------------------------------+ diff --git a/docs/release/scenarios/os-nosdn-nofeature-ha/index.rst b/docs/release/scenarios/os-nosdn-nofeature-ha/index.rst new file mode 100644 index 00000000..1902f8d9 --- /dev/null +++ b/docs/release/scenarios/os-nosdn-nofeature-ha/index.rst @@ -0,0 +1,15 @@ +.. _os-nosdn-nofeature-ha: + +.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) <optionally add copywriters name> + +============================================== +os-nosdn-nofeature-ha overview and description +============================================== + +.. toctree:: + :numbered: + :maxdepth: 4 + + os-nosdn-nofeature-ha.rst diff --git a/docs/release/scenarios/os-nosdn-nofeature-ha/os-nosdn-nofeature-ha.rst b/docs/release/scenarios/os-nosdn-nofeature-ha/os-nosdn-nofeature-ha.rst new file mode 100644 index 00000000..e315d367 --- /dev/null +++ b/docs/release/scenarios/os-nosdn-nofeature-ha/os-nosdn-nofeature-ha.rst @@ -0,0 +1,41 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +This document provides scenario level details for Fraser 1.0 of +deployment with no SDN controller and no extra features enabled by using +Daisy installer. + +============ +Introduction +============ + +This scenario is used primarily to validate and deploy a Pike OpenStack +deployment without any NFV features or SDN controller enabled. + +Scenario components and composition +=================================== + +This scenario is composed of common OpenStack services enabled by default, +including Nova, Neutron, Glance, Cinder, Keystone, Horizon. Ceph is used as +the backend storage to Cinder, Glance and Nova on all deployed nodes. + +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. VIP is elected by using keepalived. + +Scenario usage overview +======================= + +Simply deploy this scenario by using the '-s os-nosdn-nofeature-ha' +parameter among others when calling ./ci/deploy/deploy.sh. + +Limitations, Issues and Workarounds +=================================== + +None + +References +========== + +For more information on the OPNFV Fraser release, please visit +http://www.opnfv.org/fraser diff --git a/docs/release/scenarios/os-nosdn-ovs_dpdk-noha/index.rst b/docs/release/scenarios/os-nosdn-ovs_dpdk-noha/index.rst new file mode 100644 index 00000000..699f3915 --- /dev/null +++ b/docs/release/scenarios/os-nosdn-ovs_dpdk-noha/index.rst @@ -0,0 +1,16 @@ +.. _os-nosdn-ovs_dpdk-noha: + +.. OPNFV - Open Platform for Network Function Virtualization +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +************************************************************************************ +User Space Accelerated OVS scenario: os-nosdn-ovs_dpdk-noha Overview and Description +************************************************************************************ + +.. toctree:: + :numbered: + :maxdepth: 4 + + os-nosdn-ovs_dpdk-noha.rst diff --git a/docs/release/scenarios/os-nosdn-ovs_dpdk-noha/os-nosdn-ovs_dpdk-noha.rst b/docs/release/scenarios/os-nosdn-ovs_dpdk-noha/os-nosdn-ovs_dpdk-noha.rst new file mode 100644 index 00000000..002e1181 --- /dev/null +++ b/docs/release/scenarios/os-nosdn-ovs_dpdk-noha/os-nosdn-ovs_dpdk-noha.rst @@ -0,0 +1,58 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +This document provides scenario level details for Fraser 1.0 of +deployment with no SDN controller and DPDK enabled Open vSwitch by using +Daisy installer. + +Introduction +============ + +NFV and virtualized high performance applications, such as video processing, +require Open vSwitch to be accelerated with a fast data plane solution that +provides both carrier grade forwarding performance, scalability and open +extensibility. + +A key component of any NFV solution is the virtual forwarder, which should +consist of soft switch that includes an accelerated data plane component. For +this, any virtual switch should make use of hardware accelerators and optimized +cache operation to be run in user space. + +Scenario components and composition +=================================== + +This scenario enables high performance data plan acceleration by utilizing +DPDK enabled Open vSwitch (OVS). This allows packet switching to be isolated +to particular hardware resources (CPUs, huge page memory allocation) without +kernel interrupt or context switching on the data plane CPU. + +Both tenant tunnel and external physnet1 leverage Open vSwitch accelerated +with a fast user space data path, while other network planes are performed +via non-accelerated OVS. + +Scenario Configuration +====================== + +Due to the performance optimization done by this scenario, it is recommended to +set some performance settings in the deploy settings in order to ensure maximum +performance. This is not necessary unless doing a baremetal deployment. Note, +this scenario requires taking the NIC mapped to the tenant and external network +on the compute node and binding them to DPDK. This means it will no longer be +accessible via the kernel. Ensure the NIC supports DPDK. + +40 huge pages of 1G size are allocaled on each compute and network node for DPDK +and VMs by default and currently this can not be re-configured by using +configure files. + +For each compute and network node, One CPU core of each NUMA is dedicatedly +allocated for DPDK by default and currently this can not be re-configured by using +configure files. + +Deploy this scenario by using the '-s os-nosdn-ovs_dpdk-noha' parameter among +others when calling ./ci/deploy/deploy.sh. + +References +========== + +For more information on the OPNFV Fraser release, please visit +http://www.opnfv.org/fraser diff --git a/docs/release/scenarios/os-odl-nofeature-ha/index.rst b/docs/release/scenarios/os-odl-nofeature-ha/index.rst new file mode 100644 index 00000000..4c6a443f --- /dev/null +++ b/docs/release/scenarios/os-odl-nofeature-ha/index.rst @@ -0,0 +1,15 @@ +.. _os-odl-nofeature-ha: + +.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) <optionally add copywriters name> + +============================================ +os-odl-nofeature-ha overview and description +============================================ + +.. toctree:: + :numbered: + :maxdepth: 4 + + os-odl-nofeature-ha.rst diff --git a/docs/release/scenarios/os-odl-nofeature-ha/os-odl-nofeature-ha.rst b/docs/release/scenarios/os-odl-nofeature-ha/os-odl-nofeature-ha.rst new file mode 100644 index 00000000..32d53931 --- /dev/null +++ b/docs/release/scenarios/os-odl-nofeature-ha/os-odl-nofeature-ha.rst @@ -0,0 +1,41 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +This document provides scenario level details for Fraser 1.0 of +deployment with the OpenDaylight SDN controller and no extra features enabled. + +============ +Introduction +============ + +This scenario is used primarily to validate and deploy a Pike OpenStack +deployment with OpenDaylight, and without any NFV features enabled. + +Scenario components and composition +=================================== + +This scenario is composed of common OpenStack services enabled by default, +including Nova, Neutron, Glance, Cinder, Keystone, Horizon. Ceph is used as +the backend storage to Cinder, Glance and Nova on all deployed nodes. + +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. VIP is elected by using keepalived. + +OpenDaylight is also enabled in HA, and forms a cluster. Neutron +communicates with a Virtual IP Address for OpenDaylight which is load +balanced across the OpenDaylight cluster. Every Open vSwitch node is +connected to every OpenDaylight for High Availability, thus it is the +OpenDaylight controllers responsbility to elect a master. + +Scenario usage overview +======================= + +Simply deploy this scenario by using the '-s os-odl-nofeature-ha' +parameter among others when calling ./ci/deploy/deploy.sh. + +References +========== + +For more information on the OPNFV Fraser release, please visit +http://www.opnfv.org/fraser |