summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer
diff options
context:
space:
mode:
authorEric Debeau <eric.debeau@orange.com>2019-12-16 16:21:39 +0000
committerGerrit Code Review <gerrit@onap.org>2019-12-16 16:21:39 +0000
commit410e4188b754b626ad5e24d52e6fed42019763d9 (patch)
treeb97bdb8008935ccc4a7400e11334272b10c2e8d3 /docs/guides/onap-developer
parent55073ff18635129e39f3f7a6d831c01e9352a0dd (diff)
parent55ae2d256a84394d1ef2985bdb43f9f7b92ba405 (diff)
Merge "Creating an "Operations and Administration Guides" section and restructuring chapters"
Diffstat (limited to 'docs/guides/onap-developer')
-rw-r--r--docs/guides/onap-developer/architecture/index.rst4
-rw-r--r--docs/guides/onap-developer/settingup/index.rst105
-rw-r--r--docs/guides/onap-developer/settingup/nodeports.csv100
3 files changed, 2 insertions, 207 deletions
diff --git a/docs/guides/onap-developer/architecture/index.rst b/docs/guides/onap-developer/architecture/index.rst
index d4f38d9cf..34e0bb356 100644
--- a/docs/guides/onap-developer/architecture/index.rst
+++ b/docs/guides/onap-developer/architecture/index.rst
@@ -7,8 +7,8 @@
.. _doc-architecture:
-Architecture
-============
+ONAP Architecture
+=================
.. toctree::
:maxdepth: 2
diff --git a/docs/guides/onap-developer/settingup/index.rst b/docs/guides/onap-developer/settingup/index.rst
deleted file mode 100644
index f96388891..000000000
--- a/docs/guides/onap-developer/settingup/index.rst
+++ /dev/null
@@ -1,105 +0,0 @@
-.. This work is licensed under
-.. a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2017-2018 AT&T Intellectual Property. All rights reserved.
-.. Modifications Copyright 2018 Orange
-.. Modifications Copyright 2018 Amdocs
-.. Modifications Copyright 2018 Huawei
-.. Modifications Copyright 2019 Orange
-
-Setting Up ONAP
-===============
-
-.. _installing-onap:
-
-ONAP is deployed using the ONAP Operations Manager (OOM).
-
-The recommended ONAP deployment is based on Kubernetes, Docker containers
-and Helm installer.
-
-Requirements
-------------
-
-The following is the recommended component version.
-
- =========== =========
- Software Version
- =========== =========
- 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:
-
-.. 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
-------------
-
-Creation of Kubernetes cluster is described here:
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- ../../../../submodules/oom.git/docs/oom_cloud_setup_guide.rst
-
-ONAP installation is described here:
-
-.. toctree::
- :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: 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
----------
-
-NodePorts are used to allow client applications, that run outside of
-Kubernetes, access to ONAP components deployed by OOM.
-A NodePort maps an externally reachable port to an internal port of an ONAP
-microservice.
-It should be noted that the use of NodePorts is temporary.
-An alternative solution is currently being scoped for the Dublin Release.
-
-More information from official Kubernetes documentation about
-`NodePort <https://kubernetes.io/docs/concepts/services-networking/service/#nodeport>`_.
-
-The following table lists all the NodePorts used by ONAP.
-
-.. csv-table:: NodePorts table
- :file: nodeports.csv
- :widths: 20,20,20,20,20
- :header-rows: 1
-
-This table retrieves information from the ONAP deployment using the following
-Kubernetes command:
-
-.. code-block:: bash
-
- kubectl get svc -n onap -o go-template='{{range .items}}{{range.spec.ports}}{{if .nodePort}}{{.nodePort}}{{.}}{{"\n"}}{{end}}{{end}}{{end}}'
diff --git a/docs/guides/onap-developer/settingup/nodeports.csv b/docs/guides/onap-developer/settingup/nodeports.csv
deleted file mode 100644
index 2fb6a2c24..000000000
--- a/docs/guides/onap-developer/settingup/nodeports.csv
+++ /dev/null
@@ -1,100 +0,0 @@
-NodePort,Component,Service name,targetPort,Port
-30200,VID,vid,8443,8443
-30201,SDNC,sdnc-portal,8843,8843
-30202,SDNC,sdnc-8282,8181,8282
-30203,SDNC,dgbuilder,3100,3000
-30204,SDC,sdc-be,8443,8443
-30205,SDC,sdc-be,8080,8080
-30206,SDC,sdc-fe,8181,8181
-30207,SDC,sdc-fe,9443,9443
-30208,SDNC,sdnc-8202,8101,8202
-30209,ROBOT,httpd,8702,8702
-30210,AAI,aai-modelloader,8080,8080
-30211,APPC,appc-9090,9191,9090
-30212,PORTAL,portal-sdk,8080,8080
-30213,PORTAL,portal-app,8005,8006
-30214,PORTAL,portal-app3,8009,8010
-30215,PORTAL,portal-app,8080,8989
-30218,POLICY,pap-9091,9091,9091
-30219,POLICY,pap-8443,8443,8443
-30220,AAI,aai-sparky-be,8000,8000
-30222,DCAE,xport-t-6061,6061,6061
-30224,SO,so-monitor-port,9091,9091
-30225,PORTAL,portal-app4,8443,8443
-30226,DMAAP,message-router-3905,3905,3905
-30227,DMAAP,message-router-3904,3904,3904
-30228,APPC,dgbuilder,3100,3000
-30229,AAI,aai-modelloader-ssl,8443,8443
-30230,APPC,appc-8282,8181,8282
-30231,APPC,appc-1830,1830,1830
-30233,AAI,aai-ssl,8443,8443
-30234,POMBA,pomba-kibana,5601,5601
-30235,DCAE,xport-t-8080,8080,8080
-30238,VID,vid-http,8080,8080
-30239,AAI,spike,9518,9518
-30241,DMAAP,dmaap-bc,8080,8080
-30242,DMAAP,dmaap-bc2,8443,8443
-30246,SDNC,sdnc-8280,8080,8280
-30248,OOF,oof-has-api,8699,8698
-30249,POMBA,pomba-data-router,9502,9502
-30253,LOG,log-kibana,5601,5601
-30254,LOG,log-es,9200,9200
-30255,LOG,log-ls,5044,5044
-30256,SDC,sdc-wfd-fe,8080,8080
-30257,SDC,sdc-wfd-be,8080,8080
-30258,CLAMP,clamp,8443,8443
-30259,DMAAP,dmaap-dr-prov,8080,8080
-30260,CLI,cli8080,8443,8080
-30263,DCAE,dcae-fe,8183,8183
-30264,DCAE,dcae-fe2,9444,9444
-30265,DCAE,dcae-dt,8186,8186
-30266,DCAE,dcae-dt2,9446,9446
-30267,SDNC,sdnc-8443,2550,8443
-30268,AAI,aai-crud-service,9520,9520
-30269,DMAAP,dmaap-dr-prov2,8443,8443
-30270,CONSUL,consul-ui,8500,8500
-30271,CLI,cli9090,8080,9090
-30274,API,api-8080,8080,8080
-30275,OOF,oof-has-api,8091,8091
-30277,SO,so-apih-port,8080,8080
-30278,AAI,aai-champ,9522,9522
-30279,AAI,babel,9516,9516
-30280,MSB,http-msb-iag,443,443
-30281,MSB,http-msb-discovery,10081,10081
-30282,MSB,http-msb-eag,10081,10081
-30283,MSB,https-msb-iag,443,443
-30284,MSB,https-msb-eag,443,443
-30285,MSB,http-msb-consul,8500,8500
-30286,DCAE,client,6379,6379
-30287,DCAE,gossip,16379,16379
-30289,APPC,appc-cdt,18080,18080
-30290,CLAMP,cdash-kibana,5601,5601
-30297,VNFSDK,refrepo,8702,8702
-30299,POMBA,https,8443,9531
-30398,UUI,uui,8080,8080
-30399,UUI,uui-server,8082,8082
-30406,SO,so-vnfm-port,9092,9092
-30415,DCAE,config-binding-service,10000,10000
-30417,DCAE,xport-t-8443,8443,8443
-30418,DCAE,xport-t-8080,8080,8080
-30419,DCAE,xport-t-8443,8443,8443
-30420,API,api-8080,8080,8080
-30431,SDC,sdc-wfd-fe2,8443,8443
-30470,DCAE,xport-u-6162,6162,6162
-30476,DCAE,tomcat,8080,8080
-30490,DMAAP,message-router-kafka-0,9093,9093
-30491,DMAAP,message-router-kafka-1,9093,9093
-30492,DMAAP,message-router-kafka-1,9093,9093
-30493,DMAAP,dmaap-dr-node,8080,8080
-30494,DMAAP,dmaap-dr-node,8443,8443
-30497,CDS,cds-ui-3000,3000,3000
-30499,CDS,blueprints-processor-http,8080,8080
-31110,AAF,aaf-service,8100,8100
-31111,AAF,aaf-locate,8095,8095
-31112,AAF,aaf-oauth,8140,8140
-31113,AAF,aaf-hello,8200,8200
-31114,AAF,aaf-cm,8150,8150
-31115,AAF,aaf-hello,8096,8096
-31116,AAF,aaf-hello,8130,8130
-31907,DMAAP,dmaap-dr-prov2,5000,5000
-32010,DCAE,xport-t-11011,11011,11011