aboutsummaryrefslogtreecommitdiffstats
path: root/docs/configguide/installerconfig.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/installerconfig.rst
parent507d971868b551bec44db62362c2dafe0f3af6c3 (diff)
parent7787a0805a1edff958956bc0d134729c1d8ddcb0 (diff)
Merge "modify compass4nfv configuration documentation"
Diffstat (limited to 'docs/configguide/installerconfig.rst')
-rw-r--r--docs/configguide/installerconfig.rst234
1 files changed, 23 insertions, 211 deletions
diff --git a/docs/configguide/installerconfig.rst b/docs/configguide/installerconfig.rst
index 1d542eb4..21cd0825 100644
--- a/docs/configguide/installerconfig.rst
+++ b/docs/configguide/installerconfig.rst
@@ -6,43 +6,43 @@ Compass4nfv configuration
=========================
This document describes providing guidelines on how to install and
-configure the Brahmaputra release of OPNFV when using Compass as a
+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 VMs or Bare Metal
+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 Brahmaputra release of OPNFV,
+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 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/
-NOTE: Search the keyword "Compass4nfv/Brahmaputra" to locate the ISO image.
+NOTE: Search the keyword "compass4nfv/Colorado" to locate the ISO image.
E.g.
-compass4nfv/brahmaputra/opnfv-2016-01-16_15-03-18.iso
-compass4nfv/brahmaputra/opnfv-2016-01-16_15-03-18.properties
+compass4nfv/colorado/opnfv-2016-01-16_15-03-18.iso
+compass4nfv/colorado/opnfv-2016-01-16_15-03-18.properties
The name of iso image includes the time of iso building, you can get the daily
ISO according the building time.
@@ -51,17 +51,17 @@ 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
-To get stable/brahmaputra release, you can use the following command:
+NOTE: PLEASE DO NOT GIT CLONE COMPASS4NFV IN root DIRECTORY.
-- git checkout brahmaputra.1.0
+To get stable /colorado release, you can use the following command:
-NOTE: PLEASE DO NOT GIT CLONE COMPASS4NFV IN root DIRECTORY.
+- git checkout colorado.1.0
If you don't have a Linux foundation user id, get it first by the url:
@@ -77,20 +77,17 @@ d5a13ce7cc2ce89946d34b0402ecf33c1d291851
- git checkout d5a13ce7cc2ce89946d34b0402ecf33c1d291851
-Preparing the installation environment
---------------------------------------
+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.
-------------------
-Setup Requirements
-------------------
Jumphost Requirements
----------------------
+~~~~~~~~~~~~~~~~~~~~~
The Jumphost requirements are outlined below:
@@ -108,9 +105,10 @@ The Jumphost requirements are outlined below:
- External Network (Optional: Internet access)
-5. 16 GB of RAM for a Bare Metal deployment, 64 GB of RAM for a VM deployment.
+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)
-6. Minimum 100G storage.
Bare Metal Node Requirements
----------------------------
@@ -129,6 +127,7 @@ Bare Metal nodes require:
- External Network (OpenStack mgmt/external/storage/tenant network)
+
Network Requirements
--------------------
@@ -157,202 +156,15 @@ Network requirements include:
**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 for the nodes.
+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.
-
-----------------------------------
-Installation Guide (BM Deployment)
-----------------------------------
-
-Nodes Configuration (BM Deployment)
------------------------------------
-
-The bellow file is the inventory template of deployment nodes:
-
-"compass4nfv/deploy/conf/hardware_environment/huawei_us_lab/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 (BM 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 (BM Deployment)
---------------------------------
-
-1. Set PXE/Installation NIC for Jumphost. (set eth1 E.g.)
-
-.. code-block:: bash
-
- export INSTALL_NIC=eth1
-
-2. Set OS version for nodes provisioning. (set Ubuntu14.04 E.g.)
-
-.. code-block:: bash
-
- export OS_VERSION=trusty
-
-3. Set OpenStack version for deployment nodes. (set liberty E.g.)
-
-.. code-block:: bash
-
- export OPENSTACK_VERSION=liberty
-
-4. 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
-
-5. Run ``deploy.sh`` with inventory and network configuration
-
-.. code-block:: bash
-
- ./deploy.sh --dha ${YOUR_OWN}/dha.yml --network ${YOUR_OWN}/network.yml
-
-
-
+..