Update git submodules
[doc.git] / docs / guides / onap-developer / settingup / index.rst
index d3f5c66..f963888 100644 (file)
@@ -5,6 +5,7 @@
 .. Modifications Copyright 2018 Orange
 .. Modifications Copyright 2018 Amdocs
 .. Modifications Copyright 2018 Huawei
+.. Modifications Copyright 2019 Orange
 
 Setting Up ONAP
 ===============
@@ -24,17 +25,21 @@ The following is the recommended component version.
   ===========  =========
   Software     Version
   ===========  =========
-  Kubernetes   1.11.5
-  Helm         2.9.1
-  kubectl      1.11.5
-  Docker       17.03.x
+  Kubernetes   1.13.5
+  Helm         2.12.3
+  kubectl      1.13.5
+  Docker       18.09.5
   ===========  =========
 
 The ONAP full installation is validated with the following footprint:
- - 14 VM (1 Rancher, 13 K8s nodes)
-   - 8 vCPU
-   - 16 GB RAM
- - 160 GB Storage
+
+.. csv-table:: Validated installation footprint
+   :widths: 3,5,10
+
+   VM number, VM flavor, VM role
+   12, 16 GB RAM - 8 vCPUs, Running the K8S worker role
+   3, 8 GB RAM - 4 vCPUs, Running the K8S controller role
+   1, 8 GB RAM - 4 vCPUs, Running the shared NFS server for /dockerdata-nfs/
 
 Installation
 ------------
@@ -42,7 +47,7 @@ Installation
 Creation of Kubernetes cluster is described here:
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :titlesonly:
 
    ../../../../submodules/oom.git/docs/oom_cloud_setup_guide.rst
@@ -50,19 +55,28 @@ Creation of Kubernetes cluster is described here:
 ONAP installation is described here:
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :titlesonly:
 
    ../../../../submodules/oom.git/docs/oom_quickstart_guide.rst
+   ../../../../submodules/oom.git/docs/oom_user_guide.rst
 
 Alternative way of offline ONAP installation is described here:
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :titlesonly:
 
    ../../../../submodules/oom/offline-installer.git/docs/index.rst
 
+.. note::
+   Prior to deployment of ONAP, there is no need to download manually any Docker container.
+   The OOM deployment takes care to automatically download the Docker containers.
+
+   It is also possible to deploy a subset of ONAP components on a single VM.
+   The VM flavor to be used depends on the number of ONAP components to be
+   deployed.
+
 NodePorts
 ---------
 
@@ -73,23 +87,19 @@ microservice.
 It should be noted that the use of NodePorts is temporary.
 An alternative solution is currently being scoped for the Dublin Release.
 
-* The list of node ports used by ONAP is documented
-  in `ONAP Node Port List <https://wiki.onap.org/display/DW/OOM+NodePort+List>`_.
+More information from official Kubernetes documentation about
+`NodePort <https://kubernetes.io/docs/concepts/services-networking/service/#nodeport>`_.
 
-.. note::
-   Prior to deployment of ONAP, there is no need to download manually any Docker container.
-   The OOM deployment takes care to automatically download the Docker containers.
+The following table lists all the NodePorts used by ONAP.
 
-   It is also possible to deploy a subset of ONAP components on a single VM.
-   The VM flavor to be used depends on the number of ONAP components to be
-   deployed.
+.. csv-table:: NodePorts table
+   :file: nodeports.csv
+   :widths: 20,20,20,20,20
+   :header-rows: 1
 
-.. note::
-   For test purposes, it is possible to use other installations:
+This table retrieves information from the ONAP deployment using the following
+Kubernetes command:
 
-.. toctree::
-   :maxdepth: 1
-   :titlesonly:
+.. code-block:: bash
 
-   onap_heat.rst
-   onap_individual.rst
+  kubectl get svc -n onap -o go-template='{{range .items}}{{range.spec.ports}}{{if .nodePort}}{{.nodePort}}{{.}}{{"\n"}}{{end}}{{end}}{{end}}'