NFV URN Namespace: Difference between revisions

From NFVwiki
(Moving "NFVURN Page" from private wiki to public wiki.)
 
(Added link to updated template as per decision in TSC#212)
 
(10 intermediate revisions by 3 users not shown)
Line 11: Line 11:
!NFV sub-tree
!NFV sub-tree
!Full Namespace
!Full Namespace
!Type
!Description
!Description
|-
|coord
|
<nowiki>urn:etsi:nfv:coord</nowiki>
|Namespace for public LCM coordination action names defined in ETSI NFV specifications, including [https://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL002ed351_RESTful_protocols_spec ETSI GS NFV-SOL 002 v3.5.1] and later.
|-
|-
|yang:etsi-nfv-descriptors
|yang:etsi-nfv-descriptors
|
|
  <nowiki>urn:etsi:nfv:yang:etsi-nfv-descriptors</nowiki>
  <nowiki>urn:etsi:nfv:yang:etsi-nfv-descriptors</nowiki>
|string
|The namespace for YANG modules specified in ETSI GS NFV-SOL 006, available for download as [https://www.etsi.org/standards#page=1&search=NFV-SOL%20006&title=1&etsiNumber=1&content=0&version=1&onApproval=1&published=1&historical=1&startDate=1988-01-15&endDate=2021-05-03&harmonized=0&keyword=&TB=826,,835,,833,,789,,832,,831,,795,,796,,800,,798,,799,,848,,797,,828&stdType=&frequency=&mandate=&collection=&sort=1 ETSI GS NFV-SOL 006] and as a YANG specification in [https://forge.etsi.org/gitlab/nfv/SOL006/blob/master/src/yang/etsi-nfv-descriptors.yang etsi-nfv-descriptors.yang].
|Namespace for YANG modules specified in ETSI GS NFV-SOL 006.
|-
[https://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL006_YANG_based_NFV_Descriptors_spec Latest draft of SOL006]
|yang:etsi-nfv-vnfd
|
<nowiki>urn:etsi:nfv:yang:etsi-nfv-vnfd</nowiki>
|Namespace for the YANG module that is used to model a single VNFD, according to the YANG specification available in [https://forge.etsi.org/rep/nfv/SOL006/blob/v2.6.1/src/yang/etsi-nfv-vnfd.yang etsi-nfv-vnfd.yang] file and specified in [https://www.etsi.org/standards#page=1&search=NFV-SOL%20006&title=1&etsiNumber=1&content=0&version=1&onApproval=1&published=1&historical=1&startDate=1988-01-15&endDate=2021-05-03&harmonized=0&keyword=&TB=826,,835,,833,,789,,832,,831,,795,,796,,800,,798,,799,,848,,797,,828&stdType=&frequency=&mandate=&collection=&sort=1 ETSI GS NFV-SOL 006].
|-
|yang:etsi-nfv-nsd
|
<nowiki>urn:etsi:nfv:yang:etsi-nfv-nsd</nowiki>
|Namespace for the YANG module that is used to model a single NSD, according to the YANG specification available in [https://forge.etsi.org/rep/nfv/SOL006/blob/v2.6.1/src/yang/etsi-nfv-nsd.yang etsi-nfv-nsd.yang] file and specified in [https://www.etsi.org/standards#page=1&search=NFV-SOL%20006&title=1&etsiNumber=1&content=0&version=1&onApproval=1&published=1&historical=1&startDate=1988-01-15&endDate=2021-05-03&harmonized=0&keyword=&TB=826,,835,,833,,789,,832,,831,,795,,796,,800,,798,,799,,848,,797,,828&stdType=&frequency=&mandate=&collection=&sort=1 ETSI GS NFV-SOL 006].
|-
|yang:etsi-nfv-pnfd
|
<nowiki>urn:etsi:nfv:yang:etsi-nfv-pnfd</nowiki>
|Namespace for the YANG module that is used to model a single PNFD, according to the YANG specification available in [https://forge.etsi.org/rep/nfv/SOL006/blob/v2.6.1/src/yang/etsi-nfv-pnfd.yang etsi-nfv-pnfd.yang] file and specified in [https://www.etsi.org/standards#page=1&search=NFV-SOL%20006&title=1&etsiNumber=1&content=0&version=1&onApproval=1&published=1&historical=1&startDate=1988-01-15&endDate=2021-05-03&harmonized=0&keyword=&TB=826,,835,,833,,789,,832,,831,,795,,796,,800,,798,,799,,848,,797,,828&stdType=&frequency=&mandate=&collection=&sort=1 ETSI GS NFV-SOL 006].
|-
|webfinger
|<code><nowiki>urn:etsi:nfv:webfinger</nowiki></code>
|This node is a namespace for webfinger services.
Related specification [https://www.etsi.org/standards#page=1&search=NFV-SEC%20022&title=1&etsiNumber=1&content=0&version=1&onApproval=1&published=1&historical=1&startDate=1988-01-15&endDate=2021-05-03&harmonized=0&keyword=&TB=826,,835,,833,,789,,832,,831,,795,,796,,800,,798,,799,,848,,797,,828&stdType=&frequency=&mandate=&collection=&sort=1 ETSI GS NFV-SEC 022]
|-
|webfinger:rel
|<code><nowiki>urn:etsi:nfv:webfinger:rel</nowiki></code>
|This node is a namespace for "rel" value of the webfinger services used for the dynamic discovery of servers.
Related specification [https://www.etsi.org/standards#page=1&search=NFV-SEC%20022&title=1&etsiNumber=1&content=0&version=1&onApproval=1&published=1&historical=1&startDate=1988-01-15&endDate=2021-05-03&harmonized=0&keyword=&TB=826,,835,,833,,789,,832,,831,,795,,796,,800,,798,,799,,848,,797,,828&stdType=&frequency=&mandate=&collection=&sort=1 ETSI GS NFV-SEC 022]
|-
|webfinger:rel:api-oauth-server
|<code><nowiki>urn:etsi:nfv:webfinger:rel:api-oauth-server</nowiki></code>
|Value of Webfinger service for the discovery of authorization server identifier for API access control using OAuth2.0.
Related specification [https://www.etsi.org/standards#page=1&search=NFV-SEC%20022&title=1&etsiNumber=1&content=0&version=1&onApproval=1&published=1&historical=1&startDate=1988-01-15&endDate=2021-05-03&harmonized=0&keyword=&TB=826,,835,,833,,789,,832,,831,,795,,796,,800,,798,,799,,848,,797,,828&stdType=&frequency=&mandate=&collection=&sort=1 ETSI GS NFV-SEC 022]
|}
|}


==== Type definitions ====
=== Requesting an entry (for ETSI technical groups only) ===
string = (ALPHA)0*(ALPHANUMERIC/-/_)
A new NFV sub-tree can only be requested by an ETSI technical group (i.e., Technical Bodies, Industry Specification Groups, Open Source Groups and Special Communities), and their working groups (if applicable).
# a string starts with an upper- or lower-case letter followed by zero or more upper- or lower-case letters, integer numbers, hyphens or underscores
ALPHA = {a-zA-Z}
ALPHANUMERIC = {a-zA-Z0-9}
 
=== Requesting an entry (for ETSI technical bodies only) ===
A new NFV sub-tree can only be requested by a ETSI technical body.


To request a sub-tree please follow the guide below.
To request a sub-tree please follow the guidelines below.


* '''Pre-condition:''' a work item running in the WG has identified the need to enable a URN namespace. A contact person to formalize the request has been identified (e.g., a WG official such as the WG Chair, the work item rapporteur).
* '''Pre-condition:''' a work item running in the ETSI technical group has identified the need to enable a URN namespace. A contact person to formalize the request has been identified (e.g., a technical group official such as a WG Chair, the work item rapporteur).
* ''Step #1:'' Download the "URN namespace application template" in contribution [https://portal.etsi.org/ngppapp/ContributionCreation.aspx?primarykeys=168857&source=QIGSBIKSHQAZ NFVTSC(19)000003]
* ''Step #1:'' Download the "URN namespace application template" in contribution [https://docbox.etsi.org/ISG/NFV/TSC/05-CONTRIBUTIONS/2019//NFVTSC(19)000003r3_Template_for_URN_namespace_applications.docx NFVTSC(19)000003]
* ''Step #2:'' Fill in the template and submit it as a contribution under the "NFV TSC" workspace of the ETSI Portal.
* ''Step #2:'' Fill in the template and submit it as a contribution under the "NFV TSC" workspace of the ETSI Portal.
* ''Step #3:'' The TSC will review the application.
* ''Step #3:'' The ETSI NFV TSC will review the application.
** If the application is accepted, a new entry in the "NFV URN Namespace" will be enabled.
** If the application is accepted, a new entry in the "NFV URN Namespace" will be enabled.
** If the application cannot be accepted, it will be communicated to the contact person together with any additional information to be considered for resolving the "non-acceptance".
** If the application cannot be accepted, it will be communicated to the contact person together with any additional information to be considered for resolving the "non-acceptance".

Latest revision as of 13:24, 17 May 2021

Introduction

ETSI ISG NFV is maintaining a namespace registry as a sub tree of the ETSI root urn:etsi namespace. A description of the top level ETSI URN namespace can be found on the ETSI webpage [1].

The NFV URN namespace has the following structure:

urn:etsi:nfv:<NFV sub-tree>

The following sections describe the basic structure of the sub-tree and how a entry in the registry can be requested.

NFV sub-tree

NFV sub-tree Full Namespace Description
coord
urn:etsi:nfv:coord
Namespace for public LCM coordination action names defined in ETSI NFV specifications, including ETSI GS NFV-SOL 002 v3.5.1 and later.
yang:etsi-nfv-descriptors
urn:etsi:nfv:yang:etsi-nfv-descriptors
The namespace for YANG modules specified in ETSI GS NFV-SOL 006, available for download as ETSI GS NFV-SOL 006 and as a YANG specification in etsi-nfv-descriptors.yang.
yang:etsi-nfv-vnfd
urn:etsi:nfv:yang:etsi-nfv-vnfd
Namespace for the YANG module that is used to model a single VNFD, according to the YANG specification available in etsi-nfv-vnfd.yang file and specified in ETSI GS NFV-SOL 006.
yang:etsi-nfv-nsd
urn:etsi:nfv:yang:etsi-nfv-nsd
Namespace for the YANG module that is used to model a single NSD, according to the YANG specification available in etsi-nfv-nsd.yang file and specified in ETSI GS NFV-SOL 006.
yang:etsi-nfv-pnfd
urn:etsi:nfv:yang:etsi-nfv-pnfd
Namespace for the YANG module that is used to model a single PNFD, according to the YANG specification available in etsi-nfv-pnfd.yang file and specified in ETSI GS NFV-SOL 006.
webfinger urn:etsi:nfv:webfinger This node is a namespace for webfinger services.

Related specification ETSI GS NFV-SEC 022

webfinger:rel urn:etsi:nfv:webfinger:rel This node is a namespace for "rel" value of the webfinger services used for the dynamic discovery of servers.

Related specification ETSI GS NFV-SEC 022

webfinger:rel:api-oauth-server urn:etsi:nfv:webfinger:rel:api-oauth-server Value of Webfinger service for the discovery of authorization server identifier for API access control using OAuth2.0.

Related specification ETSI GS NFV-SEC 022

Requesting an entry (for ETSI technical groups only)

A new NFV sub-tree can only be requested by an ETSI technical group (i.e., Technical Bodies, Industry Specification Groups, Open Source Groups and Special Communities), and their working groups (if applicable).

To request a sub-tree please follow the guidelines below.

  • Pre-condition: a work item running in the ETSI technical group has identified the need to enable a URN namespace. A contact person to formalize the request has been identified (e.g., a technical group official such as a WG Chair, the work item rapporteur).
  • Step #1: Download the "URN namespace application template" in contribution NFVTSC(19)000003
  • Step #2: Fill in the template and submit it as a contribution under the "NFV TSC" workspace of the ETSI Portal.
  • Step #3: The ETSI NFV TSC will review the application.
    • If the application is accepted, a new entry in the "NFV URN Namespace" will be enabled.
    • If the application cannot be accepted, it will be communicated to the contact person together with any additional information to be considered for resolving the "non-acceptance".