From 5fc913227e68f4301cc5365838eb1c5f3d858ea4 Mon Sep 17 00:00:00 2001 From: Eric Debeau Date: Tue, 20 Mar 2018 21:18:58 +0000 Subject: Change Amsterdam by Beijing Modify Amsterdam by Beijing Correct to pass DOC8 Change-Id: Ia26a7f95617c5f00d646ddd5ccb66d69c27b1bcc Issue-ID: DOC-239 Signed-off-by: Eric Debeau --- docs/guides/onap-developer/settingup/fullonap.rst | 201 +++++++++++++++------- docs/guides/onap-developer/tutorials/index.rst | 5 +- 2 files changed, 143 insertions(+), 63 deletions(-) (limited to 'docs/guides') diff --git a/docs/guides/onap-developer/settingup/fullonap.rst b/docs/guides/onap-developer/settingup/fullonap.rst index 0ae6646a0..d8529ef97 100644 --- a/docs/guides/onap-developer/settingup/fullonap.rst +++ b/docs/guides/onap-developer/settingup/fullonap.rst @@ -1,6 +1,7 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. This work is licensed under a Creative Commons Attribution 4.0 + International License. http://creativecommons.org/licenses/by/4.0 - Copyright 2017 ONAP + Copyright 2017-2018 ONAP .. contents:: @@ -18,13 +19,21 @@ **Context** =========== -ONAP may be deployed in different contexts depending on your requirements. The recommended installation for Amsterdam Release is currently based on OpenStack HEAT Template. +ONAP may be deployed in different contexts depending on your requirements. +The recommended installation for Beijng Release over virtual machines is based +on OpenStack HEAT Template. -Using the Amsterdam HEAT Template installer, ONAP can be deployed in a single tenant or multiple tenants. One tenant for all the components except DCAE, and another tenant dedicated to the DCAE components. +Using the Beijing HEAT Template installer, ONAP can be deployed in a single +tenant or multiple tenants. One tenant for all the components except DCAE, and +another tenant dedicated to the DCAE components. -The VNFs managed by ONAP may be deployed in different OpenStack tenants or based on top of VMware based infrastructure. For details, refer :ref:`to MultiCloud project`. +The VNFs managed by ONAP may be deployed in different OpenStack tenants or +based on top of VMware based infrastructure. For details, refer +:ref:`to MultiCloud project`. -The current installation is based on the single tenant deployment (all the ONAP components will be hosted in a unique tenant) with DCAE components deployed in High Availability mode. +The current installation is based on the single tenant deployment (all the ONAP +components will be hosted in a unique tenant) with DCAE components deployed in +High Availability mode. The installation requires some manual tasks to setup the DCAE components. @@ -35,9 +44,12 @@ The installation requires some manual tasks to setup the DCAE components. OpenStack --------- -ONAP installation is validated on `OpenStack Ocata `_ or latter release. +ONAP installation is validated on +`OpenStack Ocata `_ or latter release. -You can use various Cloud providers offering OpenStack based solutions. A list of available Cloud providers on the `OpenStack marketplace `_. +You can use various Cloud providers offering OpenStack based solutions. +A list of available Cloud providers on the +`OpenStack marketplace `_. You can use your private Cloud infrastructure. @@ -57,11 +69,13 @@ To deploy OpenStack, you can use various solutions: - `OpenStack Ocata installation guide `_ .. tip:: - - Notice the documentation version mentioned in the URL, e.g. ocata/, pike/, latest/ ... - - The installation is pretty huge, some automated scripts have been created by the community: + - Notice the documentation version mentioned in the URL, e.g. ocata/, pike/, + latest/ ... + - The installation is pretty huge, some automated scripts have been created by + the community: - `OpenStack installation with Ansible (All openstack services) `_ - - `OpenStack Ocata installation scripts for testing environment (DO NOT install Heat, Designate and Cinder Volume services) `_ + - `OpenStack Ocata installation scripts for testing environment(DO NOT install Heat, Designate and Cinder Volume services) `_ Use the procedure below to deploy and configure *Designate* manually @@ -71,12 +85,14 @@ Use the procedure below to deploy and configure *Designate* manually install-designate.rst -The OpenStack infrastructure must enable internet access and you need to have an "External network" already configured properly. +The OpenStack infrastructure must enable internet access and you need to have +an "External network" already configured properly. The External network ID will have to be provided in the Heat environment file. ONAP components --------------- -The following table presents the mapping between the created VM and the ONAP components, and provides VM information (flavor and image): +The following table presents the mapping between the created VM and the ONAP +components, and provides VM information (flavor and image): =================== ================= ======= ============ VM name ONAP project(s) Flavor Image @@ -121,7 +137,8 @@ The ONAP installation requires the following footprint: - 3 TB Storage - 29 floating IP addresses -.. Note: The default flavor size may be optimized. The ONAP community is working to update flavors of basic ONAP installation. +.. Note: The default flavor size may be optimized. The ONAP community is + working to update flavors of basic ONAP installation. .. Note: You should also reserve some resources for the VNFs to be deployed. @@ -137,15 +154,21 @@ The following artifacts must be deployed on the OpenStack infrastructure: .. Note: The floating IP may be private IP. -.. Note: Basic flavors can reuse the default flavors as defined by `OpenStack `_ - The xxlarge flavor should be configured using the following values: 12 vCPU, 64 GB RAM and 120 GB storage. +.. Note: Basic flavors can reuse the default flavors as defined by + OpenStack + `_ + The xxlarge flavor should be configured using the following values: + 12 vCPU, 64 GB RAM and 120 GB storage. Security -------- -The default installation assumes that the Default security group is configured to enable full access between the ONAP components. -Depending on your environment, we may need to open some security groups (eg when using the portal from your desktop). +The default installation assumes that the Default security group is configured +to enable full access between the ONAP components. +Depending on your environment, we may need to open some security groups +(eg when using the portal from your desktop). -The list of various services and ports used can be found on the `ONAP wiki `_. +The list of various services and ports used can be found on the +`ONAP wiki - ports `_. **Deployment** ============== @@ -153,20 +176,23 @@ The list of various services and ports used can be found on the `ONAP wiki `_. +After the installation, it is possible to deploy the various use-cases +described in `ONAP wiki - demos `_. Detect problems --------------- @@ -415,10 +486,12 @@ If all the tests are not OK, many causes are possible. Here is a simple procedure to detect where the problem occurs: * Check the OpenStack Virtual Machine logs -* Connect to the Virtual Machine and check that the various containers are running. +* Connect to the Virtual Machine and check that the various containers are + running. -The list of containers are described on the `ONAP wiki `_ -. In case some containers are missing, check the Docker logs using the following command: +The list of containers are described on the `ONAP wiki - containers `_. +In case some containers are missing, check the Docker logs using the following +command: .. code-block:: bash @@ -428,7 +501,9 @@ The list of containers are described on the `ONAP wiki aai.ui.simpledemo.onap.org -You can use the Horizon dashboard to get the IP addresses associated with the Virtual Machines or use the following command line: +You can use the Horizon dashboard to get the IP addresses associated with the +Virtual Machines or use the following command line: .. code-block:: bash openstack server list -Launch the portal on the http://portal.api.simpledemo.onap.org:8989/ONAPPORTAL/login.htm +Launch the portal on the +http://portal.api.simpledemo.onap.org:8989/ONAPPORTAL/login.htm Various users are predefined as presented in the following table: @@ -462,7 +539,8 @@ Various users are predefined as presented in the following table: The password is *demo123456!* -Go to the `Portal component user guide `_ +Go to the `Portal component user guide +`_ Other UI documentation: - `CLAMP `_ @@ -473,7 +551,8 @@ Other UI documentation: **Components** ============== -The list of various services and ports used can be found on the `ONAP wiki `_ +The list of various services and ports used can be found on the +`ONAP wiki - services `_ .. This work is licensed under a Creative Commons Attribution 4.0 International License. http://creativecommons.org/licenses/by/4.0 diff --git a/docs/guides/onap-developer/tutorials/index.rst b/docs/guides/onap-developer/tutorials/index.rst index 2365efd10..b128224c7 100644 --- a/docs/guides/onap-developer/tutorials/index.rst +++ b/docs/guides/onap-developer/tutorials/index.rst @@ -1,4 +1,5 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. Tutorials ========= @@ -8,7 +9,7 @@ Tutorials .. caution:: The tutorials may refer to earlier versions of software - and have not been certified on the latest Amsterdam Release. + and have not been certified on the latest Beijing Release. * `Automatically Creating a Netconf Mount in APPC from SDNC `_ -- cgit 1.2.3-korg