ETSINFV.KUBERNETES.V 1

2022-04-26T11:03:52Z

Yousaf:

<nowiki>Insert non-formatted text here</nowiki>[[https://nfvwiki.etsi.org/index.php?title=VIM_connection_information back to VimConnectionInfo registry]]

== '''1 Solution information''' ==
{| class="wikitable"
|'''Solution Name [M]'''
|Kubernetes v1
|-
|'''Description [M]'''
|ETSI-registered CISM Connection Info defining the interface and access parameters to use a Kubernetes®-based CISM, to be signalled via the APIs specified in ETSI GS NFV-SOL 003.
The API of a Kubernetes®-based CISM is specified in ETSI GS NFV-SOL 018.
Valid for Kubernetes® releases starting from 1.22.
|-
|'''Specification URI [O]'''
|https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/018/
|}

== '''2 Registration information''' ==
{| class="wikitable"
|'''Registrant name [M]'''
|ETSI ISG NFV
|}

== '''3 Requested vimType identifier''' ==
{| class="wikitable"
|'''Registrant [M]'''
|
|'''VIM Name [M]'''
|
|'''Version [O]'''
|-
|ETSINFV
|'''.'''
|KUBERNETES
|'''.'''
|V_1
|}

== '''4 JSON schema definition of "interfaceInfo"''' ==
Purpose: Provides information about the interface or interfaces to the CISM, such as the URI of an interface endpoint to communicate with the CISM
{| class="wikitable"
|'''interfaceInfo [M]'''
|-
|
<code>{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "interfaceInfo",
"additionalProperties": false,
"required": [
"authType",
"endpoint"
],
"type": "object",
"properties": {
"authType": {
"type": "string",
"enum": ["OID", "TOKEN", "CERTIFICATE"],
"description": "The authentication type for the Kubernetes cluster. Indicates the required access information."
},
"endpoint": {
"type": "string",
"format": "url",
"description": "The URL representing the Kubernetes cluster API endpoint."
},
"serverCertificate": {
"type": "string",
"format": "byte",
"description": "CA certificate of the Kubernetes cluster API server in PEM format."
},
"skipCertificateVerification": {
"default": false,
"type": "boolean",
"description": "Certificate verification for the endpoint can be skipped by setting this field to true."
}
}
}

|}

== '''5 JSON schema definition of "accessInfo"''' ==
Purpose: Provides authentication credentials for accessing the CISM, and other access-related information.
{| class="wikitable"
|'''accessInfo [M]'''
|-
|
<code>{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "accessInfo",
"additionalProperties": false,
"required": [],
"type": "object",
"properties": {
"tokenAuthInfo": {
"type": "object",
"description": "The authentication credentials for token-based authentication."
"properties": {
"token": {
"type": "string",
"format": "byte",
"description": "Binary token to be used for access authentication."
}
},
"required": [
"token"
],
},
"certificateAuthInfo": {
"type": "object",
"description": "The authentication credentials for certificate-based authentication."
"properties": {
"clientCertificate": {
"type": "string",
"format": "byte",
"description": "Kubernetes client certificate data in PEM format."
},
"clientCertificateKey": {
"type": "string",
"format": "byte",
"description": "Kubernetes client certificate key data in PEM format."
}
},
"required": [
"clientCertificate",
"clientCertificateKey"
],
},
"oidAuthInfo": {
"type": "object",
"description": "The authentication credentials for Open ID-based authentication."
"properties": {
"username": {
"type": "string",
"description": "The username to use for access."
},
"password": {
"writeOnly": true,
"type": "string",
"format": "password",
"description": "The password for the username for access. Required for input, not returned on output."
},
"clientId": {
"type": "string",
"description": "An ID which identifies an client application to use for access."
},
"clientSecret": {
"writeOnly": true,
"type": "string",
"format": "password",
"description": "The secret for the clientId for access. Required for input, not returned on output."
},
"remoteServerCertificate": {
"type": "string",
"format": "byte",
"description": "CA certificate data of the Open ID API server in PEM format."
},
"skipCertificateVerification": {
"default": false,
"type": "boolean",
"description": "Certificate verification for the remote server can be skipped by setting this field to true."
}
},
"required": [
"username",
"password",
"clientId"
],
}
}
}

|}

== '''6 JSON schema definition of "extra"''' ==
Purpose: Provides optional additional CISM type specific information.
{| class="wikitable"
|'''extra [O]'''
|-
|<code>not specified</code>
|}

VIM connection information

2022-04-24T16:05:17Z

Yousaf:

ETSINFV.DOCKER

2022-04-24T16:04:51Z

Yousaf: Created page with "https://nfvwiki.etsi.org/index.php?title=VIM_connection_information back to VimConnectionInfo registry == '''1 Solution information''' == {| class="wikitable" |'''Solutio..."

VIM connection information

2022-04-24T16:03:10Z

Yousaf: Registry entry based on NFVSOL(22)000136r1

This is the ETSI NFV SOL Registry for VIM connection information. VIM connection information are parameters used by a VNFM to connect to a VIM, CISM, CIR and MCIOP repository for managing the resources of a VNF instance. Further information on VIM connection information is available in [https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/ ETSI GS NFV-SOL 003].
{| class="wikitable"
|+
!Identifier
!Solution name
!Registrant
|-
|[[ETSINFV.OPENSTACK_KEYSTONE.V_2]]
|OpenStack with Keystone V2
|ETSI ISG NFV
|-
|[[ETSINFV.OPENSTACK_KEYSTONE.V_3]]
|OpenStack with Keystone V3
|ETSI ISG NFV
|-
|[[ETSINFV.KUBERNETES.V_1]]
|Kubernetes v1
|ETSI ISG NFV
|-
|[[ETSINFV.DOCKER|ETSINFV.DOCKER.V_2]]
|Docker v2
|ETSI ISG NFV
|-
|[[ETSINFV.HELM.V_3]]
|Helm v3
|ETSI ISG NFV
|}

To register VIM connection information, the following template must be filled and submitted to NFVsupport@etsi.org: [https://nfvwiki.etsi.org/images/ETSI_NFV_VimConnectionInfoTemplate_v101.docx template]

The full process for creating and modifying information in this registry is described in annex C of [https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/ ETSI GS NFV-SOL 003].

VIM connection information

2022-04-24T16:01:53Z

Yousaf:

This is the ETSI NFV SOL Registry for VIM connection information. VIM connection information are parameters used by a VNFM to connect to a VIM, CISM, CIR and MCIOP repository for managing the resources of a VNF instance. Further information on VIM connection information is available in [https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/ ETSI GS NFV-SOL 003].
{| class="wikitable"
|+
!Identifier
!Solution name
!Registrant
|-
|[[ETSINFV.OPENSTACK_KEYSTONE.V_2]]
|OpenStack with Keystone V2
|ETSI ISG NFV
|-
|[[ETSINFV.OPENSTACK_KEYSTONE.V_3]]
|OpenStack with Keystone V3
|ETSI ISG NFV
|-
|[[ETSINFV.KUBERNETES.V_1]]
|Kubernetes v1
|ETSI ISG NFV
|-
|[[ETSINFV.DOCKER]]
|Docker v1
|ETSI ISG NFV
|-
|[[ETSINFV.HELM.V_3]]
|Helm v3
|ETSI ISG NFV
|}

To register VIM connection information, the following template must be filled and submitted to NFVsupport@etsi.org: [https://nfvwiki.etsi.org/images/ETSI_NFV_VimConnectionInfoTemplate_v101.docx template]

The full process for creating and modifying information in this registry is described in annex C of [https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/ ETSI GS NFV-SOL 003].

ETSINFV.HELM.V 3

2022-04-24T15:56:52Z

Yousaf:

[[https://nfvwiki.etsi.org/index.php?title=VIM_connection_information back to VimConnectionInfo registry]]

== '''1 Solution information''' ==
{| class="wikitable"
|'''Solution Name [M]'''
|Helm v3
|-
|'''Description [M]'''
|ETSI-registered MCIOP Repository Connection Info defining the interface and access parameters to use a HelmTM-based MCIOP Repository, to be signalled via the APIs specified in ETSI GS NFV-SOL 003.
The utilization of HelmTM-based MCIOPs is specified in ETSI GS NFV-SOL 018.
Valid for HelmTM V3.
|-
|'''Specification URI [O]'''
|<nowiki>https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/018/</nowiki>
|}

== '''2 Registration information''' ==
{| class="wikitable"
|'''Registrant name [M]'''
|ETSI ISG NFV
|}

== '''3 Requested vimType identifier''' ==
{| class="wikitable"
|'''Registrant [M]'''
|
|'''VIM Name [M]'''
|
|'''Version [O]'''
|-
|ETSINFV
|'''.'''
|OPENSTACK_KEYSTONE
|'''.'''
|V_3
|}

== '''4 JSON schema definition of "interfaceInfo"''' ==
Purpose: Provides information about the interface or interfaces to the MCIOP Repository, such as the URI of an interface endpoint to communicate with the MCIOP Repository.
{| class="wikitable"
|'''interfaceInfo [M]'''
|-
|<code>{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "interfaceInfo",
"additionalProperties": false,
"required": [
"endpoint"
],
"type": "object",
"properties": {
"endpoint": {
"type": "string",
"format": "url",
"description": "The URL representing the Helm repository endpoint."
},
"serverCertificate": {
"type": "string",
"format": "byte",
"description": "Server certificate data in PEM format to be trusted in relation to the endpoint."
},
"skipCertificateVerification": {
"default": false,
"type": "boolean",
"description": "Certificate verification for the endpoint can be skipped by setting this field to true."
}
}
}</code>
|}

== '''5 JSON schema definition of "accessInfo"''' ==
Purpose: Provides authentication credentials for accessing the MCIOP Repository, and other access-related information.
{| class="wikitable"
|'''accessInfo [M]'''
|-
|<code>{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "accessInfo",
"additionalProperties": false,
"required": [
"username",
"password"
],
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "The username to use for access."
},
"password": {
"writeOnly": true,
"type": "string",
"format": "password",
"description": "The password to use for access. Required for input, not returned on output."
},
"clientCertificate": {
"type": "string",
"format": "byte",
"description": "Client certificate data in PEM format. Required only if the client certificate key is provided."
},
"clientCertificateKey": {
"type": "string",
"format": "byte",
"description": "Client certificate key data in PEM format. Required only if the client certificate is provided."
}
}
}</code>
|}

== '''6 JSON schema definition of "extra"''' ==
Purpose: Provides optional additional MCIOP Repository type specific information.
{| class="wikitable"
|'''extra [O]'''
|-
|<code>not specified</code>
|}

ETSINFV.HELM.V 3

2022-04-24T15:55:37Z

Yousaf: /* 5 JSON schema definition of "accessInfo" */

[[https://nfvwiki.etsi.org/index.php?title=VIM_connection_information back to VimConnectionInfo registry]]

== '''1 Solution information''' ==
{| class="wikitable"
|'''Solution Name [M]'''
|Helm v3
|-
|'''Description [M]'''
|ETSI-registered MCIOP Repository Connection Info defining the interface and access parameters to use a HelmTM-based MCIOP Repository, to be signalled via the APIs specified in ETSI GS NFV-SOL 003.
The utilization of HelmTM-based MCIOPs is specified in ETSI GS NFV-SOL 018.
Valid for HelmTM V3.
|-
|'''Specification URI [O]'''
|<nowiki>https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/018/</nowiki>
|}

== '''2 Registration information''' ==
{| class="wikitable"
|'''Registrant name [M]'''
|ETSI ISG NFV
|}

== '''3 Requested vimType identifier''' ==
{| class="wikitable"
|'''Registrant [M]'''
|
|'''VIM Name [M]'''
|
|'''Version [O]'''
|-
|ETSINFV
|'''.'''
|OPENSTACK_KEYSTONE
|'''.'''
|V_3
|}

== '''4 JSON schema definition of "interfaceInfo"''' ==
Purpose: Provides information about the interface or interfaces to the MCIOP Repository, such as the URI of an interface endpoint to communicate with the MCIOP Repository.
{| class="wikitable"
|'''interfaceInfo [M]'''
|-
|<code>
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "interfaceInfo",
"additionalProperties": false,
"required": [
"endpoint"
],
"type": "object",
"properties": {
"endpoint": {
"type": "string",
"format": "url",
"description": "The URL representing the Helm repository endpoint."
},
"serverCertificate": {
"type": "string",
"format": "byte",
"description": "Server certificate data in PEM format to be trusted in relation to the endpoint."
},
"skipCertificateVerification": {
"default": false,
"type": "boolean",
"description": "Certificate verification for the endpoint can be skipped by setting this field to true."
}
}
}
</code>
|}

== '''5 JSON schema definition of "accessInfo"''' ==
Purpose: Provides authentication credentials for accessing the MCIOP Repository, and other access-related information.
{| class="wikitable"
|'''accessInfo [M]'''
|-
|<code>{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "accessInfo",
"additionalProperties": false,
"required": [
"username",
"password"
],
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "The username to use for access."
},
"password": {
"writeOnly": true,
"type": "string",
"format": "password",
"description": "The password to use for access. Required for input, not returned on output."
},
"clientCertificate": {
"type": "string",
"format": "byte",
"description": "Client certificate data in PEM format. Required only if the client certificate key is provided."
},
"clientCertificateKey": {
"type": "string",
"format": "byte",
"description": "Client certificate key data in PEM format. Required only if the client certificate is provided."
}
}
}
</code>
|}

== '''6 JSON schema definition of "extra"''' ==
Purpose: Provides optional additional MCIOP Repository type specific information.
{| class="wikitable"
|'''extra [O]'''
|-
|<code>not specified</code>
|}

ETSINFV.HELM.V 3

2022-04-24T15:55:18Z

Yousaf: /* 4 JSON schema definition of "interfaceInfo" */

ETSINFV.HELM.V 3

2022-04-24T15:54:18Z

Yousaf: VIM Registry for Helm based on NFVSOL(21)000137r1

ETSINFV.HELM.V 3

2022-04-24T15:51:31Z

VIM connection information

2022-04-24T15:49:45Z

Yousaf:

This is the ETSI NFV SOL Registry for VIM connection information. VIM connection information are parameters used by a VNFM to connect to a VIM, CISM, CIR and MCIOP repository for managing the resources of a VNF instance. Further information on VIM connection information is available in [https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/ ETSI GS NFV-SOL 003].
{| class="wikitable"
|+
!Identifier
!Solution name
!Registrant
|-
|[[ETSINFV.OPENSTACK_KEYSTONE.V_2]]
|OpenStack with Keystone V2
|ETSI ISG NFV
|-
|[[ETSINFV.OPENSTACK_KEYSTONE.V_3]]
|OpenStack with Keystone V3
|ETSI ISG NFV
|-
|[[ETSINFV.KUBERNETES.V_1]]
|Kubernetes v1
|ETSI ISG NFV
|-
|[[ETSINFV.HELM.V_3]]
|Helm v3
|ETSI ISG NFV
|}

To register VIM connection information, the following template must be filled and submitted to NFVsupport@etsi.org: [https://nfvwiki.etsi.org/images/ETSI_NFV_VimConnectionInfoTemplate_v101.docx template]

The full process for creating and modifying information in this registry is described in annex C of [https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/ ETSI GS NFV-SOL 003].

ETSINFV.KUBERNETES.V 1

2022-04-24T15:46:32Z

Yousaf:

<nowiki>Insert non-formatted text here</nowiki>[[https://nfvwiki.etsi.org/index.php?title=VIM_connection_information back to VimConnectionInfo registry]]

== '''1 Solution information''' ==
{| class="wikitable"
|'''Solution Name [M]'''
|Kubernetes v1
|-
|'''Description [M]'''
|ETSI-registered CISM Connection Info defining the interface and access parameters to use a Kubernetes®-based CISM, to be signalled via the APIs specified in ETSI GS NFV-SOL 003.
The API of a Kubernetes®-based CISM is specified in ETSI GS NFV-SOL 018.
Valid for Kubernetes® releases starting from 1.22.
|-
|'''Specification URI [O]'''
|[https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/ https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/018/]
|}

== '''2 Registration information''' ==
{| class="wikitable"
|'''Registrant name [M]'''
|ETSI ISG NFV
|}

== '''3 Requested vimType identifier''' ==
{| class="wikitable"
|'''Registrant [M]'''
|
|'''VIM Name [M]'''
|
|'''Version [O]'''
|-
|ETSINFV
|'''.'''
|KUBERNETES
|'''.'''
|V_1
|}

== '''4 JSON schema definition of "interfaceInfo"''' ==
Purpose: Provides information about the interface or interfaces to the CISM, such as the URI of an interface endpoint to communicate with the CISM
{| class="wikitable"
|'''interfaceInfo [M]'''
|-
|
<code>{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "interfaceInfo",
"additionalProperties": false,
"required": [
"authType",
"endpoint"
],
"type": "object",
"properties": {
"authType": {
"type": "string",
"enum": ["OID", "TOKEN", "CERTIFICATE"],
"description": "The authentication type for the Kubernetes cluster. Indicates the required access information."
},
"endpoint": {
"type": "string",
"format": "url",
"description": "The URL representing the Kubernetes cluster API endpoint."
},
"serverCertificate": {
"type": "string",
"format": "byte",
"description": "CA certificate of the Kubernetes cluster API server in PEM format."
},
"skipCertificateVerification": {
"default": false,
"type": "boolean",
"description": "Certificate verification for the endpoint can be skipped by setting this field to true."
}
}
}

|}

== '''5 JSON schema definition of "accessInfo"''' ==
Purpose: Provides authentication credentials for accessing the CISM, and other access-related information.
{| class="wikitable"
|'''accessInfo [M]'''
|-
|
<code>{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "accessInfo",
"additionalProperties": false,
"required": [],
"type": "object",
"properties": {
"tokenAuthInfo": {
"type": "object",
"description": "The authentication credentials for token-based authentication."
"properties": {
"token": {
"type": "string",
"format": "byte",
"description": "Binary token to be used for access authentication."
}
},
"required": [
"token"
],
},
"certificateAuthInfo": {
"type": "object",
"description": "The authentication credentials for certificate-based authentication."
"properties": {
"clientCertificate": {
"type": "string",
"format": "byte",
"description": "Kubernetes client certificate data in PEM format."
},
"clientCertificateKey": {
"type": "string",
"format": "byte",
"description": "Kubernetes client certificate key data in PEM format."
}
},
"required": [
"clientCertificate",
"clientCertificateKey"
],
},
"oidAuthInfo": {
"type": "object",
"description": "The authentication credentials for Open ID-based authentication."
"properties": {
"username": {
"type": "string",
"description": "The username to use for access."
},
"password": {
"writeOnly": true,
"type": "string",
"format": "password",
"description": "The password for the username for access. Required for input, not returned on output."
},
"clientId": {
"type": "string",
"description": "An ID which identifies an client application to use for access."
},
"clientSecret": {
"writeOnly": true,
"type": "string",
"format": "password",
"description": "The secret for the clientId for access. Required for input, not returned on output."
},
"remoteServerCertificate": {
"type": "string",
"format": "byte",
"description": "CA certificate data of the Open ID API server in PEM format."
},
"skipCertificateVerification": {
"default": false,
"type": "boolean",
"description": "Certificate verification for the remote server can be skipped by setting this field to true."
}
},
"required": [
"username",
"password",
"clientId"
],
}
}
}

|}

== '''6 JSON schema definition of "extra"''' ==
Purpose: Provides optional additional CISM type specific information.
{| class="wikitable"
|'''extra [O]'''
|-
|<code>not specified</code>
|}

ETSINFV.DOCKER.V 2

2022-04-24T15:11:16Z

Yousaf: /* 6 JSON schema definition of "extra" */

ETSINFV.DOCKER.V 2

2022-04-24T15:10:59Z

Yousaf:

ETSINFV.KUBERNETES.V 1

2022-04-24T15:06:40Z

Yousaf: /* 4 JSON schema definition of "interfaceInfo" */

<nowiki>Insert non-formatted text here</nowiki>[[https://nfvwiki.etsi.org/index.php?title=VIM_connection_information back to VimConnectionInfo registry]]

== '''1 Solution information''' ==
{| class="wikitable"
|'''Solution Name'''
|Kubernetes v1
|-
|'''Description'''
|ETSI-registered CISM Connection Info defining the interface and access parameters to use a Kubernetes®-based CISM, to be signalled via the APIs specified in ETSI GS NFV-SOL 003.
The API of a Kubernetes®-based CISM is specified in ETSI GS NFV-SOL 018.
Valid for Kubernetes® releases starting from 1.22.
|-
|'''Specification URI'''
|[https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/ https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/018/]
|}

== '''2 Registration information''' ==
{| class="wikitable"
|'''Registrant name'''
|ETSI ISG NFV
|}

== '''3 Requested vimType identifier''' ==
{| class="wikitable"
|'''Registrant'''
|
|'''VIM Name'''
|
|'''Version'''
|-
|ETSINFV
|'''.'''
|KUBERNETES
|'''.'''
|V_1
|}

== '''4 JSON schema definition of "interfaceInfo"''' ==
Purpose: Provides information about the interface or interfaces to the CISM, such as the URI of an interface endpoint to communicate with the CISM
{| class="wikitable"
|'''interfaceInfo [M]'''
|-
|
<code>{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "interfaceInfo",
"additionalProperties": false,
"required": [
"authType",
"endpoint"
],
"type": "object",
"properties": {
"authType": {
"type": "string",
"enum": ["OID", "TOKEN", "CERTIFICATE"],
"description": "The authentication type for the Kubernetes cluster. Indicates the required access information."
},
"endpoint": {
"type": "string",
"format": "url",
"description": "The URL representing the Kubernetes cluster API endpoint."
},
"serverCertificate": {
"type": "string",
"format": "byte",
"description": "CA certificate of the Kubernetes cluster API server in PEM format."
},
"skipCertificateVerification": {
"default": false,
"type": "boolean",
"description": "Certificate verification for the endpoint can be skipped by setting this field to true."
}
}
}

|}

== '''5 JSON schema definition of "accessInfo"''' ==
Purpose: Provides authentication credentials for accessing the CISM, and other access-related information.
{| class="wikitable"
|'''accessInfo [M]'''
|-
|
<code>{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "accessInfo",
"additionalProperties": false,
"required": [],
"type": "object",
"properties": {
"tokenAuthInfo": {
"type": "object",
"description": "The authentication credentials for token-based authentication."
"properties": {
"token": {
"type": "string",
"format": "byte",
"description": "Binary token to be used for access authentication."
}
},
"required": [
"token"
],
},
"certificateAuthInfo": {
"type": "object",
"description": "The authentication credentials for certificate-based authentication."
"properties": {
"clientCertificate": {
"type": "string",
"format": "byte",
"description": "Kubernetes client certificate data in PEM format."
},
"clientCertificateKey": {
"type": "string",
"format": "byte",
"description": "Kubernetes client certificate key data in PEM format."
}
},
"required": [
"clientCertificate",
"clientCertificateKey"
],
},
"oidAuthInfo": {
"type": "object",
"description": "The authentication credentials for Open ID-based authentication."
"properties": {
"username": {
"type": "string",
"description": "The username to use for access."
},
"password": {
"writeOnly": true,
"type": "string",
"format": "password",
"description": "The password for the username for access. Required for input, not returned on output."
},
"clientId": {
"type": "string",
"description": "An ID which identifies an client application to use for access."
},
"clientSecret": {
"writeOnly": true,
"type": "string",
"format": "password",
"description": "The secret for the clientId for access. Required for input, not returned on output."
},
"remoteServerCertificate": {
"type": "string",
"format": "byte",
"description": "CA certificate data of the Open ID API server in PEM format."
},
"skipCertificateVerification": {
"default": false,
"type": "boolean",
"description": "Certificate verification for the remote server can be skipped by setting this field to true."
}
},
"required": [
"username",
"password",
"clientId"
],
}
}
}

|}

== '''6 JSON schema definition of "extra"''' ==
Purpose: Provides optional additional CISM type specific information.
{| class="wikitable"
|'''extra [O]'''
|-
|<code>not specified</code>
|}

ETSINFV.KUBERNETES.V 1

2022-04-24T15:05:42Z

NFVI Platform Capability Registry

2021-07-20T18:41:09Z

Yousaf: Implements NFVSO(21)000399r2

This is the ETSI registry for key/value pairs used to represent NFVI platform capabilities and settings, as part of NFV VNF descriptors (VNFD).
== '''Introduction''' ==
Some VNF suppliers make use of the underlying NFVI platform capabilities in order to accelerate performance and optimize throughput of their VNF products. In order to ensure proper instantiation and operation of such VNFs, the VNF Descriptor is used to describe VNF-specific NFVI platform capability requirements that will be matched against the capabilities of the underlying hardware infrastructure resources, in order to ensure that appropriate resources are used for instantiation.

This registry is defined to specify capabilities that are generic to all vendors of NFVI platform components, as well as capabilities that are NFVI vendor specific. There are five different categories of capability requirements that can be specified in the VNFD: CPU, memory, storage, network and logical node requirements. They are defined in terms of data model (i.e. TOSCA, YANG) neutral attributes within information elements specified in ETSI GS NFV-IFA 011 version 2.5.1 and beyond.

The table below provides an overview of the information elements and attributes defined in ETSI GS NFV-IFA 011 where the capability requirements are included for each of these five categories.

{| class="wikitable"
!Category
!IFA011 Information Element
!Attribute
|-
|CPU
|VirtualCpuData
|vduCpuRequirements
|-
|MEMORY
|VirtualMemoryData
|vduMemRequirements
|-
|STORAGE
|BlockStorageData
|vduStorageRequirements
|-
| colspan="1" |NETWORK
| colspan="1" |VirtualNetworkInterfaceRequirements
| colspan="1" |networkInterfaceRequirements
|-
| colspan="1" |LOGICAL NODE
| colspan="1" |LogicalNodeRequirements
| colspan="1" |logicalNodeRequirementDetail
|}Each category corresponds to a table in the registry, with the entries in each table specifying the NFVI platform capabilities of this category. Each entry contains the following information items:
{| class="wikitable"
|+
|Name
|The name of the capability specified in lower camel case, for example memoryPageSize.
|-
|Permitted Value
|One or more permitted values used to configure the capability specified in lower camel case.This information may be omitted when a schema is specified.
|-
|Version
|The version of the capability specified as a decimal (X.X). There may be multiple versions supported. The versioning shall begin with 1.0 and be increased every time there is a change to the capability.
|-
|Schema
|The schema used to validate and configure the associated value. This information may be omitted if the list of permitted values is present. If present the schema shall be a JSON schema.
|-
|Type
|If the capability is applicable to any NFVI platform then this takes a value of "Generic". If not, the value is vendor specific such as Intel ® or ARM ®, etc.
|-
|Description
|A short description of the capability, such as “memory page size.
|}
The process for creating entries in this registry is subject to a governance process described in [[HPC registry operation | HPC registry operation]].

== '''The Registry''' ==

The entries in the tables below represent NFVI capabilities supported by NFVI vendors of NFVI components. When a capability is identified as "Generic" it implies the capability is applicable to any NFVI platform. Otherwise the NFVI capability is specified as vendor specific and thus is only supported by NFVI platform components provided by that vendor.

=== CPU Requirements – Example entry in the Registry ===
{| class="wikitable"
|'''Name'''
|'''Permitted Value'''
|'''Version'''
|'''Schema'''
|'''Type'''
|'''Description'''
|-
|cpuModelSpecificationBinding
|strictBinding

equalOrBetterBinding
|1.0
|
|Generic
|VDUs may be developed, compiled, optimized or validated on particular CPU models. Some deployments may wish to permit the VDU to be deployed on a platform with the specified CPU only, or with an alternative CPU with the same architecture, instruction set, and if specified, instruction set extensions, or with a CPU of equivalent or greater capability.
|}

=== Memory Requirements – Example entry in the Registry ===
{| class="wikitable"
|'''Name'''
|'''Permitted Value'''
|'''Version'''
|'''Schema'''
|'''Type'''
|'''Description'''
|-
|memoryPageSize
|ANY, 4KB, 2MB, 1GB
|1.0
|
|Generic
|Memory page size
|}

=== Storage Requirements – Example entry in the Registry ===
{| class="wikitable"
|'''Name'''
|'''Permitted Value'''
|'''Version'''
|'''Schema'''
|'''Type'''
|'''Description'''
|-
|storageLops
|0..N
|1.0
|
|Generic
|Required storage characteristics (e.g. speed), including Key Quality Indicators (KQIs) for performance and reliability/availability
|-
|storageResilencyMechanism
|Erasure

tripleReplication
|1.0
|
|Generic
|Erasure code based back-end, triple replication based back-end for ensuring data resiliency.
|}

=== Network Requirements – Example entry in the Registry ===
{| class="wikitable"
|'''Name'''
|'''Permitted Value'''
|'''Version'''
|'''Schema'''
|'''Type'''
|'''Description'''
|-
|nicFeature
|LSO, LRO, RSS, RDMA
|1.0
|
|Generic
|Long list of NIC related items such as LSO, LRO, RSS, RDMA, etc
|}

=== Logical Node Requirement Detail ===
The logical node requirements are broken-out into three types: Compute, Memory, and I/O.

==== Logical Node Compute Requirements – Example entry in the Registry ====
{| class="wikitable"
|'''Name'''
|'''Permitted Value'''
|'''Version'''
|'''Schema'''
|'''Type'''
|'''Description'''
|-
|numberCpu
|0..N
|1.0
|
|Generic
|Number of CPU cores for this logical node. The cumulative number of CPU requests per node must equal the VDU level numVirtualCpu requirement.
|}

==== Logical Node Memory Requirements – Example entry in the Registry ====
{| class="wikitable"
|'''Name'''
|'''Permitted Value'''
|'''Version'''
|'''Schema'''
|'''Type'''
|'''Description'''
|-
|localNumaMemorySize
|0..N
|1.0
|
|Generic
|The amount of memory that needs to be collocated with this specific logical (NUMA) node.
|}

==== Logical Node I/O Requirements – Example entry in the Registry ====
{| class="wikitable"
|'''Name'''
|'''Permitted Value'''
|'''Version'''
|'''Schema'''
|'''Type'''
|'''Description'''
|-
|pciVendorId
|
|1.0
|
|Generic
|PCI-SIG vendor ID for the device
|}

== '''Mappings to Specific Data Models''' ==

=== Mapping to ETSI GS NFV-SOL 001 data model (TOSCA<ins>)</ins> ===

==== Mapping Table ====
For each of the five platform capability categories - CPU, memory, storage, network and logical node - the associated attribute defined in ETSI GS NFV-IFA 011 is mapped to a property of type “map of string” of a TOSCA data type specified in ETSI GS NFV-SOL 001. The following table describes for each attribute defined in ETSI GS NFV-IFA 011 and representing one of these five categories, the corresponding TOSCA property, the TOSCA data type where this property is used and the TOSCA node type where this data type is used, in accordance with ETSI GS NFV-SOL<ins> </ins>001 v2.5.1 and beyond.
{| class="wikitable"
|'''Category'''
|'''IFA011 Attribute'''
|'''As Property'''
|'''Data Type Defined in SOL001'''
|'''Used in SOL001'''
|-
|CPU
|vduCpuRequirements
|vdu_cpu_requirements
|<ins>tosca.datatypes.nfv.VirtualCpu</ins>
|tosca.nodes.nfv.Vdu.Compute
|-
|Memory
|vduMemRequirements
|vdu_mem_requirements
|<ins>tosca.datatypes.nfv.VirtualMemory</ins>
|tosca.nodes.nfv.Vdu.Compute
|-
|Network
|networkInterfaceRequirements
|network_interface_requirements
|<ins>tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements</ins>
|tosca.nodes.nfv.VduCp

tosca.nodes.nfv.VnfExtCp
|-
|Storage
|vduStorageRequirements
|vdu_storage_requirements
|<ins>tosca.datatypes.nfv.VirtualBlockStorageData</ins>
|tosca.nodes.nfv.Vdu.VirtualBlockStorage

<ins> </ins>
|-
|Logical Node
|logicalNodeRequirementDetail
|logical_node_requirements
|<ins>tosca.datatypes.nfv.LogicalNodeData</ins>
|tosca.nodes.nfv.Vdu.Compute
|}

==== Key/Value Pair Entry Format ====
Each entry in the hash maps defined above fully defines a single NFVI platform capability. Within a given hash map entry, the "key" portion of the entry contains the capability name (as defined in the registry) and the "value" portion contains structured data in the form of key value pairs as described in the following table.
{| class="wikitable"
|'''Array Entry'''
|'''Values'''
|-
|<key>
|A string specifying the name of a given NFVI platform capability as defined in the "name" element of an entry of a given registry table.
|-
|<value>
|An optional map of key-value pairs describing the configuration value of a given capability, where the key-value pairs are defined as follows
|-
|
|
{| class="wikitable"
|'''key'''
|'''type'''
|'''value'''
|-
|version
|string
|A quoted string describing the version of the capability. This is taken from the “version” element of an entry of a given registry table. If absent, any version of the capability can be used to fulfil the requirement.
|-
|mandatory
|string
|A boolean value expressed in quoted string type specifying whether the requested capability is mandatory for proper operation of the VNF. The value of "true" indicates that a given NFVI platform capability must be present. The value of "false" indicates that the VNF can function with or without the capability. If absent, the value of “false” is assumed.
|-
|configurationValue
|string
|A quoted string describing the configuration value of a given capability, as defined by the schema or the permitted values specified in the registry. If absent, no particular configuration is required.
|}
|-
|...
|Structured data representing the NFVI platform capability configuration value-specific attributes can vary from a single attribute to complex permutations of simple attributes, lists and hash maps.
|}

==== Examples ====

===== CPU NFVI Capabilities =====
Usage of vdu_cpu_requirements key-value pairs as specified in tosca.nodes.nfv.Vdu.Compute. Note in this example that there is one NFVI capability being defined: simulatenousMultiThreading. This is the “key”. The associated “value” is composed of a specification of "mandatory" and "configurationValue" which form a complex value.

<some entity>

...

 properties:

 vdu_cpu_requirements:

 simultaneousMultiThreading: |

 mandatory: "true"

 configurationValue: "enabled"

...

===== Memory Hardware Capabilities =====
Usage of vdu_mem_requirements key-value pairs as specified in tosca.nodes.nfv.Vdu.Compute. Note in this example that there are two NFVI capabilities being defined: memoryPageSize and numberOfPages. These are the “keys”. Each associated “value” is composed of a specification of: "mandatory" and "configurationValue" which form a complex value.

<some entity>

...

properties:

vdu_mem_requirements: |

 memoryPageSize:

 mandatory: "true"

 configurationValue: "2 MB"

 numberOfPages: |

 mandatory: "true"

 configurationValue: "1024"

...

...

===== Storage Hardware Capabilities =====
Usage of vdu_storage_requirements key-value pairs as specified in tosca.nodes.nfv.Vdu.VirtualBlockStorage. Note in this example that there is one NFVI capability being defined: storageResiliencyMechanism. This is the “key”. The associated “value” is composed of a specification of "mandatory" and "configurationValue" which form a complex value.

<some entity>

...

properties:

vdu_storage_requirements:

 storageResiliencyMechanism: |

 mandatory: "true"

 configurationValue: "tripleReplication"

...

...

===== Network Hardware Capabilities =====
Usage of network_interface_requirements key-value pairs as specified in tosca.nodes.nfv.VduCp or tosca.nodes.nfv.VnfExtCp. Note in this example that there is one NFVI capability being defined: dataProcessingAccelerationLibrary. This is the “key”. The associated “value” is composed of a specification of "mandatory" and "configurationValue" which form a complex value.

<some entity>

...

properties:

network_interface_requirements:

 dataProcessingAccelerationLibrary: |

 mandatory: "true"

 configurationValue: "dpdk"

...

...

===== Logical Node Hardware Capabilities =====
Usage of logical_node_requirements key-value pairs pairs as specified in tosca.nodes.nfv.Vdu.Compute. Note in this example that there are three NFVI capabilities being defined: numberCpu, localNumaMemorySize, and pciDeviceLocalToNumaNode. These are the “keys”. Each associated “value” is composed of a specification of "mandatory" and "configurationValue" which form a complex value.

<some entity>

...

properties:

logical_node_requirements:

 numberCpu: |

 mandatory: "true"

 configurationValue: "1"

 localNumaMemorySize: |

 mandatory: "true"

 configurationValue: "4096"

 pciDeviceLocalToNumaNode: |

 mandatory: "true"

 configurationValue: "required"

...

...

==== Mapping to ETSI NFV-SOL 006 data model (YANG) ====
To be defined

== '''Registration process''' ==
[https://nfvwiki.etsi.org/index.php?title=File:Template_Capability_registration_template_for_HPC_registry.docx Link to Registration Template]

[https://nfvwiki.etsi.org/index.php?title=HPC_registry_operation Operation of the Registry]