UX requirements

Release: OPNFV Brahmaputra

Requirements for a common user-experience created by the deployment tools.

High availability requirements

• 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.
• 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 node cluster.

Network setup and configuration related requirements

• GENESIS-20: Automatically populate discovered servers into install tool (reduce user-intervention to a minimum).
• 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: Neutron DHCP servers should be configured in HA per tenant.
• GENESIS-44: SDN Controller layer 3 forwarding support.
• GENESIS-61: Support layer 1/2 networking configuration.
• GENESIS-62: Support logical networks for target system.
• GENESIS-72: Support L3-neutron agent as an option for L3.
• GENESIS-69: Provide isolated compute node resources for CEPH OSD.

Versioning requirements

• 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

• 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.
• GENESIS-25: Installers should configure NTP servers on the servers for clock synchronization.
• GENESIS-40: Hardware replacement.

Requirements pertaining to the qualities of the deployment process

• 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: Installers to be agnostic to type of hard drives used.

Security related requirements

• 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

Installation method related requirements

• GENESIS-39: Ability to install with upstream artifacts.
• 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

• 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.