diff options
Diffstat (limited to 'docs/guides')
9 files changed, 61 insertions, 45 deletions
diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 492018737..13b22f962 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -246,6 +246,7 @@ Policy Framework :maxdepth: 2 :titlesonly: + ../../../submodules/policy/parent.git/docs/index ../../../submodules/policy/engine.git/docs/index ../../../submodules/policy/apex-pdp.git/docs/index ../../../submodules/policy/distribution.git/docs/index diff --git a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst index 896c23170..89959914c 100644 --- a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst +++ b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst @@ -58,6 +58,12 @@ The following sequence will do this over ssh. If your access network restricts ssh, you will need to use equivalent git commands and HTTP Passwords as described `here <http://wiki.onap.org/x/X4AP>`_. +.. caution:: + + Don't replace ../ in *git submodule add* with any relative path on + your local file system. It refers to the location of your repository + on the server. + .. code-block:: bash git clone ssh://$lfid@gerrit.onap.org:29418/doc @@ -507,4 +513,3 @@ scan for output that applies to the files you are validating. tox -espellcheck more < docs/_build/spellcheck/output.txt - diff --git a/docs/guides/onap-developer/settingup/nodeports.csv b/docs/guides/onap-developer/settingup/nodeports.csv index 2e294d2be..2fb6a2c24 100644 --- a/docs/guides/onap-developer/settingup/nodeports.csv +++ b/docs/guides/onap-developer/settingup/nodeports.csv @@ -2,27 +2,23 @@ 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,dgbuilder3,3100,3000 +30203,SDNC,dgbuilder,3100,3000 30204,SDC,sdc-be,8443,8443 -30205,SDC,sdc-be2,8080,8080 +30205,SDC,sdc-be,8080,8080 30206,SDC,sdc-fe,8181,8181 -30207,SDC,sdc-fe2,9443,9443 -30208,SDNC,sdnc-8202,8181,8202 -30209,ROBOT,httpd,88,88 +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-app2,8005,8006 +30213,PORTAL,portal-app,8005,8006 30214,PORTAL,portal-app3,8009,8010 30215,PORTAL,portal-app,8080,8989 -30216,POLICY,brmsgw,9989,9989 -30217,POLICY,drools-6969,6969,6969 30218,POLICY,pap-9091,9091,9091 30219,POLICY,pap-8443,8443,8443 -30220,AAI,aai-sparky-be,9517,9517 -30221,POLICY,drools-9696,9696,9696 -30222,DCAE,xdcae-hv-ves-collector,6061,6061 -30223,DCAE,xdcae-datafile-collector,8100,8100 +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 @@ -31,34 +27,24 @@ NodePort,Component,Service name,targetPort,Port 30229,AAI,aai-modelloader-ssl,8443,8443 30230,APPC,appc-8282,8181,8282 30231,APPC,appc-1830,1830,1830 -30232,AAI,aai,8080,8080 30233,AAI,aai-ssl,8443,8443 30234,POMBA,pomba-kibana,5601,5601 -30235,DCAE,xdcae-ves-collector,8080,8080 -30236,POLICY,nexus,8081,8081 -30237,POLICY,policy-apex-pdp,12345,12345 +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 -30243,AAF,aaf-sms,10443,10443 -30244,AAF,aaf-sms-db,8200,8200 30246,SDNC,sdnc-8280,8080,8280 -30247,AAF,aaf-service,8100,8100 -30248,OOF,oof-osdf,8699,8698 +30248,OOF,oof-has-api,8699,8698 30249,POMBA,pomba-data-router,9502,9502 -30251,AAF,aaf-gui,8200,8200 -30252,SO,mariadb,3306,3306 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,clamp2,8443,8443 +30258,CLAMP,clamp,8443,8443 30259,DMAAP,dmaap-dr-prov,8080,8080 -30260,CLI,cli8080,80,80 -30261,MULTICLOUD,multicloud-azure,9008,9008 -30262,DCAE,xdcae-datafile-collector,8433,8443 +30260,CLI,cli8080,8443,8080 30263,DCAE,dcae-fe,8183,8183 30264,DCAE,dcae-fe2,9444,9444 30265,DCAE,dcae-dt,8186,8186 @@ -68,33 +54,47 @@ NodePort,Component,Service name,targetPort,Port 30269,DMAAP,dmaap-dr-prov2,8443,8443 30270,CONSUL,consul-ui,8500,8500 30271,CLI,cli9090,8080,9090 -30274,EXTAPI,api-8080,8080,8080 +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,80,80 +30280,MSB,http-msb-iag,443,443 30281,MSB,http-msb-discovery,10081,10081 -30282,MSB,http-msb-eag,80,80 +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 -30288,SNRIRO,httpd,80,80 -30289,APPC,appc-cdt,80,80 +30289,APPC,appc-cdt,18080,18080 30290,CLAMP,cdash-kibana,5601,5601 -30291,MULTICLOUD,multicloud-framework,9001,9001 -30292,MULTICLOUD,multicloud-vio,9004,9004 -30293,MULTICLOUD,multicloud-ocata,9006,9006 -30294,MULTICLOUD,multicloud-titaniumcloud,9005,9005 -30295,CLAMP,clamp,8080,8080 -30296,MULTICLOUD,multicloud-pike,9007,9007 30297,VNFSDK,refrepo,8702,8702 +30299,POMBA,https,8443,9531 30398,UUI,uui,8080,8080 30399,UUI,uui-server,8082,8082 -30420,CONTRIB,netbox-nginx,8080,8080 +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 -32010,DCAE,xdcae-tca-analytics,11011,11011 - - +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 diff --git a/docs/guides/onap-user/design/pre-onboarding/index.rst b/docs/guides/onap-user/design/pre-onboarding/index.rst index 155ec56fb..7a09f0db5 100644 --- a/docs/guides/onap-user/design/pre-onboarding/index.rst +++ b/docs/guides/onap-user/design/pre-onboarding/index.rst @@ -2,6 +2,8 @@ .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright 2019 ONAP Contributors. All rights reserved. +.. _doc_guide_user_des_pre-onb: + Pre-Onboarding ============== diff --git a/docs/guides/onap-user/design/resource-onboarding/index.rst b/docs/guides/onap-user/design/resource-onboarding/index.rst index 4a3cbc1e3..592651ee2 100644 --- a/docs/guides/onap-user/design/resource-onboarding/index.rst +++ b/docs/guides/onap-user/design/resource-onboarding/index.rst @@ -2,6 +2,8 @@ .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright 2019 ONAP Contributors. All rights reserved. +.. _doc_guide_user_des_res-onb: + Resource Onboarding =================== **Goal:** Add models and other artifacts required to create, configure, instantiate, and manage a VF and, optionally, a VFC. diff --git a/docs/guides/onap-user/design/service-design/index.rst b/docs/guides/onap-user/design/service-design/index.rst index dcc6b9c62..83217bdcc 100644 --- a/docs/guides/onap-user/design/service-design/index.rst +++ b/docs/guides/onap-user/design/service-design/index.rst @@ -2,6 +2,8 @@ .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright 2019 ONAP Contributors. All rights reserved. +.. _doc_guide_user_des_ser-des: + Service Design ============== @@ -30,7 +32,7 @@ instantiate, and manage services. Validate and certify the services. Create a Service ---------------- -**Prerequisites:** Create VFs required for this service (see :ref:`vfcreation-and-testing`). +**Prerequisites:** Create VFs required for this service (see :ref:`doc_guide_user_des_vf-cre`). #. From the SDC HOME page, hover over Add and select Add Service. #. In the General section, complete all fields. diff --git a/docs/guides/onap-user/design/service-distribution/index.rst b/docs/guides/onap-user/design/service-distribution/index.rst index 4ed231047..8de0e9232 100644 --- a/docs/guides/onap-user/design/service-distribution/index.rst +++ b/docs/guides/onap-user/design/service-distribution/index.rst @@ -2,6 +2,8 @@ .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright 2019 ONAP Contributors. All rights reserved. +.. _doc_guide_user_des_ser-dis: + Governance Approval and Service Distribution ============================================ diff --git a/docs/guides/onap-user/design/vfcreation/index.rst b/docs/guides/onap-user/design/vfcreation/index.rst index 39130665a..0b49b994d 100644 --- a/docs/guides/onap-user/design/vfcreation/index.rst +++ b/docs/guides/onap-user/design/vfcreation/index.rst @@ -2,7 +2,7 @@ .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright 2019 ONAP Doc Team. All rights reserved. -.. _vfcreation-and-testing: +.. _doc_guide_user_des_vf-cre: VF Creation and Testing ======================= diff --git a/docs/guides/overview/overview.rst b/docs/guides/overview/overview.rst index 83c7e9de8..fc4570532 100644 --- a/docs/guides/overview/overview.rst +++ b/docs/guides/overview/overview.rst @@ -152,7 +152,9 @@ is named after a city. +----------------------+----------------+----------------------+-----------------------------------------------------------+ |Release Name |Release version |Release Date |Features delivered | +======================+================+======================+===========================================================+ -|Casablanca |* 3.0.2 |* 31 January 2019 | :ref:`Casablanca Release Notes <casablancarelease-notes>` | +|Dublin |4.0.0 |2019 | :ref:`Dublin Release Notes <dublinrelease-notes>` | ++----------------------+----------------+----------------------+-----------------------------------------------------------+ +|Casablanca |* 3.0.2 |* 31 January 2019 | | | |* 3.0.1 |* 30 November 2018 | | | |* 3.0.0 |* 15 April 2019 | | +----------------------+----------------+----------------------+-----------------------------------------------------------+ |