Documentation tracking improvement proposal

Guilin Release introduced a lot of new features

Every new functional feature should be documented in RTD to be part of the Release

A lot of news features are not documented in the RTD

The following table describes the functional high-level requirements and the associated documentation as December 9th, 2020

DRAFT

Reference	Requirement name	Documentation link	Projects impcated	Comments
REQ-381	Bulk PM / PM Data Control Extension		DCAE	Nothing in RTD. LInk to old wiki page: 5G - Bulk PM
REQ-353	xNF License Management, Guilin R7	https://docs.onap.org/projects/onap-modeling-modelspec/en/guilin/ONAP%20Model%20Spec/im/License/LicenseModel.html	Modeling	Nothing new with regards to Frankfurt
REQ-352	Extend ORAN A1 Adapter and add A1 Policy Management	https://docs.onap.org/projects/onap-ccsdk-oran/en/guilin/index.html#master-index	CCSDK	OK. New documentation
REQ-341	ONAP CNF orchestration - Enhancements	https://docs.onap.org/projects/onap-sdc/en/guilin/onboardingpackages.html https://docs.onap.org/projects/onap-so/en/guilin/index.html#master-index https://docs.onap.org/projects/onap-ccsdk-cds/en/guilin/userguide/designtime.html https://docs.onap.org/projects/onap-multicloud-framework/en/guilin/specs/multicloud-container-plugin.html	SDC SO CDS MultiCloud	OK Nothing new with regards to Frankfurt Only a link to a turorial: https://docs.onap.org/projects/onap-ccsdk-cds/en/guilin/usecases/wordpress-cnf-poc.html Nothing new with regards to Frankfurt. Old references to Amsterdam !!!
REQ-338	Support for Test Result Auto Analysis & Certification （NFV Testing Automatic Platform）	https://docs.onap.org/projects/onap-vnfsdk-model/en/guilin/index.html	VNFSDK	No documentation about this requirement found in RTD
REQ-337	Support for Test Task Auto Execution （NFV Testing Automatic Platform）	https://docs.onap.org/projects/onap-vnfsdk-model/en/guilin/index.html	VNFSDK	No documentation about this requirement found in RTD
REQ-336	Support for Test Environment Auto Deploy（NFV Testing Automatic Platform）	https://docs.onap.org/projects/onap-vnfsdk-model/en/guilin/index.html	VNFSDK	No documentation about this requirement found in RTD
REQ-335	Support for Test Topology Auto Design （NFV Testing Automatic Platform）	https://docs.onap.org/projects/onap-vnfsdk-model/en/guilin/index.html	VNFSDK	No documentation about this requirement found in RTD
REQ-334	ETSI-Alignment for Guilin	https://docs.onap.org/projects/onap-sdc/en/guilin/onboardingpackages.html https://docs.onap.org/projects/onap-sdc/en/guilin/onboardingpackages.html?highlight=etsi#how-does-sdc-determine-which-package-type-is-being-onboarded https://docs.onap.org/projects/onap-so/en/guilin/index.html	SDC, SO, ETSI Catalog Manager, Integration Testing (VNFM Simulator)	Did not find new documentation
REQ-332	CLAMP Deployment of Native Policies	https://docs.onap.org/projects/onap-clamp/en/guilin/index.html	CLAMP	There is nothing new as such from CLAMP point of view, the only thing a user will see is additional type of Operational policies (called native) being listed in CLAMP. The listing of Operationnal policies is not new in CLAMP, it is just that Policy framework is making available in, tosca-model, new sets of policies. Previously those policies were available but not just exposed by the Policy framework in the list.
REQ-331	Policy Based Filtering	https://docs.onap.org/projects/onap-policy-parent/en/latest/xacml/xacml.html#filter-guard-policy-type	POLICY	New Documentation
REQ-327	ONAP/3GPP & O-RAN Alignment-Standards Defined Notifications over VES (Guilin)	https://docs.onap.org/projects/onap-dcaegen2/en/guilin/sections/services/ves-http/stnd-defined-validation.html	DCAE	OK. New documentation
REQ-324	Support xNF Software Upgrade in association to schema updates	https://docs.onap.org/projects/onap-integration/en/latest/docs_5G_PNF_Software_Upgrade_With_Schema_Update.html?highlight=software%20upgrade	SO, A&AI, VID (C)	Did not find new documentation
REQ-322	Configuration & Persistency Service in R7	https://docs.onap.org/projects/onap-ccsdk-distribution/en/latest/index.html#master-index	CCSDK	Nothing found about this feature
REQ-321	CMPv2 Enhancements for R7	https://docs.onap.org/projects/onap-dcaegen2/en/guilin/sections/design-components/component-specification/docker-specification.html	DCAE	OK. New documentation
REQ-320	5G Service Modeling in R7	https://docs.onap.org/projects/onap-modeling-modelspec/en/guilin/index.html	Modeling	Nothing new with regards to Frankfurt
REQ-319	PNF PreOnboarding in R7	https://docs.onap.org/projects/onap-vnfsdk-model/en/guilin/index.html	VNFSDK	Nothing new with regards to Frankfurt
REQ-318	PNF Plug & Play in R7	https://docs.onap.org/projects/onap-modeling-modelspec/en/guilin/index.html https://docs.onap.org/projects/onap-so/en/guilin/index.html#master-index	Modeling SO	Nothing new with regards to Frankfurt

