From ac5b3315a20bad9a5a86740254cf6798c1b02456 Mon Sep 17 00:00:00 2001 From: Frank Brockners Date: Thu, 21 Jan 2016 03:25:16 -0800 Subject: Editorial updates to requirements docs Updates to system-requirements and ux-requirements docs. - Fixed formatting - Fixed broken links - Moved documentation requirements from system-req document to ux-req document - Fixed (some) grammar Note that non editorial fixes (e.g. removal for certain requirements no longer apply to Brahmaputra are handled in other patches). This patch is a replica of 7435 which got abandoned due to merge issues. Change-Id: Ibb914f523a7719f8240d4a690cd645f44500108e Signed-off-by: Frank Brockners --- docs/sources/system-requirements.rst | 52 ++++++------- docs/sources/ux-requirements.rst | 141 ++++++++++++++++++----------------- 2 files changed, 92 insertions(+), 101 deletions(-) diff --git a/docs/sources/system-requirements.rst b/docs/sources/system-requirements.rst index bbf916a..ca7af03 100644 --- a/docs/sources/system-requirements.rst +++ b/docs/sources/system-requirements.rst @@ -24,59 +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 `_: Installers support either Centos 7 or -Ubuntu 14.04 as target system base OS + +* `GENESIS-4 `_: + Installers should support either Centos 7 or Ubuntu 14.04 + as target system base OS. Components/features installed for OpenStack: ============================================ -`GENESIS-53 `_: OpenStack Heat should be installed. +* `GENESIS-53 `_: + OpenStack Heat should be installed. Minimum base OpenStack distribution supported: ============================================== -`GENESIS-7 `_: Installers must support OpenStack Liberty -release + +* `GENESIS-7 `_: + Installers should support OpenStack Liberty release. SDN Controller: =============== -`GENESIS-6 `_: Installers support -OpenDaylight Lithium Release - -`GENESIS-49 `_: Installers support for ONOSFW +* `GENESIS-6 `_: + Installers should support OpenDaylight Lithium Release. +* `GENESIS-49 `_: + Installers should support ONOSFW. VM Controller: ============== Hypervisor: =========== -`GENESIS-8 `_: KVM Support + +* `GENESIS-8 `_: + Installers should support KVM hypervisor. Virtual forwarder: ================== - - -Installer Documentation: -======================== - -`GENESIS-34 `_: new requirement... -* `Jira 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 `_: + 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 `_: new requirement +* `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,65 +45,65 @@ High availability requirements Network setup and configuration related requirements ---------------------------------------------------- -* `Jira GENESIS-20 `_: Automatically populate - discovered servers into install tool (reduce user-intervention to a minimum). +* `GENESIS-20 `_: + Automatically populate discovered servers into install + tool (reduce user-intervention to a minimum). -* `Jira 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-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-43 `_: Neutron DHCP servers should - be configured in HA per tenant +* `GENESIS-43 `_: + Neutron DHCP servers should be configured in HA per tenant. -* `Jira GENESIS-44 `_: SDN Controller Layer 3 forwarding support +* `GENESIS-44 `_: + SDN Controller layer 3 forwarding support. -* `Jira GENESIS-61 `_: Supported Layer 1/2 Networking - Configurations +* `GENESIS-61 `_: + Support layer 1/2 networking configuration. -* `Jira GENESIS-62 `_: Supported Logical Networks for - Target System +* `GENESIS-62 `_: + Support logical networks for target system. -* `Jira GENESIS-72 `_: + Support L3-neutron agent as an option for L3. -* `Jira 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 `_: new requirement... -* `Jira GENESIS-12 `_: Installers should track/control - all versions of all components pulled from external sources (user should be able to identify +* `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 `_: new requirement... -* `Jira GENESIS-16 `_: Common ability to input site, - topology, and server information. -* `Jira GENESIS-17 `_: User-configurable parameters - available via config files. -* `Jira GENESIS-18 `_: Allow assignment of different roles - to servers, so that hardware and software can be configured according to the role. -* `Jira GENESIS-19 `_: +.. Please add the story reference to each requirement. + +* `GENESIS-16 `_: + Common ability to input site, topology, and server information. +* `GENESIS-17 `_: + User-configurable parameters available via config files. +* `GENESIS-18 `_: + Allow assignment of different roles to servers, so that hardware and + software can be configured according to the role. +* `GENESIS-19 `_: Deployment tool to provide for automatic device discovery. -* `Jira GENESIS-25 `_: Installers should configure NTP servers on the servers for clock synchronization. -* `Jira GENESIS-40 `_: Hardware replacement +* `GENESIS-40 `_: + Hardware replacement. Requirements pertaining to the qualities of the deployment process ------------------------------------------------------------------ -* `Jira GENESIS-74 `_: +* `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 @@ -118,43 +114,48 @@ Requirements pertaining to the qualities of the deployment process 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). -* `Jira GENESIS-31 `_: Installers to be agnostic to - type of hard drives used +* `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 `_: new requirement... -* `Jira GENESIS-23 `_: Enable Mandatory Access Control by default. Installer should enable MAC either using SElinux or AppArmour. -* `Jira GENESIS-24 `_: Installers should install ssh keys on servers so that key-based login can be used for administration +* `GENESIS-23 `_: + Installers should enable Mandatory Access Control by default. + Installers should enable MAC either using SElinux or AppArmour. +* `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 `_: new requirement... +.. Please add the story reference to each requirement. Installation method related requirements ---------------------------------------- -* `Jira GENESIS-39 `_: Ability to install with upstream - artifacts. +* `GENESIS-39 `_: + Ability to install with upstream artifacts. -* `Jira 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). - -* `Jira GENESIS-42 `: Requirement: Support deployment offline. Jump host may have Internet access, but the installers should support offline installation on target hosts during the deployment phase. (either manual or automatic) +* `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 `_: + 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 `_: new requirement... +* `GENESIS-34 `_: + Installers should provide a user guide. + +* `GENESIS-35 `_: + Installers should provide release notes for an OPNFV release as part of + the documentation provided. + -- cgit 1.2.3-korg