summaryrefslogtreecommitdiffstats
path: root/docs/sources/ux-requirements.rst
AgeCommit message (Collapse)AuthorFilesLines
2016-02-21Adding new structure for the genesis requirements doc.ChristopherPrice1-147/+0
Also aligned heading levels for readability. Change-Id: I1e673637c044dc84201e922c9d8b4e3142a2ad27 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-02-10License information updateFrank Brockners1-17/+3
OPNFV documentation is licensed under Creative Commons Attribution 4.0 International License. This patch updates the documents in the genesisreq repository to reflect license information appropriately. Change-Id: I54011bec422591853db8b3be99860c1b080cbccd Signed-off-by: Frank Brockners <fbrockne@cisco.com>
2016-01-21Editorial updates to requirements docsFrank Brockners1-70/+71
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 <fbrockne@cisco.com>
2015-12-23Merge "Requirement: SDN Controller Layer 3 forwarding support"Tim Rozet1-0/+2
2015-12-18Merge "Requirement: "All-in-one" build for Brahmaputra"Frank Brockners1-0/+11
2015-12-16Hardware replacementWei Shao1-0/+1
It must be possible to de-comision and re-commision hardware to an existing OPNFV deployment. This is among other things needed when replacing faulty hardware. JIRA: GENESIS-40 Change-Id: Ieeec061de5f315fcb00e73d66bfaa3fd0a49e118 Signed-off-by: Wei Shao <weidong.shao@huawei.com>
2015-12-16Merge "Add GENESIS-42 for support of offline deployment"Weidong Shao1-0/+4
2015-12-16Merge "Requirement: Provide isolated compute node resources for CEPH OSD"Wei Shao1-0/+3
2015-12-09Requirement: "All-in-one" build for BrahmaputraFrank Brockners1-0/+11
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). JIRA: GENESIS-74 Change-Id: Ia6f126ae8a062c8e3158b65835a9ae2429cba321 Signed-off-by: Frank Brockners <fbrockne@cisco.com>
2015-12-07Requirement: SDN Controller Layer 3 forwarding supportTim Rozet1-0/+2
This is a proposal to require Installers to support the ability to enable L3 routing functionality in the SDN Controller (where possible). Some SDN controllers may not support this functionality, in which case it is acceptable to use Neutron L3 agent. OpenDaylight also supports distributed virtual routing (DVR). This requirement also proposes that Installers should be capable of enabling DVR on SDN controllers which support DVR. JIRA: GENESIS-44 Change-Id: Ib0e585f05cc75d30b198863bba342e2062ca255e Signed-off-by: Tim Rozet <trozet@redhat.com>
2015-12-07Merge "Requirement: Ability to install with upstream artifacts"Tim Rozet1-5/+2
2015-12-07Merge "Requirement: Installers to be agnostic to type of hard drives used"Tim Rozet1-4/+2
2015-12-07Merge "User-configurable parameters available via config files"Tim Rozet1-0/+2
2015-12-07Requirement: Supported Layer 1/2 Networking ConfigurationsTim Rozet1-0/+3
Installers should support multiple kinds of network configurations for deployments. These shall include the following: 1) Multiple VLANs (untagged and tagged links) 2) NIC Bonding/Etherchannel 3) Multiple NICs These types may also be in combination with one another. For example, if a deployment uses 4 logical broadcast domains (VLANs) it may be split into 4 sub-interfaces on a single interface, which is then mapped to a bonded link consisting of 2 links. JIRA: GENESIS-61 Change-Id: Id30cfe1c01c3b82d94aaf454d6496180c29732e9 Signed-off-by: Tim Rozet <trozet@redhat.com>
2015-12-07Requirement: Supported Logical Networks for Target SystemTim Rozet1-0/+3
Installers must support being able to separate network traffic for OpenStack + SDN controllers into these logical networks: 1) Admin network - used by OpenStack for Admin user traffic 2) Private network- used by OpenStack for inter-component traffic 3) Public network- user + internet access. References OpenStack public network. 4) Storage network - for storage related traffic only OpenStack is configurable in that it allows its components to be bound to specific networks. Installers should also support configuring OpenStack this way, and separating components/traffic across these logical networks. For example, keystone admin endpoint should only be available on the Admin network. Access to keystone admin endpoint on Public network would not be allowed. Note: This requirement does not restrict installers from deploying other types of logical network configurations such as combining all traffic into a single logical network, or combining some logical networks into one. The requirement simply states that the 4 listed above must be supported and the default option. An optional 5th network for lights out management (IPMI access) is also typically used (especially with baremetal deployments), but it is beyond the scope of this requirement (logical OpenStack networks), and it's network definition/configuration should be defined by the environment/POD being used. JIRA: GENESIS-62 Change-Id: I3942bba91f0831a1f8088fa75968d23aa968eebe Signed-off-by: Tim Rozet <trozet@redhat.com>
2015-12-07Add GENESIS-42 for support of offline deploymentWeidong Shao1-0/+4
JIRA: GENESIS-42 Change-Id: I86fa60f39b97d33c6ba2c28ec952e85d6b826cf8 Signed-off-by: Weidong Shao <weidong.shao@huawei.com>
2015-12-07Requirement: Installers to be agnostic to type of hard drives usedTim Rozet1-4/+2
Installer should be agnostic to the type of hard-drive the servers boot from (spinning disks, SSD, …) as long as those types are supported by drivers found in the supported linux versions for B release. JIRA: GENESIS-31 Change-Id: Ib1e224aedaf63f1606b6e9a22a859fb0e5e09825 Signed-off-by: Tim Rozet <trozet@redhat.com>
2015-12-07Merge "Support L3-neutron agent as an option for L3"Wei Shao1-0/+3
2015-12-02Merge "Added JIRA GENESIS-38 Requirement: Script to install jumphost"Frank Brockners1-0/+2
2015-12-02Merge "Added Jira requirement GENESIS-23 Enable Mandatory Access Control by ↵Frank Brockners1-1/+1
default"
2015-12-01Requirement: Provide isolated compute node resources for CEPH OSDWei Shao1-0/+3
Installers should provide for having Compute nodes taking part as Ceph storage nodes (OSD), and reliably provide isolated resources for this role JIRA: GENESIS-69 Change-Id: Ia7669983c99eb7bcf5646b57d62fd12bd143d370 Signed-off-by: Wei Shao <weidong.shao@huawei.com>
2015-12-01Support L3-neutron agent as an option for L3Wei Shao1-0/+3
Because ODL Lithium doesn't support IPv6 in ODL-L3, in order to set up IPv6 in integrated OS+ODL environment, we need to use neutron-l3-agent instead of odl-l3, and ODL will be used only for L2 connectivity. See our gap analysis https://wiki.opnfv.org/ipv6_opnfv_project/ipv6_gap_odl. Therefore we have created this JIRA issue "Support L3-neutron agent as an option for L3 for setting up". JIRA: GENESIS-72 Change-Id: I86d7cdf6b8a802a5766f57fe33e9c8b4b7916b78 Signed-off-by: Wei Shao <weidong.shao@huawei.com>
2015-12-01Merge "Installer should configure NTP server for clock synchronization."Weidong Shao1-1/+3
2015-11-30Requirement: Ability to install with upstream artifactsTim Rozet1-5/+2
Installers should support deployment of OPNFV using artifacts (source code, packages, etc) from 3rd-party repos (vendor specific distros and trunk versions). For example, if an OPNFV project required a specific version of OVS (and provided the compatible artifact) to be installed, an installer would be able to point directly to that artifact and build/deploy with it. JIRA: GENESIS-39 Change-Id: Iea8eddf36b03c124f7fb048f4c301179b2697b59 Signed-off-by: Tim Rozet <trozet@redhat.com>
2015-11-30User-configurable parameters available via config filesTim Rozet1-0/+2
User-configurable parameters available via config.yaml files - with all defaults shown. Exact parameters and formats for these configuration files are outside the scope of this requirement (and TBD by Genesis team). The requirement is simply to be able to support parsing these yaml config files as inputs to all installers. JIRA: GENESIS-17 Change-Id: Id484d59205ce6b423329cfa0a86b7d6d22c04dba Signed-off-by: Tim Rozet <trozet@redhat.com>
2015-11-18Requirement: Neutron DHCP servers in HATim Rozet1-9/+7
We currently have most openstack services in HA, including neutron-dhcp-agent service. Meaning that there are multiple neutron-dhcp-agent processes running on the controllers. One of those is selected when there is a request to create a dhcp server namespace. A single dhcp server will be created for that tenant. This issue is created as a proposal for requiring OPNFV Target System to enable multiple dhcp servers per tenant in HA, so that a tenant would have multiple dhcp servers in HA in case one goes down. JIRA: GENESIS-43 Change-Id: I1386c790834c0924ec90eb505d14ca7c8449f408 Signed-off-by: Tim Rozet <trozet@redhat.com>
2015-11-16Installer should configure NTP server for clock synchronization.Weidong Shao1-1/+3
JIRA: GENESIS-25 Change-Id: I9d97df251e5942cfa4a77af85aa45631ec836325 Signed-off-by: Weidong Shao <weidong.shao@huawei.com>
2015-11-11Added Jira requirement GENESIS-23 Enable Mandatory Access Control by defaultNarinder Gupta1-1/+1
JIRA: GENESIS-23 Change-Id: Ic39bef4daa6dc80a2c00bc0f0ddf9f26b46da333 Signed-off-by: Narinder Gupta <narinder.gupta@canonical.com>
2015-11-10Added JIRA GENESIS-38 Requirement: Script to install jumphostDavid Duffey1-0/+2
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) Change-Id: Ie564897469a152f11a91b07339972d5e8c50f284 JIRA: GENESIS-38
2015-11-10Common ability to input site, topology, and server informationTim Rozet1-5/+11
UX Requirement. Also fixes various line length issues JIRA: GENESIS-16 Change-Id: I071a4571b922b526abc8325c430b4b933f08d3c5 Signed-off-by: Tim Rozet <trozet@redhat.com>
2015-11-10Added Jira Requirement GENESIS-28 for voting.Jonas Bjurel1-0/+3
Slogan: 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. Change-Id: Ieab5adeb9938c99387527eeed3dfac1931890bf1 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2015-11-10Added Jira requirement Genesis-71 for votingJonas Bjurel1-0/+7
Description: 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 node cluster. JIRA: GENESIS-71 Change-Id: Ie716504ff58208394545e2ee47f347fb6dc3d53f Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2015-11-10Added Jira ticket GENESIS-24 for voting:Jonas Bjurel1-0/+2
URL: https://jira.opnfv.org/browse/GENESIS-24 Description: Installers should install ssh keys on servers so that key-based login can be used for administration Change-Id: I7e04a09727f30c477332f870e43629943c4c0169 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2015-10-29Adding Jira requirement GENESIS-20 for votingJonas Bjurel1-0/+2
URL: https://jira.opnfv.org/browse/GENESIS-20 Description: Automatically populate discovered servers into install tool (reduce user-intervention to a minimum). Change-Id: I45d6291f5922ebfe81d7258943692b4786ee0326 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2015-10-29Added Jira requirement GENESIS-19 for votingJonas Bjurel1-0/+5
Change-Id: Iacd33bb2b41158931242efb24d7762261170f034 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2015-10-16Added Jira requirement GENESIS-18 for votingJonas Bjurel1-0/+1
URL: https://jira.opnfv.org/browse/GENESIS-18 Description: Allow assignment of different roles to servers, so that hardware and software can be configured according to the role. Change-Id: I769391dc3e82492439141b0d9fd9fdf9c29c7bb6 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2015-10-16Added Jira requirement GENESIS-12 for votingJonas Bjurel1-0/+1
URL: https://jira.opnfv.org/browse/GENESIS-12 Description: Add a new requirement (UX / Versioning): 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) Change-Id: I39884c4b26e32800f145c1b8013491019521de48 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2015-10-12Added Jira requirement GENESIS-9 for votingJonas Bjurel1-1/+1
URL: https://jira.opnfv.org/browse/GENESIS-9 Description: Add a requirement: 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. Change-Id: I56c5e905bb27c19b4b25e9cd796c03ec10b5caa3 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2015-08-25Base templates and directory structure for GenesisFrank Brockners1-0/+104
Base templates to articulate requirements which are common and are to be followed by all installers participating in Genesis. Template provided: * Requirements for common system components * Requirements for a common user experience In additon, a high level directory structure is put in place - to allow for later easy migration of current BGS/Genesis common files. Change-Id: I219246ee33eefe3a5b1cec421223d00745f0f910 Signed-off-by: Frank Brockners <fbrockne@cisco.com>