Commit 5ec7662e authored by Mudassar Khan's avatar Mudassar Khan Committed by Giacomo Bernini
Browse files

update response body schema as per SOL 003 version 5.1.1

parent 173aa8e0
Loading
Loading
Loading
Loading
+35 −7
Original line number Diff line number Diff line
@@ -771,7 +771,7 @@
                              }
                            },
                            "virtualCpAddress": {
                              "description": "This type represents network address data for a virtual CP.\n* NOTE 1: If the container cluster is set up to be able to configure an external load balancer this address will be used,\n          otherwise it will be ignored by the CISM.\n* NOTE 2: In case the cluster can configure an external load balancer but no loadBalancerIp is provided the container\n          cluster will assign an IP address.\n* NOTE 3: The attribute is only relevant if the virtual CP is instantiated in a cluster that supports configuration of IP\n          address pools for virtual CPs. Otherwise it shall be ignored. MetalLB is an example of a solution for\n          Kubernetes® that supports configuration of address pools for load balancer services.\n* NOTE 4: The loadBalancerIp and the addressPoolName attributes shall not be present at the same time.\n",
                              "description": "This type represents network address data for a virtual CP.\n* NOTE 1: The loadBalancerIp and the loadBalancerSourceRanges attributes are only used if the CIS cluster is set up to be \n          able to configure an external load balancer. Otherwise it shall be ignored.\n* NOTE 2: In case the cluster can configure an external load balancer but no loadBalancerIp is provided the container\n          cluster will assign an IP address.\n* NOTE 3: The attribute is only relevant if the virtual CP is instantiated in a cluster that supports configuration of IP\n          address pools for virtual CPs. Otherwise it shall be ignored. MetalLB is an example of a solution for\n          Kubernetes® that supports configuration of address pools for load balancer services.\n* NOTE 4: The loadBalancerIp, addressPoolName and the externalIp attributes shall not be present at the same time.               \n",
                              "type": "object",
                              "required": [
                                "type"
@@ -790,9 +790,37 @@
                                  "type": "string",
                                  "format": "IP"
                                },
                                "externalIp": {
                                  "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
                                  "type": "string",
                                  "format": "IP"
                                },
                                "addressPoolName": {
                                  "description": "Name of an address pool from which the container cluster will assign an IP address to the virtual CP. See notes 3 and 4.\n",
                                  "description": "Name of an address pool from which the CIS cluster will assign an IP address to the virtual CP. See notes 3 and 4.\n",
                                  "type": "string"
                                },
                                "loadBalancerSourceRanges": {
                                  "description": "List of client IP address ranges allowed to access an external load balancer. See note 1.\n",
                                  "type": "array",
                                  "items": {
                                    "type": "object",
                                    "required": [
                                      "minAddress",
                                      "maxAddress"
                                    ],
                                    "properties": {
                                      "minAddress": {
                                        "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
                                        "type": "string",
                                        "format": "IP"
                                      },
                                      "maxAddress": {
                                        "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
                                        "type": "string",
                                        "format": "IP"
                                      }
                                    }
                                  }
                                }
                              }
                            }
