summaryrefslogtreecommitdiffstats
path: root/docs/configguide
diff options
context:
space:
mode:
authorJustin chi <chigang@huawei.com>2016-09-18 02:27:19 +0000
committerGerrit Code Review <gerrit@172.30.200.206>2016-09-18 02:27:19 +0000
commit6a676de6bbf845bcfabf58d4e9adbfb4e28b8c3f (patch)
treeae76cd7956701ac25f4399deb68eb14649475013 /docs/configguide
parent77ed8a151a33caf50c1bb2ac7edf60b55fab9e06 (diff)
parenteb4f5a098ddb31bc85f3fcdcaf503345422f1b79 (diff)
Merge "Add a run.sh" into stable/colorado
Diffstat (limited to 'docs/configguide')
-rw-r--r--docs/configguide/bmdeploy.rst183
-rw-r--r--docs/configguide/installerconfig.rst17
-rw-r--r--docs/configguide/vmdeploy.rst127
3 files changed, 199 insertions, 128 deletions
diff --git a/docs/configguide/bmdeploy.rst b/docs/configguide/bmdeploy.rst
index d8430adc..7cc4b9ce 100644
--- a/docs/configguide/bmdeploy.rst
+++ b/docs/configguide/bmdeploy.rst
@@ -10,10 +10,12 @@ Nodes Configuration (Bare Metal Deployment)
The below file is the inventory template of deployment nodes:
-"compass4nfv/deploy/conf/hardware_environment/huawei-pod1/[dha].yml"
+"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.
@@ -26,12 +28,26 @@ You can write your own IPMI IP/User/Password/Mac address/roles reference to it.
- mac -- MAC Address of deployment node PXE NIC .
- - name -- Host name for deployment node after installation.
-
- roles -- Components deployed.
+**Set TYPE/FLAVOR and POWER TOOL**
+
+E.g.
+.. code-block:: yaml
+
+ TYPE: baremetal
+ FLAVOR: cluster
+ POWER_TOOL: ipmitool
-**Assignment of different roles to servers**
+**Set ipmiUser/ipmiPass and ipmiVer**
+
+E.g.
+
+.. code-block:: yaml
+
+ ipmiUser: USER
+ ipmiPass: PASSWORD
+ ipmiVer: '2.0'
E.g. Openstack only deployment roles setting
@@ -39,11 +55,19 @@ E.g. Openstack only deployment roles setting
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
@@ -56,6 +80,10 @@ E.g. Openstack and ceph deployment roles setting
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
@@ -63,6 +91,10 @@ E.g. Openstack and ceph deployment roles setting
- 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
@@ -73,12 +105,20 @@ E.g. Openstack and ODL deployment roles setting
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
@@ -88,21 +128,29 @@ E.g. Openstack and ONOS deployment roles setting
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/network_cfg.yaml".
+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.**
@@ -155,107 +203,124 @@ You can write your own reference to it.
Start Deployment (Bare Metal Deployment)
----------------------------------------
-1. Set PXE/Installation NIC for Jumphost. (set eth1 E.g.)
-
-.. code-block:: bash
-
- export INSTALL_NIC=eth1
-
-
-2.Set OS version and OpenStack version for deployment nodes.
+1. Edit run.sh
+Set OS version and OpenStack version for deployment nodes.
Compass4nfv Colorado supports three OS version based openstack mitaka.
-Ubuntu 14.04 mitaka:
+E.g.
.. code-block:: bash
+ ########## Ubuntu14.04 Mitaka ##########
export OS_VERSION=trusty
export OPENSTACK_VERSION=mitaka
-Ubuntu 16.04 mitaka:
+ ########## Ubuntu16.04 Mitaka ##########
+ # export OS_VERSION=xenial
+ # export OPENSTACK_VERSION=mitaka_xenial
-.. code-block:: bash
+ ########## Centos7 Mitaka ##########
+ # export OS_VERSION=centos7
+ # export OPENSTACK_VERSION=mitaka
- export OS_VERSION=xenial
- export OPENSTACK_VERSION=mitaka_xenial
+Set ISO image that you want to deploy
-Centos 7 mitaka:
+E.g.
.. code-block:: bash
- export OS_VERSION=centos7
- export OPENSTACK_VERSION=mitaka
+ # 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
-3. Set ISO image that you want to deploy
+Set Jumphost PXE NIC. (set eth1 E.g.)
+
+E.g.
.. code-block:: bash
- export ISO_URL=file:///${YOUR_OWN}/compass.iso
- or
- export ISO_URL=http://artifacts.opnfv.org/compass4nfv/colorado/opnfv-colorado.1.0.iso
+ ########## Hardware Deploy Jumpserver PXE NIC ##########
+ # you need comment out it when virtual deploy
+ export INSTALL_NIC=eth1
-4. Run ``deploy.sh`` with inventory and network configuration
+Set scenario that you want to deploy
+
+E.g.
+
+nosdn-nofeature scenario deploy sample
.. code-block:: bash
- ./deploy.sh --dha ${YOUR_OWN}/dha.yml --network ${YOUR_OWN}/network.yml
+ # DHA is your dha.yml's path
+ export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-nosdn-nofeature-ha.yml
-E.g.
+ # NETWORK is your network.yml's path
+ export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network.yml
-1. nosdn-nofeature scenario deploy sample
+ocl-nofeature scenario deploy sample
.. code-block:: bash
- ./deploy.sh \
- --dha ./deploy/conf/hardware_environment/huawei-pod1/os-nosdn-nofeature-ha.yml \
- --network ./deploy/conf/hardware_environment/huawei-pod1/network.yml
+ # 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
-2. ocl-nofeature scenario deploy sample
+odl_l2-moon scenario deploy sample
.. code-block:: bash
- ./deploy.sh \
- --dha ./deploy/conf/hardware_environment/huawei-pod1/os-ocl-nofeature-ha.yml \
- --network ./deploy/conf/hardware_environment/huawei-pod1/network_ocl.yml
+ # DHA is your dha.yml's path
+ export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-odl_l2-moon-ha.yml
-3. odl_l2-moon scenario deploy sample
+ # 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
- ./deploy.sh \
- --dha ./deploy/conf/hardware_environment/huawei-pod1/os-odl_l2-moon-ha.yml \
- --network ./deploy/conf/hardware_environment/huawei-pod1/network.yml
+ # 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
- 4. odl_l2-nofeature scenario deploy template
+odl_l3-nofeature scenario deploy sample
.. code-block:: bash
- ./deploy.sh \
- --dha ./deploy/conf/hardware_environment/huawei-pod1/os-odl_l2-nofeature-ha.yml \
- --network ./deploy/conf/hardware_environment/huawei-pod1/network.yml
+ # DHA is your dha.yml's path
+ export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-odl_l3-nofeature-ha.yml
-5. odl_l3-nofeature scenario deploy sample
+ # 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
- ./deploy.sh \
- --dha ./deploy/conf/hardware_environment/huawei-pod1/os-odl_l3-nofeature-ha.yml \
- --network ./deploy/conf/hardware_environment/huawei-pod1/network.yml
+ # 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
-6. onos-nofeature scenario deploy sample
+onos-sfc deploy scenario sample
.. code-block:: bash
- ./deploy.sh \
- --dha ./deploy/conf/hardware_environment/huawei-pod1/os-onos-nofeature-ha.yml \
- --network ./deploy/conf/hardware_environment/huawei-pod1/network_onos.yml
+ # DHA is your dha.yml's path
+ export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-onos-sfc-ha.yml
-7. onos-sfc deploy scenario sample
+ # NETWORK is your network.yml's path
+ export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network_onos.yml
-.. code-block:: bash
+2. Run ``run.sh``
- ./deploy.sh \
- --dha ./deploy/conf/hardware_environment/huawei-pod1/os-onos-sfc-ha.yml \
- --network ./deploy/conf/hardware_environment/huawei-pod1/network_onos.yml
+.. code-block:: bash
+ ./run.sh
diff --git a/docs/configguide/installerconfig.rst b/docs/configguide/installerconfig.rst
index 21cd0825..9e552494 100644
--- a/docs/configguide/installerconfig.rst
+++ b/docs/configguide/installerconfig.rst
@@ -57,26 +57,12 @@ 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.
+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
-If you don't have a Linux foundation user id, get it first by the url:
-
-https://wiki.opnfv.org/developer/getting_started
-
-If you want to use a daily release ISO, please checkout the corresponding sha1 to
-get the deployment scripts:
-
-E.g.
-Git sha1 in file "opnfv-2016-01-16_15-03-18.properties" is
-d5a13ce7cc2ce89946d34b0402ecf33c1d291851
-
-- git checkout d5a13ce7cc2ce89946d34b0402ecf33c1d291851
-
-
Setup Requirements
------------------
@@ -167,4 +153,3 @@ In order to execute a deployment, one must gather the following information:
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/vmdeploy.rst b/docs/configguide/vmdeploy.rst
index 546936d7..cb5df6fb 100644
--- a/docs/configguide/vmdeploy.rst
+++ b/docs/configguide/vmdeploy.rst
@@ -10,7 +10,7 @@ Nodes Configuration (Virtual Deployment)
The below file is the inventory template of deployment nodes:
-"compass4nfv/deploy/conf/vm_environment/huawei-virtual1/network.yml"
+"./deploy/conf/vm_environment/huawei-virtual1/network.yml"
You can write your own address/roles reference to it.
@@ -18,6 +18,14 @@ You can write your own address/roles reference to it.
- roles -- Components deployed.
+**Set TYPE and FLAVOR**
+
+E.g.
+
+.. code-block:: yaml
+
+ TYPE: virtual
+ FLAVOR: cluster
**Assignment of different roles to servers**
@@ -85,12 +93,12 @@ E.g. Openstack and ONOS deployment roles setting
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/network_cfg.yaml".
+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.**
@@ -133,107 +141,120 @@ You can write your own reference to it.
| External Network | |
+---------------------------+ |
+-----------------------+---+
- | PXE(Installation) Network |
+ | Installation Network |
+---------------------------+
-
Start Deployment (Virtual Deployment)
-------------------------------------
-1. Set OS version and OpenStack version for deployment nodes.
+1. Edit run.sh
+Set OS version and OpenStack version for deployment nodes.
Compass4nfv Colorado supports three OS version based openstack mitaka.
-Ubuntu 14.04 mitaka:
+E.g.
.. code-block:: bash
+ ########## Ubuntu14.04 Mitaka ##########
export OS_VERSION=trusty
export OPENSTACK_VERSION=mitaka
-Ubuntu 16.04 mitaka:
+ ########## Ubuntu16.04 Mitaka ##########
+ # export OS_VERSION=xenial
+ # export OPENSTACK_VERSION=mitaka_xenial
-.. code-block:: bash
+ ########## Centos7 Mitaka ##########
+ # export OS_VERSION=centos7
+ # export OPENSTACK_VERSION=mitaka
- export OS_VERSION=xenial
- export OPENSTACK_VERSION=mitaka_xenial
+Set ISO image that you want to deploy
-Centos 7 mitaka:
+E.g.
.. code-block:: bash
- export OS_VERSION=centos7
- export OPENSTACK_VERSION=mitaka
-
-2. Set ISO image that you want to deploy
+ # 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
-.. code-block:: bash
+Set scenario that you want to deploy
- export ISO_URL=file:///${YOUR_OWN}/compass.iso
- or
- export ISO_URL=http://artifacts.opnfv.org/compass4nfv/colorado/opnfv-colorado.1.0.iso
+E.g.
-3. Run ``deploy.sh`` with inventory and network configuration
+nosdn-nofeature scenario deploy sample
.. code-block:: bash
- ./deploy.sh --dha ${YOUR_OWN}/dha.yml --network ${YOUR_OWN}/network.yml
+ # DHA is your dha.yml's path
+ export DHA=./deploy/conf/vm_environment/os-nosdn-nofeature-ha.yml
-E.g.
+ # NETWORK is your network.yml's path
+ export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network.yml
-1. nosdn-nofeature scenario deploy sample
+ocl-nofeature scenario deploy sample
.. code-block:: bash
- ./deploy.sh \
- --dha ./deploy/conf/vm_environment/os-nosdn-nofeature-ha.yml \
- --network ./deploy/conf/vm_environment/huawei-virtual1/network.yml
+ # 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
-2. ocl-nofeature scenario deploy sample
+odl_l2-moon scenario deploy sample
.. code-block:: bash
- ./deploy.sh \
- --dha ./deploy/conf/vm_environment/os-ocl-nofeature-ha.yml \
- --network ./deploy/conf/vm_environment/huawei-virtual1/network_ocl.yml
+ # 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
-3. odl_l2-moon scenario deploy sample
+odl_l2-nofeature scenario deploy sample
.. code-block:: bash
- ./deploy.sh \
- --dha ./deploy/conf/vm_environment/os-odl_l2-moon-ha.yml \
- --network ./deploy/conf/vm_environment/huawei-virtual1/network.yml
+ # DHA is your dha.yml's path
+ export DHA=./deploy/conf/vm_environment/os-odl_l2-nofeature-ha.yml
-4. odl_l2-nofeature scenario deploy sample
+ # 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
- ./deploy.sh \
- --dha ./deploy/conf/vm_environment/os-odl_l2-nofeature-ha.yml \
- --network ./deploy/conf/vm_environment/huawei-virtual1/network.yml
+ # 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
-5. odl_l3-nofeature scenario deploy sample
+onos-nofeature scenario deploy sample
.. code-block:: bash
- ./deploy.sh \
- --dha ./deploy/conf/vm_environment/os-odl_l3-nofeature-ha.yml \
- --network ./deploy/conf/vm_environment/huawei-virtual1/network.yml
+ # 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
-6. onos-nofeature scenario deploy sample
+onos-sfc deploy scenario sample
.. code-block:: bash
- ./deploy.sh \
- --dha ./deploy/conf/vm_environment/os-onos-nofeature-ha.yml \
- --network ./deploy/conf/vm_environment/huawei-virtual1/network_onos.yml
+ # DHA is your dha.yml's path
+ export DHA=./deploy/conf/vm_environment/os-onos-sfc-ha.yml
-7. onos-sfc deploy scenario sample
+ # NETWORK is your network.yml's path
+ export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network_onos.yml
-.. code-block:: bash
+2. Run ``run.sh``
- ./deploy.sh \
- --dha ./deploy/conf/vm_environment/os-onos-sfc-ha.yml \
- --network ./deploy/conf/vm_environment/huawei-virtual1/network_onos.yml
+.. code-block:: bash
+ ./run.sh