diff options
| -rw-r--r-- | docs/build-instruction.rst (renamed from docs/build-instructions.rst) | 68 | ||||
| -rw-r--r-- | docs/installation-instruction.rst (renamed from docs/installation-instructions.rst) | 315 | ||||
| -rw-r--r-- | docs/release-notes.rst | 59 |
3 files changed, 317 insertions, 125 deletions
diff --git a/docs/build-instructions.rst b/docs/build-instruction.rst index aa8077e6e..b7b13c896 100644 --- a/docs/build-instructions.rst +++ b/docs/build-instruction.rst @@ -1,5 +1,5 @@ ============================================================================ -OPNFV Build instructions for the Fuel deployment tool +OPNFV Build instruction for the Fuel deployment tool ============================================================================ .. contents:: Table of Contents @@ -8,7 +8,10 @@ OPNFV Build instructions for the Fuel deployment tool Abstract ======== -This document describes how to build the Fuel deployment tool for the B release of OPNFV - the build system, dependencies and required system resources. +This document describes how to build the Fuel deployment tool for the +B release of OPNFV - the build system, dependencies and required +system resources. + License ======= @@ -25,16 +28,16 @@ Version history | **Date** | **Ver.** | **Author** | **Comment** | | | | | | +--------------------+--------------------+--------------------+----------------------+ -| 2015-06-03 | 1.0.0 | Jonas Bjurel | Instructions for | +| 2015-06-03 | 1.0.0 | Jonas Bjurel | Instruction for | | | | (Ericsson AB) | the Arno release | +--------------------+--------------------+--------------------+----------------------+ -| 2015-09-24 | 1.1.0 | Jonas Bjurel | Instructions for | +| 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 instructions | +| 2015-10-23 | 1.1.1 | Stefan Berg | Added instruction | | | | (Ericsson AB) | for proxy builds | +--------------------+--------------------+--------------------+----------------------+ -| 2015-12-03 | 1.2.0 | Stefan Berg | Added instructions | +| 2015-12-03 | 1.2.0 | Stefan Berg | Added instruction | | | | (Ericsson AB) | for plugin build | | | | | selection | +--------------------+--------------------+--------------------+----------------------+ @@ -42,11 +45,18 @@ Version history 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. +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. -The Fuel build system is desigened 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. +The Fuel build system is desigened 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. -The audience of this document is assumed to have good knowledge in network and Unix/Linux administration. +The audience of this document is assumed to have good knowledge in +network and Unix/Linux administration. Requirements ============ @@ -67,7 +77,9 @@ 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/installation/ubuntulinux/ for installation notes for Ubuntu 14.04. Note: only use the Ubuntu stock distro of Docker (docker.io) +- docker - see https://docs.docker.com/installation/ubuntulinux/ for + installation notes for Ubuntu 14.04. Note: only use the Ubuntu stock + distro of Docker (docker.io) - git (simply available through sudo apt-get install git) @@ -95,12 +107,15 @@ Then restart docker: Setting up OPNFV Gerrit in order to being able to clone the code ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- Start setting up OPNFV gerrit by creating a SSH key (unless you don't already have one), create one with ssh-keygen +- Start setting up OPNFV gerrit by creating a SSH key (unless you + 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 already have one) + (this requires a linuxfoundation account, create one if you do not + already have one) -- Select "SSH Public Keys" to the left and then "Add Key" and paste your public key in. +- Select "SSH Public Keys" to the left and then "Add Key" and paste + your public key in. Clone the OPNFV code Git repository with your SSH key ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -108,7 +123,8 @@ Now it is time to clone the code repository: <git clone ssh://'Linux foundation user'@gerrit.opnfv.org:29418/fuel> -Now you should have the OPNFV fuel repository with the Fuel directories stored locally on your build host. +Now you should have the OPNFV fuel repository with the Fuel +directories stored locally on your build host. Check out the Brahmaputra release: <cd fuel> @@ -243,25 +259,32 @@ Following targets exist: - If not already existing, initialize the docker build environment - - If not already done, build OpenDaylight from upstream (as defined by fuel-build config-spec) + - If not already done, build OpenDaylight from upstream (as defined + by fuel-build config-spec) - - If not already done, build fuel from upstream (as defined by fuel-build/config-spec) + - If not already done, build fuel from upstream (as defined by + fuel-build/config-spec) - - Build the defined additions to fuel (as defined by the structure of this framework) + - Build the defined additions to fuel (as defined by the structure + of this framework) - - Apply changes and patches to fuel (as defined by the structure of this framework) + - Apply changes and patches to fuel (as defined by the structure of + this framework) - Reconstruct a fuel .iso image - clean - this will remove all artifacts from earlier builds. -If the build is successful, you will find the generated ISO file in the <fuel/build/release> subdirectory! +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: +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. +- Create and use a build cache - significantly speeding up the + buildtime if upstream repositories have not changed. - push/pull cache and artifacts to an arbitrary URI (http(s):, file:, ftp:) @@ -272,7 +295,8 @@ Artifacts The artifacts produced are: -- <OPNFV_XXXX.iso> - Which represents the bootable Fuel image, XXXX is replaced with the build identity provided to the build system +- <OPNFV_XXXX.iso> - Which represents the bootable Fuel image, XXXX is + replaced with the build identity provided to the build system - <OPNFV_XXXX.iso.txt> - Which holds version metadata. diff --git a/docs/installation-instructions.rst b/docs/installation-instruction.rst index aedbb53d5..5c4438991 100644 --- a/docs/installation-instructions.rst +++ b/docs/installation-instruction.rst @@ -1,85 +1,115 @@ -================================================================================================== -OPNFV Installation instructions for the Arno release of OPNFV when using Fuel as a deployment tool -================================================================================================== +============================================================================================================= +OPNFV Installation instruction for the Brahmaputra WP1 release of OPNFV when using Fuel as a deployment tool +============================================================================================================= .. contents:: Table of Contents :backlinks: none - Abstract ======== - -This document describes how to install the Arno SR1 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 WP1 release of +OPNFV when using Fuel as a deployment tool covering it's limitations, +dependencies and required system resources. License ======= -Arno SR1 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 (c) by Jonas Bjurel (Ericsson AB) -Arno SR1 release of OPNFV when using Fuel as a 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/>. +Brahmaputra WP1 release of OPNFV when using Fuel as a 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/>. Version history =============== - +--------------------+--------------------+--------------------+--------------------+ | **Date** | **Ver.** | **Author** | **Comment** | | | | | | +--------------------+--------------------+--------------------+--------------------+ | 2015-06-03 | 1.0.0 | Jonas Bjurel | Installation | -| | | (Ericsson AB) | instructions for | +| | | (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 Arno SR1 release of OPNFV when using Fuel as a deployment tool including required software and hardware configurations. +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. -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 compliant reference architecture. This instruction provides a step-by-step guide that results in an OPNFV Arno SR1 compliant deployment. +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 +compliant reference architecture. This instruction provides a +step-by-step guide that results in an OPNFV Brahmaputra WP1 compliant +deployment. -The audience of this document is assumed to have good knowledge in networking and Unix/Linux administration. +The audience of this document is assumed to have good knowledge in +networking and Unix/Linux administration. Preface ======= - -Before starting the installation of the Arno SR1 release of OPNFV when using Fuel as a deployment tool, some planning must be done. +Before starting the installation of the Brahmaputra WP1 release of +OPNFV when 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 Arno SR1 release of OPNFV when using Fuel as a deployment tool can be found at http://artifacts.opnfv.org/arno.2015.2.0/fuel/arno.2015.2.0.fuel.iso +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 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 release use the following command: +Alternatively, you may build the .iso from source by cloning the +opnfv/genesis git repository. To retrieve the repository for the Arno +release use the following command: -- git clone https://<linux foundation uid>@gerrit.opnf.org/gerrit/genesis +- git clone https://<linux foundation uid>@gerrit.opnf.org/gerrit/fuel -Check-out the Arno SR1 release tag to set the branch to the baseline required to replicate the Arno SR1 release: +Check-out the Brahmaputra WP1 release tag to set the branch to the +baseline required to replicate the Brahmaputra WP1 release: -- cd genesis; git checkout stable/arno2015.2.0 +- TODO: NEEDS UPDATE TO REFLECT WP1 TAG / NEW REPO - cd genesis; git + checkout stable/arno2015.2.0 Go to the fuel directory and build the .iso: - cd fuel/build; make all -For more information on how to build, please see "OPNFV Build instructions for - Arno SR1 release of OPNFV when using Fuel as a deployment tool which you retrieved with the repository at </genesis/fuel/docs/src/build-instructions.rst> +For more information on how to build, please see "OPNFV Build +instructions for - Brahmaputra WP1 release of OPNFV when using Fuel as +a deployment tool which you retrieved with the repository at +</fuel/fuel/docs/src/build-instructions.rst> -Next, familiarize yourself with the Fuel 6.1 version by reading the following documents: +Next, familiarize yourself with the Fuel 7.0 version by reading the +following documents: -- Fuel planning guide <https://docs.mirantis.com/openstack/fuel/fuel-6.1/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-6.1/user-guide.html#user-guide> +- 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-6.1/operations.html#operations-guide> +- 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> @@ -97,19 +127,23 @@ A number of deployment specific parameters must be collected, those are: 6. Linux Distro you intend to deploy. -7. 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) 8. Monitoring Options you want to deploy (Ceilometer, MongoDB). -9. Other options not covered in the document are available in the links above +9. 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. +This information will be needed for the configuration procedures +provided in this document. Hardware requirements ===================== -The following minimum hardware requirements must be met for the installation of Arno SR1 using Fuel: +The following minimum hardware requirements must be met for the +installation of Brahmaputra WP1 using Fuel: +--------------------+------------------------------------------------------+ | **HW Aspect** | **Requirement** | @@ -148,33 +182,59 @@ Help with Hardware Requirements Calculate hardware requirements: -You can use the Fuel Hardware Calculator <https://www.mirantis.com/openstack-services/bom-calculator/> to calculate the hardware required for your OpenStack environment. +Refer to the OpenStack Hardware Compability 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: +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 ================================================ -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. - -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 Arno SR1 hardware platform should be carried out according to the Pharos specification TODO-<insert link to Pharos ARNO SR1 Specification> +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. + +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 WP1 hardware platform should +be carried out according to the Pharos specification TODO-<insert link +to Pharos ARNO SR1 Specification> OPNFV Software installation and deployment ========================================== -This section describes the installation of the OPNFV installation server (Fuel master) as well as the deployment of the full OPNFV reference platform stack across a server cluster. +This section describes the installation of the OPNFV installation +server (Fuel master) as well as the deployment of the full OPNFV +reference platform stack across a server cluster. Install Fuel master ------------------- -1. Mount the Arno SR1 ISO file as a boot device to the jump host server. +1. Mount the Brahmaputra WP1 ISO file as a boot device to the jump host server. 2. Reboot the jump host to establish the Fuel server. @@ -186,11 +246,22 @@ Install Fuel master 3. Wait until screen Fuel setup is shown (Note: This can take up to 30 minutes). -4. 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. +4. In the 'Fuel User' Section - Confirm/change the default password + - Enter 'admin' in the Fuel password input + + - Enter 'admin' in the Confim password input + + - Select 'Check' and press [Enter] + +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. - - Configure eth1 or other network interfaces here as well (if you have them present on your FUEL server). + - Configure eth1 or other network interfaces here as well (if you + have them present on your FUEL server). -5. Select PXE Setup and change the following fields to appropriate values (example below): +6. In 'PXE Setup' Section - Change the following fields to appropriate +values (example below): - DHCP Pool Start 10.20.0.3 @@ -198,15 +269,33 @@ Install Fuel master - DHCP Pool Gateway 10.20.0.2 (ip of Fuel node) +7. In 'DNS & Hostname' - Change the following fields to appropriate values: + - Hostname <OPNFV Region name>-fuel - Domain <Domain Name> - Search Domain <Search Domain Name> + - External DNS + - Hostname to test DNS <Hostname to test DNS> -6. Select Time Sync and change the following fields to appropriate values: + - Select 'Check' and press [Enter] + + +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) + + - Navigate to 'HTTP proxy' and input your http proxy address + + - Select 'Check' and press [Enter] + + +9. In 'Time Sync' Section - Change the following fields to appropriate values: - NTP Server 1 <Customer NTP server 1> @@ -214,7 +303,7 @@ Install Fuel master - NTP Server 3 <Customer NTP server 3> -7. Start the installation. +10. Start the installation. - Select Quit Setup and press Save and Quit. @@ -224,45 +313,59 @@ Install Fuel master Boot the Node Servers --------------------- -After the Fuel Master node has rebooted from the above step 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 +After the Fuel Master node has rebooted from the above step 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. -8. Enable PXE booting +11. 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. + - 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. -9. Reboot all the control and compute blades. +12. Reboot all the control and compute blades. -10. Wait for the availability of nodes showing up in the Fuel GUI. +13. Wait for the availability of nodes showing up in the Fuel GUI. - - 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. + - 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 ODL Plugin on FUEL node ------------------------------- -11. SSH to your FUEL node (e.g. root@10.20.0.2 pwd: r00tme) +NOTE: CURRENTLY DISABLED IN B-REL WP1 + +14. SSH to your FUEL node (e.g. root@10.20.0.2 pwd: r00tme) -12. Verify the plugin exists at /opt/opnfv/opendaylight-0.6-0.6.1-1.noarch.rpm +15. Verify the plugin exists at /opt/opnfv/opendaylight-0.6-0.6.1-1.noarch.rpm -13. Install the plugin with the command +16. Install the plugin with the command - "fuel plugins --install /opt/opnfv/opendaylight-0.6-0.6.1-1.noarch.rpm" - - Expected output: "Plugin opendaylight-0.6-0.6.1-1.noarch.rpm was successfully installed." + - Expected output: "Plugin opendaylight-0.6-0.6.1-1.noarch.rpm was + successfully installed." Create an OPNFV Environment --------------------------- -14. Connect to Fuel WEB UI with a browser towards port http://<ip of fuel server>:8000 (login admin/admin) +17. Connect to Fuel WEB UI with a browser towards port http://<ip of +fuel server>:8000 (login admin/admin) -15. Create and name a new OpenStack environment, to be installed. +18. Create and name a new OpenStack environment, to be installed. -16. Select <Juno on Ubuntu> or <Juno on CentOS> as per your which in the "OpenStack Release" field and press "Next" +19. Select <Kilo on Ubuntu 14.04> and press "Next" -17. Select compute virtulization method. +20. Select compute virtulization method. - Select KVM as hypervisor (or one of your choosing) and press "Next" @@ -270,17 +373,19 @@ Create an OPNFV Environment - Select Neutron with GRE segmentation and press "Next" - Note: this is the supportted method when using the ODL installation, other options will not work with the plugin and this Instruction Set. + Note: Required if using the ODL plugin 19. Select Storage Back-ends. - - Select "Yes, use Ceph" if you intend to deploy Ceph Backends and press "Next" - + - Select "Yes, use Ceph" if you intend to deploy Ceph Backends and + press "Next" 20. Select additional services you wish to install. - 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 + 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 21. Create the new environment. @@ -291,11 +396,15 @@ Configure the OPNFV environment 22. Enable PXE booting (if you haven't done this already) - - 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. + - 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. 23. Wait for the availability of nodes showing up in the Fuel GUI. - - 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. + - 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. 24. Open the environment you previously created. @@ -373,21 +482,27 @@ Configure the OPNFV environment 34. Configure interfaces. - - Check Select <All> to select all nodes with Control, Telemetry, MongoDB and Compute node roles. + - Check Select <All> to select all nodes with Control, Telemetry, + MongoDB and Compute node roles. - Click <Configure Interfaces> - Screen Configure interfaces on number of <number of nodes> nodes is shown. - - Assign interfaces (bonded) for mgmt-, admin-, private-, public- and storage networks + - Assign interfaces (bonded) for mgmt-, admin-, private-, public- + and storage networks - - Note: Set MTU level to at least MTU=2090 (recommended MTU=2140 for SDN over VXLAN Usage) for each network + 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 - Click Apply Enable ODL ---------- +TODO: NOT UPDATED YET FOR WP1 - NOT AVAILABLE AT TIME OF EDIT + 35. In the FUEL UI of your Enviornment, click the "Settings" Tab - Enable OpenStack debug logging (in the Common Section) - optional @@ -404,41 +519,60 @@ Enable ODL 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. +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. -36. In the Fuel UI of your Environment, click the Settings Tab and scroll to the Repositories Section. +36. In the Fuel UI of your Environment, click the Settings Tab and +scroll to the Repositories Section. - 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" + - "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 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. +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. 37. From the FUEL UI in your Environment, Select the Networks Tab - At the bottom of the page, Select "Verify Networks" - - Continue to fix your topology (physical switch, etc) until the "Verification Succeeded - Your network is configured correctly" message is shown + - 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 Deploy Changes. - - Wait until your Environment is deployed and the Horizon URI to connect is displayed in the FUEL GUI for your 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' + Tag to see the progress and status of your deployment. Installation health-check ========================= @@ -449,13 +583,18 @@ Installation health-check - 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 + 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 - Allow tests to run and investigate results where appropriate 40. Verify that the OpenDaylight GUI is accessible -Point your browser to the following URL: http://{Controller-VIP}:8181/index.html> and login: +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 @@ -473,7 +612,7 @@ OPNFV OpenStack --------- -`OpenStack Juno Release artifacts <http://www.openstack.org/software/juno>`_ +`OpenStack Kilo Release artifacts <http://www.openstack.org/software/kilo>`_ `OpenStack documentation <http://docs.openstack.org>`_ @@ -488,7 +627,7 @@ Fuel `Fuel documentation <https://wiki.openstack.org/wiki/Fuel>`_ :Authors: Daniel Smith (Ericsson AB) -:Version: 1.1.0 +:Version: 2.0.0 **Documentation tracking** diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 435789767..e7b52156c 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -10,14 +10,20 @@ OPNFV Release Note for the Arno SR1 release of OPNFV when using Fuel as a deploy Abstract ======== -This document compiles the release notes for the Arno SR1 release of OPNFV when using Fuel as a deployment tool. +This document compiles the release notes for the Arno SR1 release of +OPNFV when using Fuel as a deployment tool. License ======= -Arno SR1 release with the Fuel deployment tool Docs (c) by Jonas Bjurel (Ericsson AB) +Arno SR1 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/>. -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/>. Version history =============== @@ -36,23 +42,39 @@ Version history 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. +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. + + +Carefully follow the installation-instructions and pay special +attention to the pre-deploy script that needs to be run before +deployment is started. -Carefully follow the installation-instructions and pay special attention to the pre-deploy script that needs to be run before deployment is started. 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 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. + + +This Arno artefact provides Fuel as the deployment stage tool in the +OPNFV CI pipeline including: -This Arno artefact provides Fuel as the deployment stage tool in the OPNFV CI pipeline including: - Documentation built by Jenkins - 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 deployment of Arno with running on bare metal or a nested + hypervisor environment (KVM) - Automated validation of the Arno deployment @@ -81,7 +103,8 @@ Version change Module version changes ~~~~~~~~~~~~~~~~~~~~~~ -This is the second tracked release of genesis/fuel. It is based on following upstream versions: +This is the second tracked release of genesis/fuel. It is based on +following upstream versions: - Fuel 6.1.0 - OpenStack Juno release @@ -89,7 +112,8 @@ This is the second tracked release of genesis/fuel. It is based on following ups Document version changes ~~~~~~~~~~~~~~~~~~~~~~~~ -This is the second tracked version of the fuel installer for OPNFV. It comes with the following documentation: +This is the second 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 @@ -143,9 +167,12 @@ Fuel-based installer iso file <arno.2015.2.0.fuel.iso> 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 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) Known Limitations, Issues and Workarounds ========================================= @@ -188,12 +215,14 @@ 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 runs with the following results: +Arno SR1 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 References ========== -For more information on the OPNFV Arno release, please see http://wiki.opnfv.org/releases/arno. +For more information on the OPNFV Arno release, please see +http://wiki.opnfv.org/releases/arno. :Authors: Jonas Bjurel (Ericsson) :Version: 1.1.3 |