aboutsummaryrefslogtreecommitdiffstats
path: root/docs/installationprocedure
diff options
context:
space:
mode:
Diffstat (limited to 'docs/installationprocedure')
-rw-r--r--docs/installationprocedure/bmdeploy.rst340
-rw-r--r--docs/installationprocedure/expansion.rst339
-rw-r--r--docs/installationprocedure/index.rst18
-rw-r--r--docs/installationprocedure/installation.instruction.rst154
-rw-r--r--docs/installationprocedure/introduction.rst35
-rw-r--r--docs/installationprocedure/offline-deploy.rst47
-rw-r--r--docs/installationprocedure/postinstall.rst32
-rw-r--r--docs/installationprocedure/references.rst40
-rw-r--r--docs/installationprocedure/vmdeploy.rst272
9 files changed, 0 insertions, 1277 deletions
diff --git a/docs/installationprocedure/bmdeploy.rst b/docs/installationprocedure/bmdeploy.rst
deleted file mode 100644
index 3b294f1f..00000000
--- a/docs/installationprocedure/bmdeploy.rst
+++ /dev/null
@@ -1,340 +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"
-
-The "dha.yml" is a collectively name for "os-nosdn-nofeature-ha.yml
-os-ocl-nofeature-ha.yml os-odl_l2-moon-ha.yml etc".
-
-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 deploy.sh
-
-Set OS version and OpenStack version for deployment nodes.
- Compass4nfv Colorado supports three OS version based openstack mitaka.
-
-E.g.
-
-.. code-block:: bash
-
- ######################### The environment for Openstack ######################
- # Ubuntu16.04 Newton
- #export OS_VERSION=xenial
- #export OPENSTACK_VERSION=newton_xenial
-
- # 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
-
- # Redhat7 OSP9
- #export OS_VERSION=redhat7
- #export OPENSTACK_VERSION=osp9
-
-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 Jumphost 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 ``deploy.sh``
-
-.. code-block:: bash
-
- ./deploy.sh
diff --git a/docs/installationprocedure/expansion.rst b/docs/installationprocedure/expansion.rst
deleted file mode 100644
index 697945ba..00000000
--- a/docs/installationprocedure/expansion.rst
+++ /dev/null
@@ -1,339 +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)
-
-Expansion Guide
-===============
-
-Bare Metal Expansion
---------------------
-
-Edit NETWORK File
-~~~~~~~~~~~~~~~~~
-
-The below file is the inventory template of deployment nodes:
-
- "./deploy/conf/hardware_environment/huawei-pod1/network.yml"
-
-You can edit the network.yml which you had edited before the first deployment.
-
-NOTE:
-External subnet's ip_range should be changed as the first 6 IPs are already taken
-by the first deployment.
-
-Edit DHA File
-~~~~~~~~~~~~~
-
-The below file is the inventory template of deployment nodes:
-
-"./deploy/conf/hardware_environment/expansion-sample/hardware_cluster_expansion.yml"
-
-You can write your own IPMI IP/User/Password/Mac address/roles reference to it.
-
- - name -- Host name for deployment node after installation.
-
- - 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 .
-
-**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 roles to servers**
-
-E.g. Only increase one compute node
-
-.. code-block:: yaml
-
- hosts:
- - name: host6
- mac: 'E8:4D:D0:BA:60:45'
- interfaces:
- - eth1: '08:4D:D0:BA:60:44'
- ipmiIp: 172.16.131.23
- roles:
- - compute
-
-
-E.g. Increase two compute nodes
-
-.. code-block:: yaml
-
- hosts:
- - name: host6
- mac: 'E8:4D:D0:BA:60:45'
- interfaces:
- - eth1: '08:4D:D0:BA:60:44'
- ipmiIp: 172.16.131.23
- roles:
- - compute
-
- - name: host6
- mac: 'E8:4D:D0:BA:60:78'
- interfaces:
- - eth1: '08:4D:56:BA:60:83'
- ipmiIp: 172.16.131.23
- roles:
- - compute
-
-Start Expansion
-~~~~~~~~~~~~~~~
-
-1. Edit deploy.sh
-
-Set the EXPANSION to true.
-
-E.g.
-
-.. code-block:: bash
-
- ######################### Deploy or Expansion ###############################
- # Modify network.yml and virtual_cluster_expansion.yml or
- # hardware_cluster_expansion.yml.
- # Edit the DHA and NETWORK envionment variables.
- # External subnet's ip_range and management ip should be changed as the
- # first 6 IPs are already taken by the first deployment.
- # VIRT_NUMBER decide how many virtual machines needs to expand when virtual expansion
-
- export EXPANSION="true"
- export MANAGEMENT_IP_START="10.1.0.55"
- #export VIRT_NUMBER=1
- export DEPLOY_FIRST_TIME="false"
-
-
-Set OS version and OpenStack version for deployment nodes.
-
-E.g.
-
-.. code-block:: bash
-
- ######################### The environment for Openstack ######################
- # Ubuntu16.04 Newton
- #export OS_VERSION=xenial
- #export OPENSTACK_VERSION=newton_xenial
-
- # 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
-
- # Redhat7 OSP9
- #export OS_VERSION=redhat7
- #export OPENSTACK_VERSION=osp9
-
-NOTE:
-The OS version and OpenStack version should be same as the first deployment.
-
-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
-
-NOTE:
-The ISO should be same as the first deployment.
-
-Set scenario that you want to expansion
-
-E.g.
-
-.. code-block:: bash
-
- # DHA is your dha.yml's path
- export DHA=./deploy/conf/hardware_environment/expansion-sample/hardware_cluster_expansion.yml
-
- # NETWORK is your network.yml's path
- export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network.yml
-
-Set jumpserver PXE NIC
-
-E.g.
-
-.. code-block:: bash
-
- INSTALL_NIC=${INSTALL_NIC:-eth1}
-
-Check the environment variable.
-
-2. Run ``deploy.sh``
-
-.. code-block:: bash
-
- ./deploy.sh
-
-Virtual Expansion
------------------
-
-Edit NETWORK File
-~~~~~~~~~~~~~~~~~
-
-The below file is the inventory template of deployment nodes:
-
- "./deploy/conf/vm_environment/huawei-virtual1/network.yml"
-
-You can edit the network.yml which you had edited before the first deployment.
-
-NOTE:
-External subnet's ip_range should be changed as the first 6 IPs are already taken
-by the first deployment.
-
-Edit DHA File
-~~~~~~~~~~~~~
-
-The below file is the inventory template of deployment nodes:
-
-"./deploy/conf/vm_environment/virtual_cluster_expansion.yml"
-
-**Set TYPE and FLAVOR**
-
-E.g.
-
-.. code-block:: yaml
-
- TYPE: virtual
- FLAVOR: cluster
-
-**Assignment of roles to servers**
-
-E.g. Only increase one compute node
-
-.. code-block:: yaml
-
- hosts:
- - name: host6
- roles:
- - compute
-
-E.g. Increase two compute nodes
-
-.. code-block:: yaml
-
- hosts:
- - name: host6
- roles:
- - compute
-
- - name: host7
- roles:
- - compute
-
-Start Expansion
-~~~~~~~~~~~~~~~
-
-1. Edit add.sh
-
-Set the EXPANSION to true.
-
-E.g.
-
-.. code-block:: bash
-
- ######################### Deploy or Expansion ###############################
- # Modify network.yml and virtual_cluster_expansion.yml or
- # hardware_cluster_expansion.yml.
- # Edit the DHA and NETWORK envionment variables.
- # External subnet's ip_range and management ip should be changed as the
- # first 6 IPs are already taken by the first deployment.
- # VIRT_NUMBER decide how many virtual machines needs to expand when virtual expansion
-
- export EXPANSION="true"
- export MANAGEMENT_IP_START="10.1.0.55"
- export VIRT_NUMBER=1
- export DEPLOY_FIRST_TIME="false"
-
-Set OS version and OpenStack version for deployment nodes.
-
-E.g.
-
-.. code-block:: bash
-
- ######################### The environment for Openstack ######################
- # Ubuntu16.04 Newton
- #export OS_VERSION=xenial
- #export OPENSTACK_VERSION=newton_xenial
-
- # 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
-
- # Redhat7 OSP9
- #export OS_VERSION=redhat7
- #export OPENSTACK_VERSION=osp9
-
-NOTE:
-The OS version and OpenStack version should be same as the first deployment.
-
-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
-
-NOTE:
-The OS version and OpenStack version should be same as the first deployment.
-
-Set scenario that you want to expansion
-
-E.g.
-
-.. code-block:: bash
-
- # DHA is your dha.yml's path
- export DHA=./deploy/conf/vm_environment/virtual_cluster_expansion.yml
-
- # NETWORK is your network.yml's path
- export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network.yml
-
-Check the environment variable.
-
-2. Run ``deploy.sh``
-
-.. code-block:: bash
-
- ./deploy.sh
diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst
deleted file mode 100644
index 7bcbc281..00000000
--- a/docs/installationprocedure/index.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-********************************************************
-OPNFV(Colorado) Compass4nfv Installation Instructions
-********************************************************
-
-.. toctree::
- :numbered:
- :maxdepth: 4
-
- introduction.rst
- installation.instruction.rst
- bmdeploy.rst
- vmdeploy.rst
- offline-deploy.rst
- expansion.rst
- references.rst
diff --git a/docs/installationprocedure/installation.instruction.rst b/docs/installationprocedure/installation.instruction.rst
deleted file mode 100644
index 87c8a55c..00000000
--- a/docs/installationprocedure/installation.instruction.rst
+++ /dev/null
@@ -1,154 +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 <https://www.opnfv.org/software>`_
-
-The daily build ISO can be retrieved via OPNFV artifacts repository:
-
-http://artifacts.opnfv.org/compass4nfv.html
-
-NOTE: Search the keyword "compass4nfv/Colorado" to locate the ISO image.
-
-E.g.
-compass4nfv/colorado/opnfv-2016-09-18_08-15-13.iso
-
-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
deleted file mode 100644
index 835a5788..00000000
--- a/docs/installationprocedure/introduction.rst
+++ /dev/null
@@ -1,35 +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 Colorado 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/offline-deploy.rst b/docs/installationprocedure/offline-deploy.rst
deleted file mode 100644
index 68c78a0b..00000000
--- a/docs/installationprocedure/offline-deploy.rst
+++ /dev/null
@@ -1,47 +0,0 @@
-.. two dots create a comment. please leave this logo at the top of each of your rst files.
-
-Offline Deploy
-==============
-
-Compass4nfv uses offline approuch to deploy cluster and support complete offline
-deployment on a jumphost without access internet. Here is the offline deployment
-instuction:
-
-Preparation for offline deploy
-------------------------------
-
-1. Download compass.iso from OPNFV artifacts repository (Search compass4nfv in
- http://artifacts.opnfv.org/ and download an appropriate ISO. ISO can also be
- generated by script build.sh in compass4nfv root directory.)
-
-2. Download the Jumphost preparation package from our httpserver. (Download the
- jumphost environment package from `here <http://205.177.226.237:9999/jh_env_package.tar.gz>`_.
- It should be awared that currently we only support ubuntu trusty as offline
- jumphost OS.)
-
-3. Clone the compass4nfv code repository.
-
-Steps of offline deploy
------------------------
-
-1. Copy the compass.iso, jh_env_package.tar.gz and the compass4nfv code
- repository to your jumphost.
-
-2. Export the local path of the compass.iso and jh_env_package.tar.gz on
- jumphost. Then you can perform deployment on a offline jumphost.
-
-E.g.
-
-Export the compass4nfv.iso and jh_env_package.tar.gz path
-
-.. code-block:: bash
-
- # ISO_URL and JHPKG_URL should be absolute path
- export ISO_URL=file:///home/compass/compass4nfv.iso
- export JHPKG_URL=file:///home/compass/jh_env_package.tar.gz
-
-Run deploy.sh
-
-.. code-block:: bash
-
- ./deploy.sh
diff --git a/docs/installationprocedure/postinstall.rst b/docs/installationprocedure/postinstall.rst
deleted file mode 100644
index f9b7aa92..00000000
--- a/docs/installationprocedure/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.
-
-.. <Project> 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.
-
-.. <Project> post configuration procedures
-.. ---------------------------------------
-.. Describe any deploy tool or feature specific scripts, tests or procedures
-.. that should be carried out on the deployment post install and configuration
-.. in this section.
-
-.. 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
deleted file mode 100644
index 69ca4e7b..00000000
--- a/docs/installationprocedure/references.rst
+++ /dev/null
@@ -1,40 +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 <www.opnfv.org>`_
-
-`OPNFV Genesis project page <https://wiki.opnfv.org/get_started>`_
-
-`OPNFV Compass4nfv project page <https://wiki.opnfv.org/compass4nfv>`_
-
-`OPNFV Compass4nfv release notes <http://artifacts.opnfv.org/compass4nfv/colorado/docs/release-notes/index.html>`_
-
-OpenStack
----------
-
-`OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_
-
-`OpenStack documentation <http://docs.openstack.org>`_
-
-OpenDaylight
-------------
-
-`OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
-
-ONOS
-----
-
-`ONOS artifacts <http://onosproject.org/software/>`_
-
-Compass
--------
-
-`Compass Home Page <http://www.syscompass.org/>`_
-
diff --git a/docs/installationprocedure/vmdeploy.rst b/docs/installationprocedure/vmdeploy.rst
deleted file mode 100644
index 54d7863e..00000000
--- a/docs/installationprocedure/vmdeploy.rst
+++ /dev/null
@@ -1,272 +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/dha.yml"
-
-The "dha.yml" is a collectively name for "os-nosdn-nofeature-ha.yml
-os-ocl-nofeature-ha.yml os-odl_l2-moon-ha.yml etc".
-
-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 deploy.sh
-
-Set OS version and OpenStack version for deployment nodes.
- Compass4nfv Colorado supports three OS version based openstack mitaka.
-
-E.g.
-
-.. code-block:: bash
-
- ######################### The environment for Openstack ######################
- # Ubuntu16.04 Newton
- #export OS_VERSION=xenial
- #export OPENSTACK_VERSION=newton_xenial
-
- # 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
-
- # Redhat7 OSP9
- #export OS_VERSION=redhat7
- #export OPENSTACK_VERSION=osp9
-
-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 ``deploy.sh``
-
-.. code-block:: bash
-
- ./deploy.sh