summaryrefslogtreecommitdiffstats
path: root/docs/configguide/bmdeploy.rst
diff options
context:
space:
mode:
authorQiLiang <liangqi1@huawei.com>2016-08-12 02:31:15 +0000
committerQiLiang <liangqi1@huawei.com>2016-08-16 07:51:13 +0000
commit7787a0805a1edff958956bc0d134729c1d8ddcb0 (patch)
treed96d488be7b760d0e3f2c9371b3173ea1480a422 /docs/configguide/bmdeploy.rst
parente5f4a56fc69f25f1c0753dcbd56c418fcae49c7a (diff)
modify compass4nfv configuration documentation
JIRA: DOCS-141 Change-Id: I136ae88163d4290e5fb2485ae6b58f723237f0df Signed-off-by: QiLiang <liangqi1@huawei.com>
Diffstat (limited to 'docs/configguide/bmdeploy.rst')
-rw-r--r--docs/configguide/bmdeploy.rst261
1 files changed, 261 insertions, 0 deletions
diff --git a/docs/configguide/bmdeploy.rst b/docs/configguide/bmdeploy.rst
new file mode 100644
index 00000000..d8430adc
--- /dev/null
+++ b/docs/configguide/bmdeploy.rst
@@ -0,0 +1,261 @@
+.. 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.
+
+ - 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 .
+
+ - name -- Host name for deployment node after installation.
+
+ - roles -- Components deployed.
+
+
+**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 (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".
+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. 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.
+
+ Compass4nfv Colorado supports three OS version based openstack mitaka.
+
+Ubuntu 14.04 mitaka:
+
+.. code-block:: bash
+
+ export OS_VERSION=trusty
+ export OPENSTACK_VERSION=mitaka
+
+Ubuntu 16.04 mitaka:
+
+.. code-block:: bash
+
+ export OS_VERSION=xenial
+ export OPENSTACK_VERSION=mitaka_xenial
+
+Centos 7 mitaka:
+
+.. code-block:: bash
+
+ export OS_VERSION=centos7
+ export OPENSTACK_VERSION=mitaka
+
+3. Set ISO image that you want to deploy
+
+.. 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
+
+4. Run ``deploy.sh`` with inventory and network configuration
+
+.. code-block:: bash
+
+ ./deploy.sh --dha ${YOUR_OWN}/dha.yml --network ${YOUR_OWN}/network.yml
+
+E.g.
+
+1. nosdn-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
+
+2. ocl-nofeature 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
+
+3. odl_l2-moon 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
+
+ 4. odl_l2-nofeature scenario deploy template
+
+.. 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
+
+5. odl_l3-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
+
+6. onos-nofeature scenario deploy 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
+
+7. onos-sfc deploy scenario sample
+
+.. code-block:: bash
+
+ ./deploy.sh \
+ --dha ./deploy/conf/hardware_environment/huawei-pod1/os-onos-sfc-ha.yml \
+ --network ./deploy/conf/hardware_environment/huawei-pod1/network_onos.yml
+