From 0b6dbdf333c4aa9c9ac3959585eba83522ae9dd8 Mon Sep 17 00:00:00 2001 From: liyuenan Date: Mon, 12 Sep 2016 11:32:39 +0800 Subject: Adjusted the docs structure JIRA:DOCS-159 Change-Id: I30b655740634fc5a46fec3be707cb3abc9274502 Signed-off-by: liyuenan (cherry picked from commit 2ea21d3473c30674c5e7b53564e0a6699dacffbb) --- docs/configguide/bmdeploy.rst | 326 -------------------- docs/configguide/index.rst | 16 - docs/configguide/installerconfig.rst | 155 ---------- docs/configguide/introduction.rst | 29 -- docs/configguide/postinstall.rst | 32 -- docs/configguide/references.rst | 38 --- docs/configguide/vmdeploy.rst | 260 ---------------- docs/installationprocedure/bmdeploy.rst | 328 +++++++++++++++++++++ docs/installationprocedure/index.rst | 13 +- .../installation.instruction.rst | 153 +++++++++- docs/installationprocedure/introduction.rst | 35 +++ docs/installationprocedure/postinstall.rst | 32 ++ docs/installationprocedure/references.rst | 38 +++ docs/installationprocedure/vmdeploy.rst | 260 ++++++++++++++++ 14 files changed, 853 insertions(+), 862 deletions(-) delete mode 100644 docs/configguide/bmdeploy.rst delete mode 100644 docs/configguide/index.rst delete mode 100644 docs/configguide/installerconfig.rst delete mode 100644 docs/configguide/introduction.rst delete mode 100644 docs/configguide/postinstall.rst delete mode 100644 docs/configguide/references.rst delete mode 100644 docs/configguide/vmdeploy.rst create mode 100644 docs/installationprocedure/bmdeploy.rst create mode 100644 docs/installationprocedure/introduction.rst create mode 100644 docs/installationprocedure/postinstall.rst create mode 100644 docs/installationprocedure/references.rst create mode 100644 docs/installationprocedure/vmdeploy.rst diff --git a/docs/configguide/bmdeploy.rst b/docs/configguide/bmdeploy.rst deleted file mode 100644 index 7cc4b9ce..00000000 --- a/docs/configguide/bmdeploy.rst +++ /dev/null @@ -1,326 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI) - -Installation Guide (Bare Metal Deployment) -========================================== - -Nodes Configuration (Bare Metal Deployment) -------------------------------------------- - -The below file is the inventory template of deployment nodes: - -"compass4nfv/deploy/conf/hardware_environment/huawei-pod1/dha.yml" - -You can write your own IPMI IP/User/Password/Mac address/roles reference to it. - - - name -- Host name for deployment node after installation. - - - ipmiVer -- IPMI interface version for deployment node support. IPMI 1.0 - or IPMI 2.0 is available. - - - ipmiIP -- IPMI IP address for deployment node. Make sure it can access - from Jumphost. - - - ipmiUser -- IPMI Username for deployment node. - - - ipmiPass -- IPMI Password for deployment node. - - - mac -- MAC Address of deployment node PXE NIC . - - - roles -- Components deployed. - -**Set TYPE/FLAVOR and POWER TOOL** - -E.g. -.. code-block:: yaml - - TYPE: baremetal - FLAVOR: cluster - POWER_TOOL: ipmitool - -**Set ipmiUser/ipmiPass and ipmiVer** - -E.g. - -.. code-block:: yaml - - ipmiUser: USER - ipmiPass: PASSWORD - ipmiVer: '2.0' - -E.g. Openstack only deployment roles setting - -.. code-block:: yaml - - hosts: - - name: host1 - mac: 'F8:4A:BF:55:A2:8D' - interfaces: - - eth1: 'F8:4A:BF:55:A2:8E' - ipmiIp: 172.16.130.26 - roles: - - controller - - ha - - - name: host2 - mac: 'D8:49:0B:DA:5A:B7' - interfaces: - - eth1: 'D8:49:0B:DA:5A:B8' - ipmiIp: 172.16.130.27 - roles: - - compute - -NOTE: -IF YOU SELECT MUTIPLE NODES AS CONTROLLER, THE 'ha' role MUST BE SELECT, TOO. - -E.g. Openstack and ceph deployment roles setting - -.. code-block:: yaml - - hosts: - - name: host1 - mac: 'F8:4A:BF:55:A2:8D' - interfaces: - - eth1: 'F8:4A:BF:55:A2:8E' - ipmiIp: 172.16.130.26 - roles: - - controller - - ha - - ceph-adm - - ceph-mon - - - name: host2 - mac: 'D8:49:0B:DA:5A:B7' - interfaces: - - eth1: 'D8:49:0B:DA:5A:B8' - ipmiIp: 172.16.130.27 - roles: - - compute - - ceph-osd - -E.g. Openstack and ODL deployment roles setting - -.. code-block:: yaml - - hosts: - - name: host1 - mac: 'F8:4A:BF:55:A2:8D' - interfaces: - - eth1: 'F8:4A:BF:55:A2:8E' - ipmiIp: 172.16.130.26 - roles: - - controller - - ha - - odl - - - name: host2 - mac: 'D8:49:0B:DA:5A:B7' - interfaces: - - eth1: 'D8:49:0B:DA:5A:B8' - ipmiIp: 172.16.130.27 - roles: - - compute - -E.g. Openstack and ONOS deployment roles setting - -.. code-block:: yaml - - hosts: - - name: host1 - mac: 'F8:4A:BF:55:A2:8D' - interfaces: - - eth1: 'F8:4A:BF:55:A2:8E' - ipmiIp: 172.16.130.26 - roles: - - controller - - ha - - onos - - - name: host2 - mac: 'D8:49:0B:DA:5A:B7' - interfaces: - - eth1: 'D8:49:0B:DA:5A:B8' - ipmiIp: 172.16.130.27 - roles: - - compute - -Network Configuration (Bare Metal Deployment) ---------------------------------------------- - -Before deployment, there are some network configuration to be checked based -on your network topology.Compass4nfv network default configuration file is -"compass4nfv/deploy/conf/hardware_environment/huawei-pod1/network.yml". -You can write your own reference to it. - -**The following figure shows the default network configuration.** - -.. code-block:: console - - - +--+ +--+ +--+ - | | | | | | - | | +------------+ | | | | - | +------+ Jumphost +------+ | | | - | | +------+-----+ | | | | - | | | | | | | - | | +------------+ +-----+ | - | | | | | | - | | +------------+ | | | | - | +------+ host1 +------+ | | | - | | +------+-----+ | | | | - | | | | | | | - | | +------------+ +-----+ | - | | | | | | - | | +------------+ | | | | - | +------+ host2 +------+ | | | - | | +------+-----+ | | | | - | | | | | | | - | | +------------+ +-----+ | - | | | | | | - | | +------------+ | | | | - | +------+ host3 +------+ | | | - | | +------+-----+ | | | | - | | | | | | | - | | +------------+ +-----+ | - | | | | | | - | | | | | | - +-++ ++-+ +-++ - ^ ^ ^ - | | | - | | | - +-+-------------------------+ | | - | External Network | | | - +---------------------------+ | | - +-----------------------+---+ | - | IPMI Network | | - +---------------------------+ | - +-------------------------+-+ - | PXE(Installation) Network | - +---------------------------+ - - -Start Deployment (Bare Metal Deployment) ----------------------------------------- - -1. Edit run.sh - -Set OS version and OpenStack version for deployment nodes. - Compass4nfv Colorado supports three OS version based openstack mitaka. - -E.g. - -.. code-block:: bash - - ########## Ubuntu14.04 Mitaka ########## - export OS_VERSION=trusty - export OPENSTACK_VERSION=mitaka - - ########## Ubuntu16.04 Mitaka ########## - # export OS_VERSION=xenial - # export OPENSTACK_VERSION=mitaka_xenial - - ########## Centos7 Mitaka ########## - # export OS_VERSION=centos7 - # export OPENSTACK_VERSION=mitaka - -Set ISO image that you want to deploy - -E.g. - -.. code-block:: bash - - # ISO_URL is your iso's absolute path - export ISO_URL=file:///home/compass/compass4nfv.iso - # or - # export ISO_URL=http://artifacts.opnfv.org/compass4nfv/colorado/opnfv-colorado.1.0.iso - -Set Jumphost PXE NIC. (set eth1 E.g.) - -E.g. - -.. code-block:: bash - - ########## Hardware Deploy Jumpserver PXE NIC ########## - # you need comment out it when virtual deploy - export INSTALL_NIC=eth1 - -Set scenario that you want to deploy - -E.g. - -nosdn-nofeature scenario deploy sample - -.. code-block:: bash - - # DHA is your dha.yml's path - export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-nosdn-nofeature-ha.yml - - # NETWORK is your network.yml's path - export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network.yml - -ocl-nofeature scenario deploy sample - -.. code-block:: bash - - # DHA is your dha.yml's path - export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-ocl-nofeature-ha.yml - - # NETWORK is your network.yml's path - export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network_ocl.yml - -odl_l2-moon scenario deploy sample - -.. code-block:: bash - - # DHA is your dha.yml's path - export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-odl_l2-moon-ha.yml - - # NETWORK is your network.yml's path - export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network.yml - -odl_l2-nofeature scenario deploy sample - -.. code-block:: bash - - # DHA is your dha.yml's path - export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-odl_l2-nofeature-ha.yml - - # NETWORK is your network.yml's path - export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network.yml - -odl_l3-nofeature scenario deploy sample - -.. code-block:: bash - - # DHA is your dha.yml's path - export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-odl_l3-nofeature-ha.yml - - # NETWORK is your network.yml's path - export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network.yml - -onos-nofeature scenario deploy sample - -.. code-block:: bash - - # DHA is your dha.yml's path - export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-onos-nofeature-ha.yml - - # NETWORK is your network.yml's path - export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network_onos.yml - -onos-sfc deploy scenario sample - -.. code-block:: bash - - # DHA is your dha.yml's path - export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-onos-sfc-ha.yml - - # NETWORK is your network.yml's path - export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network_onos.yml - -2. Run ``run.sh`` - -.. code-block:: bash - - ./run.sh diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst deleted file mode 100644 index fa212a03..00000000 --- a/docs/configguide/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. -.. http://creativecommons.org/licenses/by/4.0 - -******************************************************** -OPNFV(Colorado) Compass4nfv installation instructions -******************************************************** - -.. toctree:: - :numbered: - :maxdepth: 4 - - introduction.rst - installerconfig.rst - bmdeploy.rst - vmdeploy.rst - references.rst diff --git a/docs/configguide/installerconfig.rst b/docs/configguide/installerconfig.rst deleted file mode 100644 index 9e552494..00000000 --- a/docs/configguide/installerconfig.rst +++ /dev/null @@ -1,155 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI) - -Compass4nfv configuration -========================= - -This document describes providing guidelines on how to install and -configure the Colorado release of OPNFV when using Compass as a -deployment tool including required software and hardware -configurations. - -Installation and configuration of host OS, OpenStack, OpenDaylight, -ONOS, Ceph etc. can be supported by Compass on Virtual nodes or Bare Metal -nodes. - -The audience of this document is assumed to have good knowledge in -networking and Unix/Linux administration. - - -Preconditions -------------- - -Before starting the installation of the Colorado release of OPNFV, -some planning must be done. - - -Retrieving the installation ISO image -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -First of all, The installation ISO is needed for deploying your OPNFV -environment, it included packages of Compass, OpenStack, OpenDaylight, ONOS -and so on. - -The stable release ISO can be retrieved via `OPNFV software download page `_ - -The daily build ISO can be retrieved via OPNFV artifacts repository: - -http://artifacts.opnfv.org/ - -NOTE: Search the keyword "compass4nfv/Colorado" to locate the ISO image. - -E.g. -compass4nfv/colorado/opnfv-2016-01-16_15-03-18.iso -compass4nfv/colorado/opnfv-2016-01-16_15-03-18.properties - -The name of iso image includes the time of iso building, you can get the daily -ISO according the building time. -The git url and sha1 of Compass4nfv are recorded in properties files, -According these, the corresponding deployment scripts can be retrieved. - - -Getting the deployment scripts -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To retrieve the repository of Compass4nfv on Jumphost use the following command: - -- git clone https://gerrit.opnfv.org/gerrit/compass4nfv - -NOTE: PLEASE DO NOT GIT CLONE COMPASS4NFV IN root DIRECTORY(Include subfolders). - -To get stable /colorado release, you can use the following command: - -- git checkout colorado.1.0 - -Setup Requirements ------------------- - -If you have only 1 Bare Metal server, Virtual deployment is recommended. if more -than or equal 3 servers, the Bare Metal deployment is recommended. The minimum number of -servers for Bare metal deployment is 3, 1 for JumpServer(Jumphost), 1 for controller, -1 for compute. - - -Jumphost Requirements -~~~~~~~~~~~~~~~~~~~~~ - -The Jumphost requirements are outlined below: - -1. Ubuntu 14.04 (Pre-installed). - -2. Root access. - -3. libvirt virtualization support. - -4. Minimum 2 NICs. - - - PXE installation Network (Receiving PXE request from nodes and providing OS provisioning) - - - IPMI Network (Nodes power control and set boot PXE first via IPMI interface) - - - External Network (Optional: Internet access) - -5. 16 GB of RAM for a Bare Metal deployment, 64 GB of RAM for a Virtual deployment. - -6. CPU cores: 32, Memory: 64 GB, Hard Disk: 500 GB, (Virtual Deloment needs 1 TB Hard Disk) - - -Bare Metal Node Requirements ----------------------------- - -Bare Metal nodes require: - -1. IPMI enabled on OOB interface for power control. - -2. BIOS boot priority should be PXE first then local hard disk. - -3. Minimum 3 NICs. - - - PXE installation Network (Broadcasting PXE request) - - - IPMI Network (Receiving IPMI command from Jumphost) - - - External Network (OpenStack mgmt/external/storage/tenant network) - - -Network Requirements --------------------- - -Network requirements include: - -1. No DHCP or TFTP server running on networks used by OPNFV. - -2. 2-6 separate networks with connectivity between Jumphost and nodes. - - - PXE installation Network - - - IPMI Network - - - Openstack mgmt Network* - - - Openstack external Network* - - - Openstack tenant Network* - - - Openstack storage Network* - -3. Lights out OOB network access from Jumphost with IPMI node enabled (Bare Metal deployment only). - -4. External network has Internet access, meaning a gateway and DNS availability. - -**The networks with(*) can be share one NIC(Default configuration) or use an exclusive** -**NIC(Reconfigurated in network.yml).** - - -Execution Requirements (Bare Metal Only) ----------------------------------------- - -In order to execute a deployment, one must gather the following information: - -1. IPMI IP addresses of the nodes. - -2. IPMI login information for the nodes (user/pass). - -3. MAC address of Control Plane / Provisioning interfaces of the Bare Metal nodes. diff --git a/docs/configguide/introduction.rst b/docs/configguide/introduction.rst deleted file mode 100644 index 820cb29a..00000000 --- a/docs/configguide/introduction.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI) - -Abstract -======== - -This document describes how to install the Brahmaputra release of OPNFV when -using Compass4nfv as a deployment tool covering it's limitations, dependencies -and required system resources. - -Version history -=============== - -+--------------------+--------------------+--------------------+---------------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+---------------------------+ -| 2016-01-17 | 1.0.0 | Justin chi | Rewritten for | -| | | (HUAWEI) | Compass4nfv B release | -+--------------------+--------------------+--------------------+---------------------------+ -| 2015-12-16 | 0.0.2 | Matthew Li | Minor changes & | -| | | (HUAWEI) | formatting | -+--------------------+--------------------+--------------------+---------------------------+ -| 2015-09-12 | 0.0.1 | Chen Shuai | First draft | -| | | (HUAWEI) | | -+--------------------+--------------------+--------------------+---------------------------+ - - diff --git a/docs/configguide/postinstall.rst b/docs/configguide/postinstall.rst deleted file mode 100644 index f9b7aa92..00000000 --- a/docs/configguide/postinstall.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. -.. http://creativecommons.org/licenses/by/4.0 - -.. commented as there is no content for this file at this time. - -.. post installation procedures -.. ====================================== -.. Add a brief introduction to the methods of validating the installation -.. according to this specific installer or feature. - -.. 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. - -.. 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. - -.. 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. - -.. Platform components validation -.. --------------------------------- -.. Describe any component specific validation procedures necessary for your -.. deployment tool in this section. - diff --git a/docs/configguide/references.rst b/docs/configguide/references.rst deleted file mode 100644 index 467bf08d..00000000 --- a/docs/configguide/references.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI) - -References -========== - -OPNFV ------ - -`OPNFV Home Page `_ - -`OPNFV Genesis project page `_ - -`OPNFV Compass4nfv project page `_ - -OpenStack ---------- - -`OpenStack Liberty Release artifacts `_ - -`OpenStack documentation `_ - -OpenDaylight ------------- - -`OpenDaylight artifacts `_ - -ONOS ----- - -`ONOS artifacts `_ - -Compass -------- - -`Compass Home Page `_ - diff --git a/docs/configguide/vmdeploy.rst b/docs/configguide/vmdeploy.rst deleted file mode 100644 index cb5df6fb..00000000 --- a/docs/configguide/vmdeploy.rst +++ /dev/null @@ -1,260 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI) - -Installation Guide (Virtual Deployment) -======================================= - -Nodes Configuration (Virtual Deployment) ----------------------------------------- - -The below file is the inventory template of deployment nodes: - -"./deploy/conf/vm_environment/huawei-virtual1/network.yml" - -You can write your own address/roles reference to it. - - - name -- Host name for deployment node after installation. - - - roles -- Components deployed. - -**Set TYPE and FLAVOR** - -E.g. - -.. code-block:: yaml - - TYPE: virtual - FLAVOR: cluster - -**Assignment of different roles to servers** - -E.g. Openstack only deployment roles setting - -.. code-block:: yaml - - hosts: - - name: host1 - roles: - - controller - - ha - - - name: host2 - roles: - - compute - -NOTE: -IF YOU SELECT MUTIPLE NODES AS CONTROLLER, THE 'ha' role MUST BE SELECT, TOO. - -E.g. Openstack and ceph deployment roles setting - -.. code-block:: yaml - - hosts: - - name: host1 - roles: - - controller - - ha - - ceph-adm - - ceph-mon - - - name: host2 - roles: - - compute - - ceph-osd - -E.g. Openstack and ODL deployment roles setting - -.. code-block:: yaml - - hosts: - - name: host1 - roles: - - controller - - ha - - odl - - - name: host2 - roles: - - compute - -E.g. Openstack and ONOS deployment roles setting - -.. code-block:: yaml - - hosts: - - name: host1 - roles: - - controller - - ha - - onos - - - name: host2 - roles: - - compute - -Network Configuration (Virtual Deployment) ------------------------------------------- - -Before deployment, there are some network configuration to be checked based -on your network topology.Compass4nfv network default configuration file is -"compass4nfv/deploy/conf/vm_environment/huawei-virtual1/network.yml". -You can write your own reference to it. - -**The following figure shows the default network configuration.** - -.. code-block:: console - - - +--+ +--+ - | | | | - | | +------------+ | | - | +------+ Jumphost +------+ | - | | +------+-----+ | | - | | | | | - | | +------------+ | - | | | | - | | +------------+ | | - | +------+ host1 +------+ | - | | +------+-----+ | | - | | | | | - | | +------------+ | - | | | | - | | +------------+ | | - | +------+ host2 +------+ | - | | +------+-----+ | | - | | | | | - | | +------------+ | - | | | | - | | +------------+ | | - | +------+ host3 +------+ | - | | +------+-----+ | | - | | | | | - | | +------------+ | - | | | | - | | | | - +-++ ++-+ - ^ ^ - | | - | | - +-+-------------------------+ | - | External Network | | - +---------------------------+ | - +-----------------------+---+ - | Installation Network | - +---------------------------+ - -Start Deployment (Virtual Deployment) -------------------------------------- - -1. Edit run.sh - -Set OS version and OpenStack version for deployment nodes. - Compass4nfv Colorado supports three OS version based openstack mitaka. - -E.g. - -.. code-block:: bash - - ########## Ubuntu14.04 Mitaka ########## - export OS_VERSION=trusty - export OPENSTACK_VERSION=mitaka - - ########## Ubuntu16.04 Mitaka ########## - # export OS_VERSION=xenial - # export OPENSTACK_VERSION=mitaka_xenial - - ########## Centos7 Mitaka ########## - # export OS_VERSION=centos7 - # export OPENSTACK_VERSION=mitaka - -Set ISO image that you want to deploy - -E.g. - -.. code-block:: bash - - # ISO_URL is your iso's absolute path - # export ISO_URL=file:///home/compass/compass4nfv.iso - # or - # export ISO_URL=http://artifacts.opnfv.org/compass4nfv/colorado/opnfv-colorado.1.0.iso - -Set scenario that you want to deploy - -E.g. - -nosdn-nofeature scenario deploy sample - -.. code-block:: bash - - # DHA is your dha.yml's path - export DHA=./deploy/conf/vm_environment/os-nosdn-nofeature-ha.yml - - # NETWORK is your network.yml's path - export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network.yml - -ocl-nofeature scenario deploy sample - -.. code-block:: bash - - # DHA is your dha.yml's path - export DHA=./deploy/conf/vm_environment/os-ocl-nofeature-ha.yml - - # NETWORK is your network.yml's path - export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network_ocl.yml - -odl_l2-moon scenario deploy sample - -.. code-block:: bash - - # DHA is your dha.yml's path - export DHA=./deploy/conf/vm_environment/os-odl_l2-moon-ha.yml - - # NETWORK is your network.yml's path - export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network.yml - -odl_l2-nofeature scenario deploy sample - -.. code-block:: bash - - # DHA is your dha.yml's path - export DHA=./deploy/conf/vm_environment/os-odl_l2-nofeature-ha.yml - - # NETWORK is your network.yml's path - export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network.yml - -odl_l3-nofeature scenario deploy sample - -.. code-block:: bash - - # DHA is your dha.yml's path - export DHA=./deploy/conf/vm_environment/os-odl_l3-nofeature-ha.yml - - # NETWORK is your network.yml's path - export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network.yml - -onos-nofeature scenario deploy sample - -.. code-block:: bash - - # DHA is your dha.yml's path - export DHA=./deploy/conf/vm_environment/os-onos-nofeature-ha.yml - - # NETWORK is your network.yml's path - export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network_onos.yml - -onos-sfc deploy scenario sample - -.. code-block:: bash - - # DHA is your dha.yml's path - export DHA=./deploy/conf/vm_environment/os-onos-sfc-ha.yml - - # NETWORK is your network.yml's path - export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network_onos.yml - -2. Run ``run.sh`` - -.. code-block:: bash - - ./run.sh diff --git a/docs/installationprocedure/bmdeploy.rst b/docs/installationprocedure/bmdeploy.rst new file mode 100644 index 00000000..d08a8f8a --- /dev/null +++ b/docs/installationprocedure/bmdeploy.rst @@ -0,0 +1,328 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI) + +Installation Guide (Bare Metal Deployment) +========================================== + +Nodes Configuration (Bare Metal Deployment) +------------------------------------------- + +The below file is the inventory template of deployment nodes: + +"compass4nfv/deploy/conf/hardware_environment/huawei-pod1/dha.yml" + +You can write your own IPMI IP/User/Password/Mac address/roles reference to it. + + - name -- Host name for deployment node after installation. + + - ipmiVer -- IPMI interface version for deployment node support. IPMI 1.0 + or IPMI 2.0 is available. + + - ipmiIP -- IPMI IP address for deployment node. Make sure it can access + from Jumphost. + + - ipmiUser -- IPMI Username for deployment node. + + - ipmiPass -- IPMI Password for deployment node. + + - mac -- MAC Address of deployment node PXE NIC . + + - roles -- Components deployed. + +**Set TYPE/FLAVOR and POWER TOOL** + +E.g. +.. code-block:: yaml + + TYPE: baremetal + FLAVOR: cluster + POWER_TOOL: ipmitool + +**Set ipmiUser/ipmiPass and ipmiVer** + +E.g. + +.. code-block:: yaml + + ipmiUser: USER + ipmiPass: PASSWORD + ipmiVer: '2.0' + +**Assignment of different roles to servers** + +E.g. Openstack only deployment roles setting + +.. code-block:: yaml + + hosts: + - name: host1 + mac: 'F8:4A:BF:55:A2:8D' + interfaces: + - eth1: 'F8:4A:BF:55:A2:8E' + ipmiIp: 172.16.130.26 + roles: + - controller + - ha + + - name: host2 + mac: 'D8:49:0B:DA:5A:B7' + interfaces: + - eth1: 'D8:49:0B:DA:5A:B8' + ipmiIp: 172.16.130.27 + roles: + - compute + +NOTE: +IF YOU SELECT MUTIPLE NODES AS CONTROLLER, THE 'ha' role MUST BE SELECT, TOO. + +E.g. Openstack and ceph deployment roles setting + +.. code-block:: yaml + + hosts: + - name: host1 + mac: 'F8:4A:BF:55:A2:8D' + interfaces: + - eth1: 'F8:4A:BF:55:A2:8E' + ipmiIp: 172.16.130.26 + roles: + - controller + - ha + - ceph-adm + - ceph-mon + + - name: host2 + mac: 'D8:49:0B:DA:5A:B7' + interfaces: + - eth1: 'D8:49:0B:DA:5A:B8' + ipmiIp: 172.16.130.27 + roles: + - compute + - ceph-osd + +E.g. Openstack and ODL deployment roles setting + +.. code-block:: yaml + + hosts: + - name: host1 + mac: 'F8:4A:BF:55:A2:8D' + interfaces: + - eth1: 'F8:4A:BF:55:A2:8E' + ipmiIp: 172.16.130.26 + roles: + - controller + - ha + - odl + + - name: host2 + mac: 'D8:49:0B:DA:5A:B7' + interfaces: + - eth1: 'D8:49:0B:DA:5A:B8' + ipmiIp: 172.16.130.27 + roles: + - compute + +E.g. Openstack and ONOS deployment roles setting + +.. code-block:: yaml + + hosts: + - name: host1 + mac: 'F8:4A:BF:55:A2:8D' + interfaces: + - eth1: 'F8:4A:BF:55:A2:8E' + ipmiIp: 172.16.130.26 + roles: + - controller + - ha + - onos + + - name: host2 + mac: 'D8:49:0B:DA:5A:B7' + interfaces: + - eth1: 'D8:49:0B:DA:5A:B8' + ipmiIp: 172.16.130.27 + roles: + - compute + +Network Configuration (Bare Metal Deployment) +--------------------------------------------- + +Before deployment, there are some network configuration to be checked based +on your network topology.Compass4nfv network default configuration file is +"compass4nfv/deploy/conf/hardware_environment/huawei-pod1/network.yml". +You can write your own reference to it. + +**The following figure shows the default network configuration.** + +.. code-block:: console + + + +--+ +--+ +--+ + | | | | | | + | | +------------+ | | | | + | +------+ Jumphost +------+ | | | + | | +------+-----+ | | | | + | | | | | | | + | | +------------+ +-----+ | + | | | | | | + | | +------------+ | | | | + | +------+ host1 +------+ | | | + | | +------+-----+ | | | | + | | | | | | | + | | +------------+ +-----+ | + | | | | | | + | | +------------+ | | | | + | +------+ host2 +------+ | | | + | | +------+-----+ | | | | + | | | | | | | + | | +------------+ +-----+ | + | | | | | | + | | +------------+ | | | | + | +------+ host3 +------+ | | | + | | +------+-----+ | | | | + | | | | | | | + | | +------------+ +-----+ | + | | | | | | + | | | | | | + +-++ ++-+ +-++ + ^ ^ ^ + | | | + | | | + +-+-------------------------+ | | + | External Network | | | + +---------------------------+ | | + +-----------------------+---+ | + | IPMI Network | | + +---------------------------+ | + +-------------------------+-+ + | PXE(Installation) Network | + +---------------------------+ + + +Start Deployment (Bare Metal Deployment) +---------------------------------------- + +1. Edit run.sh + +Set OS version and OpenStack version for deployment nodes. + Compass4nfv Colorado supports three OS version based openstack mitaka. + +E.g. + +.. code-block:: bash + + ########## Ubuntu14.04 Mitaka ########## + export OS_VERSION=trusty + export OPENSTACK_VERSION=mitaka + + ########## Ubuntu16.04 Mitaka ########## + # export OS_VERSION=xenial + # export OPENSTACK_VERSION=mitaka_xenial + + ########## Centos7 Mitaka ########## + # export OS_VERSION=centos7 + # export OPENSTACK_VERSION=mitaka + +Set ISO image that you want to deploy + +E.g. + +.. code-block:: bash + + # ISO_URL is your iso's absolute path + export ISO_URL=file:///home/compass/compass4nfv.iso + # or + # export ISO_URL=http://artifacts.opnfv.org/compass4nfv/colorado/opnfv-colorado.1.0.iso + +Set Jumphost PXE NIC. (set eth1 E.g.) + +E.g. + +.. code-block:: bash + + ########## Hardware Deploy Jumpserver PXE NIC ########## + # you need comment out it when virtual deploy + export INSTALL_NIC=eth1 + +Set scenario that you want to deploy + +E.g. + +nosdn-nofeature scenario deploy sample + +.. code-block:: bash + + # DHA is your dha.yml's path + export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-nosdn-nofeature-ha.yml + + # NETWORK is your network.yml's path + export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network.yml + +ocl-nofeature scenario deploy sample + +.. code-block:: bash + + # DHA is your dha.yml's path + export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-ocl-nofeature-ha.yml + + # NETWORK is your network.yml's path + export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network_ocl.yml + +odl_l2-moon scenario deploy sample + +.. code-block:: bash + + # DHA is your dha.yml's path + export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-odl_l2-moon-ha.yml + + # NETWORK is your network.yml's path + export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network.yml + +odl_l2-nofeature scenario deploy sample + +.. code-block:: bash + + # DHA is your dha.yml's path + export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-odl_l2-nofeature-ha.yml + + # NETWORK is your network.yml's path + export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network.yml + +odl_l3-nofeature scenario deploy sample + +.. code-block:: bash + + # DHA is your dha.yml's path + export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-odl_l3-nofeature-ha.yml + + # NETWORK is your network.yml's path + export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network.yml + +onos-nofeature scenario deploy sample + +.. code-block:: bash + + # DHA is your dha.yml's path + export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-onos-nofeature-ha.yml + + # NETWORK is your network.yml's path + export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network_onos.yml + +onos-sfc deploy scenario sample + +.. code-block:: bash + + # DHA is your dha.yml's path + export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-onos-sfc-ha.yml + + # NETWORK is your network.yml's path + export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network_onos.yml + +2. Run ``run.sh`` + +.. code-block:: bash + + ./run.sh diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst index c0bcc6ce..6416e35d 100644 --- a/docs/installationprocedure/index.rst +++ b/docs/installationprocedure/index.rst @@ -1,13 +1,16 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. (c) -************************************ -Compass4nfv Installation Instruction -************************************ +******************************************************** +OPNFV(Colorado) Compass4nfv Installation Instructions +******************************************************** .. toctree:: :numbered: - :maxdepth: 2 + :maxdepth: 4 + introduction.rst installation.instruction.rst + bmdeploy.rst + vmdeploy.rst + references.rst diff --git a/docs/installationprocedure/installation.instruction.rst b/docs/installationprocedure/installation.instruction.rst index 12c6a184..9e552494 100644 --- a/docs/installationprocedure/installation.instruction.rst +++ b/docs/installationprocedure/installation.instruction.rst @@ -1,4 +1,155 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 - .. (c) +.. (c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI) +Compass4nfv configuration +========================= + +This document describes providing guidelines on how to install and +configure the Colorado release of OPNFV when using Compass as a +deployment tool including required software and hardware +configurations. + +Installation and configuration of host OS, OpenStack, OpenDaylight, +ONOS, Ceph etc. can be supported by Compass on Virtual nodes or Bare Metal +nodes. + +The audience of this document is assumed to have good knowledge in +networking and Unix/Linux administration. + + +Preconditions +------------- + +Before starting the installation of the Colorado release of OPNFV, +some planning must be done. + + +Retrieving the installation ISO image +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +First of all, The installation ISO is needed for deploying your OPNFV +environment, it included packages of Compass, OpenStack, OpenDaylight, ONOS +and so on. + +The stable release ISO can be retrieved via `OPNFV software download page `_ + +The daily build ISO can be retrieved via OPNFV artifacts repository: + +http://artifacts.opnfv.org/ + +NOTE: Search the keyword "compass4nfv/Colorado" to locate the ISO image. + +E.g. +compass4nfv/colorado/opnfv-2016-01-16_15-03-18.iso +compass4nfv/colorado/opnfv-2016-01-16_15-03-18.properties + +The name of iso image includes the time of iso building, you can get the daily +ISO according the building time. +The git url and sha1 of Compass4nfv are recorded in properties files, +According these, the corresponding deployment scripts can be retrieved. + + +Getting the deployment scripts +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To retrieve the repository of Compass4nfv on Jumphost use the following command: + +- git clone https://gerrit.opnfv.org/gerrit/compass4nfv + +NOTE: PLEASE DO NOT GIT CLONE COMPASS4NFV IN root DIRECTORY(Include subfolders). + +To get stable /colorado release, you can use the following command: + +- git checkout colorado.1.0 + +Setup Requirements +------------------ + +If you have only 1 Bare Metal server, Virtual deployment is recommended. if more +than or equal 3 servers, the Bare Metal deployment is recommended. The minimum number of +servers for Bare metal deployment is 3, 1 for JumpServer(Jumphost), 1 for controller, +1 for compute. + + +Jumphost Requirements +~~~~~~~~~~~~~~~~~~~~~ + +The Jumphost requirements are outlined below: + +1. Ubuntu 14.04 (Pre-installed). + +2. Root access. + +3. libvirt virtualization support. + +4. Minimum 2 NICs. + + - PXE installation Network (Receiving PXE request from nodes and providing OS provisioning) + + - IPMI Network (Nodes power control and set boot PXE first via IPMI interface) + + - External Network (Optional: Internet access) + +5. 16 GB of RAM for a Bare Metal deployment, 64 GB of RAM for a Virtual deployment. + +6. CPU cores: 32, Memory: 64 GB, Hard Disk: 500 GB, (Virtual Deloment needs 1 TB Hard Disk) + + +Bare Metal Node Requirements +---------------------------- + +Bare Metal nodes require: + +1. IPMI enabled on OOB interface for power control. + +2. BIOS boot priority should be PXE first then local hard disk. + +3. Minimum 3 NICs. + + - PXE installation Network (Broadcasting PXE request) + + - IPMI Network (Receiving IPMI command from Jumphost) + + - External Network (OpenStack mgmt/external/storage/tenant network) + + +Network Requirements +-------------------- + +Network requirements include: + +1. No DHCP or TFTP server running on networks used by OPNFV. + +2. 2-6 separate networks with connectivity between Jumphost and nodes. + + - PXE installation Network + + - IPMI Network + + - Openstack mgmt Network* + + - Openstack external Network* + + - Openstack tenant Network* + + - Openstack storage Network* + +3. Lights out OOB network access from Jumphost with IPMI node enabled (Bare Metal deployment only). + +4. External network has Internet access, meaning a gateway and DNS availability. + +**The networks with(*) can be share one NIC(Default configuration) or use an exclusive** +**NIC(Reconfigurated in network.yml).** + + +Execution Requirements (Bare Metal Only) +---------------------------------------- + +In order to execute a deployment, one must gather the following information: + +1. IPMI IP addresses of the nodes. + +2. IPMI login information for the nodes (user/pass). + +3. MAC address of Control Plane / Provisioning interfaces of the Bare Metal nodes. diff --git a/docs/installationprocedure/introduction.rst b/docs/installationprocedure/introduction.rst new file mode 100644 index 00000000..d1c581e2 --- /dev/null +++ b/docs/installationprocedure/introduction.rst @@ -0,0 +1,35 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI) + +Abstract +======== + +This document describes how to install the Brahmaputra release of OPNFV when +using Compass4nfv as a deployment tool covering it's limitations, dependencies +and required system resources. + +Version history +=============== + ++--------------------+--------------------+--------------------+---------------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+---------------------------+ +| 2016-09-13 | 2.1.0 | Yuenan Li | Adjusted the docs | +| | | (HUAWEI) | structure | ++--------------------+--------------------+--------------------+---------------------------+ +| 2016-09-12 | 2.0.0 | Yuenan Li | Rewritten for | +| | | (HUAWEI) | Compass4nfv C release | ++--------------------+--------------------+--------------------+---------------------------+ +| 2016-01-17 | 1.0.0 | Justin chi | Rewritten for | +| | | (HUAWEI) | Compass4nfv B release | ++--------------------+--------------------+--------------------+---------------------------+ +| 2015-12-16 | 0.0.2 | Matthew Li | Minor changes & | +| | | (HUAWEI) | formatting | ++--------------------+--------------------+--------------------+---------------------------+ +| 2015-09-12 | 0.0.1 | Chen Shuai | First draft | +| | | (HUAWEI) | | ++--------------------+--------------------+--------------------+---------------------------+ + + diff --git a/docs/installationprocedure/postinstall.rst b/docs/installationprocedure/postinstall.rst new file mode 100644 index 00000000..f9b7aa92 --- /dev/null +++ b/docs/installationprocedure/postinstall.rst @@ -0,0 +1,32 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. +.. http://creativecommons.org/licenses/by/4.0 + +.. commented as there is no content for this file at this time. + +.. post installation procedures +.. ====================================== +.. Add a brief introduction to the methods of validating the installation +.. according to this specific installer or feature. + +.. 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. + +.. 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. + +.. 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. + +.. Platform components validation +.. --------------------------------- +.. Describe any component specific validation procedures necessary for your +.. deployment tool in this section. + diff --git a/docs/installationprocedure/references.rst b/docs/installationprocedure/references.rst new file mode 100644 index 00000000..467bf08d --- /dev/null +++ b/docs/installationprocedure/references.rst @@ -0,0 +1,38 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI) + +References +========== + +OPNFV +----- + +`OPNFV Home Page `_ + +`OPNFV Genesis project page `_ + +`OPNFV Compass4nfv project page `_ + +OpenStack +--------- + +`OpenStack Liberty Release artifacts `_ + +`OpenStack documentation `_ + +OpenDaylight +------------ + +`OpenDaylight artifacts `_ + +ONOS +---- + +`ONOS artifacts `_ + +Compass +------- + +`Compass Home Page `_ + diff --git a/docs/installationprocedure/vmdeploy.rst b/docs/installationprocedure/vmdeploy.rst new file mode 100644 index 00000000..cb5df6fb --- /dev/null +++ b/docs/installationprocedure/vmdeploy.rst @@ -0,0 +1,260 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI) + +Installation Guide (Virtual Deployment) +======================================= + +Nodes Configuration (Virtual Deployment) +---------------------------------------- + +The below file is the inventory template of deployment nodes: + +"./deploy/conf/vm_environment/huawei-virtual1/network.yml" + +You can write your own address/roles reference to it. + + - name -- Host name for deployment node after installation. + + - roles -- Components deployed. + +**Set TYPE and FLAVOR** + +E.g. + +.. code-block:: yaml + + TYPE: virtual + FLAVOR: cluster + +**Assignment of different roles to servers** + +E.g. Openstack only deployment roles setting + +.. code-block:: yaml + + hosts: + - name: host1 + roles: + - controller + - ha + + - name: host2 + roles: + - compute + +NOTE: +IF YOU SELECT MUTIPLE NODES AS CONTROLLER, THE 'ha' role MUST BE SELECT, TOO. + +E.g. Openstack and ceph deployment roles setting + +.. code-block:: yaml + + hosts: + - name: host1 + roles: + - controller + - ha + - ceph-adm + - ceph-mon + + - name: host2 + roles: + - compute + - ceph-osd + +E.g. Openstack and ODL deployment roles setting + +.. code-block:: yaml + + hosts: + - name: host1 + roles: + - controller + - ha + - odl + + - name: host2 + roles: + - compute + +E.g. Openstack and ONOS deployment roles setting + +.. code-block:: yaml + + hosts: + - name: host1 + roles: + - controller + - ha + - onos + + - name: host2 + roles: + - compute + +Network Configuration (Virtual Deployment) +------------------------------------------ + +Before deployment, there are some network configuration to be checked based +on your network topology.Compass4nfv network default configuration file is +"compass4nfv/deploy/conf/vm_environment/huawei-virtual1/network.yml". +You can write your own reference to it. + +**The following figure shows the default network configuration.** + +.. code-block:: console + + + +--+ +--+ + | | | | + | | +------------+ | | + | +------+ Jumphost +------+ | + | | +------+-----+ | | + | | | | | + | | +------------+ | + | | | | + | | +------------+ | | + | +------+ host1 +------+ | + | | +------+-----+ | | + | | | | | + | | +------------+ | + | | | | + | | +------------+ | | + | +------+ host2 +------+ | + | | +------+-----+ | | + | | | | | + | | +------------+ | + | | | | + | | +------------+ | | + | +------+ host3 +------+ | + | | +------+-----+ | | + | | | | | + | | +------------+ | + | | | | + | | | | + +-++ ++-+ + ^ ^ + | | + | | + +-+-------------------------+ | + | External Network | | + +---------------------------+ | + +-----------------------+---+ + | Installation Network | + +---------------------------+ + +Start Deployment (Virtual Deployment) +------------------------------------- + +1. Edit run.sh + +Set OS version and OpenStack version for deployment nodes. + Compass4nfv Colorado supports three OS version based openstack mitaka. + +E.g. + +.. code-block:: bash + + ########## Ubuntu14.04 Mitaka ########## + export OS_VERSION=trusty + export OPENSTACK_VERSION=mitaka + + ########## Ubuntu16.04 Mitaka ########## + # export OS_VERSION=xenial + # export OPENSTACK_VERSION=mitaka_xenial + + ########## Centos7 Mitaka ########## + # export OS_VERSION=centos7 + # export OPENSTACK_VERSION=mitaka + +Set ISO image that you want to deploy + +E.g. + +.. code-block:: bash + + # ISO_URL is your iso's absolute path + # export ISO_URL=file:///home/compass/compass4nfv.iso + # or + # export ISO_URL=http://artifacts.opnfv.org/compass4nfv/colorado/opnfv-colorado.1.0.iso + +Set scenario that you want to deploy + +E.g. + +nosdn-nofeature scenario deploy sample + +.. code-block:: bash + + # DHA is your dha.yml's path + export DHA=./deploy/conf/vm_environment/os-nosdn-nofeature-ha.yml + + # NETWORK is your network.yml's path + export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network.yml + +ocl-nofeature scenario deploy sample + +.. code-block:: bash + + # DHA is your dha.yml's path + export DHA=./deploy/conf/vm_environment/os-ocl-nofeature-ha.yml + + # NETWORK is your network.yml's path + export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network_ocl.yml + +odl_l2-moon scenario deploy sample + +.. code-block:: bash + + # DHA is your dha.yml's path + export DHA=./deploy/conf/vm_environment/os-odl_l2-moon-ha.yml + + # NETWORK is your network.yml's path + export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network.yml + +odl_l2-nofeature scenario deploy sample + +.. code-block:: bash + + # DHA is your dha.yml's path + export DHA=./deploy/conf/vm_environment/os-odl_l2-nofeature-ha.yml + + # NETWORK is your network.yml's path + export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network.yml + +odl_l3-nofeature scenario deploy sample + +.. code-block:: bash + + # DHA is your dha.yml's path + export DHA=./deploy/conf/vm_environment/os-odl_l3-nofeature-ha.yml + + # NETWORK is your network.yml's path + export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network.yml + +onos-nofeature scenario deploy sample + +.. code-block:: bash + + # DHA is your dha.yml's path + export DHA=./deploy/conf/vm_environment/os-onos-nofeature-ha.yml + + # NETWORK is your network.yml's path + export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network_onos.yml + +onos-sfc deploy scenario sample + +.. code-block:: bash + + # DHA is your dha.yml's path + export DHA=./deploy/conf/vm_environment/os-onos-sfc-ha.yml + + # NETWORK is your network.yml's path + export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network_onos.yml + +2. Run ``run.sh`` + +.. code-block:: bash + + ./run.sh -- cgit 1.2.3-korg