/
Dublin Documentation Review

Dublin Documentation Review

This page lists all projects and the associated Documentation Reviewer

Project Name

Reviewer

Last Review date

Comments

Status

Project Name

Reviewer

Last Review date

Comments

Status

A & AI









Application Authorization Framework









APPC









CLAMP

@Eric Debeau

May 14, 2019 

Architecture: OK. Aligned with ARC CLAMP Component Description - Dublin

Offered APIS: NOK
link to html doc not working
Swagger API non compliant with Swagger: Semantic error at paths./clds/action/{action}/{modelName}?test={test}Query strings in paths are not allowed. and many other errors

Consumed API: OK

Delivery: OK

Logging: OK

Installation: To be clarified that is the standalone installation. Put the link towards the docker-compose.yml

Configuration: OK

Administration: OK

Human Interfaxes
HealthCheck API: only the local port is provided.
Open Closed loop in CLAMP : all UI are defined ;-)
Closed Loop properties: all UI are presented. Some parameters should be explained
Operational policy properties: all UI are presented. Some parameters should be explained
Configuration policy properties: all UI are presented. Some parameters should be explained
Saving Closed loop: all UI are presented. Some parameters should be explained
Submitting the Closed loop to policy: all UI are defined ;-)
Deploy/undeploy the Closed loop to DCAE

Release Notes: missing. No Release Note available for Dublin. We should explain the CLAMP limitations

CLAMP-389: Align API with OpenAPI (Swagger)Closed

CLAMP-390: Describe all the parameters that can be used for the different UIClosed

Common Controller SDK









DCAE

@Eric Debeau

May 14, 2019 

Architecture:

Offered APIS:

Consumed API:

Delivery:

Logging:

Installation:

Configuration:

Administration:

Human Interfaces:

Release Notes: No release note for Dublin



DMaaP



May 14, 2019 

Architecture: Alignement with ARC DMaaP Component Description - Dublin to be checked

Offered APIS: Swagger API OK for MR

Consumed API: OK fo MR

Delivery: OK fo MR

Logging: OK fo MR

Installation: OK fo MR

Configuration: OK fo MR

Administration: OK fo MR

Human Interfaces: OK fo MR

Release Notes: No release note for Dublin

Note: it will be good to get the list of Topics managed and the components 

DMAAP-1206: List of DMAAP TopicsClosed

Documentation

@Sofia Wallin







External API Framework

@Eric Debeau

May 14, 2019 

Architecture: OK. Aligned with ARC ExternalAPI Component Description - Dublin

Offered APIS: OK. Swagger OK

Consumed API: OK Clarify DMAAP API topic used for both SDC and AAI. MSB API Is missing

Delivery: OK

Logging: OK. Clarify log file location and roadmap to send logs to ONAP log component

Installation: OK. Add the link to docs/offeredapis/postman

Configuration: OK

Administration: OK

Human Interfaces: OK

Release Notes: OK



Holmes

@Eric Debeau

May 14, 2019 

Architecture: OK. Clarify Topic listened by Holmes (Topic1 and Topic2) . PNF may emit events also. Policy may also go to APPC.

Offered APIS: OK. Swagger API OK

Consumed API: OK

Delivery: OK, but still a link to Beijing Release

Logging: OK, but still a link to Beijing Release

Installation: Seems to be linked to Amsterdam

Configuration: OK

Administration: OK

Human Interfaces: OK, but still a link to Beijing Release. API description to be removed

Release Notes: No release note for Dublin

HOLMES-228

Integration









Logging Enhancements Project









Microservices Bus









Modeling









Multi VIM/Cloud









Music









ONAP CLI









ONAP Operations Manager









ONAP Optimization Framework





HAS : user manual: lack of an "hello world" for a simple VNF, describing the design operations and the instantiation operations in order to obtain a VNF instance on a cloud platform when several cloud platform are available.



ONAP University









ONAP Usecase UI Project Proposal









Policy Framework Project

@Eric Debeau

May 14, 2019 

Architecture: Some old figures remaining (9/28/2017). Still valid ?

Casablanca Additions to Architecture => to be removed

Offered APIS: OK for Policy engine

Consumed API:

Delivery: https://onap.readthedocs.io/en/latest/submodules/policy/engine.git/docs/platform/deployment.html Aligned with OOM ?

Logging:

Installation: Some old reference to Heat installation: https://onap.readthedocs.io/en/latest/submodules/policy/engine.git/docs/platform/cookbook.html

Configuration:

Administration:

Human Interfaces:

Release Notes: No release note for Dublin

Policy Platform Tutorials: https://onap.readthedocs.io/en/latest/submodules/policy/engine.git/docs/platform/index.html#policy-platform-tutorials => does not seem updated



Portal Platform Project









SDN-C









Service Design & Creation





User Interfaces: Updates for Page needed: SDC-2300: Update "Human Interfaces" Links to ReadTheDocsClosed



Service Orchestrator





User Manual : need for a tutorial to explain how to declare a new cloud-site



VF-C: Virtual Function Controller









VID project









VNF SDK









VNF Requirements









VNF Validation (VVP)









ONAP Benchmark