Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

PlantUML Macro
titleVNF/PNF Onboarding
@startuml
participant VENDOR
participant ONAPUSER
participant VNFSDK
participant SDC
autonumber 

group VNF/PNF PACKAGE DELIVERY
	hnote over ONAPUSER : Vendor Package Delivery
	VENDOR -> ONAPUSER : VNF/PNF Package Delivery 	
end

group PRE-ONBOARDING
	hnote over VNFSDK : Optional step
end

group Create a resource
hnote over SDC : Options to create a resource in SDC
group Onboarding
	hnote over SDC : Two onboarding options
	group Options
		group PACKAGE ONBOARDING
			hnote over SDC : Create a VSP model using onboarding package (PNF csar, VNF csar, or Heat)
			ONAPUSER -> SDC : onboarding a package
			SDC -> SDC : Create an internal model with Metadata added
 			SDC -> SDC : Transform onboarding artifacts into SDC onboarding
			SDC -> SDC : Transform onboarding descriptor into internal descriptor 
			SDC -> SDC : License Model Files Added
		end

		group Manual VNF VSP creation
			hnote over SDC : Manual create a VNF VSP model
			ONAPUSER -> SDC : Create a VSP
			SDC -> SDC : Create an internal model with Metadata added
			ONAPUSER -> SDC : Update internal descriptor proprieties 
			ONAPUSER -> SDC : License Model Files Added
			ONAPUSER -> SDC : Artifacts Added
		end
	end
end

group Create a resource
	group Create resource from a VSP
		hnote over SDC : Create resource model from a VSP
		ONAPUSER -> SDC : Create a VSP
		SDC -> SDC : Transform a VSP into a resource model
		SDC -> SDC : update internal descriptor proprieties 
		SDC -> SDC : update License Model Files
		ONAPUSER -> SDC : Additional Artifacts Added (Manual/Optional)
	end

	group Manual create a VNF or PNF resource
		hnote over SDC : Manual create a VNF / PNF Resources
		SDC -> SDC : create an internal VNF / PNF model with Metadata added
		ONAPUSER -> SDC : Update internal descriptor proprieties 
		ONAPUSER -> SDC : License Model Files Added
		ONAPUSER -> SDC : Additional Artifacts Added (Manual/Optional)
	end
end
end

group Create a Service
	hnote over SDC : Manual create a Service model
	SDC -> SDC : create an internal service model with Metadata added
	ONAPUSER -> SDC : Add Resource(s)
	ONAPUSER -> SDC : Additional Artifacts Added
end

@enduml

The following sections describe the above (UML) steps in more detail:

3.3 Flow Description: PNF PACKAGE DELIVERY

1. PNF PACKAGE DELIVERY – Vendor Delivers the Package.

There are multiple ways that a vendor could deliver a package. There is not SOL or any other kind of standard which specifies HOW a vendor shall deliver a package. There is no API, it could  be on a memory/flash drive or cloud shared delivery system or any other conceivable way to deliver digital information.

2. PNF PACKAGE DELIVERY – Package is accepted into ONAP

the Vendor provided package is imported by a Technology Specialist/Asset manager into SDC.

3.4 Flow Description: PACKAGE VALIDATION (VNF-SDK)

Image Removed

3. LICENSE FILE CHECK – VNF-SDK performs a license file check within the vendor-delivered PNF package.

...

@enduml


The following sections describe the above (UML) steps in more detail:

3.3 Flow Description: PNF PACKAGE DELIVERY


1. PNF PACKAGE DELIVERY – Vendor Delivers the Package.

There are multiple ways that a vendor could deliver a package. There is not SOL or any other kind of standard which specifies HOW a vendor shall deliver a package. There is no API, it could  be on a memory/flash drive or cloud shared delivery system or any other conceivable way to deliver digital information.

2. PNF PACKAGE DELIVERY – Package is accepted into ONAP

the Vendor provided package is imported by a Technology Specialist/Asset manager into SDC.

3.4 Flow Description: PACKAGE VALIDATION (VNF-SDK)

Image Added

3. LICENSE FILE CHECK – VNF-SDK performs a license file check within the vendor-delivered PNF package.

4.CERTIFICATE FILE CHECK – VNF-SDK performs a certificate file check within the vendor-delivered PNF package.

