TOSCA Namespaces suggestion for ONAP Shitao li Namespace

TOSCA Namespaces suggestion for ONAP Shitao li

Namespace suggestion from OASIS TOSCA • 2017 -11 -02 - TOSCA Namespacing Explained - Draft. pptx • There are four important keynames need to take into consideration: • • tosca_definitions_version Namespace Alias Namespace URI Namespace Prefix

conclusion has been made for tosca-nfv-profile 1. tosca_definitions_version ? • conclusion from TOSCA: In the tosca-nfv-profile spec, it is suggested to set this value to tosca_simple_yaml_1_2 • Representing TOSCA grammar version • Representing default TOSCA Namespace URI and Namespace Prefix • Automatically imports the normative type definitions 2. 3. 4. Namespace Alias ? Namespace URI ? Namespace Prefix ? • Namespace alias is only need in tosca-simple-profile-yaml : In the TOSCA Simple Profile, TOSCA Service Templates MUST always have, as the first line of YAML, the keyword “tosca_definitions_version” with an associated TOSCA Namespace Alias value. • conclusion from TOSCA: It is suggested not to set namespace Alias in tosca-nfv-profile unless there is a clear usage of the namespace alias. • conclusion from TOSCA: It is suggested to use the existing one (http: //docs. oasisopen. org/tosca/ns/simple/yaml/1. 0/nfv/1. 0/) already defined in tosca-nfv-profile. • concluson from TOSCA: It is suggested to use “nfv: ” as the namespace prefix in tosca-nfv-profile, • e. g. nfv: tosca. nodes. nfv. Cpd

Suggestion to ONAP 1. tosca_definitions_version ? • It is suggested to set this value to tosca_simple_yaml_1_2 in ONAP for all the used TOSCA service templates • 2. Namespace Alias ? • It is suggested not to set namespace Alias in tosca-nfv-profile unless there is a clear usage of the namespace alias. • 3. Same as tosca-nfv-profile Namespace URI ? • It is suggested to create a new namespace URI in ONAP for ONAP specific TOSCA types to avoid name conflict. If ONAP requires to use the TOSCA types as defined in other documents (e. g. tosca-nfv-profile), it can be achieved by“imports” the required documents. • The URI can be maintained at onap. org imports: - file: <file_URI> repository: <repository_name> namespace_uri: <definition_namespace_uri> namespace_prefix: <definition_namespace_prefix> 4. Namespace Prefix ? • It is suggested to use “onap: ” as the namespace prefix for ONAP specific TOSCA types, • e. g. onap: onap. nodes. xxx

Backup

Profiles & Conformance What is intended • • • Approved, TOSCA Namespace URI - define a TOSCA-approved Namespace URI for the Profile’s Types that matches spec. version • i. e. , for default/target namespace Extensibility via Profile Types - define new Types needed to model the subject area for the Profile • These Types would be bound to the TOSCA approved Namespace URI for the Profile Simplified Import – allow profile types to be imported “on-top” of TOSCA Simple Profile base types • Ideally, “import” of a Profile’s Types should be accomplished with one (1) line of YAML • Namespace Prefix: possible a reserved Namespace Prefix for the Profile • Note: TOSCA base profile version compatibility is an issue to discuss What is not intended • • No new Grammar - Profiles are not allowed to define new grammar • Should not define new “keywords” for TOSCA entities • Profile WGs should submit uses cases to the Simple Profile WG that express needs in the base profile Limited ability to describe additional Requirements (prose) on individual Types • e. g. , describe special treatment of property/attribute values • Perhaps “constraints” grammar is not expressive enough? or one Property value depends on another? • Note: the Profile WG should try to submit uses cases to Simple Profile WG when they find limitations that could be fixed via the core grammar