@@ -825,7 +853,7 @@
                    "resourceId"
                  ],
                  "type": "object",
                  "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n* NOTE 1: The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or CISM or the resource \n          provider and can be used as information that complements the ResourceHandle. This value set is different from \n          the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2). When the container \n          infrastructure service management is a Kubernetes® instance the vimLevelResourceType is the type of \n          resource, as would correspond to the 'kind' field if the resource is declared in its own Kubernetes® manifest, \n          e.g.: Pod, PersistentVolumeClaim, NetworkAttachmentDefinition.\n* NOTE 2: When the container infrastructure service management is a Kubernetes® instance the resourceId shall be \n          populated in the following way:\n          - For a compute MCIO, it is the instance identifier that Kubernetes® assigns, which is unique cluster wide \n          per resource type.\n          - For a storage MCIO modelled as a persistent volume claim, it is the name of the persistent volume claim, \n          i.e. the value of the 'claimName' field in the Kubernetes® manifest, or a compound name built by \n          Kubernetes® if the persistent volume claim is defined inline in another template instead of in its own \n          manifest.\n          - For a network MCIO representing a NetworkAttachmentDefinition, a Service or an Ingress, it is the value of \n          the 'metadata.name' field in Kubernetes® manifest.\n",
                  "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n* NOTE 1: The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or CISM or the resource \n          provider and can be used as information that complements the ResourceHandle. This value set is different from \n          the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2). When the container \n          infrastructure service management is a Kubernetes® instance the vimLevelResourceType is the type of \n          resource, as would correspond to the 'kind' field if the resource is declared in its own Kubernetes® manifest, \n          e.g.: Pod, PersistentVolumeClaim, NetworkAttachmentDefinition.\n\n* NOTE 2: When the container infrastructure service management is a Kubernetes® instance the resourceId shall be \n          populated in the following way:\n          - For a compute MCIO, it is the instance identifier that Kubernetes® assigns, which is unique cluster wide \n          per resource type.\n          - For a storage MCIO modelled as a persistent volume claim, it is the name of the persistent volume claim, \n          i.e. the value of the 'claimName' field in the Kubernetes® manifest, or a compound name built by \n          Kubernetes® if the persistent volume claim is defined inline in another template instead of in its own \n          manifest.\n          - For a network MCIO representing a NetworkAttachmentDefinition, a Service or an Ingress, it is the value of \n          the 'metadata.name' field in Kubernetes® manifest.\n",
                  "properties": {
                    "vimConnectionId": {
                      "description": "An identifier with the intention of being globally unique.\n",
@@ -946,7 +974,7 @@
      "description": "Information about internal VLs that are managed by other entities than the VNFM. See notes 4, 5, 7 and 8.\n",
      "type": "array",
      "items": {
        "description": "This type represents an externally-managed internal VL.\n* NOTE 1: It is only applicable if the externally-managed VL is realized by a secondary container cluster network. It shall\n          not be present otherwise.\n* NOTE 2: A link port is not needed for a VNFC internal connection point connected to a secondary container cluster\n          network.\n* NOTE 3: An example of the network attachment definition resource when the container infrastructure service\n          management is a Kubernetes® instance is a network attachment definition (NAD).\n* NOTE 4: In the case that the cloud native template included in the MCIOP describes the set of VNFC instances, an \n          instance of intCp need not be included for each VNFC instance as all instances would contain the same \n          information. It is sufficient to include one intCp for the related CPD. The case of using, for a scalable VDU, a \n          cloud native template in the MCIOP that describes one single VNFC instance is not specified in the present \n          document version\n",
        "description": "This type represents an externally-managed internal VL.\n* NOTE 1: It is only applicable if the externally-managed VL is realized by a secondary container cluster network. It shall\n          not be present otherwise.\n* NOTE 2: A link port is not needed for a VNFC internal connection point connected to a secondary container cluster\n          network.\n* NOTE 3: An example of the network attachment definition resource when the container infrastructure service\n          management is a Kubernetes® instance is a network attachment definition (NAD).\n\n* NOTE 4: In the case that the cloud native template included in the MCIOP describes the set of VNFC instances, an \n          instance of intCp need not be included for each VNFC instance as all instances would contain the same \n          information. It is sufficient to include one intCp for the related CPD. The case of using, for a scalable VDU, a \n          cloud native template in the MCIOP that describes one single VNFC instance is not specified in the present \n          document version\n",
        "type": "object",
        "required": [
          "id",
@@ -994,7 +1022,7 @@
                    "resourceId"
                  ],
                  "type": "object",
                  "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n* NOTE 1: The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or CISM or the resource \n          provider and can be used as information that complements the ResourceHandle. This value set is different from \n          the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2). When the container \n          infrastructure service management is a Kubernetes® instance the vimLevelResourceType is the type of \n          resource, as would correspond to the 'kind' field if the resource is declared in its own Kubernetes® manifest, \n          e.g.: Pod, PersistentVolumeClaim, NetworkAttachmentDefinition.\n* NOTE 2: When the container infrastructure service management is a Kubernetes® instance the resourceId shall be \n          populated in the following way:\n          - For a compute MCIO, it is the instance identifier that Kubernetes® assigns, which is unique cluster wide \n          per resource type.\n          - For a storage MCIO modelled as a persistent volume claim, it is the name of the persistent volume claim, \n          i.e. the value of the 'claimName' field in the Kubernetes® manifest, or a compound name built by \n          Kubernetes® if the persistent volume claim is defined inline in another template instead of in its own \n          manifest.\n          - For a network MCIO representing a NetworkAttachmentDefinition, a Service or an Ingress, it is the value of \n          the 'metadata.name' field in Kubernetes® manifest.\n",
                  "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n* NOTE 1: The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or CISM or the resource \n          provider and can be used as information that complements the ResourceHandle. This value set is different from \n          the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2). When the container \n          infrastructure service management is a Kubernetes® instance the vimLevelResourceType is the type of \n          resource, as would correspond to the 'kind' field if the resource is declared in its own Kubernetes® manifest, \n          e.g.: Pod, PersistentVolumeClaim, NetworkAttachmentDefinition.\n\n* NOTE 2: When the container infrastructure service management is a Kubernetes® instance the resourceId shall be \n          populated in the following way:\n          - For a compute MCIO, it is the instance identifier that Kubernetes® assigns, which is unique cluster wide \n          per resource type.\n          - For a storage MCIO modelled as a persistent volume claim, it is the name of the persistent volume claim, \n          i.e. the value of the 'claimName' field in the Kubernetes® manifest, or a compound name built by \n          Kubernetes® if the persistent volume claim is defined inline in another template instead of in its own \n          manifest.\n          - For a network MCIO representing a NetworkAttachmentDefinition, a Service or an Ingress, it is the value of \n          the 'metadata.name' field in Kubernetes® manifest.\n",
                  "properties": {
                    "vimConnectionId": {
                      "description": "An identifier with the intention of being globally unique.\n",
@@ -1069,7 +1097,7 @@
            "description": "Externally provided link ports to be used to connect VNFC connection points to this externally-managed VL on this network resource. If this attribute is not present, the VNFM shall create the link ports on the externally-managed VL. See note 2.\n",
            "type": "array",
            "items": {
              "description": "This type represents an externally provided link port to be used to connect a VNFC connection point  to an exernally managed VL.\n",
              "description": "This type represents an externally provided link port to be used to connect a VNFC connection point  to an externally managed VL.\n",
              "type": "object",
              "required": [
                "vnfLinkPortId",
@@ -1085,7 +1113,7 @@
                    "resourceId"
                  ],
                  "type": "object",
                  "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n* NOTE 1: The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or CISM or the resource \n          provider and can be used as information that complements the ResourceHandle. This value set is different from \n          the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2). When the container \n          infrastructure service management is a Kubernetes® instance the vimLevelResourceType is the type of \n          resource, as would correspond to the 'kind' field if the resource is declared in its own Kubernetes® manifest, \n          e.g.: Pod, PersistentVolumeClaim, NetworkAttachmentDefinition.\n* NOTE 2: When the container infrastructure service management is a Kubernetes® instance the resourceId shall be \n          populated in the following way:\n          - For a compute MCIO, it is the instance identifier that Kubernetes® assigns, which is unique cluster wide \n          per resource type.\n          - For a storage MCIO modelled as a persistent volume claim, it is the name of the persistent volume claim, \n          i.e. the value of the 'claimName' field in the Kubernetes® manifest, or a compound name built by \n          Kubernetes® if the persistent volume claim is defined inline in another template instead of in its own \n          manifest.\n          - For a network MCIO representing a NetworkAttachmentDefinition, a Service or an Ingress, it is the value of \n          the 'metadata.name' field in Kubernetes® manifest.\n",
                  "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n* NOTE 1: The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or CISM or the resource \n          provider and can be used as information that complements the ResourceHandle. This value set is different from \n          the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2). When the container \n          infrastructure service management is a Kubernetes® instance the vimLevelResourceType is the type of \n          resource, as would correspond to the 'kind' field if the resource is declared in its own Kubernetes® manifest, \n          e.g.: Pod, PersistentVolumeClaim, NetworkAttachmentDefinition.\n\n* NOTE 2: When the container infrastructure service management is a Kubernetes® instance the resourceId shall be \n          populated in the following way:\n          - For a compute MCIO, it is the instance identifier that Kubernetes® assigns, which is unique cluster wide \n          per resource type.\n          - For a storage MCIO modelled as a persistent volume claim, it is the name of the persistent volume claim, \n          i.e. the value of the 'claimName' field in the Kubernetes® manifest, or a compound name built by \n          Kubernetes® if the persistent volume claim is defined inline in another template instead of in its own \n          manifest.\n          - For a network MCIO representing a NetworkAttachmentDefinition, a Service or an Ingress, it is the value of \n          the 'metadata.name' field in Kubernetes® manifest.\n",
                  "properties": {
                    "vimConnectionId": {
                      "description": "An identifier with the intention of being globally unique.\n",