5.FILE AND DESTINATION CHECK – VNF-SDK examines the MainServiceTemplate.mf (Manifest file) and performs a cross-check of the files & pathway directories specified within the manifest faile against the actual files within the vendor-delivered PNF package. It checks that the files that have been specified in the manifest file are actually in the given destination (directories).

6. MANIFEST FILE TAG VALIDATION – VNF-SDK performs a check of the PNF keywords in the MainServiceTemplate.mf (Manifest file). The tags are pnf_product_name, pnf_provider_id, pnf_package_version, pnf_release_data_time, and non-mano_artifact_sets.

7. TOSCA METADATA FILE VALIDATION – VNF checks the Meta Data file (TOSCA.meta) in the PNF package with the ETSI SOL004 validation tags. The checks performed are the Entry definition, Entry-manifest, Entry-change-log, Entry-tests, Entry certificates.

8. USER CHECKS VALIDATION – The end user may then inspect that the PNF package has been appropriately verified in the Certification studio.

3.5 Flow Description: SDC PACKAGE ONBOARDING

In the next steps, SDC brings that Vendor provided package into the SDC Catalog and creates an SDC internal representation of that package.


Image Added

A. UUID IDENTIFIER – SDC adds a UUID identifier.

B.TOSCA METADATA – SDC adds additional TOSCA Meta-data.

C.TOSCA DESCRIPTOR – SDC may add a TOSCA Descriptor

D. LICENSE MODEL FILE – SDC can add a license model file.

E. ADDITIONAL ARTIFACTS – The User may optionally manually add additional artifacts.


PACKAGE ONBOARDING

There are two options to onboard into SDC. OPTION #1 is to "automatically" onboard a package.

In this case, a VSP model is created using an Onboarding package (PNF CSAR, VNF CSAR or Heat)

9. ONBOARD PACKAGE - The onboarding package is accessed by a Technology specialist/Asset manager

10. INTERNAL MODEL - An internal model is created in SDC with MetaData added.

11. TRANSFORM ARTIFACTS - The artifacts from the PNF or VNF package are transformed into onboarding artifacts during SDC onboarding.

12. ONBOARD DESCRIPTOR - SDC transforms the xNF onboarding descriptor (PNFD or VNFD) into an SDC internal descriptor.

13. LICENSE MODEL FILES - License Model Files are added (optional).

PACKAGE ONBOARDING - MANUAL VNF VSP CREATION

The second option is to manually onboard into SDC, this entails the manual creation of a VNF VSP.

In this case, a VNF VSP model is manually created.

14. CREATE A VSP - The Technology specialist/Asset manager initiates a manual VSP creation.

15. INTERNAL MODEL - SDC is used to create an internal model with Metadata added.

16. INTERNAL DESCRIPTOR - The internal descriptor proprieties are updated. The vendor provided descriptor can specify attribute value limitations or ranges.

17. LICENSE MODEL FILES - The License Model Files are then added to the VSP

18. ARTIFACTS ADDED -  Finally, additional artifacts are added if necessary (optional).


CREATE RESOURCE - FROM A VSP

There are two ways to create a resource. A resource can be: (option 1) created from a VSP or (option 2) through manual creation.

These are the steps for creating a resource from a VSP.

19. CREATE VSP - The ONAP Operator requests for a resource to be created from a VSP.

20. RESOURCE MODEL - A VSP is transformed into a resource model.

21. INTERNAL DESCRIPTORS - The SDC Internal descriptor properties are updated. Customized types during design time allows service providers to specify additional restrictions on onboarded parameters. For example a vendor specified attribute might have allowed values 1 through 6; and customized types would restrict certain allowed values.

22. LICENSE MODEL FILES - License model files are updated in SDC.

23

6. MANIFEST FILE TAG VALIDATION – VNF-SDK performs a check of the PNF keywords in the MainServiceTemplate.mf (Manifest file). The tags are pnf_product_name, pnf_provider_id, pnf_package_version, pnf_release_data_time, and non-mano_artifact_sets.

7. TOSCA METADATA FILE VALIDATION – VNF checks the Meta Data file (TOSCA.meta) in the PNF package with the ETSI SOL004 validation tags. The checks performed are the Entry definition, Entry-manifest, Entry-change-log, Entry-tests, Entry certificates.

8. USER CHECKS VALIDATION – The end user may then inspect that the PNF package has been appropriately verified in the Certification studio.

