Documentation tracking improvement proposal

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

https://docs.onap.org/projects/onap-integration/en/latest/docs_5G_Bulk_PM.html

DCAE

OK. 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.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

Documentation 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.html

VNFSDK

Documentation 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.html

VNFSDK

Documentation 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.html

VNFSDK

Documentation 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.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

A new page will be created as part of this MR: https://gerrit.onap.org/r/c/vnfsdk/model/+/116395

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

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

 

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