ETSINFV.DOCKER.V 2: Difference between revisions

From NFVwiki
Line 73: Line 73:


== '''5 JSON schema definition of "accessInfo"''' ==
== '''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"
{| class="wikitable"
|'''accessInfo'''
|'''accessInfo'''
|-
|-
|
|
<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>
|}
|}



Revision as of 15:01, 24 April 2022

Insert non-formatted text here[back to VimConnectionInfo registry]

1 Solution information

Solution Name Docker v2
Description ETSI-registered CIR Connection Info defining the interface and access parameters to use a DockerTM-based CIR, to be signalled via the APIs specified in ETSI GS NFV-SOL 003.

The API of a DockerTM-based CIR is specified in ETSI GS NFV-SOL 018. Valid for DockerTM Registry API V2.

Specification URI https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/018/

2 Registration information

Registrant name ETSI ISG NFV

3 Requested vimType identifier

Registrant VIM Name Version
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

{

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

{

  "$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 VIM type specific information.

extra
not specified