diff options
| -rw-r--r-- | build/f_isoroot/f_ovs-nsh-dpdk-pluginbuild/config.mk | 2 | ||||
| -rw-r--r-- | build/patch-repos/build/repos/fuel-library/0001-Reduce-ceilometer-memory-usage.patch | 30 | ||||
| -rw-r--r-- | deploy/common.py | 3 | ||||
| -rw-r--r-- | deploy/config/labs/devel-pipeline/intel-sc/fuel/config/dea-pod-override.yaml | 264 | ||||
| -rw-r--r-- | deploy/config/labs/devel-pipeline/intel-sc/fuel/config/dha.yaml | 101 | ||||
| -rw-r--r-- | deploy/dha_adapters/zte_adapter.py | 28 | ||||
| -rw-r--r-- | docs/buildprocedure/build.instruction.rst | 80 | ||||
| -rw-r--r-- | docs/buildprocedure/index.rst | 6 | ||||
| -rw-r--r-- | docs/installationprocedure/index.rst | 6 | ||||
| -rw-r--r-- | docs/installationprocedure/installation.instruction.rst | 73 | ||||
| -rw-r--r-- | docs/releasenotes/index.rst | 6 | ||||
| -rw-r--r-- | docs/releasenotes/release-notes.rst | 106 |
12 files changed, 540 insertions, 165 deletions
diff --git a/build/f_isoroot/f_ovs-nsh-dpdk-pluginbuild/config.mk b/build/f_isoroot/f_ovs-nsh-dpdk-pluginbuild/config.mk index a599ecc8c..e895b6ddf 100644 --- a/build/f_isoroot/f_ovs-nsh-dpdk-pluginbuild/config.mk +++ b/build/f_isoroot/f_ovs-nsh-dpdk-pluginbuild/config.mk @@ -7,6 +7,6 @@ # http://www.apache.org/licenses/LICENSE-2.0 ############################################################################## -OVS_NSH_DPDK_BRANCH?=137748b828f03debe5ae1b40a4ee440b8f5e96f8 +OVS_NSH_DPDK_BRANCH?=c77582ea96880cc854b9d82cbaa5b5ed2c5c4639 OVS_NSH_DPDK_REPO?=https://review.openstack.org/openstack/fuel-plugin-ovs OVS_NSH_DPDK_CHANGE?= diff --git a/build/patch-repos/build/repos/fuel-library/0001-Reduce-ceilometer-memory-usage.patch b/build/patch-repos/build/repos/fuel-library/0001-Reduce-ceilometer-memory-usage.patch new file mode 100644 index 000000000..f7fe06884 --- /dev/null +++ b/build/patch-repos/build/repos/fuel-library/0001-Reduce-ceilometer-memory-usage.patch @@ -0,0 +1,30 @@ +From 38315ee3945a5444de13918eb29e7771eb9927c7 Mon Sep 17 00:00:00 2001 +From: Michael Polenchuk <mpolenchuk@mirantis.com> +Date: Thu, 8 Sep 2016 19:25:14 +0300 +Subject: [PATCH 1/1] Reduce ceilometer memory usage + +Change-Id: I8b1a97bd710c859a3543d1aed8226313f35f4f10 +--- + .../manifests/ceilometer/controller.pp | 7 +++++++ + 1 file changed, 7 insertions(+) + +diff --git a/deployment/puppet/openstack_tasks/manifests/ceilometer/controller.pp b/deployment/puppet/openstack_tasks/manifests/ceilometer/controller.pp +index 2c63ff0..1dda109 100644 +--- a/deployment/puppet/openstack_tasks/manifests/ceilometer/controller.pp ++++ b/deployment/puppet/openstack_tasks/manifests/ceilometer/controller.pp +@@ -234,5 +234,12 @@ class openstack_tasks::ceilometer::controller { + Ceilometer_config<| title == 'oslo_messaging_rabbit/kombu_compression' |> { value => $kombu_compression } + } + } ++ ++ # Reduce memory usage ++ ceilometer_config { ++ 'DEFAULT/executor_thread_pool_size': value => ceiling($service_workers*0.5); ++ 'notification/pipeline_processing_queues': value => ceiling($service_workers*1.5); ++ 'oslo_messaging_rabbit/rabbit_qos_prefetch_count': value => 5; ++ } + } + } +-- +1.7.9.5 + diff --git a/deploy/common.py b/deploy/common.py index 353045867..80832e201 100644 --- a/deploy/common.py +++ b/deploy/common.py @@ -18,6 +18,7 @@ import shutil import stat import errno import time +import shlex N = {'id': 0, 'status': 1, 'name': 2, 'cluster': 3, 'ip': 4, 'mac': 5, 'roles': 6, 'pending_roles': 7, 'online': 8, 'group_id': 9} @@ -41,7 +42,7 @@ os.chmod(LOGFILE, 0664) def mask_arguments(cmd, mask_args, mask_str): - cmd_line = cmd.split() + cmd_line = shlex.split(cmd) for pos in mask_args: # Don't mask the actual command; also check if we don't reference # beyond bounds diff --git a/deploy/config/labs/devel-pipeline/intel-sc/fuel/config/dea-pod-override.yaml b/deploy/config/labs/devel-pipeline/intel-sc/fuel/config/dea-pod-override.yaml new file mode 100644 index 000000000..eed982d01 --- /dev/null +++ b/deploy/config/labs/devel-pipeline/intel-sc/fuel/config/dea-pod-override.yaml @@ -0,0 +1,264 @@ +############################################################################## +# Copyright (c) 2015 Ericsson AB and others. +# stefan.k.berg@ericsson.com +# jonas.bjurel@ericsson.com +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + +dea-pod-override-config-metadata: + title: 'Deployment Environment Adapter POD override for Development Pipeline - Intel Santa Clara, CA, USA version' + version: '0.1' + created: 'Wed Sept 7 2016' + comment: 'For Fuel 9' +environment: + name: opnfv_virt +interfaces_1: + ens3: + - fuelweb_admin + - storage + ens4: + - management + ens5: + - private + ens6: + - public +transformations_1: + transformations: + - action: add-br + name: br-fw-admin + - action: add-br + name: br-mgmt + - action: add-br + name: br-storage + - action: add-br + name: br-ex + - action: add-br + name: br-floating + provider: ovs + - action: add-patch + bridges: + - br-floating + - br-ex + mtu: 65000 + provider: ovs + - action: add-br + name: br-mesh + - action: add-port + bridge: br-fw-admin + name: ens3 + - action: add-port + bridge: br-mgmt + name: ens4 + - action: add-port + bridge: br-storage + name: ens3.102 + - action: add-port + bridge: br-mesh + name: ens5.103 + - action: add-port + bridge: br-ex + name: ens6 +fuel: + ADMIN_NETWORK: + dhcp_pool_end: 10.20.0.254 + dhcp_pool_start: 10.20.0.3 + ipaddress: 10.20.0.2 + netmask: 255.255.255.0 + ssh_network: 10.20.0.0/24 + DNS_DOMAIN: domain.tld + DNS_SEARCH: domain.tld + DNS_UPSTREAM: 10.248.2.1 + HOSTNAME: fuel + NTP1: 10.20.0.1 + NTP2: null + NTP3: null +network: + networking_parameters: + base_mac: fa:16:3e:00:00:00 + configuration_template: null + dns_nameservers: + - 10.248.2.1 + floating_name: admin_floating_net + floating_ranges: + - - 172.16.0.130 + - 172.16.0.254 + gre_id_range: + - 2 + - 65535 + internal_cidr: 192.168.111.0/24 + internal_gateway: 192.168.111.1 + internal_name: admin_internal_net + net_l23_provider: ovs + segmentation_type: tun + vlan_range: + - 1000 + - 1030 + networks: + - cidr: 192.168.1.0/24 + gateway: null + ip_ranges: + - - 192.168.1.1 + - 192.168.1.254 + meta: + cidr: 192.168.1.0/24 + configurable: true + map_priority: 2 + name: storage + notation: cidr + render_addr_mask: storage + render_type: cidr + use_gateway: false + vlan_start: 102 + name: storage + vlan_start: 102 + - cidr: 192.168.0.0/24 + gateway: null + ip_ranges: + - - 192.168.0.1 + - 192.168.0.253 + meta: + cidr: 192.168.0.0/24 + configurable: true + map_priority: 2 + name: management + notation: ip_ranges + render_addr_mask: internal + render_type: cidr + use_gateway: false + vips: + - haproxy + - vrouter + vlan_start: null + name: management + vlan_start: null + - cidr: 192.168.2.0/24 + gateway: null + ip_ranges: + - - 192.168.2.1 + - 192.168.2.254 + meta: + cidr: 192.168.2.0/24 + configurable: true + map_priority: 2 + name: private + notation: cidr + render_addr_mask: null + render_type: cidr + seg_type: tun + use_gateway: false + vlan_start: 103 + name: private + vlan_start: 103 + - cidr: 172.16.0.0/24 + gateway: 172.16.0.1 + ip_ranges: + - - 172.16.0.2 + - 172.16.0.126 + meta: + cidr: 172.16.0.0/24 + configurable: true + floating_range_var: floating_ranges + ip_range: + - 172.16.0.2 + - 172.16.0.126 + map_priority: 1 + name: public + notation: ip_ranges + render_addr_mask: public + render_type: null + use_gateway: true + vips: + - haproxy + - vrouter + vlan_start: null + name: public + vlan_start: null + - cidr: 10.20.0.0/24 + gateway: 10.20.0.2 + ip_ranges: + - - 10.20.0.3 + - 10.20.0.254 + meta: + configurable: false + map_priority: 0 + notation: ip_ranges + render_addr_mask: null + render_type: null + unmovable: true + use_gateway: true + name: fuelweb_admin + vlan_start: null +settings: + editable: + external_dns: + dns_list: + description: List of upstream DNS servers + label: DNS list + max: 3 + regex: + error: Invalid IP address + source: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$ + type: text_list + value: + - 147.214.6.234 + weight: 10 + metadata: + group: network + label: Host OS DNS Servers + weight: 30 + external_ntp: + metadata: + group: network + label: Host OS NTP Servers + weight: 40 + ntp_list: + description: List of upstream NTP servers + label: NTP server list + regex: + error: Invalid NTP server + source: ^[a-zA-Z\d]+[-\.\da-zA-Z]*$ + type: text_list + value: + - 10.20.0.1 + weight: 10 + syslog: + metadata: + enabled: false + group: logging + label: Syslog + toggleable: true + weight: 50 + syslog_port: + description: Remote syslog port + label: Port + regex: + error: Invalid syslog port + source: ^([1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$ + type: text + value: '514' + weight: 20 + syslog_server: + description: Remote syslog hostname + label: Hostname + regex: + error: Invalid hostname + source: ^[a-zA-Z\d]+[-\.\da-zA-Z]*$ + type: text + value: '' + weight: 10 + syslog_transport: + label: Syslog transport protocol + type: radio + value: tcp + values: + - data: udp + description: '' + label: UDP + - data: tcp + description: '' + label: TCP + weight: 30 + diff --git a/deploy/config/labs/devel-pipeline/intel-sc/fuel/config/dha.yaml b/deploy/config/labs/devel-pipeline/intel-sc/fuel/config/dha.yaml new file mode 100644 index 000000000..3657285e8 --- /dev/null +++ b/deploy/config/labs/devel-pipeline/intel-sc/fuel/config/dha.yaml @@ -0,0 +1,101 @@ +dha-pod-config-metadata: + title: Deployment Hardware Adapter (DHA) for fuel development pipeline - Intel Santa Clara, CA. USA version + version: 0.0.1 + created: Sept 7 2016 + comment: Intel Santa Clara, CA, USA Fuel 9 version + +# Adapter to use for this definition +adapter: libvirt + +# Node list. +# Mandatory property is id, all other properties are adapter specific. + +nodes: +- id: 1 + libvirtName: controller1 + libvirtTemplate: templates/virtual_environment/vms/controller.xml +- id: 2 + libvirtName: compute1 + libvirtTemplate: templates/virtual_environment/vms/compute.xml +- id: 3 + libvirtName: compute2 + libvirtTemplate: templates/virtual_environment/vms/compute.xml +- id: 4 + libvirtName: compute3 + libvirtTemplate: templates/virtual_environment/vms/compute.xml +- id: 5 + libvirtName: fuel-master + libvirtTemplate: templates/virtual_environment/vms/fuel.xml + isFuel: yes + username: root + password: r00tme + +virtNetConfDir: templates/virtual_environment/networks + +disks: + fuel: 100G + controller: 100G + compute: 100G + +# Here the infrastructure VMs can be defined. +# The entries are not mandatory! If it is left empty +# the default defined in deploy/templates will +# be used. +define_vms: + fuel: + vcpu: + value: 2 + memory: + attribute_equlas: + unit: KiB + value: 8388608 + currentMemory: + attribute_equlas: + unit: KiB + value: 8388608 + devices: + interface: + # With attribute_equlas someone can define which + # interface type is meant + attribute_equlas: + type: network + # This will overwrite the type of the model of + # the interface + model: + attribute: + type: virtio + controller: + vcpu: + value: 4 + memory: + attribute_equlas: + unit: KiB + value: 10485760 + currentMemory: + attribute_equlas: + unit: KiB + value: 10485760 + devices: + interface: + attribute_equlas: + type: network + model: + attribute: + type: e1000 + compute: + memory: + attribute_equlas: + unit: KiB + value: 6291456 + currentMemory: + attribute_equlas: + unit: KiB + value: 6291456 + devices: + interface: + attribute_equlas: + type: network + model: + attribute: + type: e1000 + diff --git a/deploy/dha_adapters/zte_adapter.py b/deploy/dha_adapters/zte_adapter.py index a40a02685..da651ca15 100644 --- a/deploy/dha_adapters/zte_adapter.py +++ b/deploy/dha_adapters/zte_adapter.py @@ -1,5 +1,5 @@ ############################################################################### -# Copyright (c) 2015 Ericsson AB and others. +# Copyright (c) 2016 Ericsson AB, ZTE and others. # szilard.cserey@ericsson.com # All rights reserved. This program and the accompanying materials # are made available under the terms of the Apache License, Version 2.0 @@ -24,27 +24,9 @@ class ZteAdapter(IpmiAdapter): super(ZteAdapter, self).__init__(yaml_path, attempts) def node_reset(self, node_id): - WAIT_LOOP = 600 log('RESET Node %s' % node_id) - cmd_prefix = self.ipmi_cmd(node_id) - state = exec_cmd('%s chassis power status' % cmd_prefix, mask_args=[8,10]) - if state == 'Chassis Power is on': - was_shut_off = False - done = False - exec_cmd('%s chassis power cycle' % cmd_prefix, mask_args=[8,10]) - for i in range(WAIT_LOOP): - state, _ = exec_cmd('%s chassis power status' % cmd_prefix, - check=False, - mask_args=[8,10]) - if state == 'Chassis Power is off': - was_shut_off = True - elif state == 'Chassis Power is on' and was_shut_off: - done = True - break - time.sleep(1) - if not done: - err('Could Not RESET Node %s' % node_id) - else: - err('Cannot RESET Node %s because it\'s not Active, state: %s' - % (node_id, state)) + cmd = '%s chassis power cycle' % self.ipmi_cmd(node_id) + exec_cmd(cmd, attempts=self.attempts, delay=self.delay, + verbose=True, + mask_args=[8,10]) diff --git a/docs/buildprocedure/build.instruction.rst b/docs/buildprocedure/build.instruction.rst index 8ec8cb7b0..d755ee5fb 100644 --- a/docs/buildprocedure/build.instruction.rst +++ b/docs/buildprocedure/build.instruction.rst @@ -1,14 +1,10 @@ -============================================================================================== -OPNFV Build instruction for the Colorado release of OPNFV when using Fuel as a deployment tool -============================================================================================== - -License -======= - -This work is licensed under a Creative Commons Attribution 4.0 -International License. .. http://creativecommons.org/licenses/by/4.0 .. -(c) Jonas Bjurel (Ericsson AB) and others +.. This document is protected/licensed under the following conditions +.. (c) Jonas Bjurel (Ericsson AB) +.. Licensed under a Creative Commons Attribution 4.0 International License. +.. You should have received a copy of the license along with this work. +.. If not, see <http://creativecommons.org/licenses/by/4.0/>. +======== Abstract ======== @@ -16,6 +12,7 @@ This document describes how to build the Fuel deployment tool for the Colorado release of OPNFV build system, dependencies and required system resources. +============ Introduction ============ @@ -32,20 +29,21 @@ performed by the build system. The audience of this document is assumed to have good knowledge in network and Unix/Linux administration. +============ Requirements ============ Minimum Hardware Requirements ------------------------------ +============================= - ~30 GB available disc - 4 GB RAM Minimum Software Requirements ------------------------------ +============================= -The build host should run Ubuntu 14.04 operating system. +The build host should run Ubuntu 14.04 or 16.04 operating system. On the host, the following packages must be installed: @@ -68,11 +66,13 @@ 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: .. code-block:: bash @@ -96,7 +96,8 @@ Then restart docker: $ sudo service docker restart 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 @@ -108,7 +109,8 @@ Setting up OPNFV Gerrit in order to being able to clone the code your public key in. Clone the OPNFV code Git repository with your SSH key -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +----------------------------------------------------- + Now it is time to clone the code repository: .. code-block:: bash @@ -126,7 +128,8 @@ Check out the Colorado release: $ git checkout colorado.1.0 Clone the OPNFV code Git repository without a SSH key -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +----------------------------------------------------- + You can also opt to clone the code repository without a SSH key: .. code-block:: bash @@ -136,17 +139,17 @@ You can also opt to clone the code repository without a SSH key: Make sure to checkout the release tag as described above. Support for building behind a http/https/rsync proxy ----------------------------------------------------- +==================================================== The build system is able to make use of a web proxy setup if the http_proxy, https_proxy, no_proxy (if needed) and RSYNC_PROXY or RSYNC_CONNECT_PROG environment variables have been set before invoking make. -The proxy setup must permit port 80 (http), 443 (https) and 873 -(rsync). +The proxy setup must permit port 80 (http) and 443 (https). +Rsync protocol is currently not used during build process. Important note about the host Docker daemon settings -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +---------------------------------------------------- The Docker daemon on the host must be configured to use the http proxy for it to be able to pull the base Ubuntu 14.04 image from the Docker @@ -160,7 +163,7 @@ like: to /etc/default/docker and restarting the Docker daemon. Setting proxy environment variables prior to build -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +-------------------------------------------------- The build system will make use the following environment variables that needs to be exported to subshells by using export (bash) or @@ -185,7 +188,7 @@ As an example, these are the settings that were put in the user's export no_proxy=localhost,127.0.0.1,.consultron.com,.sock Using a ssh proxy for the rsync connection -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------------------ If the proxy setup is not allowing the rsync protocol, an alternative solution is to use a SSH tunnel to a machine capable of accessing the @@ -198,25 +201,8 @@ Make sure that the ssh command also refers to the user on the remote system, as the command itself will be run from the Docker build container as the root user (but with the invoking user's SSH keys). -Disabling the Ubuntu repo cache if rsync is not allowed -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -During the build phase, a local Ubuntu package repository is fetched -from upstream in order to be added to the OPNFV Fuel ISO and for parts -of this process rsync is used. - -If neither of the two available methods for proxying rsync are -available, the last resort is to turn off the caching of the Ubuntu -packages in the build system. This is done by removing the -"f_repobuild" from SUBDIRS in the beginning of -the fuel/build/f_isoroot/Makefile. - -Note! Doing this will require the Fuel master node to have Internet -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 Colorado release ** @@ -225,7 +211,8 @@ Select the versions of the components you want to build by editing the fuel/build/config.mk file. Non official build: Selecting which plugins to build ----------------------------------------------------- +==================================================== + In order to cut the build time for unofficial builds (made by an individual developer locally), the selection if which Fuel plugins to build (if any) can be done by environment variable @@ -241,6 +228,7 @@ that this is not a full build. This method of plugin selection is not meant to be used from within Gerrit! +======== Building ======== @@ -251,7 +239,8 @@ There are two methods available for building Fuel: - An abstracted method using build.sh Low level build method using make ---------------------------------- +================================= + The low level method is based on Make: From the <fuel/build> directory, invoke <make [target]> @@ -282,7 +271,8 @@ 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: @@ -293,6 +283,7 @@ allows you to: For more info type <fuel/ci/build.sh -h>. +========= Artifacts ========= @@ -303,6 +294,7 @@ The artifacts produced are: - <OPNFV_XXXX.iso.txt> - Which holds version metadata. +========== References ========== diff --git a/docs/buildprocedure/index.rst b/docs/buildprocedure/index.rst index d2a7512af..4f88814b5 100644 --- a/docs/buildprocedure/index.rst +++ b/docs/buildprocedure/index.rst @@ -4,9 +4,9 @@ .. You should have received a copy of the license along with this work. .. If not, see <http://creativecommons.org/licenses/by/4.0/>. -****************************** -Fuel\@OPNFV build instructions -****************************** +********************************* +Build instruction for Fuel\@OPNFV +********************************* .. toctree:: :numbered: diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst index 171647188..8e61be219 100644 --- a/docs/installationprocedure/index.rst +++ b/docs/installationprocedure/index.rst @@ -4,9 +4,9 @@ .. You should have received a copy of the license along with this work. .. If not, see <http://creativecommons.org/licenses/by/4.0/>. -************************************ -Fuel\@OPNFV Installation Instruction -************************************ +**************************************** +Installation instruction for Fuel\@OPNFV +**************************************** .. toctree:: :numbered: diff --git a/docs/installationprocedure/installation.instruction.rst b/docs/installationprocedure/installation.instruction.rst index bb56a53cf..e9d2f5f73 100644 --- a/docs/installationprocedure/installation.instruction.rst +++ b/docs/installationprocedure/installation.instruction.rst @@ -1,21 +1,18 @@ -======================================================================================================== -OPNFV Installation instruction for the Colorado release of OPNFV when using Fuel as a deployment tool -======================================================================================================== - -License -======= - -This work is licensed under a Creative Commons Attribution 4.0 International -License. .. http://creativecommons.org/licenses/by/4.0 .. -(c) Jonas Bjurel (Ericsson AB) and others +.. This document is protected/licensed under the following conditions +.. (c) Jonas Bjurel (Ericsson AB) +.. Licensed under a Creative Commons Attribution 4.0 International License. +.. You should have received a copy of the license along with this work. +.. If not, see <http://creativecommons.org/licenses/by/4.0/>. +======== Abstract ======== This document describes how to install the Colorado release of -OPNFV when using Fuel as a deployment tool, covering it's usage, +OPNFV when using Fuel as a deployment tool, covering its usage, limitations, dependencies and required system resources. +============ Introduction ============ @@ -33,6 +30,7 @@ deployment. The audience of this document is assumed to have good knowledge in networking and Unix/Linux administration. +======= Preface ======= @@ -41,13 +39,13 @@ 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 Fuel .iso image of the Colorado release can be found at *Reference: 2* Building the ISO image ----------------------- +====================== Alternatively, you may build the Fuel .iso from source by cloning the opnfv/fuel git repository. To retrieve the repository for the Colorado @@ -73,7 +71,7 @@ Go to the fuel directory and build the .iso: For more information on how to build, please see *Reference: 14* Other preparations ------------------- +================== Next, familiarize yourself with Fuel by reading the following documents: @@ -107,6 +105,7 @@ Prior to installation, a number of deployment specific parameters must be collec This information will be needed for the configuration procedures provided in this document. +===================== Hardware requirements ===================== @@ -145,6 +144,7 @@ installation of Colorado using Fuel: | | supports. | +--------------------+------------------------------------------------------+ +=============================== Help with Hardware Requirements =============================== @@ -163,7 +163,7 @@ environment, you should think about: - Networking -- Depends on the Choose Network Topology, the network bandwidth per virtual machine, and network storage. - +================================================ Top of the rack (TOR) Configuration requirements ================================================ @@ -188,6 +188,7 @@ Manual configuration of the Colorado hardware platform should be carried out according to the OPNFV Pharos specification: <https://wiki.opnfv.org/pharos/pharos_specification> +========================================== OPNFV Software installation and deployment ========================================== @@ -196,7 +197,8 @@ server (Fuel master) as well as the deployment of the full OPNFV reference platform stack across a server cluster. Install Fuel master -------------------- +=================== + #. Mount the Colorado Fuel ISO file/media as a boot device to the jump host server. #. Reboot the jump host to establish the Fuel server. @@ -278,9 +280,8 @@ Install Fuel master - The installation will now start, wait until the login screen is shown. - Boot the Node Servers ---------------------- +===================== After the Fuel Master node has rebooted from the above steps and is at the login prompt, you should boot the Node Servers (Your @@ -301,9 +302,8 @@ scheme so that the FUEL Master can pick them up for control. .. figure:: img/nodes.png - Install additional Plugins/Features on the FUEL node ----------------------------------------------------- +==================================================== #. SSH to your FUEL node (e.g. root@10.20.0.2 pwd: r00tme) @@ -324,7 +324,7 @@ Install additional Plugins/Features on the FUEL node .. figure:: img/plugin_install.png Create an OpenStack Environment -------------------------------- +=============================== #. Connect to Fuel WEB UI with a browser (default: https://10.20.0.2:8443) (login: admin/admin) @@ -359,7 +359,7 @@ Create an OpenStack Environment - Click <Create> Button Configure the network environment ---------------------------------- +================================= #. Open the environment you previously created. @@ -458,7 +458,7 @@ Configure the network environment - Provide the NTP server settings Select Hypervisor type ----------------------- +====================== #. In the FUEL UI of your Environment, click the "Settings" Tab @@ -469,7 +469,7 @@ Select Hypervisor type .. figure:: img/compute.png Enable Plugins --------------- +============== #. In the FUEL UI of your Environment, click the "Settings" Tab @@ -480,7 +480,7 @@ Enable Plugins .. figure:: img/plugins.png Allocate nodes to environment and assign functional roles ---------------------------------------------------------- +========================================================= #. Click on the "Nodes" Tab in the FUEL WEB UI (see figure below). @@ -526,9 +526,8 @@ Allocate nodes to environment and assign functional roles .. figure:: img/interfaceconf.png - OPTIONAL - Set Local Mirror Repos ---------------------------------- +================================= The following steps must be executed if you are in an environment with no connection to the Internet. The Fuel server delivers a local repo @@ -551,7 +550,7 @@ that can be used for installation / deployment of openstack. - Click <Save Settings> at the bottom to Save your changes Target specific configuration ------------------------------ +============================= #. Set up targets for provisioning with non-default "Offloading Modes" @@ -600,7 +599,7 @@ Target specific configuration - Repeat the step above for all affected nodes/interfaces in the POD. Verify Networks ---------------- +=============== It is important that the Verify Networks action is performed as it will verify that communicate works for the networks you have setup, as well as check that @@ -614,9 +613,8 @@ packages needed for a successful deployment can be fetched. .. figure:: img/verifynet.png - Deploy Your Environment ------------------------ +======================= #. Deploy the environment. @@ -629,6 +627,7 @@ Deploy Your Environment Wait for your deployment to complete, you can view the "Dashboard" Tab to see the progress and status of your deployment. +========================= Installation health-check ========================= @@ -642,30 +641,32 @@ Installation health-check .. figure:: img/health.png +========== References ========== OPNFV ------ +===== 1) `OPNFV Home Page <http://www.opnfv.org>`_: http://www.opnfv.org 2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_: https://www.opnfv.org/software/download OpenStack ---------- +========= 3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_: http://www.openstack.org/software/mitaka 4) `OpenStack documentation <http://docs.openstack.org>`_: http://docs.openstack.org OpenDaylight ------------- +============ 5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_: http://www.opendaylight.org/software/downloads Fuel ----- +==== + 6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_: https://wiki.openstack.org/wiki/Fuel 7) `Fuel documentation overview <http://docs.openstack.org/developer/fuel-docs>`_: http://docs.openstack.org/developer/fuel-docs @@ -681,7 +682,7 @@ Fuel 12) `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list>`_: https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list Fuel in OPNFV -------------- +============= 13) `OPNFV Installation instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/installationprocedure/index.html>`_: http://artifacts.opnfv.org/fuel/colorado/docs/installationprocedure/index.html diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst index 8fb1fef78..db97a7492 100644 --- a/docs/releasenotes/index.rst +++ b/docs/releasenotes/index.rst @@ -4,9 +4,9 @@ .. You should have received a copy of the license along with this work. .. If not, see <http://creativecommons.org/licenses/by/4.0/>. -************************* -Fuel\@OPNFV release notes -************************* +***************************** +Release notes for Fuel\@OPNFV +***************************** .. toctree:: :numbered: diff --git a/docs/releasenotes/release-notes.rst b/docs/releasenotes/release-notes.rst index 427f0a9db..fa9e98e07 100644 --- a/docs/releasenotes/release-notes.rst +++ b/docs/releasenotes/release-notes.rst @@ -1,20 +1,17 @@ -============================================================================================ -OPNFV Release Note for the Colorado 1.0 release of OPNFV when using Fuel as a deployment tool -============================================================================================ - -License -======= - -This work is licensed under a Creative Commons Attribution 4.0 International -License. .. http://creativecommons.org/licenses/by/4.0 .. -(c) Jonas Bjurel (Ericsson AB) and others +.. This document is protected/licensed under the following conditions +.. (c) Jonas Bjurel (Ericsson AB) +.. Licensed under a Creative Commons Attribution 4.0 International License. +.. You should have received a copy of the license along with this work. +.. If not, see <http://creativecommons.org/licenses/by/4.0/>. +======== Abstract ======== This document compiles the release notes for the Colorado 1.0 release of OPNFV when using Fuel as a deployment tool. +=============== Important notes =============== @@ -27,25 +24,26 @@ of the OPNFV infrastructure. Carefully follow the installation-instructions provided in *Reference 13*. +======= Summary ======= For Colorado, 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 SR3" +- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Beryllium SR3" [1]_ - 'http://www.opendaylight.org/software' -- `ONOS <http://onosproject.org/>`_ version "Drake" +- `ONOS <http://onosproject.org/>`_ version "Drake" - 'http://onosproject.org/' -- `Service function chaining <https://wiki.opnfv.org/service_function_chaining>`_ +- `Service function chaining <https://wiki.opnfv.org/service_function_chaining>`_ 'https://wiki.opnfv.org/service_function_chaining' -- `SDN distributed routing and VPN <https://wiki.opnfv.org/sdnvpn>`_ +- `SDN distributed routing and VPN <https://wiki.opnfv.org/sdnvpn>`_ 'https://wiki.opnfv.org/sdnvpn' -- `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_ +- `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_ 'https://wiki.opnfv.org/nfv-kvm' -- `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_ +- `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_ 'https://wiki.opnfv.org/ovsnfv' -- `VSPERF <https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases>`_ +- `VSPERF <https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases>`_ 'https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases' As well as OPNFV-unique configurations of the Hardware- and Software stack. @@ -68,6 +66,7 @@ OPNFV CI pipeline including: - Automated validation of the Colorado deployment +============ Release Data ============ @@ -89,17 +88,17 @@ Release Data | | the following feaures/scenarios: | | | - NFV Hypervisors-KVM | | | - Open vSwitch for NFV | -| | - OpenDaylight SR3 | +| | - OpenDaylight | | | - SDN distributed routing and VPN | | | - Service function chaining | | | | +--------------------------------------+--------------------------------------+ Version change --------------- +============== Module version changes -~~~~~~~~~~~~~~~~~~~~~~ +---------------------- This is a follow-up release to Colorado 1.0. It is based on following upstream versions: @@ -107,12 +106,12 @@ following upstream versions: - OpenStack Mitaka release -- OpenDaylight Beryllium SR3 release +- OpenDaylight Beryllium SR3 release [1]_ - ONOS Drake release Document changes -~~~~~~~~~~~~~~~~ +---------------- This is a follow-up release to Colorado 1.0. It comes with the following documentation: @@ -123,17 +122,17 @@ comes with the following documentation: - Release notes - *Reference 15* - **Changed** (This document) Reason for version ------------------- +================== Feature additions -~~~~~~~~~~~~~~~~~ +----------------- **JIRA TICKETS:** - Bug corrections -~~~~~~~~~~~~~~~ +--------------- **JIRA TICKETS:** @@ -142,15 +141,15 @@ Bug corrections (Also See respective Integrated feature project's bug tracking) Deliverables ------------- +============ Software deliverables -~~~~~~~~~~~~~~~~~~~~~ +--------------------- Fuel-based installer iso file found in *Reference 2* Documentation deliverables -~~~~~~~~~~~~~~~~~~~~~~~~~~ +-------------------------- - Installation instructions - *Reference 13* @@ -158,11 +157,12 @@ Documentation deliverables - Release notes - *Reference 15* (This document) +========================================= Known Limitations, Issues and Workarounds ========================================= System Limitations ------------------- +================== - **Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades @@ -174,7 +174,7 @@ System Limitations Known issues ------------- +============ **JIRA TICKETS:** @@ -183,7 +183,7 @@ Known issues (Also See respective Integrated feature project's bug tracking) Workarounds ------------ +=========== **JIRA TICKETS:** @@ -191,56 +191,60 @@ Workarounds (Also See respective Integrated feature project's bug tracking) +============ Test results ============ The Colorado 1.0 release with the Fuel deployment tool has undergone QA test runs, see separate test results. +========== References ========== For more information on the OPNFV Colorado release, please see: OPNFV ------ +===== -1) `OPNFV Home Page <http://www.opnfv.org>`_ +1) `OPNFV Home Page <http://www.opnfv.org>`_ 'http://www.opnfv.org' -2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_ +2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_ 'https://www.opnfv.org/software/download' OpenStack ---------- +========= -3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_ +3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_ 'http://www.openstack.org/software/mitaka' -4) `OpenStack documentation <http://docs.openstack.org>`_ +4) `OpenStack documentation <http://docs.openstack.org>`_ 'http://docs.openstack.org' OpenDaylight ------------- +============ -5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_ +5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_ 'http://www.opendaylight.org/software/downloads' Fuel ----- +==== -6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_ +6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_ 'https://wiki.openstack.org/wiki/Fuel' -7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/>`_ +7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/>`_ 'https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/' -8) `Fuel planning guide <https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/mos-planning-guide.html>`_ +8) `Fuel planning guide <https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/mos-planning-guide.html>`_ 'https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/mos-planning-guide.html' -9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html>`_ +9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html>`_ 'https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html' -10) `Fuel reference architecture <https://docs.mirantis.com/openstack/fuel/fuel-9.0/reference-architecture.html>`_ +10) `Fuel reference architecture <https://docs.mirantis.com/openstack/fuel/fuel-9.0/reference-architecture.html>`_ 'https://docs.mirantis.com/openstack/fuel/fuel-9.0/reference-architecture.html' -11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_ +11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_ 'https://wiki.openstack.org/wiki/Fuel/Plugins' -12) `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list>`_ +12) `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list>`_ 'https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list' Fuel in OPNFV -------------- +============= + +13) `OPNFV Installation instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/installation-instruction.html>`_ 'http://artifacts.opnfv.org/fuel/colorado/docs/installation-instruction.html' -13) `OPNFV Installation instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/installation-instruction.html>`_ +14) `OPNFV Build instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/build-instruction.html>`_ 'http://artifacts.opnfv.org/fuel/colorado/docs/build-instruction.html' -14) `OPNFV Build instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/build-instruction.html>`_ +15) `OPNFV Release Note for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/release-notes.html>`_ 'http://artifacts.opnfv.org/fuel/colorado/docs/release-notes.html' -15) `OPNFV Release Note for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/release-notes.html>`_ +.. [1] OpenDaylight Boron RC2 is used when Service Function Chaining is enabled in Fuel plugin. |