3.5 Flow Description: SDC PACKAGE ONBOARDING

In the next steps, SDC brings that Vendor provided package into the SDC Catalog and creates an SDC internal representation of that package.

Image Removed

A. UUID IDENTIFIER – SDC adds a UUID identifier.

...

D. LICENSE MODEL FILE – SDC can add a license model file.

E. ADDITIONAL ARTIFACTS – The User may optionally manually add additional artifacts.

PACKAGE ONBOARDING

There are two options to onboard into SDC. OPTION #1 is to "automatically" onboard a package.

In this case, a VSP model is created using an Onboarding package (PNF CSAR, VNF CSAR or Heat)

9. ONBOARD PACKAGE - The onboarding package is accessed by a Technology specialist/Asset manager

10. INTERNAL MODEL - An internal model is created in SDC with MetaData added.

11. TRANSFORM ARTIFACTS - The artifacts from the PNF or VNF package are transformed into onboarding artifacts during SDC onboarding.

12. ONBOARD DESCRIPTOR - SDC transforms the xNF onboarding descriptor (PNFD or VNFD) into an SDC internal descriptor.

13. LICENSE MODEL FILES - License Model Files are added (optional).

PACKAGE ONBOARDING - MANUAL VNF VSP CREATION

The second option is to manually onboard into SDC, this entails the manual creation of a VNF VSP.

In this case, a VNF VSP model is manually created.

14. CREATE A VSP - The Technology specialist/Asset manager initiates a manual VSP creation.

15. INTERNAL MODEL - SDC is used to create an internal model with Metadata added.

16. INTERNAL DESCRIPTOR - The internal descriptor proprieties are updated. The vendor provided descriptor can specify attribute value limitations or ranges.

17. LICENSE MODEL FILES - The License Model Files are then added to the VSP

18. ARTIFACTS ADDED -  Finally, additional artifacts are added if necessary (optional).

CREATE RESOURCE - FROM A VSP

There are two ways to create a resource. A resource can be: (option 1) created from a VSP or (option 2) through manual creation.

These are the steps for creating a resource from a VSP.

19. CREATE VSP - The ONAP Operator requests for a resource to be created from a VSP.

20. RESOURCE MODEL - A VSP is transformed into a resource model.

21. INTERNAL DESCRIPTORS - The SDC Internal descriptor properties are updated. Customized types during design time allows service providers to specify additional restrictions on onboarded parameters. For example a vendor specified attribute might have allowed values 1 through 6; and customized types would restrict certain allowed values.

22. LICENSE MODEL FILES - License model files are updated in SDC.

23. ADDITIONAL ARTIFACTS - The operator may add additional artifacts to the resource. The resource becomes available in the SDC catalog for use in service creation (steps 28-30).

CREATE RESOURCE - MANUAL CREATION OF xNF RESOURCE

24. MANUAL CREATION, INTERNAL MODEL - The operator invokes the manual creation of a PNF or VNF resource. An internal VNF / PNF model is created with Metadata added.

25. INTERNAL DESCRIPTOR - In SDC, the internal descriptor properties are updated by the ONAP user.

26. LICENSE MODEL FILES - License model files can be added by the user in SDC.

27. ADDITIONAL ARTIFACTS - The operator may add additional artifacts to the resource (optional). The resource becomes available in the SDC catalog for use in service creation (steps 28-30).  


CREATE

...

RESOURCE - MANUAL CREATION OF xNF RESOURCE

24. MANUAL CREATION, INTERNAL MODEL - The operator invokes the manual creation of a PNF or VNF resource. An internal VNF / PNF model is created with Metadata added.

25. INTERNAL DESCRIPTOR - In SDC, the internal descriptor properties are updated by the ONAP user.

26. LICENSE MODEL FILES - License model files can be added by the user in SDC.

27. ADDITIONAL ARTIFACTS - The operator may add additional artifacts to the resource (optional). The resource becomes available in the SDC catalog for use in service creation.  

28. CREATE SERVICE - Create a internal service model with meta-data added. Additional restrictions to parameters may be given with customized types.

29. ADD RESOURCES - Resources can be added to the service by the user.

30. ADD ARTIFACTS - Other artifacts can be (optionally) added to the service by the user.


4. Post Conditions

4a. Post Condition (Pre-onboarding)

...