diff options
| author |   Jonas Bjurel <jonas.bjurel@ericsson.com> | 2016-01-13 20:22:14 +0100 |
|---|---|---|
| committer | Jonas Bjurel <jonas.bjurel@ericsson.com> | 2016-02-10 20:49:07 +0100 |
| commit | ef0b33dcc34ee38d090487eabba122ae018980a0 (patch) | |
| tree | a57ea12ec9274b7a0996e0eba6f202f55dadd500 | |
| parent | 28abcb7287d3170e007e938872116161c927c38a (diff) | |
Documentation according to new template provided by the Docs team
- The Config guide is not an atonomos document, but will be scraped into a
bigger context.
- The post install guide is not an atonomos document, but will be scraped
into a bigger context.
- Installation instructions is an atonomos document describing details on
how to install Fuel@OPNFV
- Build instructions is an atonomos document describing how to build Fuel@OPNFV
- Release notes
- Agreed with the community that binary image files shall be in the repo,
as much as I hate it.
DO NOT MERGE
JIRA: FUEL-38
Change-Id: I88a93e20ef2c67a2c973147a7a1e332e3da55674
Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
| -rw-r--r-- | docs/build-instruction.rst | 91 | ||||
| -rw-r--r-- | docs/configguide/installerconfig.rst | 275 | ||||
| -rw-r--r-- | docs/configguide/postinstall.rst | 30 | ||||
| -rw-r--r-- | docs/img/addnodes.png | bin | 0 -> 24624 bytes | |||
| -rw-r--r-- | docs/img/compute.png | bin | 0 -> 49919 bytes | |||
| -rw-r--r-- | docs/img/computelist.png | bin | 0 -> 70343 bytes | |||
| -rw-r--r-- | docs/img/fuelmenu1.png | bin | 0 -> 8766 bytes | |||
| -rw-r--r-- | docs/img/fuelmenu2.png | bin | 0 -> 9679 bytes | |||
| -rw-r--r-- | docs/img/fuelmenu3.png | bin | 0 -> 9634 bytes | |||
| -rw-r--r-- | docs/img/fuelmenu4.png | bin | 0 -> 9843 bytes | |||
| -rw-r--r-- | docs/img/fuelmenu5.png | bin | 0 -> 22548 bytes | |||
| -rw-r--r-- | docs/img/fuelmenu6.png | bin | 0 -> 10703 bytes | |||
| -rw-r--r-- | docs/img/grub-1.png | bin | 0 -> 381031 bytes | |||
| -rw-r--r-- | docs/img/health.png | bin | 0 -> 54348 bytes | |||
| -rw-r--r-- | docs/img/interfaceconf.png | bin | 0 -> 58890 bytes | |||
| -rw-r--r-- | docs/img/interfaces.png | bin | 0 -> 58851 bytes | |||
| -rw-r--r-- | docs/img/network.png | bin | 0 -> 53472 bytes | |||
| -rw-r--r-- | docs/img/neutronl3.png | bin | 0 -> 71846 bytes | |||
| -rw-r--r-- | docs/img/newenv.png | bin | 0 -> 37483 bytes | |||
| -rw-r--r-- | docs/img/nodes.png | bin | 0 -> 9155 bytes | |||
| -rw-r--r-- | docs/img/other.png | bin | 0 -> 71641 bytes | |||
| -rw-r--r-- | docs/img/plugin_install.png | bin | 0 -> 17431 bytes | |||
| -rw-r--r-- | docs/img/plugins.png | bin | 0 -> 39118 bytes | |||
| -rw-r--r-- | docs/img/verifynet.png | bin | 0 -> 61499 bytes | |||
| -rw-r--r-- | docs/index.rst | 4 | ||||
| -rw-r--r-- | docs/installation-instruction.rst | 591 | ||||
| -rw-r--r-- | docs/release-notes.rst | 213 |
27 files changed, 677 insertions, 527 deletions
diff --git a/docs/build-instruction.rst b/docs/build-instruction.rst index 1bfc8bed6..f280799fd 100644 --- a/docs/build-instruction.rst +++ b/docs/build-instruction.rst @@ -17,33 +17,8 @@ License ======= Brahmaputra release of OPNFV when using Fuel as a deployment tool DOCs (c) by Jonas Bjurel (Ericsson AB) and others. -Brahmaputra release of OPNFV when using Fuel as a deployment tool DOCs (c) are licensed under a Creative Commons Attribution 4.0 International License. You should have received a copy of the license along with this. If not, see <http://creativecommons.org/licenses/by/4.0/>. - - - -Version history -=============== - -+--------------------+--------------------+--------------------+----------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+----------------------+ -| 2015-06-03 | 1.0.0 | Jonas Bjurel | Instruction for | -| | | (Ericsson AB) | the Arno release | -+--------------------+--------------------+--------------------+----------------------+ -| 2015-09-24 | 1.1.0 | Jonas Bjurel | Instruction for | -| | | (Ericsson AB) | the Arno SR1 release | -+--------------------+--------------------+--------------------+----------------------+ -| 2015-10-23 | 1.1.1 | Stefan Berg | Added instruction | -| | | (Ericsson AB) | for proxy builds | -+--------------------+--------------------+--------------------+----------------------+ -| 2015-12-03 | 1.2.0 | Stefan Berg | Added instruction | -| | | (Ericsson AB) | for plugin build | -| | | | selection | -+--------------------+--------------------+--------------------+----------------------+ -| 2016-01-20 | 1.2.1 | Daniel Smith | Minor updates for | -| | | (Ericsson AB) | docker requirements | -+--------------------+--------------------+--------------------+----------------------+ +This document is licensed under a Creative Commons Attribution 4.0 International License. You should have received a copy of the license along with this. If not, see <http://creativecommons.org/licenses/by/4.0/>. + Introduction ============ @@ -51,9 +26,9 @@ Introduction This document describes the build system used to build the Fuel deployment tool for the Brahmaputra release of OPNFV, required dependencies and minimum requirements on the host to be used for the -buildsystem. +build system. -The Fuel build system is desigened around Docker containers such that +The Fuel build system is designed around Docker containers such that dependencies outside of the build system can be kept to a minimum. It also shields the host from any potential dangerous operations performed by the build system. @@ -67,10 +42,6 @@ Requirements Minimum Hardware Requirements ----------------------------- -- An x86_64 host (Bare-metal or VM) with Ubuntu 14.04 LTS installed - - - Note: Builds on Wily (Ubuntu 15.x) are not supportted currently - - ~30 GB available disc - 4 GB RAM @@ -82,9 +53,13 @@ The build host should run Ubuntu 14.04 operating system. On the host, the following packages must be installed: -- docker - see https://docs.docker.com/engine/installation/ubuntulinux/ for - installation notes for Ubuntu 14.04. Note: only use the Ubuntu stock - distro of Docker (docker-engine). Tested against ver 1.9.x and greater +- An x86_64 host (Bare-metal or VM) with Ubuntu 14.04 LTS installed + + - A kernel equal or later than 3.19 (Vivid) (simply available through sudo apt-get install linux-generic-lts-vivid) + + - **Note:** Builds on Wily (Ubuntu 15.x) are currently not supported + +- docker - see https://docs.docker.com/engine/installation/ubuntulinux/ for installation notes for Ubuntu 14.04. Tested against ver 1.9.x and greater - git (simply available through sudo apt-get install git) @@ -93,10 +68,10 @@ On the host, the following packages must be installed: - curl (simply available through sudo apt-get install curl) Preparations ------------- +============ Setting up the Docker build container -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------------- After having installed Docker, add yourself to the docker group: <sudo usermod -a -G docker [userid]> @@ -117,7 +92,7 @@ Setting up OPNFV Gerrit in order to being able to clone the code don't already have one), create one with ssh-keygen - Add your generated public key in OPNFV Gerrit <https://gerrit.opnfv.org/> - (this requires a linuxfoundation account, create one if you do not + (this requires a Linux foundation account, create one if you do not already have one) - Select "SSH Public Keys" to the left and then "Add Key" and paste @@ -144,17 +119,6 @@ You can also opt to clone the code repository without a SSH key: Make sure to checkout the release tag as described above. - -Building -======== - -There are two methods available for building Fuel: - -- A low level method using Make - -- An abstracted method using build.sh - - Support for building behind a http/https/rsync proxy ---------------------------------------------------- @@ -230,7 +194,7 @@ access when installing the ISO artifact built as no Ubuntu package cache will be on the ISO! Configure your build environment -------------------------------------- +-------------------------------- ** Configuring the build environment should not be performed if building standard Brahmaputra release ** @@ -253,6 +217,15 @@ that this is not a full build. This method of plugin selection is not meant to be used from within Gerrit! +Building +======== + +There are two methods available for building Fuel: + +- A low level method using Make + +- An abstracted method using build.sh + Low level build method using make --------------------------------- The low level method is based on Make: @@ -281,16 +254,18 @@ Following targets exist: - clean - this will remove all artifacts from earlier builds. +- debug - this will simply enter the build container without starting a build, from here you can start a build by enter "make iso" + If the build is successful, you will find the generated ISO file in the <fuel/build/release> subdirectory! Abstracted build method using build.sh -====================================== +-------------------------------------- The abstracted build method uses the <fuel/ci/build.sh> script which allows you to: - Create and use a build cache - significantly speeding up the - buildtime if upstream repositories have not changed. + build time if upstream repositories have not changed. - push/pull cache and artifacts to an arbitrary URI (http(s):, file:, ftp:) @@ -308,13 +283,5 @@ The artifacts produced are: References ========== -- -:Authors: Jonas Bjurel (Ericsson), Stefan Berg (Ericsson) -:Version: x.x.x - -**Documentation tracking** - -Revision: _sha1_ - -Build date: _date_ +- diff --git a/docs/configguide/installerconfig.rst b/docs/configguide/installerconfig.rst index d89033ec5..f5ab62c26 100644 --- a/docs/configguide/installerconfig.rst +++ b/docs/configguide/installerconfig.rst @@ -4,25 +4,278 @@ .. You should have received a copy of the license along with this work. .. If not, see <http://creativecommons.org/licenses/by/4.0/>. -<Project> configuration -======================= -Add a brief introduction to configure OPNFV with this specific installer +Fuel configuration +================== +This section provides brief guidelines on how to install and +configure the Brahmaputra release of OPNFV when using Fuel as a +deployment tool including required software and hardware +configurations. + +For detailed instructions on how to install the Brahmaputra release using Fuel, see:<TODO> Pre-configuration activities ------------------------------ -Describe specific pre-configuration activities. Refer to Installations guide and release notes +---------------------------- + +Planning the deployment + +Before starting the installation of the Brahmaputra release of +OPNFV when using Fuel as a deployment tool, some planning must be +done. + +Familiarize yourself with the Fuel by reading the +following documents: + +- Fuel planning guide <https://docs.mirantis.com/openstack/fuel/fuel-7.0/planning-guide.html> + +- Fuel user guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html> + +- Fuel operations guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/operations.html> + + +Before the installation can start, 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) + +#. Monitoring Options you want to deploy (Ceilometer, Syslog, etc.) + +#. How many nodes and what roles you want to deploy (Controllers, Storage, Computes) + +#. Other options not covered in the document are available in the links above + + +Retrieving the ISO image +^^^^^^^^^^^^^^^^^^^^^^^^ +First of all, the Fuel deployment ISO image needs to be retrieved, the +.iso image of the Brahmaputra release of OPNFV when using Fuel as +a deployment tool can be found at: <TODO> + +Alternatively, you may build the .iso from source by cloning the +opnfv/fuel git repository. Detailed instructions on how to build +a Fuel OPNFV .iso can be found here: <TODO> + +Hardware requirements +--------------------- +Following high level hardware requirements must be met: + ++--------------------+------------------------------------------------------+ +| **HW Aspect** | **Requirement** | +| | | ++--------------------+------------------------------------------------------+ +| **# of nodes** | Minimum 5 (3 for non redundant deployment): | +| | | +| | - 1 Fuel deployment master (may be virtualized) | +| | | +| | - 3(1) Controllers (1 colocated mongo/ceilometer | +| | role, 2 Ceph-OSD roles) | +| | | +| | - 1 Compute (1 co-located Ceph-OSD role) | +| | | ++--------------------+------------------------------------------------------+ +| **CPU** | Minimum 1 socket x86_AMD64 with Virtualization | +| | support | ++--------------------+------------------------------------------------------+ +| **RAM** | Minimum 16GB/server (Depending on VNF work load) | +| | | ++--------------------+------------------------------------------------------+ +| **Disk** | Minimum 256GB 10kRPM spinning disks | +| | | ++--------------------+------------------------------------------------------+ +| **Networks** | 4 Tagged VLANs (PUBLIC, MGMT, STORAGE, PRIVATE) | +| | | +| | 1 Un-Tagged VLAN for PXE Boot - ADMIN Network | +| | | +| | note: These can be run on single NIC - or spread out | +| | over other nics as your hardware supports | ++--------------------+------------------------------------------------------+ -Hardware configuration ------------------------ -Describe the hardware configuration needed for this specific installer +For a detailed hardware compatibility matrix - please see: +<https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list/> + +Top of the rack (TOR) Configuration requirements +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The switching infrastructure provides connectivity for the OPNFV +infrastructure operations, tenant networks (East/West) and provider +connectivity (North/South); it also provides needed +connectivity for the storage Area Network (SAN). To avoid traffic +congestion, it is strongly suggested that three physically separated +networks are used, that is: 1 physical network for administration and +control, one physical network for tenant private and public networks, +and one physical network for SAN. The switching connectivity can (but +does not need to) be fully redundant, in such case it and comprises a +redundant 10GE switch pair for each of the three physically separated +networks. + +The physical TOR switches are **not** automatically configured from +the OPNFV reference platform. All the networks involved in the OPNFV +infrastructure as well as the provider networks and the private tenant +VLANs needs to be manually configured. + +Manual configuration of the Brahmaputra hardware platform should +be carried out according to the OPNFV Pharos specification <TODO> Jumphost configuration ------------------------ -Describe intial Jumphost configuration (network and software)needed in order to deploy the installer +---------------------- +The Jumphost server, also known as the "Fuel master" provides needed +services/functions to deploy an OPNFV/OpenStack cluster as well functions +for cluster life-cycle management (extensions, repair actions and upgrades). + +The Jumphost server requires 2 (4 if redundancy is required) Ethernet +interfaces - one for external management of the OPNFV installation, +and another for jump-host communication with the OPNFV cluster. + +Install the Fuel jump-host +^^^^^^^^^^^^^^^^^^^^^^^^^^ +Mount the Fuel Brahmaputra ISO file as a boot device to the jump host +server, reboot it, and install the Fuel Jumphost in accordance with the +instructions found here: <TODO> + Platform components configuration --------------------------------- -Describe the configuration of each component in the installer +Fuel-Plugins +^^^^^^^^^^^^ +Fuel plugins enable you to install and configure additional capabilities for +your Fuel OPNFV based cloud, such as additional storage types, networking +functionality, or NFV features developed by OPNFV. + +Fuel offers an open source framework for creating these plugins, so there’s +a wide range of capabilities that you can enable Fuel to add to your OpenStack +clouds. + +The OPNFV Brahmaputra version of Fuel provides a set of pre-packaged plugins +developed by OPNFV: + ++--------------------+------------------------------------------------------+ +| **Plugin name** | **Short description** | +| | | ++--------------------+------------------------------------------------------+ +| OpenDaylight | OpenDaylight provides an open-source SDN Controller | +| | providing networking features such as L2 and L3 | +| | network control, "Service Function Chaining", | +| | routing, networking policies, etc. | +| | More information on OpenDaylight in the OPNFV | +| | Brahmaputra release can be found in a separate | +| | section in this document. | ++--------------------+------------------------------------------------------+ +| ONOS | ONOS is another open-source SDN controller which | +| | in essense fill the same role as OpenDaylight. | +| | More information on ONOS in the OPNFV | +| | Brahmaputra release can be found in a separate | +| | section in this document. | +| | | ++--------------------+------------------------------------------------------+ +| BGP-VPN | BGP-VPN provides an BGP/MPLS VPN service | +| | More information on BGP-VPN in the OPNFV | +| | Brahmaputra release can be found in a separate | +| | section in this document. | +| | | ++--------------------+------------------------------------------------------+ +| OVS-NSH | OVS-NSH provides a variant of Open-vSwitch | +| | which supports "Network Service Headers" needed | +| | for the "Service function chaining" feature | +| | More information on "Service Function Chaining" | +| | in the OPNFV Brahmaputra release can be found in a | +| | in a separate section in this document. | +| | | ++--------------------+------------------------------------------------------+ +| OVS-NFV | OVS-NFV provides a variant of Open-vSwitch | +| | with carrier grade characteristics essential for | +| | NFV workloads. | +| | More information on OVS-NFV | +| | in the OPNFV Brahmaputra release can be found in a | +| | in a separate section in this document. | +| | | ++--------------------+------------------------------------------------------+ +| KVM-NFV | KVM-NFV provides a variant of KVM with improved | +| | virtualization characteristics essential for NFV | +| | workloads. | +| | More information on KVM-NFV | +| | in the OPNFV Brahmaputra release can be found in a | +| | in a separate section in this document. | +| | | ++--------------------+------------------------------------------------------+ +| VSPERF | VSPERF provides a networking characteristics test | +| | bench that facilitates characteristics/performance | +| | evaluation of vSwithches | +| | More information on VSPERF | +| | in the OPNFV Brahmaputra release can be found in a | +| | in a separate section in this document. | +| | | ++--------------------+------------------------------------------------------+ + +*Additional third-party plugins can be found here:* +*https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/* +**Note: Plugins are not necessarilly compatible with each other, see <TODO> +for compatibility information** + +The plugins come prepackaged, ready to install. To do so follow the +instructions provided here: <TODO> + +Fuel environment +^^^^^^^^^^^^^^^^ +A Fuel environment is an OpenStack instance managed by Fuel, +one Fuel instance can manage several OpenStack instances/environments +with different configurations, etc. + +To create a Fuel instance, follow the instructions provided +here: <TODO> + +Provisioning of aditional features and services +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Although the plugins have already previously been installed, +they are not per default enabled for the environment we just created. +The plugins of you choice need to be enabled and configured. + +To enable a plugin, follow the instructions in the installation instructions <TODO> + +For configuration of the plugins, please refer to the corresponding feature in the ????? <TODO> + +Networking +^^^^^^^^^^ +All the networking aspects need to be configured in terms of: +- Interfaces/NICs +- VLANs +- Sub-nets +- Gateways +- User network segmentation (VLAN/VXLAN) +- DNS +- NTP +- etc. + +For guidelines on how to configure networking, please refer to the +installation instructions here: <TODO> + +Node allocation +^^^^^^^^^^^^^^^ +Now, it is time to allocate the nodes in your OPNFV cluster to OpenStack-, +SDN-, and other feature/service roles. Some roles may require redundancy, +while others don't; Some roles may be co-located with other roles, while +others may not. The Fuel GUI will guide you in the allocation of roles and +will not permit you to perform invalid allocations. + +For detailed guide-lines on node allocation, please refer to the installation instructions: <TODO> + +Off-line deployment +^^^^^^^^^^^^^^^^^^^ +The OPNFV Brahmaputra version of Fuel can be deployed using on-line upstream +repositories (default) or off-line using built-in local repositories on the +Fuel jump-start server. + +For instructions on how to configure Fuel for off-line deployment, please +refer to the installation instructions: <TODO> +Deployment +^^^^^^^^^^ +You should now be ready to deploy your OPNFV Brahmaputra environment - but before doing so you may want to verify your network settings. +For further details on network verification and deployment, please refer to +the installation instructions: <TODO> diff --git a/docs/configguide/postinstall.rst b/docs/configguide/postinstall.rst index 52e0a5c30..b5d28e992 100644 --- a/docs/configguide/postinstall.rst +++ b/docs/configguide/postinstall.rst @@ -4,29 +4,19 @@ .. You should have received a copy of the license along with this work. .. If not, see <http://creativecommons.org/licenses/by/4.0/>. -<Project> post installation procedures -====================================== -Add a brief introduction to the methods of validating the installation -according to this specific installer or feature. +Fuel post installation procedures +================================= Automated post installation activities -------------------------------------- -Describe specific post installation activities performed by the OPNFV -deployment pipeline including testing activities and reports. Refer to -the relevant testing guides, results, and release notes. +Fuel provides a fairly broad coverage of built in automated health checks. +These validate the installation in terms of configuration, services, +networking, storage, policies, etc. +The execution of the full range of health checks takes less than 30 minutes. -note: this section should be singular and derived from the test projects -once we have one test suite to run for all deploy tools. This is not the -case yet so each deploy tool will need to provide (hopefully very simillar) -documentation of this. - -<Project> post configuration procedures --------------------------------------- -Describe any deploy tool or feature specific scripts, tests or procedures -that should be carried out on the deployment post install and configuration -in this section. +For instructions on how to run health-checks, please refer to the installation instructions: <TODO> Platform components validation ---------------------------------- -Describe any component specific validation procedures necessary for your -deployment tool in this section. +------------------------------ +Consult the feature sections in this document for any post-install +feature specific validation/health-checks. diff --git a/docs/img/addnodes.png b/docs/img/addnodes.png Binary files differnew file mode 100644 index 000000000..15730db90 --- /dev/null +++ b/docs/img/addnodes.png diff --git a/docs/img/compute.png b/docs/img/compute.png Binary files differnew file mode 100644 index 000000000..fd7811f37 --- /dev/null +++ b/docs/img/compute.png diff --git a/docs/img/computelist.png b/docs/img/computelist.png Binary files differnew file mode 100644 index 000000000..a4453d958 --- /dev/null +++ b/docs/img/computelist.png diff --git a/docs/img/fuelmenu1.png b/docs/img/fuelmenu1.png Binary files differnew file mode 100644 index 000000000..15fccc434 --- /dev/null +++ b/docs/img/fuelmenu1.png diff --git a/docs/img/fuelmenu2.png b/docs/img/fuelmenu2.png Binary files differnew file mode 100644 index 000000000..1f87c53e5 --- /dev/null +++ b/docs/img/fuelmenu2.png diff --git a/docs/img/fuelmenu3.png b/docs/img/fuelmenu3.png Binary files differnew file mode 100644 index 000000000..c9fa27959 --- /dev/null +++ b/docs/img/fuelmenu3.png diff --git a/docs/img/fuelmenu4.png b/docs/img/fuelmenu4.png Binary files differnew file mode 100644 index 000000000..1bc9c0410 --- /dev/null +++ b/docs/img/fuelmenu4.png diff --git a/docs/img/fuelmenu5.png b/docs/img/fuelmenu5.png Binary files differnew file mode 100644 index 000000000..11247986b --- /dev/null +++ b/docs/img/fuelmenu5.png diff --git a/docs/img/fuelmenu6.png b/docs/img/fuelmenu6.png Binary files differnew file mode 100644 index 000000000..9ff62c798 --- /dev/null +++ b/docs/img/fuelmenu6.png diff --git a/docs/img/grub-1.png b/docs/img/grub-1.png Binary files differnew file mode 100644 index 000000000..7488503af --- /dev/null +++ b/docs/img/grub-1.png diff --git a/docs/img/health.png b/docs/img/health.png Binary files differnew file mode 100644 index 000000000..71675069e --- /dev/null +++ b/docs/img/health.png diff --git a/docs/img/interfaceconf.png b/docs/img/interfaceconf.png Binary files differnew file mode 100644 index 000000000..e8b45578c --- /dev/null +++ b/docs/img/interfaceconf.png diff --git a/docs/img/interfaces.png b/docs/img/interfaces.png Binary files differnew file mode 100644 index 000000000..291e434f6 --- /dev/null +++ b/docs/img/interfaces.png diff --git a/docs/img/network.png b/docs/img/network.png Binary files differnew file mode 100644 index 000000000..04c67d38e --- /dev/null +++ b/docs/img/network.png diff --git a/docs/img/neutronl3.png b/docs/img/neutronl3.png Binary files differnew file mode 100644 index 000000000..dd8d7954b --- /dev/null +++ b/docs/img/neutronl3.png diff --git a/docs/img/newenv.png b/docs/img/newenv.png Binary files differnew file mode 100644 index 000000000..d6bc2827f --- /dev/null +++ b/docs/img/newenv.png diff --git a/docs/img/nodes.png b/docs/img/nodes.png Binary files differnew file mode 100644 index 000000000..771e4813d --- /dev/null +++ b/docs/img/nodes.png diff --git a/docs/img/other.png b/docs/img/other.png Binary files differnew file mode 100644 index 000000000..4e740eb06 --- /dev/null +++ b/docs/img/other.png diff --git a/docs/img/plugin_install.png b/docs/img/plugin_install.png Binary files differnew file mode 100644 index 000000000..ff50633ed --- /dev/null +++ b/docs/img/plugin_install.png diff --git a/docs/img/plugins.png b/docs/img/plugins.png Binary files differnew file mode 100644 index 000000000..bfe8781e8 --- /dev/null +++ b/docs/img/plugins.png diff --git a/docs/img/verifynet.png b/docs/img/verifynet.png Binary files differnew file mode 100644 index 000000000..5932bc223 --- /dev/null +++ b/docs/img/verifynet.png diff --git a/docs/index.rst b/docs/index.rst index f57f71204..fd61a5201 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -24,8 +24,8 @@ Contents: :maxdepth: 4 :titlesonly: - build-instructions.rst - installation-instructions.rst + build-instruction.rst + installation-instruction.rst release-notes.rst * :ref:`search` diff --git a/docs/installation-instruction.rst b/docs/installation-instruction.rst index 5c4438991..eb02d7860 100644 --- a/docs/installation-instruction.rst +++ b/docs/installation-instruction.rst @@ -1,58 +1,38 @@ -============================================================================================================= -OPNFV Installation instruction for the Brahmaputra WP1 release of OPNFV when using Fuel as a deployment tool -============================================================================================================= +======================================================================================================== +OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool +======================================================================================================== .. contents:: Table of Contents :backlinks: none Abstract ======== -This document describes how to install the Brahmaputra WP1 release of -OPNFV when using Fuel as a deployment tool covering it's limitations, -dependencies and required system resources. +This document describes how to install the Brahmaputra release of +OPNFV when using Fuel as a deployment tool, covering it's usage, +limitations, dependencies and required system resources. License ======= -Brahmaputra WP1 release of OPNFV when using Fuel as a deployment tool +Brahmaputra release of OPNFV when using Fuel as a deployment tool Docs (c) by Jonas Bjurel (Ericsson AB) -Brahmaputra WP1 release of OPNFV when using Fuel as a deployment tool -Docs are licensed under a Creative Commons Attribution 4.0 +This document is licensed under a Creative Commons Attribution 4.0 International License. You should have received a copy of the license -along with this. If not, see +along with this document. If not, see <http://creativecommons.org/licenses/by/4.0/>. -Version history -=============== -+--------------------+--------------------+--------------------+--------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| 2015-06-03 | 1.0.0 | Jonas Bjurel | Installation | -| | | (Ericsson AB) | instruction for | -| | | | the Arno release | -| | | | | -| 2015-09-27 | 1.1.0 | Daniel Smith | ARNO SR1-RC1 | -| | | (Ericsson AB) | update | -| | | | | -| | | | | -| 2015-11-19 | 2.0.0 | Daniel Smith | B-Rel WP1 update | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ - Introduction ============ -This document describes providing guidelines on how to install and -configure the Brahmaputra WP1 release of OPNFV when using Fuel as a -deployment tool including required software and hardware -configurations. +This document provides guidelines on how to install and +configure the Brahmaputra release of OPNFV when using Fuel as a +deployment tool, including required software and hardware configurations. -Although the available installation options gives 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 +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 Brahmaputra WP1 compliant +step-by-step guide that results in an OPNFV Brahmaputra compliant deployment. The audience of this document is assumed to have good knowledge in @@ -60,80 +40,66 @@ networking and Unix/Linux administration. Preface ======= -Before starting the installation of the Brahmaputra WP1 release of -OPNFV when using Fuel as a deployment tool, some planning must be +Before starting the installation of the Brahmaputra release of +OPNFV, using Fuel as a deployment tool, some planning must be done. Retrieving the ISO image ------------------------ First of all, the Fuel deployment ISO image needs to be retrieved, the -.iso image of the Brahmaputra WP1 release of OPNFV when using Fuel as -a deployment tool can be found at -http://artifacts.opnfv.org/fuel/opnfv-2015-11-19_03-04-21.iso NOTE: -TO BE UPDATED WITH FINAL B-REL ARTIFACT - +Fuel .iso image of the Brahmaputra release can be found at <TODO> Building the ISO image ---------------------- - -Alternatively, you may build the .iso from source by cloning the -opnfv/genesis git repository. To retrieve the repository for the Arno +Alternatively, you may build the Fuel .iso from source by cloning the +opnfv/fuel git repository. To retrieve the repository for the Brahmaputra release use the following command: -- git clone https://<linux foundation uid>@gerrit.opnf.org/gerrit/fuel +$git clone https://<linux foundation uid>@gerrit.opnf.org/gerrit/fuel -Check-out the Brahmaputra WP1 release tag to set the branch to the -baseline required to replicate the Brahmaputra WP1 release: +Check-out the Brahmaputra release tag to set the branch to the +baseline required to replicate the Brahmaputra release: -- TODO: NEEDS UPDATE TO REFLECT WP1 TAG / NEW REPO - cd genesis; git - checkout stable/arno2015.2.0 +$ git checkout stable/<TODO> Go to the fuel directory and build the .iso: -- cd fuel/build; make all +$ cd fuel/build; make all For more information on how to build, please see "OPNFV Build -instructions for - Brahmaputra WP1 release of OPNFV when using Fuel as +instructions for - Brahmaputra release of OPNFV when using Fuel as a deployment tool which you retrieved with the repository at -</fuel/fuel/docs/src/build-instructions.rst> +</fuel/fuel/docs/src/build-instructions.rst> <TODO> -Next, familiarize yourself with the Fuel 7.0 version by reading the -following documents: +Next, familiarize yourself with Fuel by reading the following documents: -- Fuel planning guide - <https://docs.mirantis.com/openstack/fuel/fuel-7.0/planning-guide.html> +- Fuel planning guide <https://docs.mirantis.com/openstack/fuel/fuel-7.0/planning-guide.html> -- Fuel user guide - <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html> +- Fuel user guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html> -- Fuel operations guide - <http://docs.mirantis.com/openstack/fuel/fuel-7.0/operations.html> +- Fuel operations guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/operations.html> - Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins> -A number of deployment specific parameters must be collected, those are: +Prior to installation, a number of deployment specific parameters must be collected, those are: -1. Provider sub-net and gateway information +#. Provider sub-net and gateway information -2. Provider VLAN information +#. Provider VLAN information -3. Provider DNS addresses +#. Provider DNS addresses -4. Provider NTP addresses +#. Provider NTP addresses -5. Network Topology you plan to Deploy (VLAN, GRE(VXLAN), FLAT) +#. Network overlay you plan to deploy (VLAN, VXLAN, FLAT) -6. Linux Distro you intend to deploy. +#. How many nodes and what roles you want to deploy (Controllers, Storage, Computes) -7. How many nodes and what roles you want to deploy (Controllers, -Storage, Computes) +#. Monitoring options you want to deploy (Ceilometer, Syslog, erc.). -8. Monitoring Options you want to deploy (Ceilometer, MongoDB). - -9. Other options not covered in the document are available in the -links above +#. Other options not covered in the document are available in the links above This information will be needed for the configuration procedures @@ -143,24 +109,24 @@ Hardware requirements ===================== The following minimum hardware requirements must be met for the -installation of Brahmaputra WP1 using Fuel: +installation of Brahmaputra using Fuel: +--------------------+------------------------------------------------------+ | **HW Aspect** | **Requirement** | | | | +--------------------+------------------------------------------------------+ -| **# of nodes** | Minimum 6 (3 for non redundant deployment): | +| **# of nodes** | Minimum 5 (3 for non redundant deployment): | | | | | | - 1 Fuel deployment master (may be virtualized) | | | | -| | - 3(1) Controllers | +| | - 3(1) Controllers (1 colocated mongo/ceilometer | +| | role, 2 Ceph-OSD roles) | | | | -| | - 1 Compute | +| | - 1 Compute (1 co-located Ceph-OSD role) | | | | -| | - 1 Ceilometer (VM option) | +--------------------+------------------------------------------------------+ | **CPU** | Minimum 1 socket x86_AMD64 with Virtualization | -| | support | +| | support | +--------------------+------------------------------------------------------+ | **RAM** | Minimum 16GB/server (Depending on VNF work load) | | | | @@ -172,33 +138,30 @@ installation of Brahmaputra WP1 using Fuel: | | | | | 1 Un-Tagged VLAN for PXE Boot - ADMIN Network | | | | -| | note: These can be run on single NIC - or spread out | -| | over other nics as your hardware supports | +| | Note: These can be allocated to a single NIC - | +| | or spread out over multiple NICs as your hardware | +| | supports. | +--------------------+------------------------------------------------------+ Help with Hardware Requirements =============================== - Calculate hardware requirements: -Refer to the OpenStack Hardware Compability List +Refer to the OpenStack Hardware Compatibility List: <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list/> for more information on various hardware types available for use. When choosing the hardware on which you will deploy your OpenStack environment, you should think about: - - CPU -- Consider the number of virtual machines that you plan - to deploy in your cloud environment and the CPU per virtual - machine. - - Memory -- Depends on the amount of RAM assigned per virtual - machine and the controller node. - - Storage -- Depends on the local drive space per virtual - machine, remote volumes that can be attached to a virtual - machine, and object storage. - - Networking -- Depends on the Choose Network Topology, the - network bandwidth per virtual machine, and network storage. +- CPU -- Consider the number of virtual machines that you plan to deploy in your cloud environment and the CPU per virtual machine. + +- Memory -- Depends on the amount of RAM assigned per virtual machine and the controller node. + +- Storage -- Depends on the local drive space per virtual machine, remote volumes that can be attached to a virtual machine, and object storage. + +- Networking -- Depends on the Choose Network Topology, the network bandwidth per virtual machine, and network storage. Top of the rack (TOR) Configuration requirements @@ -206,24 +169,24 @@ Top of the rack (TOR) Configuration requirements The switching infrastructure provides connectivity for the OPNFV infrastructure operations, tenant networks (East/West) and provider -connectivity (North/South bound connectivity); it also provides needed -connectivity for the storage Area Network (SAN). To avoid traffic -congestion, it is strongly suggested that three physically separated -networks are used, that is: 1 physical network for administration and -control, one physical network for tenant private and public networks, -and one physical network for SAN. The switching connectivity can (but -does not need to) be fully redundant, in such case it and comprises a -redundant 10GE switch pair for each of the three physically separated -networks. +connectivity (North/South); it also provides needed connectivity for +the storage Area Network (SAN). +To avoid traffic congestion, it is strongly suggested that three +physically separated networks are used, that is: 1 physical network +for administration and control, one physical network for tenant private +and public networks, and one physical network for SAN. +The switching connectivity can (but does not need to) be fully redundant, +in such case it comprises a redundant 10GE switch pair for each of the +three physically separated networks. The physical TOR switches are **not** automatically configured from -the OPNFV reference platform. All the networks involved in the OPNFV +the Fuel OPNFV reference platform. All the networks involved in the OPNFV infrastructure as well as the provider networks and the private tenant VLANs needs to be manually configured. -Manual configuration of the Brahmaputra WP1 hardware platform should -be carried out according to the Pharos specification TODO-<insert link -to Pharos ARNO SR1 Specification> +Manual configuration of the Brahmaputra hardware platform should +be carried out according to the OPNFV Pharos specification: +<https://wiki.opnfv.org/pharos/pharos_specification> OPNFV Software installation and deployment ========================================== @@ -234,68 +197,72 @@ reference platform stack across a server cluster. Install Fuel master ------------------- -1. Mount the Brahmaputra WP1 ISO file as a boot device to the jump host server. +#. Mount the Brahmaputra Fuel ISO file/media as a boot device to the jump host server. -2. Reboot the jump host to establish the Fuel server. +#. Reboot the jump host to establish the Fuel server. - The system now boots from the ISO image. - - Select 'DVD Fuel Install (Static IP)' + - Select "Fuel Install (Static IP)" (See figure below) - Press [Enter]. -3. Wait until screen Fuel setup is shown (Note: This can take up to 30 minutes). + .. figure:: img/grub-1.png + +#. Wait until screen Fuel setup is shown (Note: This can take up to 30 minutes). -4. In the 'Fuel User' Section - Confirm/change the default password - - Enter 'admin' in the Fuel password input +#. In the "Fuel User" section - Confirm/change the default password (See figure below) - - Enter 'admin' in the Confim password input + - Enter "admin" in the Fuel password input - - Select 'Check' and press [Enter] + - Enter "admin" in the Confirm password input -5. In '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. + - Select "Check" and press [Enter] - - Configure eth1 or other network interfaces here as well (if you - have them present on your FUEL server). + .. figure:: img/fuelmenu1.png -6. In 'PXE Setup' Section - Change the following fields to appropriate -values (example below): +#. 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 (see figure below). + + - Configure eth1 or other network interfaces here as well (if you have them present on your FUEL server). + + .. figure:: img/fuelmenu2.png + +#. In the "PXE Setup" section (see figure below) - 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 of Fuel node) + - DHCP Pool Gateway 10.20.0.2 (IP address of Fuel node) + + .. figure:: img/fuelmenu3.png -7. In 'DNS & Hostname' - Change the following fields to appropriate values: +#. In the "DNS & Hostname" section (see figure below) - Change the following fields to appropriate values: - - Hostname <OPNFV Region name>-fuel + - Hostname - - Domain <Domain Name> + - Domain - - Search Domain <Search Domain Name> + - Search Domain - External DNS - - Hostname to test DNS <Hostname to test DNS> + - Hostname to test DNS - - Select 'Check' and press [Enter] + - Select <Check> and press [Enter] + .. figure:: img/fuelmenu4.png -8. OPTION TO ENABLE PROXY SUPPORT - In 'Bootstrap Image', edit the -following fields to define a proxy. - NOTE: cannot be used in tandem with local repo support - NOTE: not tested with ODL for support (plugin) +#. OPTION TO ENABLE PROXY SUPPORT - In the "Bootstrap Image" section (see figure below), edit the following fields to define a proxy. (**NOTE:** cannot be used in tandem with local repository support) - - Navigate to 'HTTP proxy' and input your http proxy address + - Navigate to "HTTP proxy" and enter your http proxy address - - Select 'Check' and press [Enter] + - Select <Check> and press [Enter] + .. figure:: img/fuelmenu5.png -9. In 'Time Sync' Section - Change the following fields to appropriate values: +#. In the "Time Sync" section (see figure below) - Change the following fields to appropriate values: - NTP Server 1 <Customer NTP server 1> @@ -303,301 +270,322 @@ following fields to define a proxy. - NTP Server 3 <Customer NTP server 3> -10. Start the installation. + .. figure:: img/fuelmenu6.png + +#. Start the installation. - Select Quit Setup and press Save and Quit. - - Installation starts, wait until a screen with logon credentials is shown. + - Installation starts, wait until the login screen is shown. Boot the Node Servers --------------------- -After the Fuel Master node has rebooted from the above step and is at +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. +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. -11. Enable PXE booting +#. Wait for the availability of nodes showing up in the Fuel GUI. - - 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. + - Connect to the FUEL UI via the URL provided in the Console (default: https://10.20.0.2:8443) -12. Reboot all the control and compute blades. + - Wait until all nodes are displayed in top right corner of the Fuel GUI: Total nodes and Unallocated nodes (see figure below). -13. Wait for the availability of nodes showing up in the Fuel GUI. + .. figure:: img/nodes.png - - Connect to the FUEL UI via the URL provided in the Console - (default: http://10.20.0.2:8000) - - Wait until all nodes are displayed in top right corner of the - Fuel GUI: <total number of server> TOTAL NODES and <total number - of servers> 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 ODL Plugin on FUEL node +#. Install the wanted plugin with the command "fuel plugins --install /opt/opnfv/<plugin-name>-<version>.<arch>.rpm" + Expected output: "Plugin ....... was successfully installed." (see figure below) + + .. figure:: img/plugin_install.png + +Create an OpenStack Environment ------------------------------- -NOTE: CURRENTLY DISABLED IN B-REL WP1 +#. Connect to Fuel WEB UI with a browser (default: https://10.20.0.2:8443) (login admin/admin) -14. SSH to your FUEL node (e.g. root@10.20.0.2 pwd: r00tme) +#. Create and name a new OpenStack environment, to be installed. -15. Verify the plugin exists at /opt/opnfv/opendaylight-0.6-0.6.1-1.noarch.rpm + .. figure:: img/newenv.png -16. Install the plugin with the command +#. Select "<Liberty on Ubuntu 14.04>" and press <Next> - - "fuel plugins --install /opt/opnfv/opendaylight-0.6-0.6.1-1.noarch.rpm" +#. Select "compute virtulization method". - - Expected output: "Plugin opendaylight-0.6-0.6.1-1.noarch.rpm was - successfully installed." + - Select "QEMU-KVM as hypervisor" and press <Next> +#. Select "network mode". -Create an OPNFV Environment ---------------------------- + - Select "Neutron with ML2 plugin" -17. Connect to Fuel WEB UI with a browser towards port http://<ip of -fuel server>:8000 (login admin/admin) + - Select "Neutron with tunneling segmentation" (Required when using the ODL or ONOS plugins) -18. Create and name a new OpenStack environment, to be installed. + - Press <Next> -19. Select <Kilo on Ubuntu 14.04> and press "Next" +#. Select "Storage Back-ends". -20. Select compute virtulization method. + - Select "Ceph for block storage" and press <Next> - - Select KVM as hypervisor (or one of your choosing) and press "Next" +#. Select "additional services" you wish to install. -18. Select network mode. + - Check option "Install Celiometer (OpenStack Telemetry)" and press <Next> - - Select Neutron with GRE segmentation and press "Next" +#. Create the new environment. - Note: Required if using the ODL plugin + - Click <Create> Button -19. Select Storage Back-ends. +Configure the network environment +--------------------------------- - - Select "Yes, use Ceph" if you intend to deploy Ceph Backends and - press "Next" +#. Open the environment you previously created. -20. Select additional services you wish to install. +#. Open the networks tab and select the "default Node Networks group to" on the left pane (see figure below). - - Check option <Install Celiometer (OpenStack Telemetry)> and press "Next" - Note: If you use Ceilometer and you only have 5 nodes, you may - have to run in a 3/1/1 (controller/ceilo-mongo/compute) - configuration. Suggest adding more compute nodes + .. figure:: img/network.png -21. Create the new environment. +#. Update the Public network configuration and change the following fields to appropriate values: - - Click "Create" Button + - CIDR to <CIDR for Public IP Addresses> -Configure the OPNFV environment -------------------------------- + - IP Range Start to <Public IP Address start> -22. Enable PXE booting (if you haven't done this already) + - IP Range End to <Public IP Address end> - - 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. + - Gateway to <Gateway for Public IP Addresses> -23. Wait for the availability of nodes showing up in the Fuel GUI. + - Check <VLAN tagging>. - - Wait until all nodes are displayed in top right corner of the - Fuel GUI: <total number of server> TOTAL NODES and <total number - of servers> UNALLOCATED NODES. + - Set appropriate VLAN id. -24. Open the environment you previously created. +#. Update the Storage Network Configuration -25. Open the networks tab. + - Set CIDR to appropriate value (default 192.168.1.0/24) -26. Update the Public network configuration. + - Set IP Range Start to appropriate value (default 192.168.1.1) - Change the following fields to appropriate values: + - Set IP Range End to appropriate value (default 192.168.1.254) - - IP Range Start to <Public IP Address start> + - Set vlan to appropriate value (default 102) - - IP Range End to <Public IP Address end> +#. Update the Management network configuration. - - CIDR to <CIDR for Public IP Addresses> + - Set CIDR to appropriate value (default 192.168.0.0/24) - - Check VLAN tagging. + - Set IP Range Start to appropriate value (default 192.168.0.1) - - Set appropriate VLAN id. + - Set IP Range End to appropriate value (default 192.168.0.254) - - Gateway to <Gateway for Public IP Addresses> + - Check <VLAN tagging>. - - Set floating ip ranges + - Set appropriate VLAN id. (default 101) +#. Update the Private Network Information -27. Update the Storage Network Configuration + - Set CIDR to appropriate value (default 192.168.2.0/24 - - Set CIDR to appropriate value (default 192.168.1.0/24) + - Set IP Range Start to appropriate value (default 192.168.2.1) - - Set vlan to appropriate value (default 102) + - Set IP Range End to appropriate value (default 192.168.2.254) -28. Update the Management network configuration. + - Check <VLAN tagging>. - - Set CIDR to appropriate value (default 192.168.0.0/24) + - Set appropriate VLAN tag (default 103) - - Check VLAN tagging. +#. Select the "Neutron L3 Node Networks group" on the left pane. - - Set appropriate VLAN id. (default 101) + .. figure:: img/neutronl3.png -29. Update the Private Network Information +#. Update the Floating Network configuration. - - Set CIDR to appropriate value (default 192.168.2.0/24 + - Set the Floating IP range start (default 172.16.0.130) - - Check and set VLAN tag appropriately (default 103) + - Set the Floating IP range end (default 172.16.0.254) -30. Update the Neutron L3 configuration. + - Set the Floating network name (default admin_floating_net) - - Set Internal network CIDR to an appropriate value +#. Update the Internal Network configuration. - - Set Internal network gateway to an appropriate value + - Set Internal network CIDR to an appropriate value (default 192.168.111.0/24) - - Set Guest OS DNS Server values appropriately + - Set Internal network gateway to an appropriate value -31. Save Settings. + - Set the Internal network name (default admin_internal_net) -32. Click on the "Nodes" Tab in the FUEL WEB UI. +#. Update the Guest OS DNS servers. -33. Assign roles. + - Set Guest OS DNS Server values appropriately - - Click on "+Add Nodes" button +#. Save Settings. - - Check "Controller" and the "Storage-Ceph OSD" in the Assign Roles Section +#. Select the "Other Node Networks group" on the left pane(see figure below). - - Check the 3 Nodes you want to act as Controllers from the bottom half of the screen + .. figure:: img/other.png - - Click <Apply Changes>. +#. Update the Public network assignment. - - Click on "+Add Nodes" button + - Check the box for "Assign public network to all nodes" (Required by OpenDaylight) - - Check "Compute" in the Assign Roles Section +#. Update Host OS DNS Servers. - - Check the Nodes that you want to act as Computes from the bottom half of the screen + - Provide the DNS server settings - - Click <Apply Changes>. +#. Update Host OS NTP Servers. + - Provide the NTP server settings -34. Configure interfaces. +Select Hypervisor type +---------------------- - - Check Select <All> to select all nodes with Control, Telemetry, - MongoDB and Compute node roles. +#. In the FUEL UI of your Environment, click the "Settings" Tab - - Click <Configure Interfaces> +#. Select Compute on the left side pane (see figure below) - - Screen Configure interfaces on number of <number of nodes> nodes is shown. + - Check the KVM box and press "Save settings" - - Assign interfaces (bonded) for mgmt-, admin-, private-, public- - and storage networks + .. figure:: img/compute.png + +Enable Plugins +-------------- + +#. In the FUEL UI of your Environment, click the "Settings" Tab + +#. Select Other on the left side pane (see figure below) - Note: Set MTU level to at least MTU=1458 (recommended - MTU=1450 for SDN over VXLAN Usage) for each network if you - using ODL plugin + - Enable and configure the plugins of your choice - - Click Apply + .. figure:: img/plugins.png -Enable ODL ----------- +Allocate nodes to environment and assign functional roles +--------------------------------------------------------- -TODO: NOT UPDATED YET FOR WP1 - NOT AVAILABLE AT TIME OF EDIT +#. Click on the "Nodes" Tab in the FUEL WEB UI (see figure below). -35. In the FUEL UI of your Enviornment, click the "Settings" Tab + .. figure:: img/addnodes.png - - Enable OpenStack debug logging (in the Common Section) - optional +#. Assign roles (see figure below). - - Check the OpenDaylight Lithium Plugin Section + - 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>. - - Check to enable VXLAN + - Click on the <+Add Nodes> button - - Modify VNI and Port Range if desired + - Check the <Controller> and <Storage - Ceph OSD> roles. - - Click "Save Settings" at the bottom to Save. + - 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>. + + .. figure:: img/computelist.png + +#. Configure interfaces (see figure below). + + - Check Select <All> to select all allocated nodes + + - Click <Configure Interfaces> + + - Assign interfaces (bonded) for mgmt-, admin-, private-, public- + and storage networks + + - Click <Apply> + + .. figure:: img/interfaceconf.png 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 +no connection to the Internet. The Fuel server delivers a local repo that can be used for installation / deployment of openstack. -36. In the Fuel UI of your Environment, click the Settings Tab and -scroll to the Repositories Section. +#. 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/ubuntu-part trusty main" - - "ubuntu-security" URI="deb - http://<ip-of-fuel-server>:8080/ubuntu-part trusty main" - - "ubuntu-updates" URI="deb - http://<ip-of-fuel-server>:8080/ubuntu-part trusty main" - - "mos-updates" URI="deb - http://<ip-of-fuel-server>:8080/mos-ubuntu mos6.1-updates main - restricted" - - "mos-security" URI="deb - http://<ip-of-fuel-server>:8080/mos-ubuntu mos6.1-security main - restricted" - - "mos-holdback" URI="deb - http://<ip-of-fuel-server>:8080/mos-ubuntu mos6.1-holdback main - restricted" - - - Click "Save Settings" at the bottom to Save your changes + + - "ubuntu-security" URI="deb http://<ip-of-fuel-server>:8080/ubuntu-part trusty main" + + - "ubuntu-updates" URI="deb http://<ip-of-fuel-server>:8080/ubuntu-part trusty main" + + - "mos-updates" URI="deb http://<ip-of-fuel-server>:8080/mos-ubuntu mos8.0-updates main restricted" + + - "mos-security" URI="deb http://<ip-of-fuel-server>:8080/mos-ubuntu mos8.0-security main restricted" + + - "mos-holdback" URI="deb http://<ip-of-fuel-server>:8080/mos-ubuntu mos8.0-holdback main restricted" + + - Click <Save Settings> at the bottom to Save your changes Verify Networks --------------- -Its is important that Verify Networks be done as it will ensure that -you can not only communicate on the networks you have setup, but can -fetch the packages needed for a succesful deployment. +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 (see figure below) -37. From the FUEL UI in your Environment, Select the Networks Tab + - Select <Verify Networks> - - At the bottom of the page, Select "Verify Networks" + - Continue to fix your topology (physical switch, etc) until the "Verification Succeeded" and "Your network is configured correctly" message is shown + + .. figure:: img/verifynet.png - - Continue to fix your topology (physical switch, etc) until the - "Verification Succeeded - Your network is configured correctly" - message is shown Deploy Your Environment ----------------------- 38. Deploy the environment. - In the Fuel GUI, click on the Dashboard Tab. + - In the Fuel GUI, click on the "Dashboard" Tab. - - Click on 'Deploy Changes' in the 'Ready to Deploy?' Section + - Click on <Deploy Changes> in the "Ready to Deploy?" section - - Examine any information notice that pops up and click 'Deploy' + - Examine any information notice that pops up and click <Deploy> - Wait for your deployment to complete, you can view the 'Dashboard' - Tag to see the progress and status of your deployment. + Wait for your deployment to complete, you can view the "Dashboard" + Tab to see the progress and status of your deployment. Installation health-check ========================= -39. Perform system 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" - - Note: Live-Migraition test will fail (Bug in ODL currently), - you can skip this test in the list if you choose to not see - the error message, simply uncheck it in the list + - Check <Select All> and Click <Run Tests> - Allow tests to run and investigate results where appropriate -40. Verify that the OpenDaylight GUI is accessible - -TODO: Not available for WP1 Update at time of writing - -Point your browser to the following URL: -http://{Controller-VIP}:8181/index.html> and login: - - - Username: admin - - Password: admin + .. figure:: img/health.png References ========== @@ -607,12 +595,10 @@ OPNFV `OPNFV Home Page <www.opnfv.org>`_ -`OPNFV Genesis project page <https://wiki.opnfv.org/get_started>`_ - OpenStack --------- -`OpenStack Kilo Release artifacts <http://www.openstack.org/software/kilo>`_ +`OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_ `OpenStack documentation <http://docs.openstack.org>`_ @@ -625,12 +611,3 @@ Fuel ---- `Fuel documentation <https://wiki.openstack.org/wiki/Fuel>`_ - -:Authors: Daniel Smith (Ericsson AB) -:Version: 2.0.0 - -**Documentation tracking** - -Revision: _sha1_ - -Build date: _date diff --git a/docs/release-notes.rst b/docs/release-notes.rst index e7b52156c..0ffa683cb 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,100 +1,99 @@ -========================================================================================= -OPNFV Release Note for the Arno SR1 release of OPNFV when using Fuel as a deployment tool -========================================================================================= - +============================================================================================ +OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool +============================================================================================ .. contents:: Table of Contents :backlinks: none - Abstract ======== -This document compiles the release notes for the Arno SR1 release of +This document compiles the release notes for the Brahmaputra release of OPNFV when using Fuel as a deployment tool. License ======= -Arno SR1 release with the Fuel deployment tool Docs (c) by Jonas +Brahmaputra release with the Fuel deployment tool Docs (c) by Jonas Bjurel (Ericsson AB) -Arno SR1 release with the Fuel deployment tool Docs are licensed under -a Creative Commons Attribution 4.0 International License. You should -have received a copy of the license along with this. If not, see -<http://creativecommons.org/licenses/by/4.0/>. +This document is licensed under a Creative Commons Attribution 4.0 +International License. - -Version history -=============== - -+--------------------+--------------------+--------------------+--------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| 2015-06-03 | 1.0.0 | Jonas Bjurel | Arno SR0 release | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| 2015-09-28 | 1.1.3 | Jonas Bjurel | Arno SR1 release | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ +You should have received a copy of the license along with this document. +If not, see <http://creativecommons.org/licenses/by/4.0/>. Important notes =============== -For the first OPNFV release (Arno), these notes introduce use of -`OpenStack Fuel <https://wiki.openstack.org/wiki/Fuel>` for the -deployment stage of the OPNFV continuous integration (CI) pipeline. -The goal of the Arno release and this Fuel-based deployment process is -to establish a foundational platform accelerating further development -of the OPNFV infrastructure. - +These notes provides release information for the use of Fuel as deployment +tool for the Brahmaputra release of OPNFV. -Carefully follow the installation-instructions and pay special -attention to the pre-deploy script that needs to be run before -deployment is started. +The goal of the Brahmaputra release and this Fuel-based deployment process is +to establish a lab ready platform accelerating further development +of the OPNFV infrastructure. +Carefully follow the installation-instructions. Summary ======= -For Arno SR1, the typical use of Fuel as an OpenStack installer is -supplemented with OPNFV unique components such as `OpenDaylight -<http://www.opendaylight.org/software>`_ version Helium as well as -OPNFV-unique configurations. +For Brahmaputra, the typical use of Fuel as an OpenStack installer is +supplemented with OPNFV unique components such as: +- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Berylium RC1 as" -This Arno artefact provides Fuel as the deployment stage tool in the -OPNFV CI pipeline including: +- `ONOS <http://onosproject.org/>`_ version "Drake" + +- `Service function chaining <https://wiki.opnfv.org/service_function_chaining>`_ + +- `SDN distributed routing and VPN <https://wiki.opnfv.org/sdnvpn>`_ + +- `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_ + +- `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_ + +- `VSPERF <https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases>`_ +As well as OPNFV-unique configurations of the Hardware- and Software stack. + +This Brahmaputra artifact provides Fuel as the deployment stage tool in the +OPNFV CI pipeline including: - Documentation built by Jenkins + + - overall OPNFV documentation + - this document (release notes) + - installation instructions + - build-instructions -- The Arno Fuel installer image (.iso) built by Jenkins -- Automated deployment of Arno with running on bare metal or a nested - hypervisor environment (KVM) -- Automated validation of the Arno deployment + +- The Brahmaputra Fuel installer image (.iso) built by Jenkins + +- Automated deployment of Brahmaputra with running on bare metal or a nested hypervisor environment (KVM) + +- Automated validation of the Brahmaputra deployment Release Data ============ +--------------------------------------+--------------------------------------+ -| **Project** | genesis/bgs | +| **Project** | fuel | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | genesis/arno.2015.2.0 | +| **Repo/tag** | fuel/<TODO> | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Arno Base Service release 1 (SR1) | +| **Release designation** | Brahmaputra base release | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | 2015-10-01 | +| **Release date** | <TODO> | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | OPNFV Arno Base SR1 release | +| **Purpose of the delivery** | Brahmaputra base release | | | | +--------------------------------------+--------------------------------------+ @@ -106,73 +105,58 @@ Module version changes This is the second tracked release of genesis/fuel. It is based on following upstream versions: -- Fuel 6.1.0 -- OpenStack Juno release -- OpenDaylight Litium release +- Fuel 8.0 pre-release + +- OpenStack Liberty release + +- OpenDaylight Beryllium pre-release -Document version changes -~~~~~~~~~~~~~~~~~~~~~~~~ -This is the second tracked version of the fuel installer for OPNFV. It +- ONOS Drake release + +Document changes +~~~~~~~~~~~~~~~~ +This is the third tracked version of the fuel installer for OPNFV. It comes with the following documentation: -- OPNFV Installation instructions for Arno with Fuel as deployment tool -- OPNFV Release Notes for Arno use of Fuel as deployment tool -- OPNFV Build instructions for Arno with Fuel as deployment tool +- OPNFV Installation instructions for Brahmaputra with Fuel as deployment tool - **Changed** + +- OPNFV Release Notes for Brahmaputra use of Fuel as deployment tool - **Changed** +- OPNFV Build instructions for Brahmaputra with Fuel as deployment tool - **Changed** Reason for version ------------------ Feature additions ~~~~~~~~~~~~~~~~~ -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: FUEL-4 | Baselining Fuel 6.0.1 for OPNFV | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: FUEL-17 | Integration of OpenDaylight | -| | | -+--------------------------------------+--------------------------------------+ +**JIRA TICKETS:** + +`New features <https://jira.opnfv.org/browse/FUEL-81?jql=project%20%3D%20FUEL%20AND%20issuetype%20in%20%28Improvement%2C%20%22New%20Feature%22%2C%20Story%2C%20Sub-task%29%20AND%20status%20in%20%28Resolved%2C%20Closed%29%20AND%20resolution%20%3D%20Fixed%20AND%20labels%20in%20%28Fuel-B-WP1%2C%20R2%2C%20brahmaputra%29>`_ Bug corrections ~~~~~~~~~~~~~~~ **JIRA TICKETS:** -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: BGS-57 | The OpenDaylight Helium release is | -| | not fully functional and the | -| | resulting Fuel integration is not | -| | able to cope with the deficiancies. | -| | It is therefore not recommended to | -| | to enable this option. | -| | A functional integration of ODL | -| | version: Lithium is expected to be | -| | available in an upcomming service | -| | release. | -| | | -+--------------------------------------+--------------------------------------+ +`Bug-fixes <https://jira.opnfv.org/browse/FUEL-96?jql=project%20%3D%20FUEL%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20%28Resolved%2C%20Closed%29%20AND%20resolution%20%3D%20Fixed%20AND%20labels%20in%20%28Fuel-B-WP1%2C%20R2%2C%20brahmaputra%29>`_ Deliverables ------------ Software deliverables ~~~~~~~~~~~~~~~~~~~~~ -Fuel-based installer iso file <arno.2015.2.0.fuel.iso> + +Fuel-based installer iso file <TODO> Documentation deliverables ~~~~~~~~~~~~~~~~~~~~~~~~~~ -- OPNFV Installation instructions for Arno release with the Fuel - deployment tool - ver. 1.1.0 -- OPNFV Build instructions for Arno release with the Fuel deployment - tool - ver. 1.1.0 -- OPNFV Release Note for Arno release with the Fuel deployment tool - - ver. 1.1.3 (this document) + +- OPNFV Installation instructions for Brahmaputra release with the Fuel deployment tool + +- OPNFV Build instructions for Brahmaputra release with the Fuel deployment + tool + +- OPNFV Release Note for Brahmaputra release with the Fuel deployment tool - (this document) Known Limitations, Issues and Workarounds ========================================= @@ -180,13 +164,13 @@ Known Limitations, Issues and Workarounds System Limitations ------------------ -**Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades +- **Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades -**Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade +- **Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade -**Storage:** Ceph is the only supported storage configuration. +- **Storage:** Ceph is the only supported storage configuration. -**Max number of networks:** 3800 (Needs special switch config.) +- **Max number of networks:** 65k Known issues @@ -194,41 +178,20 @@ Known issues **JIRA TICKETS:** -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: FUEL-43 | VMs not accessible through SSH due | -| | to VXLAN 50 Byte overhead and lack | -| | of proper MTU value setting on | -| | virtual ethernet devices | -+--------------------------------------+--------------------------------------+ -| JIRA: FUEL-44 | Centos 6.5 option has not been | -| | enough verified | -+--------------------------------------+--------------------------------------+ - +`Known issues <https://jira.opnfv.org/browse/FUEL-99?jql=project%20%3D%20FUEL%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20%28Open%2C%20%22In%20Progress%22%2C%20Reopened%29>`_ Workarounds ----------- -See JIRA: `FUEL-43 <https://jira.opnfv.org/browse/FUEL-43>` +- -Test Result -=========== -Arno SR1 release with the Fuel deployment tool has undergone QA test +Test results +============ +The Brahmaputra release with the Fuel deployment tool has undergone QA test runs with the following results: -https://wiki.opnfv.org/arno_sr1_result_page?rev=1443626728 +<TODO> References ========== -For more information on the OPNFV Arno release, please see -http://wiki.opnfv.org/releases/arno. - -:Authors: Jonas Bjurel (Ericsson) -:Version: 1.1.3 - -**Documentation tracking** - -Revision: _sha1_ - -Build date: _date_ +For more information on the OPNFV Brahmaputra release, please see +<TODO> |
