diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/sources/artifacts-location.rst | 52 | ||||
| -rw-r--r-- | docs/sources/system-requirements.rst | 68 | ||||
| -rw-r--r-- | docs/sources/ux-requirements.rst | 148 |
3 files changed, 162 insertions, 106 deletions
diff --git a/docs/sources/artifacts-location.rst b/docs/sources/artifacts-location.rst new file mode 100644 index 0000000..4592d2a --- /dev/null +++ b/docs/sources/artifacts-location.rst @@ -0,0 +1,52 @@ +.. Copyright 2015 Open Platform for NFV Project, Inc. and its contributors + +.. Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +.. ----------------------------------------------------------------------- + + +================================= +Key artifacts and their locations +================================= + +Release: OPNFV Brahmaputra + + +VM manager components +===================== + +* OpenStack:: + location: `<http://docs.openstack.org/releases/releases/liberty.html>`_ + release: Liberty + +Network controller components +============================= + +* OpenDaylight Controller:: + location: `<https://nexus.opendaylight.org/content/repositories/opendaylight.release/org/opendaylight/integration/distribution-karaf/0.3.2-Lithium-SR2/distribution-karaf-0.3.2-Lithium-SR2.zip>`_ + release: Lithium SR2 + +* OpenDaylight SFC:: + location: `<https://www.dropbox.com/s/6w76eo7loltvvb5/openstack.net-virt-sfc-karaf-1.2.1-SNAPSHOT.zip>`_ + +* ONOS Controller:: + location: `<http://downloads.onosproject.org/nightly/onos-1.4.0-rc2.tar.gz>`_ + release: Emu 1.4.0-rc2 + + +vSwitch components +================== + + * OVS NSH build:: + location: `<https://github.com/openvswitch/ovs.git>`_ + commit: 121daded51b9798fe3722824b27a05c16806cbd1 diff --git a/docs/sources/system-requirements.rst b/docs/sources/system-requirements.rst index 5cc11ad..ca7af03 100644 --- a/docs/sources/system-requirements.rst +++ b/docs/sources/system-requirements.rst @@ -24,67 +24,49 @@ Target system requirements Release: OPNFV Brahmaputra -This document lists requirements for the target system that an installer creates. Different from the requirements document on user-experience, this document focuses on the key hardware and software components the different deployment tools install and/or configure. +This document lists requirements for the target system that +an installer creates. Different from the requirements document +on user-experience, this document focuses on the key hardware +and software components the different deployment tools install +and/or configure. -Hardware components -------------------- -.. Please add the Jira story reference to each requirement. - Note that the below listed "GENESIS-1" Jira story are place holders - and are to be changed for the actual Jira reference. - - -Software components -------------------- -.. Please add the Jira story to each requirement as reference. Minimum base Operating System distribution supported: ===================================================== -`GENESIS-4 <https://jira.opnfv.org/browse/GENESIS-4>`_: Installers support either Centos 7 or -Ubuntu 14.04 as target system base OS + +* `GENESIS-4 <https://jira.opnfv.org/browse/GENESIS-4>`_: + Installers should support either Centos 7 or Ubuntu 14.04 + as target system base OS. + +Components/features installed for OpenStack: +============================================ + +* `GENESIS-53 <https://jira.opnfv.org/browse/GENESIS-53>`_: + OpenStack Heat should be installed. Minimum base OpenStack distribution supported: ============================================== -`GENESIS-7 <https://jira.opnfv.org/browse/GENESIS-7>`_: Installers must support OpenStack Liberty -release + +* `GENESIS-7 <https://jira.opnfv.org/browse/GENESIS-7>`_: + Installers should support OpenStack Liberty release. SDN Controller: =============== -`GENESIS-6 <https://jira.opnfv.org/browse/GENESIS-6>`_: Installers support -OpenDaylight Lithium Release - -`GENESIS-49 <https://jira.opnfv.org/browse/GENESIS-49>`_: Installers support for ONOSFW +* `GENESIS-6 <https://jira.opnfv.org/browse/GENESIS-6>`_: + Installers should support OpenDaylight Lithium Release. +* `GENESIS-49 <https://jira.opnfv.org/browse/GENESIS-49>`_: + Installers should support ONOSFW. VM Controller: ============== Hypervisor: =========== -`GENESIS-8 <https://jira.opnfv.org/browse/GENESIS-8>`_: KVM Support -`GENESIS-50 <https://jira.opnfv.org/browse/GENESIS-50>`_: nfv-kvm installation requirement +* `GENESIS-8 <https://jira.opnfv.org/browse/GENESIS-8>`_: + Installers should support KVM hypervisor. + Virtual forwarder: ================== - -`GENESIS-46 <https://jira.opnfv.org/browse/GENESIS-46>`_: SFC support - The SFC project needs a version of OVS that supports Network Service Headers ' - (NSH). The required end-system state for the B-release will be an official - OVS patch that Intel is preparing that will provide full OVS 2.4 support. - This official OVS patch is not available yet. Until this official patch is - available, there is a patch available in a private branch that we will have - to use during the life cycle of the B release. This private OVS branch does - not support all of the OVS 2.4 features. The private OVS branch can be - obtained as follows: - git clone https://github.com/priteshk/ovs.git - git checkout nsh-v8 - - -Installer Documentation: -======================== - -`GENESIS-34 <https://jira.opnfv.org/browse/GENESIS-34`_: Installers should provide a user guide - -`GENESIS-35 <https://jira.opnfv.org/browse/GENESIS-35`_: Installers should provide release notes for an OPNFV release as part of the documentation provided - - diff --git a/docs/sources/ux-requirements.rst b/docs/sources/ux-requirements.rst index bd93abd..a41995e 100644 --- a/docs/sources/ux-requirements.rst +++ b/docs/sources/ux-requirements.rst @@ -26,21 +26,17 @@ Release: OPNFV Brahmaputra Requirements for a common user-experience created by the deployment tools. - - High availability requirements ------------------------------ -.. Please add the Jira story reference to each requirement. - Note that the below listed "GENESIS-3" Jira story are place holders - and are to be changed for the actual Jira reference. +.. Please add the story reference to each requirement. -* `Jira GENESIS-3 <https://jira.opnfv.org/browse/GENESIS-3>`_: new requirement... -* `Jira GENESIS-9 <https://jira.opnfv.org/browse/GENESIS-9>`_: The installer shall support the - deployment of OpenStack with High-Availability (for those components that support it in - Liberty) on 3 or more control nodes. Functest tests should be able to verify that the HA is - enabled and functional. +* `GENESIS-9 <https://jira.opnfv.org/browse/GENESIS-9>`_: + Installers shall support the deployment of OpenStack with + High-Availability (for those components that support it in + Liberty) on 3 or more control nodes. Functest tests should + be able to verify that the HA is enabled and functional. -* `Jira GENESIS-71 <https://jira.opnfv.org/browse/GENESIS-71>`_: new requirement +* `GENESIS-71 <https://jira.opnfv.org/browse/GENESIS-71>`_: Hitless hardware upgrade: Increase size of a deployment in terms of compute nodes (add additional compute nodes) without service interruption. This requirement doesn't mandate upgrade/increasing the size of the control @@ -49,91 +45,117 @@ High availability requirements Network setup and configuration related requirements ---------------------------------------------------- -* `Jira GENESIS-20 <https://jira.opnfv.org/browse/GENESIS-20>`_: Automatically populate - discovered servers into install tool (reduce user-intervention to a minimum). +* `GENESIS-20 <https://jira.opnfv.org/browse/GENESIS-20>`_: + Automatically populate discovered servers into install + tool (reduce user-intervention to a minimum). + +* `GENESIS-28 <https://jira.opnfv.org/browse/GENESIS-28>`_: + Installers should support a common configuration file (e.g. kickstart file) + per platform/role, so that the installed OS can be customized + for hardware and role. -* `Jira GENESIS-28 <https://jira.opnfv.org/browse/GENESIS-28>`_: Installers should support - a common configuration file (e.g. kickstart file) per platform/role, so that the installed - OS can be customized for hardware and role. +* `GENESIS-43 <https://jira.opnfv.org/browse/GENESIS-43>`_: + Neutron DHCP servers should be configured in HA per tenant. -* `Jira GENESIS-43 <https://jira.opnfv.org/browse/GENESIS-43>`_: Neutron DHCP servers should - be configured in HA per tenant +* `GENESIS-44 <https://jira.opnfv.org/browse/GENESIS-44>`_: + SDN Controller layer 3 forwarding support. -* `Jira GENESIS-61 <https://jira.opnfv.org/browse/GENESIS-61>`_: Supported Layer 1/2 Networking - Configurations +* `GENESIS-61 <https://jira.opnfv.org/browse/GENESIS-61>`_: + Support layer 1/2 networking configuration. -* `Jira GENESIS-62 <https://jira.opnfv.org/browse/GENESIS-62>`_: Supported Logical Networks for - Target System +* `GENESIS-62 <https://jira.opnfv.org/browse/GENESIS-62>`_: + Support logical networks for target system. -* `Jira GENESIS-72 <https://jira.opnfv.org/browse/GENESIS-72`_: Support L3-neutron agent - as an option for L3 +* `GENESIS-72 <https://jira.opnfv.org/browse/GENESIS-72>`_: + Support L3-neutron agent as an option for L3. + +* `GENESIS-69 <https://jira.opnfv.org/browse/GENESIS-69>`_: + Provide isolated compute node resources for CEPH OSD. Versioning requirements ----------------------- -.. Please add the Jira story reference to each requirement. - Note that the below listed "GENESIS-3" Jira stories are place holders - and are to be changed for the actual Jira reference. +.. Please add the story reference to each requirement. -* `Jira GENESIS-3 <https://jira.opnfv.org/browse/GENESIS-3>`_: new requirement... -* `Jira GENESIS-12 <https://jira.opnfv.org/browse/GENESIS-12>`_: Installers should track/control - all versions of all components pulled from external sources (user should be able to identify +* `GENESIS-12 <https://jira.opnfv.org/browse/GENESIS-12>`_: + Installers should track/control all versions of all components pulled + from external sources (user should be able to identify the versions and origins of all software components deployed). System definition and system configuration requirements ------------------------------------------------------- -.. Please add the Jira story reference to each requirement. - Note that the below listed "GENESIS-3" Jira stories are place holders - and are to be changed for the actual Jira reference. - -* `Jira GENESIS-3 <https://jira.opnfv.org/browse/GENESIS-3>`_: new requirement... -* `Jira GENESIS-16 <https://jira.opnfv.org/browse/GENESIS-16>`_: Common ability to input site, - topology, and server information. -* `Jira GENESIS-17 <https://jira.opnfv.org/browse/GENESIS-17>`_: User-configurable parameters - available via config files. -* `Jira GENESIS-18 <https://jira.opnfv.org/browse/GENESIS-18>`_: Allow assignment of different roles - to servers, so that hardware and software can be configured according to the role. -* `Jira GENESIS-19 <https://jira.opnfv.org/browse/GENESIS-19>`_: +.. Please add the story reference to each requirement. + +* `GENESIS-16 <https://jira.opnfv.org/browse/GENESIS-16>`_: + Common ability to input site, topology, and server information. +* `GENESIS-17 <https://jira.opnfv.org/browse/GENESIS-17>`_: + User-configurable parameters available via config files. +* `GENESIS-18 <https://jira.opnfv.org/browse/GENESIS-18>`_: + Allow assignment of different roles to servers, so that hardware and + software can be configured according to the role. +* `GENESIS-19 <https://jira.opnfv.org/browse/GENESIS-19>`_: Deployment tool to provide for automatic device discovery. -* `Jira GENESIS-25 <https://jira.opnfv.org/browse/GENESIS-25`_: +* `GENESIS-25 <https://jira.opnfv.org/browse/GENESIS-25>`_: Installers should configure NTP servers on the servers for clock synchronization. +* `GENESIS-40 <https://jira.opnfv.org/browse/GENESIS-40>`_: + Hardware replacement. Requirements pertaining to the qualities of the deployment process ------------------------------------------------------------------ -* `Jira GENESIS-31 <https://jira.opnfv.org/browse/GENESIS-31>`_: Installers to be agnostic to - type of hard drives used +* `GENESIS-74 <https://jira.opnfv.org/browse/GENESIS-74>`_: + Installers which create a build for Brahmaputra, should create + the build as an "all-in-one" build. The the build process of + the installer creates a single entity (e.g. ISO) - which has + all the artifacts considered and required by all the projects + for Brahmaputra packaged in. Or in other terms and as an example: + If there are 4 different versions of OVS - all these 4 versions + would be contained in the "all in one build". + Note: This requirement only applies to installers which support + a "build" phase (i.e. create a bootable image, like an iso-image + from the different artifacts required). +* `GENESIS-31 <https://jira.opnfv.org/browse/GENESIS-31>`_: + Installers to be agnostic to type of hard drives used. Security related requirements ----------------------------- -.. Please add the Jira story reference to each requirement. - Note that the below listed "GENESIS-3" Jira stories are place holders - and are to be changed for the actual Jira reference. -* `Jira GENESIS-3 <https://jira.opnfv.org/browse/GENESIS-3>`_: new requirement... -* `Jira GENESIS-23 <https://jira.opnfv.org/browse/GENESIS-23>`_: Enable Mandatory Access Control by default. Installer should enable MAC either using SElinux or AppArmour. -* `Jira GENESIS-24 <https://jira.opnfv.org/browse/GENESIS-24>`_: Installers should install ssh keys on servers so that key-based login can be used for administration +* `GENESIS-23 <https://jira.opnfv.org/browse/GENESIS-23>`_: + Installers should enable Mandatory Access Control by default. + Installers should enable MAC either using SElinux or AppArmour. +* `GENESIS-24 <https://jira.opnfv.org/browse/GENESIS-24>`_: + Installers should install ssh keys on servers so that key-based login + can be used for administration. Testing related requirements ---------------------------- -.. Please add the Jira story reference to each requirement. - Note that the below listed "GENESIS-3" Jira stories are place holders - and are to be changed for the actual Jira reference. - -* `Jira GENESIS-3 <https://jira.opnfv.org/browse/GENESIS-3>`_: new requirement... +.. Please add the story reference to each requirement. Installation method related requirements ---------------------------------------- -* `Jira GENESIS-39 <https://jira.opnfv.org/browse/GENESIS-39>`_: Ability to install with upstream - artifacts. -* `Jira GENESIS-38 <https://jira.opnfv.org/browse/GENESIS-38>`_: Installers should supply a script or set of scripts ("deploy.sh") to automatically install the jumphost (from there, the entire OPNFV system is automatically installed). +* `GENESIS-39 <https://jira.opnfv.org/browse/GENESIS-39>`_: + Ability to install with upstream artifacts. + +* `GENESIS-38 <https://jira.opnfv.org/browse/GENESIS-38>`_: + Installers should supply a script or set of scripts ("deploy.sh") to + automatically install the jumphost (from there, the + entire OPNFV system is automatically installed). + +* `GENESIS-42 <https://jira.opnfv.org/browse/GENESIS-42>`_: + Installers should support offline deployment. Jump host may have + Internet access, but the installers should support offline + installation on target hosts during the deployment phase (either + manually or automatically). Documentation related requirements ---------------------------------- -.. Please add the Jira story reference to each requirement. - Note that the below listed "GENESIS-3" Jira stories are place holders - and are to be changed for the actual Jira reference. -* `Jira GENESIS-3 <https://jira.opnfv.org/browse/GENESIS-3>`_: new requirement... +* `GENESIS-34 <https://jira.opnfv.org/browse/GENESIS-34>`_: + Installers should provide a user guide. + +* `GENESIS-35 <https://jira.opnfv.org/browse/GENESIS-35>`_: + Installers should provide release notes for an OPNFV release as part of + the documentation provided. + |