STATUS: DRAFT
1. Scope
DESCRIPTION: This flow describes the distribution of the SDC Service CSAR. The SDC Service CSAR is a package of artifacts and output from design time that is created by the various design time GUIs. It captures the things associated with a service that has been defined in design time. This is then distributed to ONAP run-time components.
WHEN EXECUTED: After Design Time (before Run Time). When SDC Service CSAR package has been composed and is ready for distribution by SDC from a user at the Deployment Studio.
PURPOSE: To distribute the SDC Service CSAR to the run-time components
INFORMATION PASSED: Service CSAR package.
ACTORS:
- Service Designer
- Operations Specialist
- SDC (Deployment Studio)
2. Pre-Conditions
The preconditions are:
- PNFD and VNFD have been mapped to platform data/information model.
- SDC contains the verified service and resource descriptors
- Associated resources (PNF, VNF, ANF) used by services have been properly onboarded.
- Services have been defined in design time, and associated templates, control loops, blueprints have been incorporated into the service
- SDC has composed the Service Design CSAR package ready for distribution.
- The Certification Studio has certified the Package ready for distribution
- The Deployment Studio operator has identified the Service Design CSAR package for distribution
3. Information Flow
PlantUML Macro | ||
---|---|---|
| ||
@startuml participant SDC participant SO participant DCAE participant AAI Participant SDNC Participant APPC Participant CLAMP Participant POLICY Participant MC autonumber == Register to Service CSAR Distribution == SO-->SO: Register for Distribution note right: performed by all recipients of the CSAR == Service CSAR Distribution == group Distribute to SO hnote over SO : SO Listener SDC -> SO : SDC Distribution Notification note left: Using DMaaP SO -> SDC : Request Artifact (Artifact Type) SDC ->SO: Respond with Artifact SO --> SO : Store CSAR SO -> SDC: Distribution Status Update end group Distribute to DCAE hnote over DCAE : Service Change Handler SDC -> DCAE : SDC Distribution Notification note left: Using DMaaP DCAE -> SDC : Request Artifact (Artifact Type) SDC -> DCAE: Respond with Artifact DCAE --> DCAE : Store CSAR DCAE -> SDC: Distribution Status Update end group Distribute to AAI hnote over AAI: AAI Listener SDC -> AAI : SDC Distribution Notification note left: Using DMaaP AAI -> SDC : Request Artifact (Artifact Type) SDC -> AAI : Respond with Artifact AAI --> AAI : Store CSAR AAI -> SDC: Distribution Status Update end group Distribute to SDNC hnote over SDNC: UEB Listener SDC -> SDNC : SDC Distribution Notification note left: Using DMaaP SDNC -> SDC : Request Artifact (Artifact Type) SDC -> SDNC : Respond with Artifact SDNC --> SDNC : Store CSAR SDNC -> SDC: Distribution Status Update end group Distribute to APPC hnote over APPC: Listener SDC -> APPC : SDC Distribution Notification note left: Using DMaaP APPC -> SDC : Request Artifact (Artifact Type) SDC -> APPC : Respond with Artifact APPC --> APPC : Store CSAR APPC -> SDC: Distribution Status Update end group Distribute to CLAMP hnote over CLAMP: Listener SDC -> CLAMP : SDC Distribution Notification note left: Using DMaaP CLAMP -> SDC : Request Artifact (Artifact Type) SDC -> CLAMP : Respond with Artifact CLAMP --> CLAMP : Store CSAR CLAMP -> SDC: Distribution Status Update end group Distribute to POLICY hnote over POLICY: Listener SDC -> POLICY : SDC Distribution Notification note left: Using DMaaP SDC <- POLICY : Request Artifact (Artifact Type) SDC -> POLICY : Respond with Artifact POLICY --> POLICY : Store CSAR POLICY -> SDC: Distribution Status Update end group Distribute to MultiCloud hnote over MC: Listener SDC -> MC : SDC Distribution Notification note left: Using DMaaP MC -> SDC : Request Artifact (Artifact Type) SDC -> MC : Respond with Artifact MC --> MC : Store CSAR MC -> SDC: Distribution Status Update end == Un-Register to Service CSAR Distribution (optional, at any time) == SO-->SO: Un-Register for Distribution note right: performed by all recipients of the CSAR that want to un-register @enduml |
The following text describes each of the steps in the above flow. More details and exceptions can be described in the detailed descriptions. Wiki page links can also be linked for a reader to explore more.
REGISTER FOR DISTRIBUTION – SO, DCAE, A&AI, SDN-C, APP-C, VF-C register for distribution of the SDC Artifact distribution via the registration service of the SDCE-6 interface. This is performed by all recipients of the CSAR. This allows the ONAP platform component to receive the message which will contain the package later on.
SDC DISTRIBUTION NOTIFICATION (with SO) – SDC Distributes to service CSAR SO using the SDCE-6 interface. The SO listener retrieves the SDC CSAR package. SDC distributes the Service Distribution CSAR package which includes all of the artifacts, templates and resources related to the service created in design time. SDC publishes a topic onto DMaaP. Any RT component that has subscribed to that topic can get that package.
- REQUEST ARTIFACT - The ONAP platform component can request for the artifacts required by the component.
- RESPOND WITH ARTIFACT - The artifacts or SDC CSAR Package is retrieved from the DMaaP Bus. SDC responds with the package.
STORE CSAR PACKAGE – SO stores the distributed package.
- DISTRIBUTION STATUS UPDATE (with SO) - SO responds to the SDC Distribution exchange using SDCE-6.
- SDC DISTRIBUTION NOTIFICATION (with DCAE) - SDC Distributes service CSAR to DCAE using the SDCE-6 interface, the DCAE Service Change Handler retrieves the SDC CSAR package, SDC distributes the Service Distribution CSAR package which includes all of the artifacts, including templates and resources related to the service created at design time.
- REQUEST ARTIFACT - The ONAP platform component can request for the artifacts required by the component.
- RESPOND WITH ARTIFACT - The artifacts or SDC CSAR Package is retrieved from the DMaaP Bus. SDC responds with the package.
- STORE CSAR PACKAGE – DCAE stores the distributed package.
- DISTRIBUTION STATUS UPDATE (with DCAE) - DCAE responds to the SDC Distribution exchange using SDCE-6.
- SDC DISTRIBUTION NOTIFICATION (with A&AI) - SDC Distributes service CSAR to A&AI using the SDCE-6 interface, the A&AI listener retrieves the SDC CSAR package, SDC distributes the Service Distribution CSAR package which includes all of the artifacts, including templates and resources related to the service created at design time.
- REQUEST ARTIFACT - The ONAP platform component can request for the artifacts required by the component.
- RESPOND WITH ARTIFACT - The artifacts or SDC CSAR Package is retrieved from the DMaaP Bus. SDC responds with the package.
- STORE CSAR PACKAGE – A&AI stores the distributed package.
- DISTRIBUTION STATUS UPDATE (with A&AI) - A&AI responds to the SDC Distribution exchange using SDCE-6.
- SDC DISTRIBUTION NOTIFICATION (with SDN-C) - SDC Distributes service CSAR to SDN-C using the SDCE-6 interface, the SDN-C UEB listener retrieves the SDC CSAR package, SDC distributes the Service Distribution CSAR package which includes all of the artifacts, including templates and resources related to the service created at design time.
- REQUEST ARTIFACT - The ONAP platform component can request for the artifacts required by the component.
- RESPOND WITH ARTIFACT - The artifacts or SDC CSAR Package is retrieved from the DMaaP Bus. SDC responds with the package.
- STORE CSAR PACKAGE – SDN-C stores the distributed package.
- DISTRIBUTION STATUS UPDATE (with SDN-C) - SDN-C responds to the SDC Distribution exchange using SDCE-6.
- SDC DISTRIBUTION NOTIFICATION (with APP-C) - SDC Distributes service CSAR to APP-C using the SDCE-6 interface, the APP-C listener retrieves the SDC CSAR package, SDC distributes the Service Distribution CSAR package which includes all of the artifacts, including templates and resources related to the service created at design time.
- REQUEST ARTIFACT - The ONAP platform component can request for the artifacts required by the component.
- RESPOND WITH ARTIFACT - The artifacts or SDC CSAR Package is retrieved from the DMaaP Bus. SDC responds with the package.
- STORE CSAR PACKAGE – APP-C stores the distributed package.
- DISTRIBUTION STATUS UPDATE (with APP-C) - APP-C responds to the SDC Distribution exchange using SDCE-6.
- SDC DISTRIBUTION NOTIFICATION (with CLAMP) - SDC Distributes service CSAR to CLAMP using the SDCE-6 interface, the CLAMP listener retrieves the SDC CSAR package, SDC distributes the Service Distribution CSAR package which includes all of the artifacts, including templates and resources related to the service created at design time.
- REQUEST ARTIFACT - The ONAP platform component can request for the artifacts required by the component.
- RESPOND WITH ARTIFACT - The artifacts or SDC CSAR Package is retrieved from the DMaaP Bus. SDC responds with the package.
- STORE CSAR PACKAGE – CLAMP stores the distributed package.
- DISTRIBUTION STATUS UPDATE (with CLAMP) - CLAMP responds to the SDC Distribution exchange using SDCE-6.
- SDC DISTRIBUTION NOTIFICATION (with POLICY) - SDC Distributes service CSAR to POLICY using the SDCE-6 interface, the POLICY listener retrieves the SDC CSAR package, SDC distributes the Service Distribution CSAR package which includes all of the artifacts, including templates and resources related to the service created at design time.
- REQUEST ARTIFACT - The ONAP platform component can request for the artifacts required by the component.
- RESPOND WITH ARTIFACT - The artifacts or SDC CSAR Package is retrieved from the DMaaP Bus. SDC responds with the package.
- STORE CSAR PACKAGE – POLICY stores the distributed package.
- DISTRIBUTION STATUS UPDATE (with POLICY) - POLICY responds to the SDC Distribution exchange using SDCE-6.
- SDC DISTRIBUTION NOTIFICATION (with MULTICLOUD) - SDC Distributes service CSAR to Multi-Cloud using the SDCE-6 interface, the Multi-Cloud listner retrieves the SDC CSAR package, SDC distributes the Service Distribution CSAR package which includes all of the artifacts, including templates and resources related to the service created at design time.
- REQUEST ARTIFACT - The ONAP platform component can request for the artifacts required by the component.
- RESPOND WITH ARTIFACT - The artifacts or SDC CSAR Package is retrieved from the DMaaP Bus. SDC responds with the package.
- STORE CSAR PACKAGE – Multi-Cloud stores the distributed package.
- DISTRIBUTION STATUS UPDATE (with MULTICLOUD) - Multi-Cloud responds to the SDC Distribution exchange using SDCE-6.
- UN-REGISTER FROM CSAR DISTRIBUTION - At any time, any module can un-register from the reception of the CSAR using the Register for distribution service of SDCE-6 interface.
4. Post Condition
The post-conditions are:
- The SDC Service CSAR package contains the (1) Service Descriptor, (2) Resource Descriptor, (3) Service Artifacts, (4) Templates and blueprints associated with the service.
- SO has successfully received and stored SDC Service CSAR package.
- SO will contain (in local storage) all of the artifacts & components of the SDC Service CSAR Package.
- DCAE has successfully received and stored the SDC Service CSAR Package.
- DCAE will contain (in local storage) all of the artifacts & components of the SDC Service CSAR Package.
- A&AI has successfully received and stored SDC Service CSAR package .
- A&AI will contain (in local storage) all of the artifacts & components of the SDC Service CSAR Package.
- SDN-C has successfully received and stored SDC Service CSAR package .
- SDN-C will contain (in local storage) all of the artifacts & components of the SDC Service CSAR Package.
- APP-C has successfully received and stored SDC Service CSAR package .
- APP-C will contain (in local storage) all of the artifacts & components of the SDC Service CSAR Package.
- CLAMP has successfully received and stored SDC Service CSAR package .
- CLAMP will contain (in local storage) all of the artifacts & components of the SDC Service CSAR Package.
- POLICY has successfully received and stored SDC Service CSAR package .
- POLICY will contain (in local storage) all of the artifacts & components of the SDC Service CSAR Package.
- Multi-cloud has successfully received and stored SDC Service CSAR package .
- Multi-cloud will contain (in local storage) all of the artifacts & components of the SDC Service CSAR Package.