Documentation tracking improvement proposal

Owned by Eric Debeau
Last updated: Dec 21, 2020 by Yan Yang
3 min read

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


ReferenceRequirement nameDocumentation linkProjects impcatedComments
REQ-381 Bulk PM / PM Data Control Extension https://docs.onap.org/projects/onap-integration/en/latest/docs_5G_Bulk_PM.htmlDCAEOK. New documentation
REQ-353 xNF License Management, Guilin R7 https://docs.onap.org/projects/onap-modeling-modelspec/en/guilin/ONAP%20Model%20Spec/im/License/LicenseModel.htmlModelingNothing 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-indexCCSDKOK. 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.htmlVNFSDKDocumentation for NFV Testing Requirements https://gerrit.onap.org/r/c/integration/+/116495
REQ-337 Support for Test Task Auto Execution （NFV Testing Automatic Platform） https://docs.onap.org/projects/onap-vnfsdk-model/en/guilin/index.htmlVNFSDKDocumentation for NFV Testing Requirements https://gerrit.onap.org/r/c/integration/+/116495
REQ-336 Support for Test Environment Auto Deploy（NFV Testing Automatic Platform） https://docs.onap.org/projects/onap-vnfsdk-model/en/guilin/index.htmlVNFSDKDocumentation for NFV Testing Requirements https://gerrit.onap.org/r/c/integration/+/116495
REQ-335 Support for Test Topology Auto Design （NFV Testing Automatic Platform） https://docs.onap.org/projects/onap-vnfsdk-model/en/guilin/index.htmlVNFSDKDocumentation for NFV Testing Requirements https://gerrit.onap.org/r/c/integration/+/116495
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.htmlCLAMPThere 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-typePOLICYNew 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.htmlDCAEOK. 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-indexCCSDKNothing 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.htmlDCAEOK. New documentation
REQ-320 5G Service Modeling in R7 https://docs.onap.org/projects/onap-modeling-modelspec/en/guilin/index.htmlModelingNothing new with regards to Frankfurt
REQ-319 PNF PreOnboarding in R7 https://docs.onap.org/projects/onap-vnfsdk-model/en/guilin/index.html

A new page will be created as part of this MR: https://gerrit.onap.org/r/c/vnfsdk/model/+/116395		VNFSDKNothing 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

PNF PnP workflow migration to Building Blocks (Confluence Page -  SO BBs)

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


