summaryrefslogtreecommitdiffstats
path: root/docs/configguide/vmdeploy.rst
diff options
context:
space:
mode:
authorshuai chen <chenshuai@huawei.com>2016-08-16 07:53:43 +0000
committerGerrit Code Review <gerrit@172.30.200.206>2016-08-16 07:53:43 +0000
commit5a17b6292e641cae7d939950fc5b3426bbcc0af9 (patch)
treefc693808d295d99db01abf7afd6c833b79e87592 /docs/configguide/vmdeploy.rst
parent507d971868b551bec44db62362c2dafe0f3af6c3 (diff)
parent7787a0805a1edff958956bc0d134729c1d8ddcb0 (diff)
Merge "modify compass4nfv configuration documentation"
Diffstat (limited to 'docs/configguide/vmdeploy.rst')
-rw-r--r--docs/configguide/vmdeploy.rst225
1 files changed, 209 insertions, 16 deletions
diff --git a/docs/configguide/vmdeploy.rst b/docs/configguide/vmdeploy.rst
index a7588845..546936d7 100644
--- a/docs/configguide/vmdeploy.rst
+++ b/docs/configguide/vmdeploy.rst
@@ -2,45 +2,238 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI)
-Installation Guide (VM Deployment)
-==================================
+Installation Guide (Virtual Deployment)
+=======================================
-Nodes Configuration (VM Deployment)
------------------------------------
+Nodes Configuration (Virtual Deployment)
+----------------------------------------
-Please follow the instructions in section `Installation Guide (BM Deployment)`,
-and no need to set IPMI/PXE/MAC parameters.
+The below file is the inventory template of deployment nodes:
-Network Configuration (VM Deployment)
+"compass4nfv/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.
+
+
+**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/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 | |
+ +---------------------------+ |
+ +-----------------------+---+
+ | PXE(Installation) Network |
+ +---------------------------+
+
+
+Start Deployment (Virtual Deployment)
-------------------------------------
-Please follow the instructions in section `Installation Guide (BM Deployment)`.
+1. Set OS version and OpenStack version for deployment nodes.
-Start Deployment (VM Deployment)
---------------------------------
+ Compass4nfv Colorado supports three OS version based openstack mitaka.
-1. Set OS version for nodes provisioning. (set Ubuntu14.04 E.g.)
+Ubuntu 14.04 mitaka:
.. code-block:: bash
export OS_VERSION=trusty
+ export OPENSTACK_VERSION=mitaka
+
+Ubuntu 16.04 mitaka:
+
+.. code-block:: bash
-3. Set OpenStack version for deployment nodes. (set liberty E.g.)
+ export OS_VERSION=xenial
+ export OPENSTACK_VERSION=mitaka_xenial
+
+Centos 7 mitaka:
.. code-block:: bash
- export OPENSTACK_VERSION=liberty
+ export OS_VERSION=centos7
+ export OPENSTACK_VERSION=mitaka
-4. Set ISO image that you want to deploy
+2. 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/brahmaputra/opnfv-release.iso
+ export ISO_URL=http://artifacts.opnfv.org/compass4nfv/colorado/opnfv-colorado.1.0.iso
-5. Run ``deploy.sh`` with inventory and network configuration
+3. 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/vm_environment/os-nosdn-nofeature-ha.yml \
+ --network ./deploy/conf/vm_environment/huawei-virtual1/network.yml
+
+2. ocl-nofeature 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
+
+3. odl_l2-moon 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
+
+4. odl_l2-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
+
+5. odl_l3-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
+
+6. onos-nofeature scenario deploy 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
+
+7. onos-sfc deploy scenario sample
+
+.. code-block:: bash
+
+ ./deploy.sh \
+ --dha ./deploy/conf/vm_environment/os-onos-sfc-ha.yml \
+ --network ./deploy/conf/vm_environment/huawei-virtual1/network_onos.yml
+