diff options
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/abstract.rst | 16 | ||||
| -rw-r--r-- | docs/userguide/common.platform.render.rst | 26 | ||||
| -rw-r--r-- | docs/userguide/feature.userguide.render.rst | 15 | ||||
| -rw-r--r-- | docs/userguide/feature.userguide.template.rst | 12 | ||||
| -rw-r--r-- | docs/userguide/index.rst | 11 | ||||
| -rw-r--r-- | docs/userguide/introduction.rst | 65 | ||||
| -rw-r--r-- | docs/userguide/onos.rst | 51 | ||||
| -rw-r--r-- | docs/userguide/opendaylight.rst | 55 | ||||
| -rw-r--r-- | docs/userguide/openstack.rst | 50 | ||||
| -rw-r--r-- | docs/userguide/userguide.introduction.rst | 58 |
10 files changed, 59 insertions, 300 deletions
diff --git a/docs/userguide/abstract.rst b/docs/userguide/abstract.rst deleted file mode 100644 index fa9b73669..000000000 --- a/docs/userguide/abstract.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - -======== -Abstract -======== - -OPNFV is a collaborative project aimed at providing a variety of virtualisation -deployments intended to host applications serving the networking and carrier industry. -This document provides guidance and instructions for using platform features designed -to support these applications, made available in the Brahmaputra release of OPNFV. - -This document is not intended to replace or replicate documentation from other open -source projects such as OpenStack or OpenDaylight, rather highlight the features and -capabilities delivered through the OPNFV project. diff --git a/docs/userguide/common.platform.render.rst b/docs/userguide/common.platform.render.rst deleted file mode 100644 index 1235c8f77..000000000 --- a/docs/userguide/common.platform.render.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - -================================ -Using common platform components -================================ - -This section outlines basic usage principals and methods for some of the commonly deployed -components of supported OPNFV scenario's in Brahmaputra. -The subsections provide an outline of how these components are commonly used and how to address them -in an OPNFV deployment. The components derive from autonomous upstream communities and where possible -this guide will provide direction to the relevant documentation made available by those communities -to better help you navigate the OPNFV deployment. - -Common VIM components -===================== - -.. include:: ./openstack.rst - -Common SDN components -===================== - -.. include:: ./opendaylight.rst -.. include:: ./onos.rst - diff --git a/docs/userguide/feature.userguide.render.rst b/docs/userguide/feature.userguide.render.rst deleted file mode 100644 index fa1186dc6..000000000 --- a/docs/userguide/feature.userguide.render.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - -========================== -Using Brahmaputra Features -========================== - -The following sections of the user guide provide feature specific usage guidelines and references. -Providing users the necessary information to leveraging the features in the platform, -some operation in this section may refer back to the guides in the general system usage section. - -.. <project>/docs/userguide/featureusage.rst files will be imported below by the build script. - - diff --git a/docs/userguide/feature.userguide.template.rst b/docs/userguide/feature.userguide.template.rst deleted file mode 100644 index f133134df..000000000 --- a/docs/userguide/feature.userguide.template.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) <optionally add copywriters name> - -<Feature> capabilities and usage -================================ -Describe the specific capabilities and usage for <XYZ> feature. - -<Feature and API usage guidelines and example> ------------------------------------------------ -Describe with examples how to use specfic features. - diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index c5c369333..baa4ae072 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -5,18 +5,9 @@ **************** OPNFV User Guide **************** -Colorado 1.0 ------------- .. toctree:: :maxdepth: 2 - ./abstract.rst - ./introduction.rst - ./common.platform.render.rst - ./onos.rst - ./opendaylight.rst - ./openstack.rst - ./feature.userguide.render.rst - ./feature.userguide.template.rst + ./userguide.introduction.rst diff --git a/docs/userguide/introduction.rst b/docs/userguide/introduction.rst deleted file mode 100644 index c702d47bc..000000000 --- a/docs/userguide/introduction.rst +++ /dev/null @@ -1,65 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - -======== -Overview -======== - -OPNFV provides a variety of virtual infrastructure deployments designed to -host virtualised network functions (VNFs). This guide intends to help users of -the platform leverage the features and capabilities delivered by the OPNFV project. - -OPNFV Continuous Integration builds, deploys and tests combinations of virtual -infrastructure components in what are defined as scenarios. A scenario may include -components such as OpenStack, OpenDaylight, OVS, KVM etc. where each scenario will -include different source components or configurations. Scenarios are designed to -enable specific features and capabilities in the platform that can be leveraged by the -OPNFV user community. - -OPNFV Features -============== - -Each OPNFV scenario provides unique features and capabilities, it is important to -ensure you have a scenario deployed on your infrastructure that provides the right capabilities -for your needs before working through the user guide. - -This user guide outlines how to work with key components and features in the platform, -each feature description section will indicate the scenarios that provide the components -and configurations required to use it. - -.. include:: ../scenario/featurematrix.rst - -For details on which scenarios are best for you and how to install and configure them -on your infrastructure the -`OPNFV Configuration Guide <http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/configguide/index.html>`_ -provides a valuable reference. - -The user guide will describe how to enable and utilise features and use cases implemented and -tested on deployed OPNFV scenarios. For details of the use cases and tests that have been run -you should check the validation procedures section of the -`OPNFV Configuration Guide <http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/configguide/post-install.html>`_. -This will provide information about the specific use cases that have been validated and are working on your deployment. - -General usage guidelines -======================== - -The user guide for OPNFV features and capabilities provide step by step instructions -for using features that have been configured according to the installation and configuration -instructions. - -This guide is structured in a manner that will provide usage instructions for each feature in its own -section. Start by identifying the feature capability you would like to leverage, then read through -the relevant user guide section to understand how to work with the feature. -The combination of platform features, if available in a given scenario and not otherwise indicated, -should operate according to the documentation. -Dependencies between features will be highlighted in the user guide text. - -You may wish to use the platform in a manner that the development teams have not foreseen, or -exercise capabilities not fully validated on the platform. If you experience issues leveraging the -platform for the uses you have envisioned, the `OPNFV user mailing list <"mailto:opnfv-user@lists.opnfv.org">`_ -provides a mechanism to establish a dialog with the community to help you overcome any issues identified. - -It may be that you have identified a bug in the system, or that you are trying to execute a use case -that has not yet been implemented. In either case it is important for OPNFV to learn about it as we are in -essence a development project looking to ensure the required capabilities for our users are available. diff --git a/docs/userguide/onos.rst b/docs/userguide/onos.rst deleted file mode 100644 index 0535c3e97..000000000 --- a/docs/userguide/onos.rst +++ /dev/null @@ -1,51 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - ---------------- -ONOS User Guide ---------------- - -ONOS is an SDN controller platform developed and released by the -`ONOS project <https://www.onosproject.org>`_. -The ONOS controller is installed and configured in OPNFV as the networking -component of a variety of OPNFV NFVI scenarios. - -ONOS runs within a JVM instance and is integrated with OpenStack via a Neutron ML2 -plugin. The ONOS instance can be configured through the OpenStack Neutron interface, -or through native ONOS tools from the OPNFV jumphost. The Brahmaputra release of -OPNFV integrates the latest -`ONOS 1.4 (EMU) <https://wiki.onosproject.org/display/ONOS/Download+packages+and+tutorial+VMs>`_ -release version. - -ONOS references ---------------- - -For an overview of the ONOS controller, please see -`User Guide <https://wiki.onosproject.org/display/ONOS/User's+Guide>`_. For more detailed information -about the EMU version of ONOS, documentation is available on the -`ONOS download page <https://wiki.onosproject.org/display/ONOS/Download+packages+and+tutorial+VMs>`_. - -Connecting to the ONOS instance -------------------------------- - -Once you are familiar with the ONOS controller and its configuration -you will want to connect to the ONOS instance from the Jumphost. -To do this you should open a browser on the JumpHost to the following address -and enter the username and password: - - http://{Controller-VIP}:8282/index.html> - username: karaf - password: karaf - -Other methods of interacting with and configuring the controller, like the REST API -and CLI are also available in the Brahmaputra deployment, see the -`ONOS User Guide <https://wiki.onosproject.org/display/ONOS/User's+Guide>`_ -for more information on using those interfaces. - -It is important to be aware that when working directly on the ONOS controller -the OpenStack instance will not always be aware of the changes you are making to the -networking controller. This may result in unrecoverable inconsistencies in your deployment. - -If you have any questions or need further assistance, you may also direct your queries to -`ONOSFW Forum <http://forum.onosfw.com>` diff --git a/docs/userguide/opendaylight.rst b/docs/userguide/opendaylight.rst deleted file mode 100644 index 4df09d03a..000000000 --- a/docs/userguide/opendaylight.rst +++ /dev/null @@ -1,55 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - ------------------------ -OpenDaylight User Guide ------------------------ - -OpenDaylight is an SDN controller platform developed and released by the -`OpenDaylight project <https://www.opendaylight.org/>`_. -The OpenDaylight controller is installed and configured in OPNFV as the networking -component of a variety of OPNFV NVFi scenarios using the neutron ODL device driver -as an integration point toward OpenStack. - -OpenDaylight runs within a JVM and is installed in OPNFV within a container and -integrated with OpenStack. The OpenDaylight instance can be configured through the -OpenStack Horizon interface, or accessed directly from the OPNFV Jumphost. The -Brahmaputra release of OPNFV integrates the latest -`Beryllium release <https://www.opendaylight.org/downloads/>`_. - -OpenDaylight references ------------------------ - -For an overview of the OpenDaylight controller a good reference is the -`Getting Started Guide <http://go.linuxfoundation.org/l/6342/2015-06-28/2l76qt/6342/128122/bk_getting_started_guide_20150629.pdf>`_. For more detailed information -about using the platform the `OpenDaylight User Guide <http://go.linuxfoundation.org/l/6342/2015-06-28/2l76qw/6342/128126/bk_user_guide_20150629.pdf>`_ -provides a good feature by feature reference. - -It is important when working on your Brahmaputra deployment to be aware of the -configured state of the OpenDaylight controller in the scenario you have deployed, -installing an SFC scenario will for instance configure the OpenDaylight controller -with the required SFC Karaf features in the OpenDaylight controller. Make sure you -read the installation and configuration guide carefully to understand the state -of the deployed system. - -Connecting to the OpenDaylight instance ---------------------------------------- - -Once you are familiar with the OpenDaylight controller and its configuration -you will want to connect to the OpenDaylight instance from the Jumphost. -To do this you should open a browser on the JumpHost to the following address -and enter the username and password: - - http://{Controller-VIP}:8181/index.html> - username: admin - password: admin - -Other methods of interacting with and configuring the controller, like the REST API -and CLI are also available in the Brahmaputra deployment, see the -`OpenDaylight User Guide <http://go.linuxfoundation.org/l/6342/2015-06-28/2l76qw/6342/128126/bk_user_guide_20150629.pdf>`_ -for more information on using those interfaces. - -It is important to be aware that when working directly on the OpenDaylight controller -the OpenStack instance will not always be aware of the changes you are making to the -networking controller. This may result in unrecoverable inconsistencies in your deployment. diff --git a/docs/userguide/openstack.rst b/docs/userguide/openstack.rst deleted file mode 100644 index 2b8255bcf..000000000 --- a/docs/userguide/openstack.rst +++ /dev/null @@ -1,50 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - --------------------------------- -Brahmaputra OpenStack User Guide --------------------------------- - -OpenStack is a cloud operating system developed and released by the -`OpenStack project <https://www.openstack.org>`_. OpenStack is used in OPNFV for -controlling pools of compute, storage, and networking resources in a Pharos -compliant infrastructure. - -OpenStack is used in Brahmaputra to manage tenants (known in OpenStack as projects), -users, services, images, flavours, and quotas across the Pharos infrastructure. -The OpenStack interface provides the primary interface for an operational Brahmaputra -deployment and it is from the "horizon console" that an OPNFV user will perform the -majority of administrative and operational activities on the deployment. - -OpenStack references --------------------- - -The `OpenStack user guide <http://docs.openstack.org/user-guide>`_ provides details -and descriptions of how to configure and interact with the OpenStack deployment. This -guide can be used by lab engineers and operators to tune the OpenStack deployment to -your liking. - -Once you have configured OpenStack to your purposes, or the Brahmaputra deployment meets -your needs as deployed, an operator, or administrator, will find the best guidance for -working with OpenStack in the -`OpenStack administration guide <http://docs.openstack.org/user-guide-admin>`_. - -Connecting to the OpenStack instance ------------------------------------- - -Once familiar with the basic of working with OpenStack you will want to connect to the -OpenStack instance via the Horizon Console. The Horizon console provide a Web based GUI -that will allow you operate the deployment. -To do this you should open a browser on the JumpHost to the following address -and enter the username and password: - - - http://{Controller-VIP}:80/index.html> - username: admin - password: admin - -Other methods of interacting with and configuring OpenStack,, like the REST API -and CLI are also available in the Brahmaputra deployment, see the -`OpenStack administration guide <http://docs.openstack.org/user-guide-admin>`_ -for more information on using those interfaces. diff --git a/docs/userguide/userguide.introduction.rst b/docs/userguide/userguide.introduction.rst new file mode 100644 index 000000000..1ab6b8442 --- /dev/null +++ b/docs/userguide/userguide.introduction.rst @@ -0,0 +1,58 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Sofia Wallin (sofia.wallin@ericssion.com) + +======== +Abstract +======== + +OPNFV is a collaborative project aimed at providing a variety of virtualization +deployments intended to host applications serving the networking and carrier +industry. This document provides guidance and instructions for using platform +features designed to support these applications, made available in the OPNFV +Colorado release. + +This document is not intended to replace or replicate documentation from other +open source projects such as OpenStack or OpenDaylight, rather highlight the +features and capabilities delivered through the OPNFV project. + +============ +Introduction +============ + +OPNFV provides a suite of scenarios, infrastructure depoyment options, which +are able to be installed to host virtualized network functions (VNFs). +This guide intends to help users of the platform leverage the features and +capabilities delivered by the OPNFV project in support of these applications. + +OPNFV Continuous Integration builds, deploys and tests combinations of virtual +infrastructure components in what are defined as scenarios. A scenario may +include components such as OpenStack, OpenDaylight, OVS, KVM etc. where each +scenario will include different source components or configurations. Scenarios +are designed to enable specific features and capabilities in the platform that +can be leveraged by the OPNFV user community. + +================ +Feature Overview +================ + +The following links outline the feature deliveries from the participant OPNFV +projects in the Colorado release. Each of the participating projects provides +detailed descriptions about the delivered features. Including use cases, +implementation and configuration specifics on a per OPNFV project basis. + +The following are User Guides and assume that the reader has already some +information about a given projects specifics and deliverables. These guides +are intended to be used following the installation of a given OPNFV installer +to allow a user to deploy and implement feature delivered by OPNFV. + +If you are unsure about the specifics of a given project, please refer to the +OPNFV projects home page, found on http://wiki.opnfv.org, for specific details. + +You can find project specific usage and configuration information below: + +- `IPv6 user guide <http://artifacts.opnfv.org/ipv6/colorado/docs/userguide/index.html>`_ +- `Multisite user guide <http://artifacts.opnfv.org/multisite/colorado/docs/userguide/index.html>`_ +- `Domino user guide <http://artifacts.opnfv.org/domino/colorado/docs/userguide.index.html>`_ +- `Moon user guide <http://artifacts.opnfv.org/moon/colorado/docs/userguide.html>`_ +- `SDNVPN user guide <http://artifacts.opnfv.org/sdnvpn/colorado/docs/userguide/index.html>`_ |