ServiceTypePortAPI Description
a1policymanagementClusterIP8433/TCP, 8081/TCP
a1policymanagement-externalNodePort8433:30294/TCP
aaf-cassClusterIP7000/TCP, 7001/TCP, 9042/TCP, 9160/TCP
aaf-cmClusterIP8150/TCP
aaf-fsClusterIP8096/TCP
aaf-guiNodePort8200:30251/TCP
aaf-helloClusterIP8130/TCP
aaf-locateClusterIP8095/TCP
aaf-oauthClusterIP8140/TCP
aaf-serviceClusterIP8100/TCP
aaf-smsClusterIP10443/TCP
aaf-sms-dbClusterIP8200/TCP
aaiNodePort8443:30233/TCP
aai-babelNodePort9516:30279/TCP
aai-elasticsearchClusterIP9200/TCP, 8443/TCP
aai-graphadminClusterIP8449/TCP, 5005/TCP
aai-modelloaderNodePort8080:30210/TCP, 8443:30229/TCP
aai-resourcesClusterIP8447/TCP, 5005/TCP
aai-schema-serviceClusterIP8452/TCP, 5005/TCP
aai-search-dataClusterIP9509/TCP
aai-sparky-beNodePort8000:30220/TCP
aai-traversalClusterIP8446/TCP, 5005/TCP
appcNodePort8443:30230/TCP, 1830:30231/TCP, 9090:30211/TCP
appc-ansible-serverClusterIP8000/TCP
appc-cdtNodePort18080:30289/TCP
appc-clusterClusterIP2550/TCP
appc-dbhostClusterIP3306/TCP
appc-dgbuilderNodePort3000:30228/TCP
awx-postgresqlClusterIP5432/TCP
awx-rabbitmqClusterIP15672/TCP, 5672/TCP
awx-rmq-mgmtClusterIP15672/TCP
awx-webNodePort80:30478/TCP
cassandraClusterIP7000/TCP, 7001/TCP, 7199/TCP, 9042/TCP, 9160/TCP, 61621/TCP
cdash-esClusterIP9200/TCP
cdash-es-tcpClusterIP9300/TCP
cdash-kibanaNodePort5601:30290/TCP
cdash-lsClusterIP9600/TCP
cds-blueprints-processor-clusterClusterIP5701/TCP
cds-blueprints-processor-grpcClusterIP9111/TCP
cds-blueprints-processor-httpClusterIP8080/TCP
cds-command-executorClusterIP50051/TCP
cds-dbClusterIP3306/TCP
cds-py-executorClusterIP50052/TCP, 50053/TCP
cds-sdc-listenerClusterIP8080/TCP
cds-uiNodePort3000:30497/TCP
clampClusterIP8443/TCP
clamp-backendClusterIP443/TCP
clamp-externalNodePort2443:30258/TCP
clampdbClusterIP3306/TCP
cliNodePort443:30260/TCP, 9090:30271/TCP
config-binding-serviceClusterIP10000/TCP, 10443/TCP
consulExternalNameNo Ports!
consul-serverClusterIP8301/TCP
consul-server-uiClusterIP8500/TCP
dashboardNodePort8443:30418/TCP
dbc-pg-primaryClusterIP5432/TCP
dbc-pg-replicaClusterIP5432/TCP
dbc-postgresClusterIP5432/TCP
dcae-cloudify-managerClusterIP443/TCP
dcae-dashboard-pg-primaryClusterIP5432/TCP
dcae-dashboard-pg-replicaClusterIP5432/TCP
dcae-dashboard-postgresClusterIP5432/TCP
dcae-healthcheckClusterIP80/TCP
dcae-hv-ves-collectorClusterIP6061/TCP
dcae-inv-pg-primaryClusterIP5432/TCP
dcae-inv-pg-replicaClusterIP5432/TCP
dcae-inv-postgresClusterIP5432/TCP
dcae-mongohostClusterIP27017/TCP
dcae-mongohost-readClusterIP27017/TCP
dcae-pg-primaryClusterIP5432/TCP
dcae-pg-replicaClusterIP5432/TCP
dcae-postgresClusterIP5432/TCP
dcae-prhClusterIP8100/TCP
dcae-tcagen2ClusterIP9091/TCP
dcae-ves-collectorClusterIP8080/TCP, 8443/TCP
dcaemod-designtoolClusterIP8080/TCP
dcaemod-distributor-apiClusterIP8080/TCP
dcaemod-genprocessorClusterIP8080/TCP
dcaemod-healthcheckClusterIP8080/TCP
dcaemod-nifi-registryClusterIP18080/TCP
dcaemod-onboarding-apiClusterIP8080/TCP
dcaemod-pg-primaryClusterIP5432/TCP
dcaemod-pg-replicaClusterIP5432/TCP
dcaemod-postgresClusterIP5432/TCP
dcaemod-runtime-apiClusterIP9090/TCP
deployment-handlerClusterIP8443/TCP
dmaap-bcNodePort8443:30242/TCP
dmaap-dr-db-svcClusterIP3306/TCP
dmaap-dr-nodeClusterIP8443/TCP, 8080/TCP
dmaap-dr-node-externalNodePort8443:30494/TCP
dmaap-dr-provNodePort443:30269/TCP
ejbcaClusterIP8443/TCP, 8080/TCP
esr-guiClusterIP8080/TCP
esr-serverClusterIP9518/TCP
holmes-engine-mgmtClusterIP9102/TCP
holmes-rule-mgmtClusterIP9101/TCP, 9104/TCP
inventoryClusterIP8080/TCP
mariadb-galeraClusterIP3306/TCP
message-routerClusterIP3905/TCP, 3904/TCP
message-router-externalNodePort3905:30226/TCP
message-router-kafkaClusterIP9092/TCP
message-router-kafka-0NodePort9091:30490/TCP
message-router-kafka-1NodePort9091:30491/TCP
message-router-kafka-2NodePort9091:30492/TCP
message-router-zookeeperClusterIP2181/TCP, 2888/TCP, 3888/TCP
modeling-etsicatalogClusterIP8806/TCP
msb-consulClusterIP8500/TCP
msb-discoveryClusterIP10081/TCP
msb-eagNodePort443:30284/TCP
msb-iagNodePort443:30283/TCP
multicloud-azureClusterIP9008/TCP
multicloud-fcapsClusterIP9011/TCP
multicloud-frameworkClusterIP9001/TCP
multicloud-k8sClusterIP9015/TCP
multicloud-k8s-etcdClusterIP2380/TCP, 2379/TCP
multicloud-k8s-mongoClusterIP27017/TCP
multicloud-k8s-mongo-readClusterIP27017/TCP
multicloud-pikeClusterIP9007/TCP
multicloud-starlingxClusterIP9009/TCP
multicloud-titaniumcloudClusterIP9005/TCP
multicloud-vioClusterIP9004/TCP
musicNodePort8443:30407/TCP
music-cassandraClusterIP9042/TCP, 9160/TCP, 61621/TCP
nbiNodePort8443:30274/TCP
nbi-mongohostClusterIP27017/TCP
nbi-mongohost-readClusterIP27017/TCP
neng-servClusterIP8080/TCP
netbox-appClusterIP8001/TCP
netbox-nginxClusterIP8080/TCP
netbox-postgresClusterIP5432/TCP
oof-cmsoClusterIP8080/TCP
oof-cmso-dbhostClusterIP3306/TCP
oof-cmso-optimizerClusterIP7997/TCP
oof-cmso-ticketmgtClusterIP7999/TCP
oof-cmso-topologyClusterIP7998/TCP
oof-has-apiNodePort8091:30275/TCP
oof-osdfNodePort8698:30248/TCP
oom-cert-serviceClusterIP8443/TCP
policy-apex-pdpClusterIP6969/TCP
policy-apiClusterIP6969/TCP
policy-distributionClusterIP6969/TCP
policy-drools-pdpClusterIP6969/TCP, 9696/TCP
policy-handlerClusterIP80/TCP
policy-mariadbClusterIP3306/TCP
policy-papClusterIP6969/TCP
policy-xacml-pdpClusterIP6969/TCP
portal-appLoadBalancer8443:30225/TCP
portal-cassandraClusterIP9160/TCP, 7000/TCP, 7001/TCP, 7199/TCP, 9042/TCP
portal-dbClusterIP3306/TCP
portal-sdkNodePort8443:30212/TCP
portal-widgetClusterIP8082/TCP
refrepoNodePort8703:30297/TCP
robotNodePort443:30209/TCP
sdc-beClusterIP8443/TCP, 8080/TCP
sdc-be-externalNodePort8443:30204/TCP
sdc-feNodePort9443:30207/TCP
sdc-onboarding-beClusterIP8445/TCP, 8081/TCP
sdc-wfd-beNodePort8443:30257/TCP
sdc-wfd-feNodePort8443:30256/TCP
sdncNodePort8443:30267/TCP
sdnc-ansible-serverClusterIP8000/TCP
sdnc-clusterClusterIP2550/TCP
sdnc-dbhostClusterIP3306/TCP
sdnc-dgbuilderNodePort3000:30203/TCP
sdnc-dmaap-listenerClusterIPNo Ports!
sdnc-oamClusterIP8282/TCP, 8202/TCP
sdnc-ueb-listenerClusterIPNo Ports!
sdnc-web-serviceNodePort8443:30205/TCP
sdnrdbClusterIP9200/TCP
sdnrdb-discoveryClusterIP9300/TCP
sdnrdb-serviceClusterIP9300/TCP
soNodePort8080:30277/TCP
so-bpmn-infraClusterIP8081/TCP
so-catalog-db-adapterClusterIP8082/TCP
so-cnf-adapterClusterIP8090/TCP
so-etsi-nfvo-ns-lcmClusterIP9095/TCP
so-monitoringNodePort9091:30224/TCP
so-nssmf-adapterClusterIP8088/TCP
so-oof-adapterClusterIP8090/TCP
so-openstack-adapterClusterIP8087/TCP
so-request-db-adapterClusterIP8083/TCP
so-sdc-controllerClusterIP8085/TCP
so-sdnc-adapterClusterIP8086/TCP
so-vfc-adapterClusterIP8084/TCP
so-vnfm-adapterNodePort9092:30406/TCP
uuiNodePort8443:30398/TCP
uui-serverNodePort8082:30399/TCP
vfc-generic-vnfm-driverClusterIP8484/TCP
vfc-huawei-vnfm-driverClusterIP8482/TCP, 8483/TCP
vfc-mariadbClusterIP3306/TCP
vfc-nslcmClusterIP8403/TCP
vfc-redisClusterIP6379/TCP
vfc-vnflcmClusterIP8801/TCP
vfc-vnfmgrClusterIP8803/TCP
vfc-vnfresClusterIP8802/TCP
vfc-zte-vnfm-driverClusterIP8410/TCP
vidNodePort8443:30200/TCP
vid-galeraClusterIP3306/TCP
vid-httpClusterIP8080/TCP
vnfsdk-dbpriClusterIP5432/TCP
vnfsdk-dbrepClusterIP5432/TCP
vnfsdk-dbsetClusterIP5432/TCP
xdcae-hv-ves-collectorNodePort6061:30222/TCP
xdcae-ves-collectorNodePort8443: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