diff options
| -rw-r--r-- | common/README.md | 18 | ||||
| -rw-r--r-- | docs/sources/README.md | 17 | ||||
| -rw-r--r-- | docs/sources/system-requirements.rst | 63 | ||||
| -rw-r--r-- | docs/sources/ux-requirements.rst | 104 |
4 files changed, 202 insertions, 0 deletions
diff --git a/common/README.md b/common/README.md new file mode 100644 index 0000000..b988986 --- /dev/null +++ b/common/README.md @@ -0,0 +1,18 @@ +<!--- +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. +--> +# Common +This directory contains those files which are common across all deployment tools and as such are also used by all deployment tools (a.k.a. "installers"). + diff --git a/docs/sources/README.md b/docs/sources/README.md new file mode 100644 index 0000000..f88c3ce --- /dev/null +++ b/docs/sources/README.md @@ -0,0 +1,17 @@ +<!--- +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. +--> +# Requirements documents +This directory contains the sources for documents which list requirements which are common across all deployment tools and as such are also met by all deployment tools (a.k.a. "installers"). diff --git a/docs/sources/system-requirements.rst b/docs/sources/system-requirements.rst new file mode 100644 index 0000000..4b3cdf3 --- /dev/null +++ b/docs/sources/system-requirements.rst @@ -0,0 +1,63 @@ +.. 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. + +.. ----------------------------------------------------------------------- + +.. Document to list the requirements the target system a + particular installer creates. + Please add a bullet each for every requirement added. + +========================== +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. + +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. + +* `Jira GENESIS-1 <https://jira.opnfv.org/browse/GENESIS-1>`_: *new requirement*. + + +Software components +------------------- +.. Please add the Jira story to each requirement as reference. + +:Minimum base OS distribution supported: + + `Jira GENESIS-1 <https://jira.opnfv.org/browse/GENESIS-1>`_: Centos ...tbd... + + `Jira GENESIS-1 <https://jira.opnfv.org/browse/GENESIS-1>`_: Ubuntu ...tbd... + + +:SDN Controller: + + `Jira GENESIS-1 <https://jira.opnfv.org/browse/GENESIS-1>`_: OpenDaylight ...tbd... + +:VM Controller: + + `Jira GENESIS-1 <https://jira.opnfv.org/browse/GENESIS-1>`_: OpenStack ...tbd... + +:Hypervisor: + + `Jira GENESIS-1 <https://jira.opnfv.org/browse/GENESIS-1>`_: KVM version ...tbd... + +:Virtual forwarder: + + `Jira GENESIS-1 <https://jira.opnfv.org/browse/GENESIS-1>`_: Openvswitch version ...tbd... diff --git a/docs/sources/ux-requirements.rst b/docs/sources/ux-requirements.rst new file mode 100644 index 0000000..076ddcd --- /dev/null +++ b/docs/sources/ux-requirements.rst @@ -0,0 +1,104 @@ +.. 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. + +.. ----------------------------------------------------------------------- + +.. Document to list the requirements for a common user experience + created by the different installers. + Please add a bullet each for every requirement added. + +=============== +UX requirements +=============== + +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. + +* `Jira GENESIS-3 <https://jira.opnfv.org/browse/GENESIS-3>`_: new requirement... + + +Network setup and configuration related 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. + +* `Jira GENESIS-3 <https://jira.opnfv.org/browse/GENESIS-3>`_: new requirement... + + +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. + +* `Jira GENESIS-3 <https://jira.opnfv.org/browse/GENESIS-3>`_: new requirement... + +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... + +Requirements pertaining to the qualities of the deployment process +------------------------------------------------------------------ +.. 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... + +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... + +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... + +Installation method 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... + +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... + |