diff options
| author |   Sofia Wallin <sofia.wallin@ericsson.com> | 2016-08-15 15:20:50 +0200 |
|---|---|---|
| committer | Sofia Wallin <sofia.wallin@ericsson.com> | 2016-09-19 14:37:59 +0200 |
| commit | e042f556c6c25858f328cb6287c164b2514a2561 (patch) | |
| tree | 2e0a495f29d608e88602299116ea6c90cfabb9ce /docs | |
| parent | 15d5bdf0756bf3faa28558d4effd7611f1767146 (diff) | |
WIP: Created 2 introduction documents for user guide and installation
Work on the contant in both installation and user guide
Started to add artifacts in the installation instruction and user guide
This is a first draft of the installation.introduction.rst and userguide.introduction.rst.
Some of the information has been reused from the Brahmaputra docs with modifications.
Please comment and add as needed/wanted.
Change-Id: I0c6d79aac7d1152ec894986dda251ad2d3c7048e
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
Diffstat (limited to 'docs')
27 files changed, 148 insertions, 1165 deletions
diff --git a/docs/installationprocedure/abstract.rst b/docs/installationprocedure/abstract.rst deleted file mode 100644 index b9b85b0c0..000000000 --- a/docs/installationprocedure/abstract.rst +++ /dev/null @@ -1,7 +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> - -This document will give the user instructions on how to deploy -available scenarios verfied for the Colorado release of the OPNFV -platform. diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst deleted file mode 100644 index 267efd5c1..000000000 --- a/docs/installationprocedure/feature.configuration.rst +++ /dev/null @@ -1,21 +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> - -===================================================== -<scenario> installation and configuration instruction -===================================================== - -Abstract -======== -This document provides information on how to configure required -components during the installation of the platform. - -Pre-configuration activites -=========================== -List the information and activities needed as pre configuration. - -Feature configuration -===================== -List the steps needed for the configuration of <feature> and <components> of the scenario. - diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst index e69204b98..3d02f310b 100644 --- a/docs/installationprocedure/index.rst +++ b/docs/installationprocedure/index.rst @@ -2,17 +2,13 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Sofia Wallin Ericsson AB -********************** -Installation procedure -********************** -Colorado 1.0 ------------- +****************************** +OPNFV Installation Instruction +****************************** .. toctree:: :numbered: - :maxdepth: 2 + :maxdepth: 3 - abstract.rst - scenario.installation.instruction.rst - scenario.release.notes.rst + installation.introduction.rst diff --git a/docs/installationprocedure/installation.introduction.rst b/docs/installationprocedure/installation.introduction.rst new file mode 100644 index 000000000..ae4a601ae --- /dev/null +++ b/docs/installationprocedure/installation.introduction.rst @@ -0,0 +1,84 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + .. (c) Sofia Wallin Ericsson AB + +======== +Abstract +======== + +The following document provides an overview of the instructions required for the installation +of the Colorado release of OPNFV. + +The Colorado release can be installed using a variety of technologies provided by the +integration projects participating in OPNFV: Apex, Compass4Nfv, Fuel and JOID. +Each installer provides the ability to install a common OPNFV platform as well as integrating +additional features delivered through a variety of scenarios by the OPNFV community. + +============ +Introduction +============ + +The OPNFV platform is comprised of a variety of upstream components that may be deployed on your physical +infrastructure. A composition of components, tools and configurations is identified in OPNFV as a +deployment scenario. +The various OPNFV scenarios provide unique features and capabilities that you may want to leverage, +it is important to understand your required target platform capabilities before installing and +configuring your target scenario. + +An OPNFV installation requires either a physical, or virtual, infrastructure environment as defined +in the `Pharos specification <http://artifacts.opnfv.org/pharos/colorado/docs/specification/index.html>`_. +When configuring a physical infrastructure it is strongly advised to follow the Pharos configuration guidelines. + +========= +Scenarios +========= + +OPNFV scenarios are designed to host virtualised network functions (VNF’s) in a variety of deployment +architectures and locations. Each scenario provides specific capabilities and/or components aimed to +solve specific problems for the deployment of VNF’s. +A scenario may, for instance, include components such as OpenStack, OpenDaylight, OVS, KVM etc... +where each scenario will include different source components or configurations. + +To learn more about the scenarios supported in the Colorado release refer to the scenario +description documents provided: + +- Accelerated OVS `os-nosdn-ovs <http://artifacts.opnfv.org/ovsnfv/colorado/docs/scenarios_os-nosdn-ovs/index.html>`_ +- FD.io based forwarding `os-nosdn-fdio-noha <http://artifacts.opnfv.org/fds/docs/scenarios_os-nosdn-fdio-noha/index.html>`_ +- Layer 3 overlay using opendaylight `os-odl-l2-bgpvpn <http://artifacts.opnfv.org/bgpvpn/colorado/docs/scenarios_os-odl_l2-bgpvpn/index.html>`_ +- FD.io based forwarding using opendaylight SDN `os-odl-12-fdio-noha <http://artifacts.opnfv.org/fds/colorado/scenarios_os-odl_l2-fdio-noha/index.html>`_ +- High availability service function chaining `os-odl-l2-sfc-ha <http://artifacts.opnfv.org/sfc/colorado/docs/scenarios_os-odl_l2-sfc-ha/index.html>`_ +- Service function chaining `os-odl-l2-sfc-noha <http://artifacts.opnfv.org/sfc/colorado/docs/scenarios_os-odl_l2-sfc-noha/index.html>`_ +- `os-odl-l2-moon-ha <http://artifacts.opnfv.org/moon/colorado/docs/senarios/os-odl_l2-moon-ha/index.html>`_ + +====================== +Installation Procedure +====================== + +Detailed step by step instructions for working with an installation toolchain and installing +the required scenario are provided by each installation project. The four projects providing installation +support for the OPNFV Colorado release are; Apex, Compass4nfv, Fuel and Joid. + +The instructions for each toolchain can be found in these links: + +- `Apex installation instruction <http://artifacts.opnfv.org/apex/colorado/docs/installationprocedure/index.html>`_ +- `Compass4nfv installation instruction <http://artifacts.opnfv.org/compass4nfv/colorado/docs/installationprocedure/index.html>`_ +- `Fuel installation instruction <http://artifacts.opnfv.org/fuel/colorado/docs/installationprocedure/index.html>`_ +- `Joid installation instruction <http://artifacts.opnfv.org/joid/colorado/docs/installationprocedure/index.html>`_ + +===================== +OPNFV Test Frameworks +===================== + +If you have elected to install the OPNFV platform using the deployment toolchain provided by OPNFV +your system will have been validated once the installation is completed. +The basic deployment validation only addresses a small component of the capability provided in +the platform and you may desire to execute more exhaustive tests. Some investigation is required to +select the right test suites to run on your platform from the available projects and suites. + +Many of the OPNFV test project provide user-guide documentation and installation instructions as provided below: + +- `Functest user guide <http://artifacts.opnfv.org/functest/colorado/docs/userguide/index.html>`_ +- `Yardstick user guide <http://artifacts.opnfv.org/yardstick/colorado/docs/userguide/index.html>`_ +- `vSwitchPerf user guide <http://artifacts.opnfv.org/vswitchperf/colorado/index.html>`_ +- `Software Fastpath Service Quality Metrics (SFQM) user guide <http://artifacts.opnfv.org/fastpathmetrics/colorado/index.html>`_ +- `Bottlenecks user guide <http://artifacts.opnfv.org/bottlenecks/colorado/docs/installationprocedure/index.html>`_ diff --git a/docs/installationprocedure/scenario.installation.instruction.rst b/docs/installationprocedure/scenario.installation.instruction.rst deleted file mode 100644 index a3ddd3ac8..000000000 --- a/docs/installationprocedure/scenario.installation.instruction.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) <optionally add copywriters name> - -=================================== -<scenario> installation instruction -=================================== - -Preparing the installation --------------------------- -.. List the activities needed prior to installation and dependent feature configurations that -.. need to be is to be configured during this process. - -HW requirements ---------------- -.. A generic Pharos lab preparation instruction will be provided, this section should describe -.. scenario has any specific hardware or hardware configuration needs. - -Installation instruction ------------------------- -.. List of steps needed to install each verified installer. - -Post-installation activities ----------------------------- -.. List the activities needed post installation. - diff --git a/docs/installationprocedure/scenario.release.notes.rst b/docs/installationprocedure/scenario.release.notes.rst deleted file mode 100644 index eaffd9b19..000000000 --- a/docs/installationprocedure/scenario.release.notes.rst +++ /dev/null @@ -1,134 +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> - -=========================== -Release Note for <scenario> -=========================== -Colorado 1.0 ------------- - -.. toctree:: - :maxdepth: 2 - -Abstract -======== - -This document contains the release notes for the Colorado release of -OPNFV when using <scenario>. - -Introduction -============ - -Provide a breif introduction of how this configuration is used in OPNFV relese using <scenario> as scenario. - -Be sure to reference your scenario installation instruction. - -Release Data -============ - -+--------------------------------------+--------------------------------------+ -| **Project** | | -| | | -+--------------------------------------+--------------------------------------+ -| **Repo/tag** | | -| | | -+--------------------------------------+--------------------------------------+ -| **Release designation** | | -| | | -+--------------------------------------+--------------------------------------+ -| **Release date** | | -| | | -+--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | | -| | | -+--------------------------------------+--------------------------------------+ - -Deliverables ------------- - -Software deliverables -~~~~~~~~~~~~~~~~~~~~~ -<XYZ>-based installer iso file <iso file version> - -Documentation deliverables -~~~~~~~~~~~~~~~~~~~~~~~~~~ -- - -Version change --------------- -.. This section describes the changes made since the last version of this document. - -Module version change -~~~~~~~~~~~~~~~~~~~~~ - -Document version change -~~~~~~~~~~~~~~~~~~~~~~~ - -Reason for new version ----------------------- - -Feature additions -~~~~~~~~~~~~~~~~~ - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | | -| | | -+--------------------------------------+--------------------------------------+ - -Bug corrections -~~~~~~~~~~~~~~~ - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | | -| | | -+--------------------------------------+--------------------------------------+ - - -Known Limitations, Issues and Workarounds -========================================= - -System Limitations ------------------- - -Known issues ------------- - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | | -+--------------------------------------+--------------------------------------+ -| JIRA: | | -+--------------------------------------+--------------------------------------+ - - -Workarounds ------------ -See JIRA: <link> - - -Test Result -=========== -Brahmaputra test result using <XYZ> as deployment tool. -<link> - -References -========== -For more information on the OPNFV Brahmaputra release, please visit -http://www.opnfv.org/brahmaputra - diff --git a/docs/installationprocedure/template-os-nosdn-nofeature-ha/abstract.rst b/docs/installationprocedure/template-os-nosdn-nofeature-ha/abstract.rst deleted file mode 100644 index ae15012ca..000000000 --- a/docs/installationprocedure/template-os-nosdn-nofeature-ha/abstract.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) and others - -Abstract -======== -.. Provide a brief abstract of the document and what it provides, in this case a -.. vanilla opnfv deployment using fuel is provided as a template. This template is -.. not accurate and does not provide instructions to deploy a Colorado scenario. - -This document describes how to install the <template> scenario of the Colorado -release of OPNFV. - -The <template> scenario will use Fuel as a deployment tool, installing and deploying an OPNFV -based OpenStack in high availability on a Pharos compliant infrastructure. diff --git a/docs/installationprocedure/template-os-nosdn-nofeature-ha/deployment.rst b/docs/installationprocedure/template-os-nosdn-nofeature-ha/deployment.rst deleted file mode 100644 index 4a8852ee6..000000000 --- a/docs/installationprocedure/template-os-nosdn-nofeature-ha/deployment.rst +++ /dev/null @@ -1,32 +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) and others - - -Verify Networks ---------------- - -It is important that the Verify Networks action is performed as it will verify -that communicate works for the networks you have setup, as well as check that -packages needed for a successful deployment can be fetched. - -From the FUEL UI in your Environment, Select the Networks Tab and select "Connectivity check" on the left pane - - - Select <Verify Networks> - - - Continue to fix your topology (physical switch, etc) until the "Verification Succeeded" and "Your network is configured correctly" message is shown - -Deploy Your Environment ------------------------ - -Deploy the environment. - - - In the Fuel GUI, click on the "Dashboard" Tab. - - - Click on <Deploy Changes> in the "Ready to Deploy?" section - - - Examine any information notice that pops up and click <Deploy> - - Wait for your deployment to complete, you can view the "Dashboard" - Tab to see the progress and status of your deployment. - diff --git a/docs/installationprocedure/template-os-nosdn-nofeature-ha/hardware.requirements.rst b/docs/installationprocedure/template-os-nosdn-nofeature-ha/hardware.requirements.rst deleted file mode 100644 index 328f92199..000000000 --- a/docs/installationprocedure/template-os-nosdn-nofeature-ha/hardware.requirements.rst +++ /dev/null @@ -1,27 +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) and others - -Hardware requirements -===================== - -The Pharos Lab --------------- - -Hardware requirements for OPNFV infrastuctures are specified by the Pharos project. -The Pharos project provides an OPNFV hardware specification for configuring your hardware -at: http://artifacts.opnfv.org/pharos/docs/pharos-spec.html . - -Virtual deployment hardware requirements ----------------------------------------- - -To perform a virtual deployment of an OPNFV scenario establised different hardware requirements. -The server requirements for this type of deployment are outlined in the <missing spec>. - -.. Additional Hardware requirements -.. -------------------------------- -.. -.. Your scenario may require specific capabilities that are not explicitly stated in -.. the Pharos spec. If this is the case add your specific hardware requirements to this -.. section of the document under sub-headings. - diff --git a/docs/installationprocedure/template-os-nosdn-nofeature-ha/index.rst b/docs/installationprocedure/template-os-nosdn-nofeature-ha/index.rst deleted file mode 100644 index 0e24d435e..000000000 --- a/docs/installationprocedure/template-os-nosdn-nofeature-ha/index.rst +++ /dev/null @@ -1,24 +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 - -======================================================================================================== -OPNFV Installation instruction for the template-os-nosdn-nofeature-ha scenario -======================================================================================================== - -.. toctree:: - :numbered: - :maxdepth: 2 - - abstract.rst - introduction.rst - preparation.rst - hardware.requirements.rst - installation.rst - install.config.rst - install.optional.rst - deployment.rst - post.deploy.rst - references.rst - - diff --git a/docs/installationprocedure/template-os-nosdn-nofeature-ha/install.config.rst b/docs/installationprocedure/template-os-nosdn-nofeature-ha/install.config.rst deleted file mode 100644 index 17200d5c2..000000000 --- a/docs/installationprocedure/template-os-nosdn-nofeature-ha/install.config.rst +++ /dev/null @@ -1,156 +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) and others - -Configure the network environment ---------------------------------- - -#. Open the environment you previously created. - -#. Open the networks tab and select the "default Node Networks group to" on the left pane. - -#. Update the Public network configuration and change the following fields to appropriate values: - - - CIDR to <CIDR for Public IP Addresses> - - - IP Range Start to <Public IP Address start> - - - IP Range End to <Public IP Address end> - - - Gateway to <Gateway for Public IP Addresses> - - - Check <VLAN tagging>. - - - Set appropriate VLAN id. - -#. Update the Storage Network Configuration - - - Set CIDR to appropriate value (default 192.168.1.0/24) - - - Set IP Range Start to appropriate value (default 192.168.1.1) - - - Set IP Range End to appropriate value (default 192.168.1.254) - - - Set vlan to appropriate value (default 102) - -#. Update the Management network configuration. - - - Set CIDR to appropriate value (default 192.168.0.0/24) - - - Set IP Range Start to appropriate value (default 192.168.0.1) - - - Set IP Range End to appropriate value (default 192.168.0.254) - - - Check <VLAN tagging>. - - - Set appropriate VLAN id. (default 101) - -#. Update the Private Network Information - - - Set CIDR to appropriate value (default 192.168.2.0/24 - - - Set IP Range Start to appropriate value (default 192.168.2.1) - - - Set IP Range End to appropriate value (default 192.168.2.254) - - - Check <VLAN tagging>. - - - Set appropriate VLAN tag (default 103) - -#. Select the "Neutron L3 Node Networks group" on the left pane. - -#. Update the Floating Network configuration. - - - Set the Floating IP range start (default 172.16.0.130) - - - Set the Floating IP range end (default 172.16.0.254) - - - Set the Floating network name (default admin_floating_net) - -#. Update the Internal Network configuration. - - - Set Internal network CIDR to an appropriate value (default 192.168.111.0/24) - - - Set Internal network gateway to an appropriate value - - - Set the Internal network name (default admin_internal_net) - -#. Update the Guest OS DNS servers. - - - Set Guest OS DNS Server values appropriately - -#. Save Settings. - -#. Select the "Other Node Networks group" on the left pane. - -#. Update the Public network assignment. - - - Check the box for "Assign public network to all nodes" (Required by OpenDaylight) - -#. Update Host OS DNS Servers. - - - Provide the DNS server settings - -#. Update Host OS NTP Servers. - - - Provide the NTP server settings - -Select Hypervisor type ----------------------- - -#. In the FUEL UI of your Environment, click the "Settings" Tab - -#. Select Compute on the left side pane - - - Check the KVM box and press "Save settings" - -Enable Plugins --------------- - -#. In the FUEL UI of your Environment, click the "Settings" Tab - -#. Select Other on the left side pane - - - Enable and configure the plugins of your choice - -Allocate nodes to environment and assign functional roles ---------------------------------------------------------- - -#. Click on the "Nodes" Tab in the FUEL WEB UI. - -#. Assign roles. - - - Click on the <+Add Nodes> button - - - Check <Controller>, <Telemetry - MongoDB> and optionally an SDN Controller role (OpenDaylight controller/ONOS) in the Assign Roles Section. - - - Check one node which you want to act as a Controller from the bottom half of the screen - - - Click <Apply Changes>. - - - Click on the <+Add Nodes> button - - - Check the <Controller> and <Storage - Ceph OSD> roles. - - - Check the two next nodes you want to act as Controllers from the bottom half of the screen - - - Click <Apply Changes> - - - Click on <+Add Nodes> button - - - Check the <Compute> and <Storage - Ceph OSD> roles. - - - Check the Nodes you want to act as Computes from the bottom half of the screen - - - Click <Apply Changes>. - -#. Configure interfaces. - - - Check Select <All> to select all allocated nodes - - - Click <Configure Interfaces> - - - Assign interfaces (bonded) for mgmt-, admin-, private-, public- - and storage networks - - - Click <Apply> diff --git a/docs/installationprocedure/template-os-nosdn-nofeature-ha/install.optional.rst b/docs/installationprocedure/template-os-nosdn-nofeature-ha/install.optional.rst deleted file mode 100644 index ed9eaf8d2..000000000 --- a/docs/installationprocedure/template-os-nosdn-nofeature-ha/install.optional.rst +++ /dev/null @@ -1,73 +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) and others - - -OPTIONAL - Set Local Mirror Repos ---------------------------------- - -The following steps can be executed if you are in an environment with -no connection to the Internet. The Fuel server delivers a local repo -that can be used for installation / deployment of openstack. - -#. In the Fuel UI of your Environment, click the Settings Tab and select General from the left pane. - - - Replace the URI values for the "Name" values outlined below: - - - "ubuntu" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty main" - - - "ubuntu-security" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty-security main" - - - "ubuntu-updates" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty-updates main" - - - "mos" URI="deb http://<ip-of-fuel-server>::8080/liberty-8.0/ubuntu/x86_64 mos8.0 main restricted" - - - "Auxiliary" URI="deb http://<ip-of-fuel-server>:8080/liberty-8.0/ubuntu/auxiliary auxiliary main restricted" - - - Click <Save Settings> at the bottom to Save your changes - -Target specific configuration ------------------------------ - -#. Set up targets for provisioning with non-default "Offloading Modes" - - Some target nodes may require additional configuration after they are - PXE booted (bootstrapped); the most frequent changes are in defaults - for ethernet devices' "Offloading Modes" settings (e.g. some targets' - ethernet drivers may strip VLAN traffic by default). - - If your target ethernet drivers have wrong "Offloading Modes" defaults, - in "Configure interfaces" page (described above), expand affected - interface's "Offloading Modes" and [un]check the relevant settings: - -#. Set up targets for "Verify Networks" with non-default "Offloading Modes" - - **NOTE**: Check *Reference 15* for an updated and comprehensive list of - known issues and/or limitations, including "Offloading Modes" not being - applied during "Verify Networks" step. - - Setting custom "Offloading Modes" in Fuel GUI will only apply those settings - during provisioning and **not** during "Verify Networks", so if your targets - need this change, you have to apply "Offloading Modes" settings by hand - to bootstrapped nodes. - - **E.g.**: Our driver has "rx-vlan-filter" default "on" (expected "off") on - the openstack interface(s) "eth1", preventing VLAN traffic from passing - during "Verify Networks". - - - From Fuel master console identify target nodes admin IPs: - - .. code-block:: bash - - $ fuel nodes - - - - SSH into each of the target nodes and disable "rx-vlan-filter" on the - affected physical interface(s) allocated for OpenStack traffic (eth1): - - .. code-block:: bash - - $ ssh root@10.20.0.6 ethtool -K eth1 rx-vlan-filter off - - - Repeat the step above for all affected nodes/interfaces in the POD. - diff --git a/docs/installationprocedure/template-os-nosdn-nofeature-ha/installation.rst b/docs/installationprocedure/template-os-nosdn-nofeature-ha/installation.rst deleted file mode 100644 index bcfb6d5de..000000000 --- a/docs/installationprocedure/template-os-nosdn-nofeature-ha/installation.rst +++ /dev/null @@ -1,155 +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) and others - -<scenario> software installation and deployment -=============================================== - -.. Let's figure out how to structure this to highlight both virtual and -.. bare metal deployments. I need some help from the scenrio owners to get -.. that right. - -This section describes the installation of the OPNFV installation -server (jumphost) as well as the deployment of the <scenario> OPNFV -reference platform stack across a server cluster. - -Install jumphost ----------------- - -If you have not already done so, prepare your jumphost according the instructions in _#ref_Preparation -this can be done using an ISO image with the following commands - -#. Mount the <scenario> ISO file/media as a boot device to the jump host server. - -#. Reboot the jump host to establish the jumphost server. - - - The system now boots from the ISO image. - - - Select "Fuel Install (Static IP)" - - - Press [Enter]. - -#. Wait until screen Fuel setup is shown (Note: This can take up to 30 minutes). - -At this time you can continue with the installation according to the following instructions. - -#. In the "Fuel User" section - Confirm/change the default password - - - Enter "admin" in the Fuel password input - - - Enter "admin" in the Confirm password input - - - Select "Check" and press [Enter] - -#. In the "Network Setup" section - Configure DHCP/Static IP information for your FUEL node - For example, ETH0 is 10.20.0.2/24 for FUEL booting and ETH1 is DHCP in your corporate/lab network. - - - Configure eth1 or other network interfaces here as well (if you have them present on your FUEL server). - -#. In the "PXE Setup" section - Change the following fields to appropriate values (example below): - - - DHCP Pool Start 10.20.0.3 - - - DHCP Pool End 10.20.0.254 - - - DHCP Pool Gateway 10.20.0.2 (IP address of Fuel node) - -#. In the "DNS & Hostname" section - Change the following fields to appropriate values: - - - Hostname - - - Domain - - - Search Domain - - - External DNS - - - Hostname to test DNS - - - Select <Check> and press [Enter] - - -#. OPTION TO ENABLE PROXY SUPPORT - In the "Bootstrap Image" section, edit the following fields to define a proxy. (**NOTE:** cannot be used in tandem with local repository support) - - - Navigate to "HTTP proxy" and enter your http proxy address - - - Select <Check> and press [Enter] - -#. In the "Time Sync" section - Change the following fields to appropriate values: - - - NTP Server 1 <Customer NTP server 1> - - - NTP Server 2 <Customer NTP server 2> - - - NTP Server 3 <Customer NTP server 3> - -#. Start the installation. - - - Select Quit Setup and press Save and Quit. - - - Installation starts, wait until the login screen is shown. - - -Boot the Node Servers ---------------------- - -After the Fuel Master node has rebooted from the above steps and is at -the login prompt, you should boot the Node Servers (Your -Compute/Control/Storage blades (nested or real) with a PXE booting -scheme so that the FUEL Master can pick them up for control. - -#. Enable PXE booting - - - For every controller and compute server: enable PXE Booting as the first boot device in the BIOS boot order menu and hard disk as the second boot device in the same menu. - -#. Reboot all the control and compute blades. - -#. Wait for the availability of nodes showing up in the Fuel GUI. - - - Connect to the FUEL UI via the URL provided in the Console (default: https://10.20.0.2:8443) - - - Wait until all nodes are displayed in top right corner of the Fuel GUI: Total nodes and Unallocated nodes. - - -Install additional Plugins/Features on the FUEL node ----------------------------------------------------- - -#. SSH to your FUEL node (e.g. root@10.20.0.2 pwd: r00tme) - -#. Select wanted plugins/features from the /opt/opnfv/ directory. - -#. Install the wanted plugin with the command "fuel plugins --install /opt/opnfv/<plugin-name>-<version>.<arch>.rpm" - Expected output: "Plugin ....... was successfully installed." - -Create an OpenStack Environment -------------------------------- - -#. Connect to Fuel WEB UI with a browser (default: https://10.20.0.2:8443) (login admin/admin) - -#. Create and name a new OpenStack environment, to be installed. - -#. Select "<Liberty on Ubuntu 14.04>" and press <Next> - -#. Select "compute virtulization method". - - - Select "QEMU-KVM as hypervisor" and press <Next> - -#. Select "network mode". - - - Select "Neutron with ML2 plugin" - - - Select "Neutron with tunneling segmentation" (Required when using the ODL or ONOS plugins) - - - Press <Next> - -#. Select "Storage Back-ends". - - - Select "Ceph for block storage" and press <Next> - -#. Select "additional services" you wish to install. - - - Check option "Install Ceilometer (OpenStack Telemetry)" and press <Next> - -#. Create the new environment. - - - Click <Create> Button - diff --git a/docs/installationprocedure/template-os-nosdn-nofeature-ha/introduction.rst b/docs/installationprocedure/template-os-nosdn-nofeature-ha/introduction.rst deleted file mode 100644 index fffe5e867..000000000 --- a/docs/installationprocedure/template-os-nosdn-nofeature-ha/introduction.rst +++ /dev/null @@ -1,18 +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) and others - -Introduction -============ - -This document provides guidelines on how to install and configure the -<template> scenario of OPNFV including required software and hardware configurations. - -Although the available installation options give a high degree of -freedom in how the system is set-up, including architecture, services -and features, etc., said permutations may not provide an OPNFV -compliant reference architecture. This instruction provides a -step-by-step guide that results in an OPNFV Compliant deployment. - -The audience of this document is assumed to have good knowledge in -networking and Unix/Linux administration. diff --git a/docs/installationprocedure/template-os-nosdn-nofeature-ha/post.deploy.rst b/docs/installationprocedure/template-os-nosdn-nofeature-ha/post.deploy.rst deleted file mode 100644 index 752db6c9e..000000000 --- a/docs/installationprocedure/template-os-nosdn-nofeature-ha/post.deploy.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) and others - - -Installation health-check -========================= - -#. Perform system health-check (see figure below) - - - Click the "Health Check" tab inside your Environment in the FUEL Web UI - - - Check <Select All> and Click <Run Tests> - - - Allow tests to run and investigate results where appropriate - diff --git a/docs/installationprocedure/template-os-nosdn-nofeature-ha/preparation.rst b/docs/installationprocedure/template-os-nosdn-nofeature-ha/preparation.rst deleted file mode 100644 index 450c8bf5e..000000000 --- a/docs/installationprocedure/template-os-nosdn-nofeature-ha/preparation.rst +++ /dev/null @@ -1,101 +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) and others - -Preparation -=========== -.. Not all of these options are relevant for all scenario's. I advise following the -.. instructions applicable to the deploy tool used in the scenario. - -Before starting the installation of the <scenario> scenario some preparation must -be done. You may choose to install the <scenario> scenario using an ISO image, or -executing the installation from a prepared jumphost. - -Preparing your jumphost to install by script --------------------------------------------- - -To deploy the <scenario> scenario from a script you will need to prepare the jumphost -with a compatible operating system. Prepare your jumphost running CentOS 7 with libvirt -running on it. You may then install the RDO Release RPM: - -``sudo yum install -y https://www.rdoproject.org/repos/rdo-release.rpm opnfv-apex-{version}.rpm`` - -The RDO Project release repository is needed to install OpenVSwitch, which is a dependency of -opnfv-apex. If you do not have external connectivity to use this repository you need to download -the OpenVSwitch RPM from the RDO Project repositories and install it with the opnfv-apex RPM. - -Preparing your jumphost using an ISO image ------------------------------------------- - -An alternative to preparing your own jumphost id to use a <scenario> ISO image as a boot image. -Download or build the ISO image according to the following instructions. - -Retrieving the ISO image -^^^^^^^^^^^^^^^^^^^^^^^^ - -If you choose to install the <scenario> scenario from an ISO image you must first -retrieve the <template-containing>.iso image of the Colorado release. This can be -found can be found at <hyperlink required>. - -Building the ISO image -^^^^^^^^^^^^^^^^^^^^^^ - -Alternatively, you may choose to build the Fuel .iso from source by cloning the -opnfv/fuel git repository. To retrieve the repository for the Colorado release use the following command: - -$ git clone https://gerrit.opnfv.org/gerrit/fuel - -Check-out the Colorado release tag to set the HEAD to the -baseline required to replicate the Colorado release: - -$ git checkout colorado.1.0 - -Go to the fuel directory and build the .iso: - -$ cd fuel/build; make all - -For more information on how to build, please see *Reference: 14* - -Booting from the ISO image -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Mount the <scenario> ISO file/media as a boot device on the jump host server. If all your hardware -preparation is complete at this time you should reboot the jumphost to establish the deployment server. - - -Additional preparations ------------------------ -.. Additional information should be provided here. it should be relatively short and informative -.. and not drag attention away from the hardware preparation section. - - -Additionally, familiarize yourself with Fuel by reading the following documents: - -- Fuel planning guide, please see *Reference: 8* - -- Fuel user guide, please see *Reference: 9* - -- Fuel operations guide, please see *Reference: 10* - -- Fuel Plugin Developers Guide, please see *Reference: 11* - -Prior to installation, a number of deployment specific parameters must be collected, those are: - -#. Provider sub-net and gateway information - -#. Provider VLAN information - -#. Provider DNS addresses - -#. Provider NTP addresses - -#. Network overlay you plan to deploy (VLAN, VXLAN, FLAT) - -#. How many nodes and what roles you want to deploy (Controllers, Storage, Computes) - -#. Monitoring options you want to deploy (Ceilometer, Syslog, etc.). - -#. Other options not covered in the document are available in the links above - -This information will be needed for the configuration procedures -provided in this document. diff --git a/docs/installationprocedure/template-os-nosdn-nofeature-ha/references.rst b/docs/installationprocedure/template-os-nosdn-nofeature-ha/references.rst deleted file mode 100644 index 5cafbab6a..000000000 --- a/docs/installationprocedure/template-os-nosdn-nofeature-ha/references.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) and others - - -References -========== - -OPNFV ------ - -1) `OPNFV Home Page <http://www.opnfv.org>`_ - -2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_ - -OpenStack ---------- - -3) `OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_ - -4) `OpenStack documentation <http://docs.openstack.org>`_ - -OpenDaylight ------------- - -5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_ - -Fuel ----- -6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_ - -7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-8.0/>`_ - -8) `Fuel planning guide <https://docs.fuel-infra.org/openstack/fuel/fuel-8.0/mos-planning-guide.html>`_ - -9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-8.0/quickstart-guide.html>`_ - -10) `Fuel operations guide <https://docs.mirantis.com/openstack/fuel/fuel-8.0/operations.html>`_ - -11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_ - -12) `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list>`_ - -Fuel in OPNFV -------------- - -13) `OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/brahmaputra/docs/installation-instruction.html>`_ - -14) `OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/brahmaputra/docs/build-instruction.html>`_ - -15) `OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/brahmaputra/docs/release-notes.html>`_ 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>`_ |