diff options
Diffstat (limited to 'docs/installationprocedure')
| -rw-r--r-- | docs/installationprocedure/bmdeploy.rst | 2 | ||||
| -rw-r--r-- | docs/installationprocedure/expansion.rst | 302 | ||||
| -rw-r--r-- | docs/installationprocedure/index.rst | 1 | ||||
| -rw-r--r-- | docs/installationprocedure/installation.instruction.rst | 7 | ||||
| -rw-r--r-- | docs/installationprocedure/introduction.rst | 2 | ||||
| -rw-r--r-- | docs/installationprocedure/references.rst | 4 |
6 files changed, 311 insertions, 7 deletions
diff --git a/docs/installationprocedure/bmdeploy.rst b/docs/installationprocedure/bmdeploy.rst index d08a8f8a..6ec70fa4 100644 --- a/docs/installationprocedure/bmdeploy.rst +++ b/docs/installationprocedure/bmdeploy.rst @@ -243,7 +243,7 @@ E.g. .. code-block:: bash - ########## Hardware Deploy Jumpserver PXE NIC ########## + ########## Hardware Deploy Jumphost PXE NIC ########## # you need comment out it when virtual deploy export INSTALL_NIC=eth1 diff --git a/docs/installationprocedure/expansion.rst b/docs/installationprocedure/expansion.rst new file mode 100644 index 00000000..1ffdafbd --- /dev/null +++ b/docs/installationprocedure/expansion.rst @@ -0,0 +1,302 @@ +.. 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 add.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 + +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 + +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 + +Comment out VIRT_NUMBER when bare metal expansion + +E.g. + +.. code-block:: bash + + #export VIRT_NUMBER=1 + +Set jumpserver PXE NIC + +E.g. + +.. code-block:: bash + + INSTALL_NIC=${INSTALL_NIC:-eth1} + +Check the environment variable. + +2. Run ``add.sh`` + +.. code-block:: bash + + ./add.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 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 + +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 + +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 + +Set nodes number need to expansion + +E.g. + +.. code-block:: bash + + export VIRT_NUMBER=1 + +Comment out NIC when virtual expansion + +E.g. + +.. code-block:: bash + + #INSTALL_NIC=${INSTALL_NIC:-eth1} + +Check the environment variable. + +2. Run ``add.sh`` + +.. code-block:: bash + + ./add.sh diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst index 6416e35d..77439ae9 100644 --- a/docs/installationprocedure/index.rst +++ b/docs/installationprocedure/index.rst @@ -13,4 +13,5 @@ OPNFV(Colorado) Compass4nfv Installation Instructions installation.instruction.rst bmdeploy.rst vmdeploy.rst + expansion.rst references.rst diff --git a/docs/installationprocedure/installation.instruction.rst b/docs/installationprocedure/installation.instruction.rst index 9e552494..87c8a55c 100644 --- a/docs/installationprocedure/installation.instruction.rst +++ b/docs/installationprocedure/installation.instruction.rst @@ -36,13 +36,12 @@ The stable release ISO can be retrieved via `OPNFV software download page <https The daily build ISO can be retrieved via OPNFV artifacts repository: -http://artifacts.opnfv.org/ +http://artifacts.opnfv.org/compass4nfv.html 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 +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. @@ -57,7 +56,7 @@ 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). +NOTE: PLEASE DO NOT GIT CLONE COMPASS4NFV IN ROOT DIRECTORY(INCLUDE SUBFOLDERS). To get stable /colorado release, you can use the following command: diff --git a/docs/installationprocedure/introduction.rst b/docs/installationprocedure/introduction.rst index d1c581e2..835a5788 100644 --- a/docs/installationprocedure/introduction.rst +++ b/docs/installationprocedure/introduction.rst @@ -5,7 +5,7 @@ Abstract ======== -This document describes how to install the Brahmaputra release of OPNFV when +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. diff --git a/docs/installationprocedure/references.rst b/docs/installationprocedure/references.rst index 467bf08d..69ca4e7b 100644 --- a/docs/installationprocedure/references.rst +++ b/docs/installationprocedure/references.rst @@ -14,10 +14,12 @@ OPNFV `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 Liberty Release artifacts <http://www.openstack.org/software/liberty>`_ +`OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_ `OpenStack documentation <http://docs.openstack.org>`_ |