From 0ea9a63b47024a16b42bcf56a63f733f6d5c0edd Mon Sep 17 00:00:00 2001 From: Dan Radez Date: Wed, 29 Mar 2017 12:33:25 -0400 Subject: Updating docs for Danube Change-Id: I7eb2d7bb62d61ca1ab7177332bb27329da85ad48 Signed-off-by: Dan Radez (cherry picked from commit a684f6b753749c355aee06412bd0f22779357089) --- config/deploy/deploy_settings.yaml | 2 +- docs/release/installation/abstract.rst | 6 +-- docs/release/installation/architecture.rst | 78 ++++++++++++++++++--------- docs/release/installation/index.rst | 2 +- docs/release/installation/introduction.rst | 4 +- docs/release/installation/references.rst | 6 +-- docs/release/installation/requirements.rst | 2 +- docs/release/installation/troubleshooting.rst | 17 ++---- docs/release/installation/verification.rst | 2 +- 9 files changed, 69 insertions(+), 50 deletions(-) diff --git a/config/deploy/deploy_settings.yaml b/config/deploy/deploy_settings.yaml index 73535795..c92a1754 100644 --- a/config/deploy/deploy_settings.yaml +++ b/config/deploy/deploy_settings.yaml @@ -81,7 +81,7 @@ deploy_options: # # This is currently the only available option in the nova section. It will # # add the provided string to vcpu_pin_set in nova.conf. This is used to pin # # guest VMs to a set of CPU cores, and is decsribed in more detail here: - # # http://docs.openstack.org/mitaka/config-reference/compute/config-options.html + # # http://docs.openstack.org/newton/config-reference/compute/config-options.html # libvirtpin: 1 # kernel: # # On compute nodes, isolcpus is usually used to reserve cores for use either by VMs diff --git a/docs/release/installation/abstract.rst b/docs/release/installation/abstract.rst index 70814cea..b2d92a23 100644 --- a/docs/release/installation/abstract.rst +++ b/docs/release/installation/abstract.rst @@ -1,16 +1,16 @@ Abstract ======== -This document describes how to install the Colorado release of OPNFV when +This document describes how to install the Danube release of OPNFV when using Apex as a deployment tool covering it's limitations, dependencies and required system resources. License ======= -Colorado release of OPNFV when using Apex as a deployment tool Docs +Danube release of OPNFV when using Apex as a deployment tool Docs (c) by Tim Rozet (Red Hat) and Dan Radez (Red Hat) -Colorado release of OPNFV when using Apex as a deployment tool Docs +Danube release of OPNFV when using Apex as a deployment tool Docs are licensed under a Creative Commons Attribution 4.0 International License. You should have received a copy of the license along with this. If not, see . diff --git a/docs/release/installation/architecture.rst b/docs/release/installation/architecture.rst index 38806391..ae634cc4 100644 --- a/docs/release/installation/architecture.rst +++ b/docs/release/installation/architecture.rst @@ -116,28 +116,56 @@ description. Also, please refer to release-notes for information about known issues per scenario. The following scenarios correspond to a supported .yaml deploy settings file: -+-------------------------+------------+-----------------+ -| **Scenario** | **Owner** | **Supported** | -+-------------------------+------------+-----------------+ -| os-nosdn-nofeature-ha | Apex | Yes | -+-------------------------+------------+-----------------+ -| os-nosdn-nofeature-noha | Apex | Yes | -+-------------------------+------------+-----------------+ -| os-nosdn-ovs-noha | OVS for NFV| Yes | -+-------------------------+------------+-----------------+ -| os-nosdn-fdio-noha | FDS | Yes | -+-------------------------+------------+-----------------+ -| os-odl_l2-nofeature-ha | Apex | Yes | -+-------------------------+------------+-----------------+ -| os-odl_l3-nofeature-ha | Apex | Yes | -+-------------------------+------------+-----------------+ -| os-odl_l2-sfc-noha | SFC | Yes | -+-------------------------+------------+-----------------+ -| os-odl-bgpvpn-ha | SDNVPN | No | -+-------------------------+------------+-----------------+ -| os-odl_l2-fdio-noha | FDS | Yes | -+-------------------------+------------+-----------------+ -| os-onos-nofeature-ha | ONOSFW | Yes | -+-------------------------+------------+-----------------+ -| os-onos-sfc-ha | ONOSFW | Yes | -+-------------------------+------------+-----------------+ ++-------------------------+-------------+---------------+ +| **Scenario** | **Owner** | **Supported** | ++-------------------------+-------------+---------------+ +| os-nosdn-nofeature-ha | Apex | Yes | ++-------------------------+-------------+---------------+ +| os-nosdn-nofeature-noha | Apex | Yes | ++-------------------------+-------------+---------------+ +| os-nosdn-ovs-ha | OVS for NFV | Yes | ++-------------------------+-------------+---------------+ +| os-nosdn-ovs-noha | OVS for NFV | Yes | ++-------------------------+-------------+---------------+ +| os-nosdn-fdio-ha | FDS | Yes | ++-------------------------+-------------+---------------+ +| os-nosdn-fdio-noha | FDS | Yes | ++-------------------------+-------------+---------------+ +| os-nosdn-kvm-ha | KVM for NFV | Yes | ++-------------------------+-------------+---------------+ +| os-nosdn-kvm-noha | KVM for NFV | Yes | ++-------------------------+-------------+---------------+ +| os-nosdn-performance-ha | Apex | Yes | ++-------------------------+-------------+---------------+ +| os-odl_l3-nofeature-ha | Apex | Yes | ++-------------------------+-------------+---------------+ +| os-odl_l3-nofeature-noha| Apex | Yes | ++-------------------------+-------------+---------------+ +| os-odl_l3-ovs-ha | OVS for NFV | Yes | ++-------------------------+-------------+---------------+ +| os-odl_l3-ovs-noha | OVS for NFV | Yes | ++-------------------------+-------------+---------------+ +| os-odl-bgpvpn-ha | SDNVPN | Yes | ++-------------------------+-------------+---------------+ +| os-odl-bgpvpn-noha | SDNVPN | Yes | ++-------------------------+-------------+---------------+ +| os-odl-gluon-noha | GluOn | Yes | ++-------------------------+-------------+---------------+ +| os-odl_l3-csit-noha | Apex | Yes | ++-------------------------+-------------+---------------+ +| os-odl_l3-fdio-ha | FDS | Yes | ++-------------------------+-------------+---------------+ +| os-odl_l3-fdio-noha | FDS | Yes | ++-------------------------+-------------+---------------+ +| os-odl_l2-fdio-ha | FDS | Yes | ++-------------------------+-------------+---------------+ +| os-odl_l2-fdio-noha | FDS | Yes | ++-------------------------+-------------+---------------+ +| os-odl_l2-sfc-noha | SFC | No | ++-------------------------+-------------+---------------+ +| os-onos-nofeature-ha | ONOSFW | No | ++-------------------------+-------------+---------------+ +| os-onos-sfc-ha | ONOSFW | No | ++-------------------------+-------------+---------------+ +| os-ovn-nofeature-noha | Apex | Yes | ++-------------------------+-------------+---------------+ diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst index c251fd5a..615aa7e5 100644 --- a/docs/release/installation/index.rst +++ b/docs/release/installation/index.rst @@ -22,7 +22,7 @@ Contents: :Authors: Tim Rozet (trozet@redhat.com) :Authors: Dan Radez (dradez@redhat.com) -:Version: 3.0 +:Version: 4.0 Indices and tables ================== diff --git a/docs/release/installation/introduction.rst b/docs/release/installation/introduction.rst index cc489917..18267848 100644 --- a/docs/release/installation/introduction.rst +++ b/docs/release/installation/introduction.rst @@ -1,7 +1,7 @@ Introduction ============ -This document describes the steps to install an OPNFV Colorado reference +This document describes the steps to install an OPNFV Danube reference platform, as defined by the Genesis Project using the Apex installer. The audience is assumed to have a good background in networking @@ -19,7 +19,7 @@ deployment tool chain. The Apex deployment artifacts contain the necessary tools to deploy and configure an OPNFV target system using the Apex deployment toolchain. These artifacts offer the choice of using the Apex bootable ISO -(``opnfv-apex-colorado.iso``) to both install CentOS 7 and the +(``opnfv-apex-danube.iso``) to both install CentOS 7 and the necessary materials to deploy or the Apex RPMs (``opnfv-apex*.rpm``), and their associated dependencies, which expects installation to a CentOS 7 libvirt enabled host. The RPM contains a collection of diff --git a/docs/release/installation/references.rst b/docs/release/installation/references.rst index a63a8421..b777bac5 100644 --- a/docs/release/installation/references.rst +++ b/docs/release/installation/references.rst @@ -14,16 +14,14 @@ OPNFV `OPNFV Home Page `_ -`OPNFV Genesis project page `_ - `OPNFV Apex project page `_ -`OPNFV Apex release notes `_ +:ref:`OPNFV Apex Release Notes ` OpenStack --------- -`OpenStack Mitaka Release artifacts `_ +`OpenStack Newton Release artifacts `_ `OpenStack documentation `_ diff --git a/docs/release/installation/requirements.rst b/docs/release/installation/requirements.rst index 507b671e..62c9963e 100644 --- a/docs/release/installation/requirements.rst +++ b/docs/release/installation/requirements.rst @@ -15,7 +15,7 @@ The Jumphost requirements are outlined below: 4. minimum 1 networks and maximum 5 networks, multiple NIC and/or VLAN combinations are supported. This is virtualized for a VM deployment. -5. The Colorado Apex RPMs and their dependencies. +5. The Danube Apex RPMs and their dependencies. 6. 16 GB of RAM for a bare metal deployment, 64 GB of RAM for a VM deployment. diff --git a/docs/release/installation/troubleshooting.rst b/docs/release/installation/troubleshooting.rst index ed0d1ff6..efff9796 100644 --- a/docs/release/installation/troubleshooting.rst +++ b/docs/release/installation/troubleshooting.rst @@ -85,18 +85,11 @@ executed. However, some other cases it could be worth it to try to debug it. OpenDaylight Integration ------------------------ -When a user deploys any of the following scenarios: - - - os-odl-bgpvpn-ha.yaml - - os-odl_l2-fdio-ha.yaml - - os-odl_l2-fdio-noha.yaml - - os-odl_l2-nofeature-ha.yaml - - os-odl_l2-sfc-noha.yaml - - os-odl_l3-nofeature-ha.yaml - -OpenDaylight (ODL) SDN controller will be deployed too and completely -integrated with OpenStack. ODL is running as a systemd service, so you can -manage it as a regular service: +When a user deploys a scenario that starts with os-odl*: + +OpenDaylight (ODL) SDN controller will be deployed and integrated with +OpenStack. ODL will run as a systemd service, and can be managed as +as a regular service: ``systemctl start/restart/stop opendaylight.service`` diff --git a/docs/release/installation/verification.rst b/docs/release/installation/verification.rst index 81e4c8e4..5156effc 100644 --- a/docs/release/installation/verification.rst +++ b/docs/release/installation/verification.rst @@ -51,7 +51,7 @@ working correctly: 1. In the left pane, click Compute -> Images, click Create Image. 2. Insert a name "cirros", Insert an Image Location - ``http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img``. + ``http://download.cirros-cloud.net/0.3.5/cirros-0.3.5-x86_64-disk.img``. 3. Select format "QCOW2", select Public, then click Create Image. -- cgit 1.2.3-korg