Every new functiobal feature should have impcat on documentation. As a result, the project should update the documentation

API Documentation for all components

Every component should have a clear API description
The following table presents the list of ONAP services (as Kubernetes services) for Guilin (extracted from https://logs.onap.org/onap-integration/daily/onap_daily_pod4_guilin/12-09-2020_04-12/infrastructure-healthcheck/k8s/kubernetes-status/index.html)

Service	Type	Port	API Description
a1policymanagement	ClusterIP	8433/TCP, 8081/TCP
a1policymanagement-external	NodePort	8433:30294/TCP
aaf-cass	ClusterIP	7000/TCP, 7001/TCP, 9042/TCP, 9160/TCP
aaf-cm	ClusterIP	8150/TCP
aaf-fs	ClusterIP	8096/TCP
aaf-gui	NodePort	8200:30251/TCP
aaf-hello	ClusterIP	8130/TCP
aaf-locate	ClusterIP	8095/TCP
aaf-oauth	ClusterIP	8140/TCP
aaf-service	ClusterIP	8100/TCP
aaf-sms	ClusterIP	10443/TCP
aaf-sms-db	ClusterIP	8200/TCP
aai	NodePort	8443:30233/TCP
aai-babel	NodePort	9516:30279/TCP
aai-elasticsearch	ClusterIP	9200/TCP, 8443/TCP
aai-graphadmin	ClusterIP	8449/TCP, 5005/TCP
aai-modelloader	NodePort	8080:30210/TCP, 8443:30229/TCP
aai-resources	ClusterIP	8447/TCP, 5005/TCP
aai-schema-service	ClusterIP	8452/TCP, 5005/TCP
aai-search-data	ClusterIP	9509/TCP
aai-sparky-be	NodePort	8000:30220/TCP
aai-traversal	ClusterIP	8446/TCP, 5005/TCP
appc	NodePort	8443:30230/TCP, 1830:30231/TCP, 9090:30211/TCP
appc-ansible-server	ClusterIP	8000/TCP
appc-cdt	NodePort	18080:30289/TCP
appc-cluster	ClusterIP	2550/TCP
appc-dbhost	ClusterIP	3306/TCP
appc-dgbuilder	NodePort	3000:30228/TCP
awx-postgresql	ClusterIP	5432/TCP
awx-rabbitmq	ClusterIP	15672/TCP, 5672/TCP
awx-rmq-mgmt	ClusterIP	15672/TCP
awx-web	NodePort	80:30478/TCP
cassandra	ClusterIP	7000/TCP, 7001/TCP, 7199/TCP, 9042/TCP, 9160/TCP, 61621/TCP
cdash-es	ClusterIP	9200/TCP
cdash-es-tcp	ClusterIP	9300/TCP
cdash-kibana	NodePort	5601:30290/TCP
cdash-ls	ClusterIP	9600/TCP
cds-blueprints-processor-cluster	ClusterIP	5701/TCP
cds-blueprints-processor-grpc	ClusterIP	9111/TCP
cds-blueprints-processor-http	ClusterIP	8080/TCP
cds-command-executor	ClusterIP	50051/TCP
cds-db	ClusterIP	3306/TCP
cds-py-executor	ClusterIP	50052/TCP, 50053/TCP
cds-sdc-listener	ClusterIP	8080/TCP
cds-ui	NodePort	3000:30497/TCP
clamp	ClusterIP	8443/TCP
clamp-backend	ClusterIP	443/TCP
clamp-external	NodePort	2443:30258/TCP
clampdb	ClusterIP	3306/TCP
cli	NodePort	443:30260/TCP, 9090:30271/TCP
config-binding-service	ClusterIP	10000/TCP, 10443/TCP
consul	ExternalName	No Ports!
consul-server	ClusterIP	8301/TCP
consul-server-ui	ClusterIP	8500/TCP
dashboard	NodePort	8443:30418/TCP
dbc-pg-primary	ClusterIP	5432/TCP
dbc-pg-replica	ClusterIP	5432/TCP
dbc-postgres	ClusterIP	5432/TCP
dcae-cloudify-manager	ClusterIP	443/TCP
dcae-dashboard-pg-primary	ClusterIP	5432/TCP
dcae-dashboard-pg-replica	ClusterIP	5432/TCP
dcae-dashboard-postgres	ClusterIP	5432/TCP
dcae-healthcheck	ClusterIP	80/TCP
dcae-hv-ves-collector	ClusterIP	6061/TCP
dcae-inv-pg-primary	ClusterIP	5432/TCP
dcae-inv-pg-replica	ClusterIP	5432/TCP
dcae-inv-postgres	ClusterIP	5432/TCP
dcae-mongohost	ClusterIP	27017/TCP
dcae-mongohost-read	ClusterIP	27017/TCP
dcae-pg-primary	ClusterIP	5432/TCP
dcae-pg-replica	ClusterIP	5432/TCP
dcae-postgres	ClusterIP	5432/TCP
dcae-prh	ClusterIP	8100/TCP
dcae-tcagen2	ClusterIP	9091/TCP
dcae-ves-collector	ClusterIP	8080/TCP, 8443/TCP
dcaemod-designtool	ClusterIP	8080/TCP
dcaemod-distributor-api	ClusterIP	8080/TCP
dcaemod-genprocessor	ClusterIP	8080/TCP
dcaemod-healthcheck	ClusterIP	8080/TCP
dcaemod-nifi-registry	ClusterIP	18080/TCP
dcaemod-onboarding-api	ClusterIP	8080/TCP
dcaemod-pg-primary	ClusterIP	5432/TCP
dcaemod-pg-replica	ClusterIP	5432/TCP
dcaemod-postgres	ClusterIP	5432/TCP
dcaemod-runtime-api	ClusterIP	9090/TCP
deployment-handler	ClusterIP	8443/TCP
dmaap-bc	NodePort	8443:30242/TCP
dmaap-dr-db-svc	ClusterIP	3306/TCP
dmaap-dr-node	ClusterIP	8443/TCP, 8080/TCP
dmaap-dr-node-external	NodePort	8443:30494/TCP
dmaap-dr-prov	NodePort	443:30269/TCP
ejbca	ClusterIP	8443/TCP, 8080/TCP
esr-gui	ClusterIP	8080/TCP
esr-server	ClusterIP	9518/TCP
holmes-engine-mgmt	ClusterIP	9102/TCP
holmes-rule-mgmt	ClusterIP	9101/TCP, 9104/TCP
inventory	ClusterIP	8080/TCP
mariadb-galera	ClusterIP	3306/TCP
message-router	ClusterIP	3905/TCP, 3904/TCP
message-router-external	NodePort	3905:30226/TCP
message-router-kafka	ClusterIP	9092/TCP
message-router-kafka-0	NodePort	9091:30490/TCP
message-router-kafka-1	NodePort	9091:30491/TCP
message-router-kafka-2	NodePort	9091:30492/TCP
message-router-zookeeper	ClusterIP	2181/TCP, 2888/TCP, 3888/TCP
modeling-etsicatalog	ClusterIP	8806/TCP
msb-consul	ClusterIP	8500/TCP
msb-discovery	ClusterIP	10081/TCP
msb-eag	NodePort	443:30284/TCP
msb-iag	NodePort	443:30283/TCP
multicloud-azure	ClusterIP	9008/TCP
multicloud-fcaps	ClusterIP	9011/TCP
multicloud-framework	ClusterIP	9001/TCP
multicloud-k8s	ClusterIP	9015/TCP
multicloud-k8s-etcd	ClusterIP	2380/TCP, 2379/TCP
multicloud-k8s-mongo	ClusterIP	27017/TCP
multicloud-k8s-mongo-read	ClusterIP	27017/TCP
multicloud-pike	ClusterIP	9007/TCP
multicloud-starlingx	ClusterIP	9009/TCP
multicloud-titaniumcloud	ClusterIP	9005/TCP
multicloud-vio	ClusterIP	9004/TCP
music	NodePort	8443:30407/TCP
music-cassandra	ClusterIP	9042/TCP, 9160/TCP, 61621/TCP
nbi	NodePort	8443:30274/TCP
nbi-mongohost	ClusterIP	27017/TCP
nbi-mongohost-read	ClusterIP	27017/TCP
neng-serv	ClusterIP	8080/TCP
netbox-app	ClusterIP	8001/TCP
netbox-nginx	ClusterIP	8080/TCP
netbox-postgres	ClusterIP	5432/TCP
oof-cmso	ClusterIP	8080/TCP
oof-cmso-dbhost	ClusterIP	3306/TCP
oof-cmso-optimizer	ClusterIP	7997/TCP
oof-cmso-ticketmgt	ClusterIP	7999/TCP
oof-cmso-topology	ClusterIP	7998/TCP
oof-has-api	NodePort	8091:30275/TCP
oof-osdf	NodePort	8698:30248/TCP
oom-cert-service	ClusterIP	8443/TCP
policy-apex-pdp	ClusterIP	6969/TCP
policy-api	ClusterIP	6969/TCP
policy-distribution	ClusterIP	6969/TCP
policy-drools-pdp	ClusterIP	6969/TCP, 9696/TCP
policy-handler	ClusterIP	80/TCP
policy-mariadb	ClusterIP	3306/TCP
policy-pap	ClusterIP	6969/TCP
policy-xacml-pdp	ClusterIP	6969/TCP
portal-app	LoadBalancer	8443:30225/TCP
portal-cassandra	ClusterIP	9160/TCP, 7000/TCP, 7001/TCP, 7199/TCP, 9042/TCP
portal-db	ClusterIP	3306/TCP
portal-sdk	NodePort	8443:30212/TCP
portal-widget	ClusterIP	8082/TCP
refrepo	NodePort	8703:30297/TCP
robot	NodePort	443:30209/TCP
sdc-be	ClusterIP	8443/TCP, 8080/TCP
sdc-be-external	NodePort	8443:30204/TCP
sdc-fe	NodePort	9443:30207/TCP
sdc-onboarding-be	ClusterIP	8445/TCP, 8081/TCP
sdc-wfd-be	NodePort	8443:30257/TCP
sdc-wfd-fe	NodePort	8443:30256/TCP
sdnc	NodePort	8443:30267/TCP
sdnc-ansible-server	ClusterIP	8000/TCP
sdnc-cluster	ClusterIP	2550/TCP
sdnc-dbhost	ClusterIP	3306/TCP
sdnc-dgbuilder	NodePort	3000:30203/TCP
sdnc-dmaap-listener	ClusterIP	No Ports!
sdnc-oam	ClusterIP	8282/TCP, 8202/TCP
sdnc-ueb-listener	ClusterIP	No Ports!
sdnc-web-service	NodePort	8443:30205/TCP
sdnrdb	ClusterIP	9200/TCP
sdnrdb-discovery	ClusterIP	9300/TCP
sdnrdb-service	ClusterIP	9300/TCP
so	NodePort	8080:30277/TCP
so-bpmn-infra	ClusterIP	8081/TCP
so-catalog-db-adapter	ClusterIP	8082/TCP
so-cnf-adapter	ClusterIP	8090/TCP
so-etsi-nfvo-ns-lcm	ClusterIP	9095/TCP
so-monitoring	NodePort	9091:30224/TCP
so-nssmf-adapter	ClusterIP	8088/TCP
so-oof-adapter	ClusterIP	8090/TCP
so-openstack-adapter	ClusterIP	8087/TCP
so-request-db-adapter	ClusterIP	8083/TCP
so-sdc-controller	ClusterIP	8085/TCP
so-sdnc-adapter	ClusterIP	8086/TCP
so-vfc-adapter	ClusterIP	8084/TCP
so-vnfm-adapter	NodePort	9092:30406/TCP
uui	NodePort	8443:30398/TCP
uui-server	NodePort	8082:30399/TCP
vfc-generic-vnfm-driver	ClusterIP	8484/TCP
vfc-huawei-vnfm-driver	ClusterIP	8482/TCP, 8483/TCP
vfc-mariadb	ClusterIP	3306/TCP
vfc-nslcm	ClusterIP	8403/TCP
vfc-redis	ClusterIP	6379/TCP
vfc-vnflcm	ClusterIP	8801/TCP
vfc-vnfmgr	ClusterIP	8803/TCP
vfc-vnfres	ClusterIP	8802/TCP
vfc-zte-vnfm-driver	ClusterIP	8410/TCP
vid	NodePort	8443:30200/TCP
vid-galera	ClusterIP	3306/TCP
vid-http	ClusterIP	8080/TCP
vnfsdk-dbpri	ClusterIP	5432/TCP
vnfsdk-dbrep	ClusterIP	5432/TCP
vnfsdk-dbset	ClusterIP	5432/TCP
xdcae-hv-ves-collector	NodePort	6061:30222/TCP
xdcae-ves-collector	NodePort	8443:30417/TCP

Every K8S service should have a clear API defiinition and should be updated for each release.

When there is no evolution, a note should state that there is no evolution from previous release.

API Documentation shoud be described as a Swagger file

=> Need to include a linter to validate that the Swagger file is correct

Architecture Documentation for all projects

Every project should describe its internal archietcure as proposed by the Documentation sub-committee