Newer
Older
Elian Kraja
committed
{
"type": "array",
"items":
{
"description": "This type represents the information of a VNF package. It shall comply with the provisions defined in table 9.5.2.5-1.\nNOTE 1:\tIf the value of the onboardingState attribute is not equal to \"ONBOARDED\", the value of the operationalState attribute shall be equal to \"DISABLED\". NOTE 2:\tIf the value of the onboardingState attribute is not equal to \"ONBOARDED\", the value of the usageState attribute shall be equal to \"NOT_IN_USE\". NOTE 3:\tState changes of a VNF package are illustrated in clause B.2. NOTE 4:\tETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.\n",
Elian Kraja
committed
"type": "object",
"required": ["id", "onboardingState", "operationalState", "usageState", "vnfmInfo", "_links"],
Elian Kraja
committed
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfProvider": {
"description": "Provider of the VNF package and the VNFD. This information is copied from the VNFD. It shall be present after the VNF package content has been on-boarded and absent otherwise.\n",
"type": "string"
},
"vnfProductName": {
"description": "Name to identify the VNF product.Invariant for the VNF product lifetime. This information is copied from the VNFD. It shall be present after the VNF package content has been on-boarded and absent otherwise.\n",
"type": "string"
},
"vnfSoftwareVersion": {
"description": "A Version. Representation: string of variable length.\n",
Elian Kraja
committed
"type": "string"
},
"vnfdVersion": {
"description": "A Version. Representation: string of variable length.\n",
"type": "string"
},
"compatibleSpecificationVersions": {
"description": "A Version. Representation: string of variable length.\n",
Elian Kraja
committed
"type": "string"
},
"checksum": {
"description": "This type represents the checksum of a VNF package or an artifact file.\n",
"required": ["algorithm", "hash"],
Elian Kraja
committed
"type": "object",
"properties": {
"algorithm": {
"description": "Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004 [5]. For example, SHA-256, SHA-512.\n",
"type": "string"
},
"hash": {
"description": "The hexadecimal value of the checksum.\n",
"type": "string"
}
}
},
"packageSecurityOption": {
"description": "Signals the security option used by the package as defined in clause 5.1 of ETSI GS NFV-SOL 004. It shall be present after the VNF package content has been on-boarded and absent otherwise. Valid values: - OPTION_1 - OPTION_2\n",
"type": "string",
"enum": ["OPTION_1", "OPTION_2"]
},
"signingCertificate": {
"description": "The singleton signing certificate if it is included as a file in the VNF package.\n",
"type": "string"
},
Elian Kraja
committed
"softwareImages": {
"description": "Information about VNF package artifacts that are software images. This attribute shall not be present before the VNF package content is on-boarded. Otherwise, this attribute shall be present unless it has been requested to be excluded per attribute selector.\n",
"type": "array",
"items": {
"description": "This type represents an artifact contained in or external to a VNF package which represents a software image. NOTE 1:\tThe list of permitted values was taken from \"Container formats\" in OpenStack®: \"Disk and container formats for images\". NOTE 2:\tThe list of permitted values was adapted from \"Disk formats\" in OpenStack®: \"Disk and container formats for images\".\n",
"required": ["id", "name", "provider", "version", "checksum", "isEncrypted", "containerFormat", "diskFormat", "createdAt", "minDisk", "minRam", "size", "imagePath"],
Elian Kraja
committed
"type": "object",
"properties": {
"id": {
"description": "Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n",
Elian Kraja
committed
"type": "string"
},
"name": {
"description": "Name of the software image.\n",
"type": "string"
},
"provider": {
"description": "Provider of the software image.\n",
"type": "string"
},
"version": {
"description": "A Version. Representation: string of variable length.\n",
Elian Kraja
committed
"type": "string"
},
"checksum": {
"description": "This type represents the checksum of a VNF package or an artifact file.\n",
"required": ["algorithm", "hash"],
Elian Kraja
committed
"type": "object",
"properties": {
"algorithm": {
"description": "Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004 [5]. For example, SHA-256, SHA-512.\n",
"type": "string"
},
"hash": {
"description": "The hexadecimal value of the checksum.\n",
"type": "string"
}
}
},
"isEncrypted": {
"description": "Reflects whether the image is encrypted (true) or not (false).\n",
"type": "boolean"
},
Elian Kraja
committed
"containerFormat": {
"description": "Container format indicates whether the software image is in a file format that also contains meta-data about the actual software. Permitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ram disk image format - BARE: the image does not have a container or meta-data envelope - DOCKER: docker container format - OVA: OVF package in a tar file - OVF: OVF container format\nSee note 1.\n",
Elian Kraja
committed
"type": "string",
"enum": ["AKI", "AMI", "ARI", "BARE", "DOCKER", "OVA", "OVF"]
Elian Kraja
committed
},
"diskFormat": {
"description": "Disk format of a software image is the format of the underlying disk image. Permitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - ISO: an archive format for the data contents of an optical disc, such as CD-ROM - QCOW2: a common disk image format, which can expand dynamically and supports copy on write - RAW: an unstructured disk image format - VDI: a common disk image format - VHD: a common disk image format - VHDX: enhanced version of VHD format - VMDK: a common disk image format\nSee note 2.\n",
Elian Kraja
committed
"type": "string",
"enum": ["AKI", "AMI", "ARI", "ISO", "QCOW2", "RAW", "VDI", "VHD", "VHDX", "VMDK"]
Elian Kraja
committed
},
"createdAt": {
"description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
Elian Kraja
committed
"format": "date-time"
},
"minDisk": {
"description": "The minimal disk for this software image in bytes.\n",
"type": "integer",
"minimum": 0
},
"minRam": {
"description": "The minimal RAM for this software image in bytes.\n",
"type": "integer",
"minimum": 0
},
"size": {
"description": "Size of this software image in bytes.\n",
"type": "integer",
"minimum": 0
},
"userMetadata": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
Elian Kraja
committed
"type": "object"
},
"imagePath": {
"description": "Path, which identifies the image artifact and also allows to access a copy of the image artifact. For a software image contained as a file in the VNF package, this attribute shall be present, and the value of this attribute shall start with the name of the first segment in the path in the package, i.e., it shall not be prefixed by path separator characters such as \".\" and \"/\".\nEXAMPLE:\tfoo/bar/m%40ster.vhd\nFor an external software image represented as a URI in the VNF descriptor, this attribute shall be present if the image artifact has been downloaded by the NFVO and shall be absent otherwise. If present, it shall contain the artifactPath under which the image artifact can be obtained using the \"Individual artifact in a VNF package\" resource defined in clause 9.4.7. It is the responsibility of the NFVO to synthesize this path in a manner that avoids any collision of the synthesized artifact path with the paths and names of image artifacts included in the package.\n",
Elian Kraja
committed
"type": "string"
},
"imageUri": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string",
"format": "uri"
Elian Kraja
committed
}
}
}
},
"additionalArtifacts": {
"description": "Information about VNF package artifacts contained in the VNF package that are not software images. This attribute shall not be present before the VNF package content is on-boarded. Otherwise, this attribute shall be present if the VNF package contains additional artifacts.\n",
"type": "array",
"items": {
"description": "This type represents an artifact other than a software image which is contained in or external to a VNF package. It shall comply with provisions defined in Table 9.5.3.3-1.\n",
"required": ["isEncrypted", "checksum"],
Elian Kraja
committed
"type": "object",
"properties": {
"artifactPath": {
"description": "A string as defined in IETF RFC 8259.\n",
Elian Kraja
committed
"type": "string"
},
"artifactURI": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string",
"format": "uri"
},
Elian Kraja
committed
"checksum": {
"description": "This type represents the checksum of a VNF package or an artifact file.\n",
"required": ["algorithm", "hash"],
Elian Kraja
committed
"type": "object",
"properties": {
"algorithm": {
"description": "Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004 [5]. For example, SHA-256, SHA-512.\n",
"type": "string"
},
"hash": {
"description": "The hexadecimal value of the checksum.\n",
"type": "string"
}
}
},
"isEncrypted": {
"description": "Reflects whether the artifact is encrypted (true) or not (false).\n",
"type": "boolean"
},
"nonManoArtifactSetId": {
"description": "Non-MANO artifact set identifier of the non-MANO artifact set to which the artifact belongs, as defined in clause 4.3.7 of ETSI GS NFV-SOL 004 [5]. Shall be provided if the artifact is a non-MANO artifact, and shall be omitted otherwise.\n",
"type": "string"
},
"artifactClassification": {
"description": "Marks specific types of artifacts as defined in the VNF package. If none of the specific classes listed below applies, the attribute shall not be present. Valid values: - HISTORY: a history artifact as per clause 4.3.3 in ETSI GS NFV-SOL 004 - TESTING: a testing artifact as per clause 4.3.4 in ETSI GS NFV-SOL 004 - LICENSE: a license artifact as per clause 4.3.5 in ETSI GS NFV-SOL 004\n",
"type": "string",
"enum": ["HISTORY", "TESTING", "LICENSE"]
},
Elian Kraja
committed
"metadata": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
Elian Kraja
committed
"type": "object"
}
}
}
},
"onboardingState": {
"description": "The enumeration PackageOnboardingStateType shall comply with the provisions defined in Table 9.5.4.3-1. Permitted values: - CREATED: The VNF package resource has been created. - UPLOADING: The associated VNF package content is being uploaded. - PROCESSING: The associated VNF package content is being processed, e.g. validation. - ONBOARDED: The associated VNF package content is successfully on-boarded. - ERROR: There was an error during upload of the VNF package content or external artifacts, or during VNF package processing.\n",
Elian Kraja
committed
"type": "string",
"enum": ["CREATED", "UPLOADING", "PROCESSING", "ONBOARDED", "ERROR"]
Elian Kraja
committed
},
"operationalState": {
"type": "string",
"description": "\"The enumeration PackageOperationalStateType shall comply with the provisions defined in Table 9.5.4.4-1.\" Acceptable values are: - ENABLED - The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances. - DISABLED - The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package is re-enabled).\n",
"enum": ["ENABLED", "DISABLED"]
Elian Kraja
committed
},
"usageState": {
"type": "string",
"description": "\"The enumeration PackageUsageStateType shall comply with the provisions. Acceptable values are: - IN_USE: \"Individual VNF instance\" resources created from this VNF package exist. - NOT_IN_USE: No \"individual VNF instance\" resource created from this VNF package exists.\n",
"enum": ["IN_USE", "NOT_IN_USE"]
},
"vnfmInfo": {
"description": "Specifies VNFMs compatible with the VNF. This information is copied from the VNFD. See note 4.\n",
"type": "array",
"items": {
"type": "string"
}
Elian Kraja
committed
},
"userDefinedData": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
Elian Kraja
committed
"type": "object"
},
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
"onboardingFailureDetails": {
"description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
"type": "object",
"required": ["status", "detail"],
"properties": {
"type": {
"description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
"type": "string",
"format": "URI"
}
}
},
Elian Kraja
committed
"_links": {
"type": "object",
"description": "Links to resources related to this resource.\n",
"required": ["self", "packageContent", "vnfd"],
Elian Kraja
committed
"properties": {
"self": {
"description": "This type represents a link to a resource.\n",
"type": "object",
Elian Kraja
committed
"properties": {
"href": {
"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
Elian Kraja
committed
"type": "string",
"format": "url"
}
}
},
"vnfd": {
"description": "This type represents a link to a resource.\n",
"type": "object",
Elian Kraja
committed
"properties": {
"href": {
"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
Elian Kraja
committed
"type": "string",
"format": "url"
}
}
},
"packageContent": {
"description": "This type represents a link to a resource.\n",
"type": "object",
Elian Kraja
committed
"properties": {
"href": {
"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",