ETSINFV.DOCKER.V 2: Difference between revisions

Latest revision as of 11:05, 26 April 2022

1 Solution information

Solution Name [M]	Docker v2
Description [M]	ETSI-registered CIR Connection Info defining the interface and access parameters to use a Docker^TM-based CIR, to be signalled via the APIs specified in ETSI GS NFV-SOL 003. The API of a Docker^TM-based CIR is specified in ETSI GS NFV-SOL 018. Valid for Docker^TM Registry API V2.
Specification URI [O]	https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/018/

2 Registration information

Registrant name [M]	ETSI ISG NFV

3 Requested vimType identifier

Registrant [M]		VIM Name [M]		Version [O]
ETSINFV	.	DOCKER	.	V_2

4 JSON schema definition of "interfaceInfo"

Purpose: Provides information about the interface or interfaces to the CIR, such as the URI of an interface endpoint to communicate with the CIR.

interfaceInfo [M]

{


  "$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 Docker registry endpoint. The endpoint consists out of the address URL of the registry and the repository path, e.g. <registry url>/<repoPath>"
     },
     "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."
     }
  }

}

5 JSON schema definition of "accessInfo"

Purpose: Provides authentication credentials for accessing the CIR, and other access-related information.

accessInfo [M]

{


  "$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."
     }
   }

}

6 JSON schema definition of "extra"

Purpose: Provides optional additional CIR type specific information.

extra [O]
`not specified`

@@ Line 1: / Line 1: @@
-<nowiki>Insert non-formatted text here</nowiki>[[https://nfvwiki.etsi.org/index.php?title=VIM_connection_information back to VimConnectionInfo registry]]
+[[https://nfvwiki.etsi.org/index.php?title=VIM_connection_information back to VimConnectionInfo registry]]
 == '''1 Solution information''' ==
 {| class="wikitable"
-|'''Solution Name'''
+|'''Solution Name [M]'''
 |Docker v2
 |-
-|'''Description'''
+|'''Description [M]'''
 |ETSI-registered CIR Connection Info defining the interface and access parameters to use a Docker<sup>TM</sup>-based CIR, to be signalled via the APIs specified in ETSI GS NFV-SOL 003.
 The API of a Docker<sup>TM</sup>-based CIR is specified in ETSI GS NFV-SOL 018.
 Valid for Docker<sup>TM</sup> Registry API V2.
 |-
-|'''Specification  URI'''
+|'''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/]
+|https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/018/
 |}
 == '''2 Registration information''' ==
 {| class="wikitable"
-|'''Registrant name'''
+|'''Registrant name [M]'''
 |ETSI ISG NFV
 |}
@@ Line 23: / Line 23: @@
 == '''3 Requested vimType identifier''' ==
 {| class="wikitable"
-|'''Registrant'''
+|'''Registrant [M]'''
 |
-|'''VIM Name'''
+|'''VIM Name [M]'''
 |
-|'''Version'''
+|'''Version [O]'''
 |-
 |ETSINFV
@@ Line 39: / Line 39: @@
 Purpose: Provides information about the interface or interfaces to the CIR, such as the URI of an interface endpoint to communicate with the CIR.
 {| class="wikitable"
-|'''interfaceInfo'''
+|'''interfaceInfo [M]'''
 |-
 |
-<code> JSON Schema Here</code>
+<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 Docker registry endpoint. The endpoint consists out of the address URL of the registry and the repository path, e.g. <registry url>/<repoPath>"
+      },
+      "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> </code>
+}</code>
 |}
 == '''5 JSON schema definition of "accessInfo"''' ==
-Purpose: Provides authentication credentials for accessing the VIM, and other access-related information such as tenants or infrastructure resource groups.
+Purpose: Provides authentication credentials for accessing the CIR, and other access-related information.
 {| class="wikitable"
-|'''accessInfo'''
+|'''accessInfo [M]'''
 |-
 |
-<code> JSON Schema here </code>
+<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 VIM type specific information.
+Purpose: Provides optional additional CIR type specific information.
 {| class="wikitable"
-|'''extra'''
+|'''extra [O]'''
 |-
 |<code>not specified</code>
 |}