diff options
Diffstat (limited to 'docs/release/installation')
| -rw-r--r-- | docs/release/installation/configure-network.rst | 3 | ||||
| -rw-r--r-- | docs/release/installation/featureTable.rst | 85 | ||||
| -rw-r--r-- | docs/release/installation/installation.rst | 12 | ||||
| -rw-r--r-- | docs/release/installation/introduction.rst | 2 | ||||
| -rw-r--r-- | docs/release/installation/k8s-deploy-arm.rst | 44 | ||||
| -rw-r--r-- | docs/release/installation/k8s-deploy.rst | 2 | ||||
| -rw-r--r-- | docs/release/installation/offline-deploy.rst | 2 | ||||
| -rw-r--r-- | docs/release/installation/preconditions.rst | 10 | ||||
| -rw-r--r-- | docs/release/installation/vmdeploy.rst | 10 |
9 files changed, 92 insertions, 78 deletions
diff --git a/docs/release/installation/configure-network.rst b/docs/release/installation/configure-network.rst index 2303be45..25dfb76d 100644 --- a/docs/release/installation/configure-network.rst +++ b/docs/release/installation/configure-network.rst @@ -1,3 +1,6 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. +.. http://creativecommons.org/licenses/by/4.0 + Configure network ================= network_cfg.yaml file describes networks configuration for openstack on hosts. It diff --git a/docs/release/installation/featureTable.rst b/docs/release/installation/featureTable.rst index 2cd74a2b..c810a072 100644 --- a/docs/release/installation/featureTable.rst +++ b/docs/release/installation/featureTable.rst @@ -1,54 +1,57 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. +.. http://creativecommons.org/licenses/by/4.0 + Features ======== Supported Openstack Version and OS ---------------------------------- -+---------------+----------+-----------+-----------+-----------+-----------+ -| | OS | OpenStack | OpenStack | OpenStack | OpenStack | -| | only | Liberty | Mitaka | Newton | Ocata | -+---------------+----------+-----------+-----------+-----------+-----------+ -| CentOS 7 | yes | yes | yes | yes | no | -+---------------+----------+-----------+-----------+-----------+-----------+ -| Ubuntu trusty | yes | yes | yes | no | no | -+---------------+----------+-----------+-----------+-----------+-----------+ -| Ubuntu xenial | yes | no | yes | yes | yes | -+---------------+----------+-----------+-----------+-----------+-----------+ ++---------------+----------+-----------+-----------+-----------+-----------+-----------+ +| | OS | OpenStack | OpenStack | OpenStack | OpenStack | OpenStack | +| | only | Liberty | Mitaka | Newton | Ocata | Pike | ++---------------+----------+-----------+-----------+-----------+-----------+-----------+ +| CentOS 7 | yes | yes | yes | yes | no | yes | ++---------------+----------+-----------+-----------+-----------+-----------+-----------+ +| Ubuntu trusty | yes | yes | yes | no | no | no | ++---------------+----------+-----------+-----------+-----------+-----------+-----------+ +| Ubuntu xenial | yes | no | yes | yes | yes | yes | ++---------------+----------+-----------+-----------+-----------+-----------+-----------+ Supported Openstack Flavor and Features --------------------------------------- -+---------------+--------------+--------------+---------------+---------------+ -| | OpenStack | OpenStack | OpenStack | OpenStack | -| | Liberty | Mitaka | Newton | Ocata | -+---------------+--------------+--------------+---------------+---------------+ -| Virtual | Yes | Yes | Yes | Yes | -| Deployment | | | | | -+---------------+--------------+--------------+---------------+---------------+ -| Baremetal | Yes | Yes | Yes | Yes | -| Deployment | | | | | -+---------------+--------------+--------------+---------------+---------------+ -| HA | Yes | Yes | Yes | Yes | -| | | | | | -+---------------+--------------+--------------+---------------+---------------+ -| Ceph | Yes | Yes | Yes | Yes | -| | | | | | -+---------------+--------------+--------------+---------------+---------------+ -| SDN | Yes | Yes | Yes | Yes* | -| ODL/ONOS | | | | | -+---------------+--------------+--------------+---------------+---------------+ -| Compute Node | Yes | Yes | Yes | No | -| Expansion | | | | | -+---------------+--------------+--------------+---------------+---------------+ -| Multi-Nic | Yes | Yes | Yes | Yes | -| Support | | | | | -+---------------+--------------+--------------+---------------+---------------+ -| Boot | Yes | Yes | Yes | Yes | -| Recovery | | | | | -+---------------+--------------+--------------+---------------+---------------+ -| SFC | No | No | Yes | Yes | -| | | | | | -+---------------+--------------+--------------+---------------+---------------+ ++---------------+--------------+--------------+---------------+---------------+---------------+ +| | OpenStack | OpenStack | OpenStack | OpenStack | OpenStack | +| | Liberty | Mitaka | Newton | Ocata | Pike | ++---------------+--------------+--------------+---------------+---------------+---------------+ +| Virtual | Yes | Yes | Yes | Yes | Yes | +| Deployment | | | | | | ++---------------+--------------+--------------+---------------+---------------+---------------+ +| Baremetal | Yes | Yes | Yes | Yes | Yes | +| Deployment | | | | | | ++---------------+--------------+--------------+---------------+---------------+---------------+ +| HA | Yes | Yes | Yes | Yes | Yes | +| | | | | | | ++---------------+--------------+--------------+---------------+---------------+---------------+ +| Ceph | Yes | Yes | Yes | Yes | Yes | +| | | | | | | ++---------------+--------------+--------------+---------------+---------------+---------------+ +| SDN | Yes | Yes | Yes | Yes* | Yes* | +| ODL/ONOS | | | | | | ++---------------+--------------+--------------+---------------+---------------+---------------+ +| Compute Node | Yes | Yes | Yes | No | No | +| Expansion | | | | | | ++---------------+--------------+--------------+---------------+---------------+---------------+ +| Multi-Nic | Yes | Yes | Yes | Yes | Yes | +| Support | | | | | | ++---------------+--------------+--------------+---------------+---------------+---------------+ +| Boot | Yes | Yes | Yes | Yes | Yes | +| Recovery | | | | | | ++---------------+--------------+--------------+---------------+---------------+---------------+ +| SFC | No | No | Yes | Yes | Yes | +| | | | | | | ++---------------+--------------+--------------+---------------+---------------+---------------+ * ONOS will not be supported in this release. diff --git a/docs/release/installation/installation.rst b/docs/release/installation/installation.rst index 05c5e2ef..2fb51641 100644 --- a/docs/release/installation/installation.rst +++ b/docs/release/installation/installation.rst @@ -6,7 +6,7 @@ Compass4nfv configuration ========================= This document describes providing guidelines on how to install and -configure the Euphrates release of OPNFV when using Compass4nfv as a +configure the Fraser release of OPNFV when using Compass4nfv as a deployment tool including required software and hardware configurations. @@ -21,7 +21,7 @@ networking and Unix/Linux administration. Preconditions ------------- -Before starting the installation of the Euphrates release of OPNFV, +Before starting the installation of the Fraser release of OPNFV, some planning must be done. @@ -37,10 +37,10 @@ The daily build tarball can be retrieved via OPNFV artifacts repository: http://artifacts.opnfv.org/compass4nfv.html -NOTE: Search the keyword "compass4nfv/Euphrates" to locate the ISO image. +NOTE: Search the keyword "compass4nfv/Fraser" to locate the ISO image. E.g. -compass4nfv/Euphrates/opnfv-2017-09-18_08-15-13.tar.gz +compass4nfv/Fraser/opnfv-2017-09-18_08-15-13.tar.gz The name of tarball includes the time of iso building, you can get the daily ISO according the building time. @@ -57,9 +57,9 @@ To retrieve the repository of Compass4nfv on Jumphost use the following command: NOTE: PLEASE DO NOT GIT CLONE COMPASS4NFV IN ROOT DIRECTORY(INCLUDE SUBFOLDERS). -To get stable /Euphrates release, you can use the following command: +To get stable /Fraser release, you can use the following command: -- git checkout Euphrates.1.0 +- git checkout Fraser.1.0 Setup Requirements ------------------ diff --git a/docs/release/installation/introduction.rst b/docs/release/installation/introduction.rst index 6ffc3d17..5f0b0b28 100644 --- a/docs/release/installation/introduction.rst +++ b/docs/release/installation/introduction.rst @@ -5,7 +5,7 @@ Abstract ======== -This document describes how to install the Euphrates release of OPNFV when +This document describes how to install the Fraser release of OPNFV when using Compass4nfv as a deployment tool covering it's limitations, dependencies and required system resources. diff --git a/docs/release/installation/k8s-deploy-arm.rst b/docs/release/installation/k8s-deploy-arm.rst index b5b54c20..8c809bf6 100644 --- a/docs/release/installation/k8s-deploy-arm.rst +++ b/docs/release/installation/k8s-deploy-arm.rst @@ -5,19 +5,15 @@ Validated platform ================== -================ ========= ================ ======== - Jump server Node ---------------------------- -------------------------- -distro libvirt distro k8s -================ ========= ================ ======== -ubuntu 16.04.3 1.3.1 centos7 1708 1.7.5 -================ ========= ================ ======== +Jump server: Baremetal, Ubuntu 16.04 + +Node: VM / Baremetal, CentOS 7 / Ubuntu 16.04, K8s 1.9.1 Prepare jump server =================== -This document assumes you are using a baremetal Arm server as Compass4NFV jump server. It's possible to deploy jump server inside a virtual machine, this case is not covered here. +A baremetal Arm server is required as Compass4NFV jump server. -#. Install Ubuntu 16.04.3 aarch64 on jump server. +#. Install Ubuntu 16.04 aarch64 on jump server. #. Install required packages. @@ -65,14 +61,14 @@ Clone Compass4NFV code. Run below command to build deployment tarball for Arm. .. code-block:: bash - $ COMPASS_ISO_REPO='http://people.linaro.org/~yibo.cai/compass' ./build.sh + $ ./build.sh It downloads and archives Ubuntu/CentOS installation ISO and Compass core docker images for later deployment. -Deploy K8s in VM -================ -This section introduces the steps to deploy K8s cluster in virtual machines running on jump server. Two VM nodes will be created, one master and one minion, with flannel networking. +Deploy K8s +========== +This section introduces the steps to deploy K8s cluster in VM and baremetal nodes. Clear old Compass core ---------------------- @@ -93,14 +89,28 @@ Run below command to remove running Compass containers for a clean deployment. Deploy OS and K8s ----------------- -To deploy OS and K8s on two virtual nodes, run: +To deploy CentOS and K8s on two virtual nodes, run: .. code-block:: bash $ ADAPTER_OS_PATTERN='(?i)CentOS-7.*arm.*' \ OS_VERSION=centos7 \ - KUBERNETES_VERSION=v1.7.5 \ - DHA=${PWD}/deploy/conf/vm_environment/k8-nosdn-nofeature-noha.yml \ - NETWORK=${PWD}/deploy/conf/vm_environment/network.yml \ + KUBERNETES_VERSION=v1.9.1 \ + DHA=deploy/conf/vm_environment/k8-nosdn-nofeature-noha.yml \ + NETWORK=deploy/conf/vm_environment/network.yml \ VIRT_NUMBER=2 VIRT_CPUS=4 VIRT_MEM=8192 VIRT_DISK=50G \ ./deploy.sh + +To deploy on baremetal nodes, reference below DHA and NETWORK files: + +.. code-block:: bash + + DHA="deploy/conf/hardware_environment/huawei-pod8/k8-nosdn-nofeature-noha.yml" + NETWORK="deploy/conf/hardware_environment/huawei-pod8/network.yml" + +To deploy Ubuntu, set: + +.. code-block:: bash + + ADAPTER_OS_PATTERN='(?i)ubuntu-16.*arm.*' + OS_VERSION=xenial diff --git a/docs/release/installation/k8s-deploy.rst b/docs/release/installation/k8s-deploy.rst index 49025ee3..0c1ffbd0 100644 --- a/docs/release/installation/k8s-deploy.rst +++ b/docs/release/installation/k8s-deploy.rst @@ -20,7 +20,7 @@ If you want to deploy noha with1 controller and 1 compute, run the following com export SCENARIO=k8-nosdn-nofeature-noha.yml export VIRT_NUMBER=2 - curl https://raw.githubusercontent.com/opnfv/compass4nfv/stable/euphrates/quickstart_k8s.sh | bash + curl https://raw.githubusercontent.com/opnfv/compass4nfv/stable/fraser/quickstart_k8s.sh | bash Installation of K8s on Bare Metal ================================= diff --git a/docs/release/installation/offline-deploy.rst b/docs/release/installation/offline-deploy.rst index d35d7e1b..a3a33a09 100644 --- a/docs/release/installation/offline-deploy.rst +++ b/docs/release/installation/offline-deploy.rst @@ -1,3 +1,5 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. +.. http://creativecommons.org/licenses/by/4.0 .. two dots create a comment. please leave this logo at the top of each of your rst files. Offline Deploy diff --git a/docs/release/installation/preconditions.rst b/docs/release/installation/preconditions.rst index 3ba42ab6..9264c793 100644 --- a/docs/release/installation/preconditions.rst +++ b/docs/release/installation/preconditions.rst @@ -21,7 +21,7 @@ networking and Unix/Linux administration. Preconditions ------------- -Before starting the installation of the Euphrates release of OPNFV, +Before starting the installation of the Fraser release of OPNFV, some planning must be done. @@ -38,10 +38,10 @@ The daily build tarball can be retrieved via OPNFV artifacts repository: http://artifacts.opnfv.org/compass4nfv.html -NOTE: Search the keyword "compass4nfv/Euphrates" to locate the tarball. +NOTE: Search the keyword "compass4nfv/Fraser" to locate the tarball. E.g. -compass4nfv/euphrates/opnfv-2017-03-29_08-55-09.tar.gz +compass4nfv/fraser/opnfv-2017-03-29_08-55-09.tar.gz The name of tarball includes the time of tarball building, you can get the daily tarball according the building time. @@ -58,9 +58,9 @@ To retrieve the repository of Compass4nfv on Jumphost use the following command: NOTE: PLEASE DO NOT GIT CLONE COMPASS4NFV IN ROOT DIRECTORY(INCLUDE SUBFOLDERS). -To get stable/euphrates release, you can use the following command: +To get stable/fraser release, you can use the following command: -- git checkout Euphrates.1.0 +- git checkout Fraser.1.0 Setup Requirements ------------------ diff --git a/docs/release/installation/vmdeploy.rst b/docs/release/installation/vmdeploy.rst index 5db934be..4f1336c5 100644 --- a/docs/release/installation/vmdeploy.rst +++ b/docs/release/installation/vmdeploy.rst @@ -12,15 +12,14 @@ Only 1 command to try virtual deployment, if you have Internet access. Just Past .. code-block:: bash - curl https://raw.githubusercontent.com/opnfv/compass4nfv/euphrates/quickstart.sh | bash + curl https://raw.githubusercontent.com/opnfv/compass4nfv/stable/fraser/quickstart.sh | bash If you want to deploy noha with1 controller and 1 compute, run the following command .. code-block:: bash export SCENARIO=os-nosdn-nofeature-noha.yml - export VIRT_NUMBER=2 - curl https://raw.githubusercontent.com/opnfv/compass4nfv/stable/euphrates/quickstart.sh | bash + curl https://raw.githubusercontent.com/opnfv/compass4nfv/stable/fraser/quickstart.sh | bash Nodes Configuration (Virtual Deployment) ---------------------------------------- @@ -28,8 +27,6 @@ Nodes Configuration (Virtual Deployment) virtual machine setting ~~~~~~~~~~~~~~~~~~~~~~~ - - VIRT_NUMBER -- the number of nodes for virtual deployment. - - VIRT_CPUS -- the number of CPUs allocated per virtual machine. - VIRT_MEM -- the memory size(MB) allocated per virtual machine. @@ -38,7 +35,6 @@ virtual machine setting .. code-block:: bash - export VIRT_NUMBER=${VIRT_NUMBER:-5} export VIRT_CPUS=${VIRT_CPU:-4} export VIRT_MEM=${VIRT_MEM:-16384} export VIRT_DISK=${VIRT_DISK:-200G} @@ -146,7 +142,7 @@ Start Deployment (Virtual Deployment) 1. Edit deploy.sh 1.1. Set OS version for deployment nodes. - Compass4nfv supports ubuntu and centos based openstack ocata. + Compass4nfv supports ubuntu and centos based openstack pike. E.g. |