From b188263699077102e956929970cc20191dafd312 Mon Sep 17 00:00:00 2001 From: Tim Rozet Date: Fri, 9 Nov 2018 11:17:28 -0500 Subject: Updates documentation for Gambia Changes-Include: - Remove references to Apex ISO and disk image RPMs - Update supported scenarios - Update using upstream documentation Change-Id: If2b66d1d5a861bd1f90b0e8829de37d84e656619 Signed-off-by: Tim Rozet --- .../k8s-nosdn-nofeature-noha.rst | 4 +- .../os-nosdn-nofeature-ha.rst | 8 ++-- .../os-nosdn-nofeature-noha.rst | 8 ++-- .../scenarios/os-nosdn-performance-ha/index.rst | 15 ------ .../os-nosdn-performance-ha.rst | 54 ---------------------- .../os-odl-nofeature-ha/os-odl-nofeature-ha.rst | 14 ++---- .../os-odl-nofeature-noha.rst | 14 ++---- .../scenarios/os-ovn-nofeature-ha/index.rst | 15 ++++++ .../os-ovn-nofeature-ha/os-ovn-nofeature-ha.rst | 39 ++++++++++++++++ .../scenarios/os-ovn-nofeature-noha/index.rst | 15 ------ .../os-ovn-nofeature-noha.rst | 40 ---------------- 11 files changed, 73 insertions(+), 153 deletions(-) delete mode 100644 docs/release/scenarios/os-nosdn-performance-ha/index.rst delete mode 100644 docs/release/scenarios/os-nosdn-performance-ha/os-nosdn-performance-ha.rst create mode 100644 docs/release/scenarios/os-ovn-nofeature-ha/index.rst create mode 100644 docs/release/scenarios/os-ovn-nofeature-ha/os-ovn-nofeature-ha.rst delete mode 100644 docs/release/scenarios/os-ovn-nofeature-noha/index.rst delete mode 100644 docs/release/scenarios/os-ovn-nofeature-noha/os-ovn-nofeature-noha.rst (limited to 'docs/release/scenarios') diff --git a/docs/release/scenarios/k8s-nosdn-nofeature-noha/k8s-nosdn-nofeature-noha.rst b/docs/release/scenarios/k8s-nosdn-nofeature-noha/k8s-nosdn-nofeature-noha.rst index 69b9c2a6..8a70c0ea 100644 --- a/docs/release/scenarios/k8s-nosdn-nofeature-noha/k8s-nosdn-nofeature-noha.rst +++ b/docs/release/scenarios/k8s-nosdn-nofeature-noha/k8s-nosdn-nofeature-noha.rst @@ -4,7 +4,9 @@ This document provides scenario level details for Gambia 1.0 of Kubernetes deployment with no SDN controller, no extra features -and no High Availability enabled. +and no High Availability enabled. Note this scenario is *not* supported +for Gambia initial release and will be supported in a later service release +of Gambia. ============ Introduction 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 index bc6d39b8..7b34d074 100644 --- 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 @@ -2,14 +2,14 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) -This document provides scenario level details for Fraser 1.0 of +This document provides scenario level details for Gambia 1.0 of deployment with no SDN controller and no extra features enabled. ============ Introduction ============ -This scenario is used primarily to validate and deploy a Pike OpenStack +This scenario is used primarily to validate and deploy a Queens OpenStack deployment without any NFV features or SDN controller enabled. Scenario components and composition @@ -38,6 +38,6 @@ None References ========== -For more information on the OPNFV Fraser release, please visit -http://www.opnfv.org/fraser +For more information on the OPNFV Gambia release, please visit +http://www.opnfv.org/gambia diff --git a/docs/release/scenarios/os-nosdn-nofeature-noha/os-nosdn-nofeature-noha.rst b/docs/release/scenarios/os-nosdn-nofeature-noha/os-nosdn-nofeature-noha.rst index 8edd29bd..1e7c5330 100644 --- a/docs/release/scenarios/os-nosdn-nofeature-noha/os-nosdn-nofeature-noha.rst +++ b/docs/release/scenarios/os-nosdn-nofeature-noha/os-nosdn-nofeature-noha.rst @@ -2,14 +2,14 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) -This document provides scenario level details for Fraser 1.0 of +This document provides scenario level details for Gambia 1.0 of deployment with no SDN controller and no extra features enabled. ============ Introduction ============ -This scenario is used primarily to validate and deploy a Pike OpenStack +This scenario is used primarily to validate and deploy a Queens OpenStack deployment without any NFV features or SDN controller enabled. Scenario components and composition @@ -35,6 +35,6 @@ None References ========== -For more information on the OPNFV Fraser release, please visit -http://www.opnfv.org/fraser +For more information on the OPNFV Gambia release, please visit +http://www.opnfv.org/gambia diff --git a/docs/release/scenarios/os-nosdn-performance-ha/index.rst b/docs/release/scenarios/os-nosdn-performance-ha/index.rst deleted file mode 100644 index e0dbca7f..00000000 --- a/docs/release/scenarios/os-nosdn-performance-ha/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _os-nosdn-performance-ha: - -.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - -================================================ -os-nosdn-performance-ha overview and description -================================================ - -.. toctree:: - :numbered: - :maxdepth: 4 - - os-nosdn-performance-ha.rst diff --git a/docs/release/scenarios/os-nosdn-performance-ha/os-nosdn-performance-ha.rst b/docs/release/scenarios/os-nosdn-performance-ha/os-nosdn-performance-ha.rst deleted file mode 100644 index beed894e..00000000 --- a/docs/release/scenarios/os-nosdn-performance-ha/os-nosdn-performance-ha.rst +++ /dev/null @@ -1,54 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - -This document provides scenario level details for Fraser 1.0 of -deployment with no SDN controller and performance options enabled. - -============ -Introduction -============ - -This scenario is used primarily to demonstrate the performance settings and -capabilities in Apex. This scenario will 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. Optionally and -by default, Tacker and Congress services are also enabled. Ceph is used as -the backend storage to Cinder 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. - -The main purpose of this scenario is to serve as an example to show how to -set optional performance settings in an Apex deploy settings file. - -Scenario usage overview -======================= - -The performance options listed in os-nosdn-performance-ha.yaml give an example -of the different options a user can set in any deploy settings file. Some -of these performance options are actually required for other scenarios which -rely on DPDK. Options under the nova section like 'libvirtpin' allow a -user to choose which core to pin nova instances to on the overcloud compute -node. Options under 'kernel' allow a user to set kernel specific arguments -at boot, which include options like hugepages, isolcpus, enabling iommu, etc. - - -Limitations, Issues and Workarounds -=================================== - -* `APEX-389 `_: - Compute kernel parameters are applied to all nodes - -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/os-odl-nofeature-ha.rst b/docs/release/scenarios/os-odl-nofeature-ha/os-odl-nofeature-ha.rst index 52530cdd..55f0e7aa 100644 --- 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 @@ -2,14 +2,14 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) -This document provides scenario level details for Fraser 1.0 of +This document provides scenario level details for Gambia 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 +This scenario is used primarily to validate and deploy a Queens OpenStack deployment with OpenDaylight, and without any NFV features enabled. Scenario components and composition @@ -38,18 +38,12 @@ settings file. Limitations, Issues and Workarounds =================================== -* `APEX-112 `_: - ODL routes local subnet traffic to GW -* `APEX-149 `_: - OpenFlow rules are populated very slowly * `APEX-268 `_: VMs with multiple floating IPs can only access via first NIC -* `APEX-422 `_: - First nova instance DHCP request fails References ========== -For more information on the OPNFV Fraser release, please visit -http://www.opnfv.org/fraser +For more information on the OPNFV Gambia release, please visit +http://www.opnfv.org/gambia diff --git a/docs/release/scenarios/os-odl-nofeature-noha/os-odl-nofeature-noha.rst b/docs/release/scenarios/os-odl-nofeature-noha/os-odl-nofeature-noha.rst index 932ccc85..f4e7a9a4 100644 --- a/docs/release/scenarios/os-odl-nofeature-noha/os-odl-nofeature-noha.rst +++ b/docs/release/scenarios/os-odl-nofeature-noha/os-odl-nofeature-noha.rst @@ -2,14 +2,14 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) -This document provides scenario level details for Fraser 1.0 of +This document provides scenario level details for Gambia 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 +This scenario is used primarily to validate and deploy a Queens OpenStack deployment with OpenDaylight, and without any NFV features enabled. Scenario components and composition @@ -32,18 +32,12 @@ settings file. Limitations, Issues and Workarounds =================================== -* `APEX-112 `_: - ODL routes local subnet traffic to GW -* `APEX-149 `_: - OpenFlow rules are populated very slowly * `APEX-268 `_: VMs with multiple floating IPs can only access via first NIC -* `APEX-422 `_: - First nova instance DHCP request fails References ========== -For more information on the OPNFV Fraser release, please visit -http://www.opnfv.org/fraser +For more information on the OPNFV Gambia release, please visit +http://www.opnfv.org/gambia diff --git a/docs/release/scenarios/os-ovn-nofeature-ha/index.rst b/docs/release/scenarios/os-ovn-nofeature-ha/index.rst new file mode 100644 index 00000000..b7e62e6c --- /dev/null +++ b/docs/release/scenarios/os-ovn-nofeature-ha/index.rst @@ -0,0 +1,15 @@ +.. _os-ovn-nofeature-ha: + +.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) + +============================================== +os-ovn-nofeature-noha overview and description +============================================== + +.. toctree:: + :numbered: + :maxdepth: 4 + + os-ovn-nofeature-ha.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 new file mode 100644 index 00000000..85b1c2ae --- /dev/null +++ b/docs/release/scenarios/os-ovn-nofeature-ha/os-ovn-nofeature-ha.rst @@ -0,0 +1,39 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) + +This document provides scenario level details for Gambia 1.0 of +deployment with the OVN SDN controller and no extra features enabled. + +============ +Introduction +============ + +This scenario is used primarily to validate and deploy a Pike OpenStack +deployment with the OVN SDN controller, 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. Optionally and +by default, Tacker and Congress services are also enabled. Ceph is used as +the backend storage to Cinder on all deployed nodes. + +Scenario usage overview +======================= + +Simply deploy this scenario by using the os-ovn-nofeature-ha.yaml deploy +settings file. + +Limitations, Issues and Workarounds +=================================== + +None + +References +========== + +For more information on the OPNFV Gambia release, please visit +http://www.opnfv.org/gambia + diff --git a/docs/release/scenarios/os-ovn-nofeature-noha/index.rst b/docs/release/scenarios/os-ovn-nofeature-noha/index.rst deleted file mode 100644 index 74545044..00000000 --- a/docs/release/scenarios/os-ovn-nofeature-noha/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _os-ovn-nofeature-noha: - -.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - -============================================== -os-ovn-nofeature-noha overview and description -============================================== - -.. toctree:: - :numbered: - :maxdepth: 4 - - os-ovn-nofeature-noha.rst diff --git a/docs/release/scenarios/os-ovn-nofeature-noha/os-ovn-nofeature-noha.rst b/docs/release/scenarios/os-ovn-nofeature-noha/os-ovn-nofeature-noha.rst deleted file mode 100644 index 1b2da194..00000000 --- a/docs/release/scenarios/os-ovn-nofeature-noha/os-ovn-nofeature-noha.rst +++ /dev/null @@ -1,40 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - -This document provides scenario level details for Fraser 1.0 of -deployment with the OVN SDN controller and no extra features enabled. - -============ -Introduction -============ - -This scenario is used primarily to validate and deploy a Pike OpenStack -deployment with the OVN SDN controller, 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. Optionally and -by default, Tacker and Congress services are also enabled. Ceph is used as -the backend storage to Cinder on all deployed nodes. - -Scenario usage overview -======================= - -Simply deploy this scenario by using the os-ovn-nofeature-noha.yaml deploy -settings file. - -Limitations, Issues and Workarounds -=================================== - -* `APEX-430 `_: - OVN HA functionality is not available. - -References -========== - -For more information on the OPNFV Fraser release, please visit -http://www.opnfv.org/fraser - -- cgit 1.2.3-korg