Loading docker/Dockerfile +2 −0 Original line number Diff line number Diff line Loading @@ -13,6 +13,8 @@ RUN apk add openjdk8 RUN apk add ca-certificates wget && update-ca-certificates RUN apk add openssl RUN gem install rdoc -v 6.3.3 || gem install rdoc -v 6.3.3 RUN gem install public_suffix -v 4.0.7 RUN gem install css_parser -v 1.12.00 RUN gem install asciidoctor-pdf-cjk RUN wget https://forge.etsi.org/swagger2markup-cli-1.3.2.jar RUN npm config set proxy $http_proxy Loading src/SOL002/APIVersion/APIVersion.yaml +2 −2 Original line number Diff line number Diff line Loading @@ -19,8 +19,8 @@ info: version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: description: ETSI GS NFV-SOL 002 V4.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/04.05.01_60/gs_NFV-SOL002v040501p.pdf description: ETSI GS NFV-SOL 002 V5.1.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/05.01.01_60/gs_NFV-SOL002v050101p.pdf paths: /vnfconfig/api_versions: Loading src/SOL002/General_Definitions/SOL002_def.yaml +371 −33 Original line number Diff line number Diff line # Copyright (c) ETSI 2017. # Copyright (c) ETSI 2024. # https://forge.etsi.org/etsi-forge-copyright-notice.txt definitions: Loading Loading @@ -131,7 +131,217 @@ definitions: structure, and whether or not this attribute is available, is dependent on the type of the PaaS Service. $ref: "#/definitions/KeyValuePairs" ResourceCapacityDefinition: description: > This type represents selected values for capacity related VDU attributes. * NOTE: Resource definitions not related to a VDU are not considered in this version of the present document. type: object required: - type properties: tag: description: Tag assigned by the issuer of a VNF LCM operation request that contains this data type with values to be applied to a VDU. It is used for tracking purposes. The tag is preserved in the run time record as long as at least one value of the capacity related attributes associated with that tag is still valid, i.e., it has not been modified by a later VNF LCM operation request. At most one tag can be included when the data type is used in a VNF LCM operation request. When the data type is used in the VnfInstance data type it may contain multiple tags, namely those provided in VNF LCM requests, if at least one of the values provided in that request associated to that tag is still applicable in the VNFCs created from this VDU, i.e., it has not been modified by a later request. type: array items: $ref: "#/definitions/String" type: description: Type of the resource definition referenced. VALUES • COMPUTE • STORAGE • OSCONTAINER type: string enum: - COMPUTE - STORAGE - OSCONTAINER vduId: description: Reference to the related Vdu applicable to this resource in the VNFD. It shall be present when the referenced resource definition is related to a VDU. See note. $ref: "#/definitions/IdentifierInVnfd" osContainerDescData: description: Indicates values for resource capacity related attributes in an OsContainerDesc. It shall be present when the attribute ‘type’ indicates OSCONTAINER and absent otherwise. type: array items: $ref: "#/definitions/OsContainerDescData" virtualComputeDescData: description: Indicates values for resource capacity related attributes in an OsContainerDesc. It shall be present when the attribute 'type' indicates OSCONTAINER and absent otherwise. $ref: "#/definitions/VirtualComputeDescData" virtualStorageDescData: description: > Indicates the value for the storage size related attribute in an VirtualStorageDesc. It shall be present when the attribute 'type' indicates STORAGE and absent otherwise. type: array items: $ref: "#/definitions/VirtualStorageDescData" OsContainerDescData: description: > This type represents selected values for capacity related VDU attributes of an OsContainer resource. * NOTE: At least one of the attributes shall be present. type: object required: - resourceTemplateId oneOf: - required: - resourceTemplateId - required: - requestedCpuResources - required: - requestedMemoryResources - required: - requestedEphemeralStorageResources - required: - extendedResourceRequests - required: - cpuResourceLimit - required: - memoryResourceLimit - required: - ephemeralStorageResourceLimit - required: - hugePageResources properties: resourceTemplateId: description: > Identifier of an osContainerDesc in the VNFD. $ref: "#/definitions/IdentifierInVnfd" requestedCpuResources: description: > Number of CPU resources requested for the container in milli-CPU. See note. type: integer requestedMemoryResources: description: > Amount of memory resources requested for the container expressed in the same units as specified in the requested_memory_resources_valid_values property in VNFD for this container descriptor. See note. type: array items: $ref: "#/definitions/Number" requestedEphemeralStorageResources: description: > Size of ephemeral storage resources requested for the container expressed in the same units as specified in the requested_ephemeral_storage_resources_valid_values property VNFD. $ref: "#/definitions/Number" extendedResourceRequests: description: > Map of the amount of extended resources of the type indicated in the key. The key is a string that identifies an extended resource indicated in the extended_resource_requests property in the VNFD for this container descriptor. The value is an integer that indicates the required amount for a particular extended resource.See note. type: object additionalProperties: type: integer cpuResourceLimit: description: > Number of CPU resources the container can maximally use in milli-CPU. See note. type: integer memoryResourceLimit: description: > Amount of memory resources the container can maximally use expressed in the same units as specified in the memory_resource_limit_valid_values property VNFD for this container descriptor. See note. $ref: "#/definitions/Number" ephemeralStorageResourceLimit: description: > Size of ephemeral storage resources the container can maximally use expressed in the same units as specified in the ephemeral_storage_resource_limit_valid_values property VNFD for this container descriptor. See note. $ref: "#/definitions/Number" hugePageResources: description: > Map of the total size values required for all the hugepages of the size indicated in the key. The key is a string and corresponds to one of the values of the hugepage sizes indicated in the huge_pages_resources property in the VNFD for this container descriptor. The value is a number that indicates the required total size expressed in the same units as in the huge_pages_resources_property in the VNFD that indicates the valid values for required total size for the particular hugepage size. See note. type: object additionalProperties: $ref: "#/definitions/Number" VirtualComputeDescData: description: > This type represents selected values for capacity related VDU attributes of the virtual compute resource of a VM. * NOTE: At least one of the attributes shall be present. type: object required: - resourceTemplateId oneOf: - required: - resourceTemplateId - required: - numVirtualCpu - required: - virtualMemSize - required: - sizeOfVirtualDisk - required: - hugePagesRequirements properties: resourceTemplateId: description: > Identifier of a VirtualComputeDesc in the VNFD. $ref: "#/definitions/IdentifierInVnfd" numVirtualCpu: description: > Number of virtual CPUs. See note. type: integer virtualMemSize: description: > Amount of virtual Memory expressed in the same units as specified in the virtual_mem_size_valid_values property in the VNFD for this virtual compute descriptor. See note. $ref: "#/definitions/Number" sizeOfVirtualDisk: description: > Size of virtualised storage resource expressed in the same units as specified in the size_of_storage_valid_values property in the VNFD for this virtual compute descriptor. See note. $ref: "#/definitions/Number" hugePagesRequirements: description: > Map of the total size values required for all the hugepages of the size indicated in the key. The key is a string and corresponds to one of the values of the hugepage sizes indicated in the huge_pages_requirements property in the VNFD for this virtual compute descriptor. The value is a number that indicates the required total size expressed in the same units as in the huge_pages_requirements property in the VNFD that indicates the valid values for required total size for the particular hugepage size. See note. type: object additionalProperties: $ref: "#/definitions/Number" VirtualStorageDescData: description: > This type represents selected values for capacity related VDU attributes of the virtual storage resource. type: object required: - resourceTemplateId - sizeOfStorage properties: resourceTemplateId: description: > Identifier of a VirtualStorageDesc in the VNFD. $ref: "#/definitions/IdentifierInVnfd" sizeOfStorage: description: > If the ‘typeOfStorage’ attribute in the VirtualStorageDesc referenced by the resourceTemplateId indicates BLOCK or FILE it is the size of the virtualized storage resource, expressed in the same units as specified in the size_of_storage_valid_values property in the VNFD. If the ‘typeOfStorage’ attribute in the VirtualStorageDesc referenced by the resourceTemplateId indicates OBJECT it is the maximum size of the virtualized storage resource expressed in the same units as specified in the max_size_of_storage_valid_values property in the VNFD. $ref: "#/definitions/Number" CmfInfo: description: > This type provides input information related to CMF for certificate management. Loading Loading @@ -236,7 +446,7 @@ definitions: anyOf: - oneOf: - required: - vnfdId - vnfdIds - required: - vnfProductsFromProviders - oneOf: Loading Loading @@ -319,6 +529,56 @@ definitions: items: type: string MonitoringConnection: description: > The MonitoringConnection shall follow the indications. * NOTE: The VNFM can be made aware of monitoring connection information, including their identifiers to be used by configuration means outside the scope of the present document (e.g. using relevant NFV-MANO management APIs as defined in ETSI GS NFV-SOL 009). type: object required: - id - monitoringType properties: id: description: > Identifier of the monitoring connection. See note. $ref: "#/definitions/Identifier" monitoringType: description: > Type of monitoring way. VALUES: • VIM_CISM • EXTERNAL • PAAS type: string enum: - VIM_CISM - EXTERNAL - PAAS vimId: description: > Information about VIM or CISM connection(s) for monitoring resources for the VNF instance. Can be set when MonitoringType is equal to “VIM_CISM”. $ref: "#/definitions/Identifier" paasServiceId: description: > Information about PaasAsset to be used. Can be set when MonitoringType is equal to “PAAS”. $ref: "#/definitions/Identifier" interfaceInfo: description: > Information about the interface(s) to the external monitoring tool, if available, including interface endpoint e.g. URL API version, and protocol type. Can be set when MonitoringType is equal to “EXTERNAL”. $ref: "#/definitions/KeyValuePairs" accessInfo: description: > Authentication credentials for accessing the external monitoring tool. Examples can include those to support different authentication schemes, e.g. OAuth, Token, Username/password, etc. Can be set when MonitoringType is equal to “EXTERNAL”. $ref: "#/definitions/KeyValuePairs" extra: description: > Type specific additional information, if applicable. $ref: "#/definitions/String" ResourceHandle: required: - resourceId Loading Loading @@ -680,8 +940,8 @@ definitions: description: > This type represents network address data for a virtual CP. * NOTE 1: If the container cluster is set up to be able to configure an external load balancer this address will be used, otherwise it will be ignored by the CISM. * NOTE 1: The loadBalancerIp and the loadBalancerSourceRanges attributes are only used if the CIS cluster is set up to be able to configure an external load balancer. Otherwise, it shall be ignored. * NOTE 2: In case the cluster can configure an external load balancer but no loadBalancerIp is provided the container cluster will assign an IP address. Loading @@ -690,7 +950,7 @@ definitions: address pools for virtual CPs. Otherwise it shall be ignored. MetalLB is an example of a solution for Kubernetes® that supports configuration of address pools for load balancer services. * NOTE 4: The loadBalancerIp and the addressPoolName attributes shall not be present at the same time. * NOTE 4: The loadBalancerIp, addressPoolName and the externalIp attributes shall not be present at the same time. type: object required: Loading @@ -709,12 +969,30 @@ definitions: Fixed address to assign to an external load balancer. See notes 1, 2 and 4. $ref: "#/definitions/IpAddress" externalIp: description: > An external IP address assigned to the virtual CP. This IP address is not managed by CISM. See note 4. $ref: "#/definitions/IpAddress" 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. Name of an address pool from which the CIS cluster will assign an IP address to the virtual CP. See notes 3 and 4. type: string loadBalancerSourceRanges: description: > List of client IP address ranges allowed to access an external load balancer. See note 1. type: object required: - minAddress - maxAddress properties: minAddress: description: > Lowest IP address belonging to the range. $ref: "#/definitions/IpAddress" maxAddress: description: > Highest IP address belonging to the range. $ref: "#/definitions/IpAddress" ExtVirtualLinkData: description: > Loading Loading @@ -1387,9 +1665,18 @@ definitions: SubscriptionAuthentication: description: > * NOTE: The clientId and clientPassword passed in a subscription shall not be the same as the clientId and * NOTE 1 : The clientId and clientPassword passed in a subscription shall not be the same as the clientId and clientPassword that are used to obtain authorization for API requests. Client credentials may differ between subscriptions. The value of clientPassword should be generated by a random process subscriptions. The value of clientPassword should be generated by a random process. * NOTE 2: As a less secure alternative to OAUTH2_CLIENT_CERT which uses mutual authentication based on X.509 certificates, this mode which uses client password to authenticate may be used in the access token request toward the authorization server (as defined by IETF RFC 6749 [7]), only to support legacy implementations (version 3.4.1 or earlier version of the present document). See clause 8.1 for more details. * NOTE 3: The following values that were included up to version 3.4.1 of the present document have been removed: "BASIC" (to signal the use of the basic HTTP authentication) has been removed because it is insecure. "TLS_CERT" to signal an alternative non-token based authorization method using TLS certificates has been removed because the method is no longer supported. * NOTE 4: The client certificate is established by means outside the scope of the present document. type: object required: - authType Loading @@ -1398,59 +1685,110 @@ definitions: description: > Defines the types of Authentication / Authorization which the API consumer is willing to accept when receiving a notification. Permitted values: * OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the notification endpoint, use an OAuth 2.0 Bearer token, obtained using the client credentials grant type. Permitted values (see note 3): * OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the notification endpoint, use an OAuth 2.0 token, obtained using the client credentials grant type after authenticating using client identifier and client password towards the token endpoint. * OAUTH2_CLIENT_CERT: In every HTTP request to the notification endpoint, use an OAuth 2.0 token, obtained using the client credentials grant type after mutually authenticating using client identifier and X.509 certificates towards the token endpoint. type: array items: type: string enum: - OAUTH2_CLIENT_CREDENTIALS paramsBasic: - OAUTH2_CLIENT_CERT paramsOauth2ClientCert: description: > Parameters for authentication/authorization using BASIC. Shall be present if authType is "BASIC" and the contained Parameters for authentication/authorization using OAUTH2_CLIENT_CERT. Shall be present if authType is "OAUTH2_CLIENT_CERT" and the contained information has not been provisioned out of band. Shall be absent otherwise. type: object required: - clientId - certificateRef - tokenEndpoint properties: userName: clientId: description: > Username to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band. Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type. The client identifier is unique in the scope of the tokenEndpoint. type: string password: certificateRef: description: > Password to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band. Fingerprint of the client certificate. The hash function shall use SHA256 or higher. See note 4. type: string required: - type - value properties: type: description: > The type of the fingerprint. Permitted values: - x5t#S256: The SHA-256 thumbprint of the X.509 certificate as defined in section 4.1.8 of IETF RFC 7515 [23]. $ref: "#/definitions/String" enum: - x5t#S256 value: description: > The fingerprint value as defined by the type. $ref: "#/definitions/String" tokenEndpoint: description: > The token endpoint from which the access token can be obtained. $ref: "#/definitions/Uri" paramsOauth2ClientCredentials: description: > Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS. Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the contained information has not been provisioned out of band. Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the contained information has not been provisioned out of band. Shall be absent otherwise. See note 2. type: object properties: clientId: description: > Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. See note. Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type. The client identifier is unique in the scope of the tokenEndpoint. Shall be present if it has not been provisioned out of band. See note 1. type: string clientPassword: description: > Client password to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. See note. Client password to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. See note 1. type: string tokenEndpoint: description: > The token endpoint from which the access token can be obtained. Shall be present if it has not been provisioned out of band. $ref: "#/definitions/Uri" LcmCoordResultType: description: > The enumeration LcmCoordResultType defines the permitted values Loading src/SOL002/VNFConfiguration/VNFConfiguration.yaml +2 −2 Original line number Diff line number Diff line Loading @@ -19,8 +19,8 @@ info: version: 1.12.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: description: ETSI GS NFV-SOL 002 V4.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/04.05.01_60/gs_NFV-SOL002v040501p.pdf description: ETSI GS NFV-SOL 002 V5.1.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/05.01.01_60/gs_NFV-SOL002v050101p.pdf servers: - url: http://127.0.0.1/vnfconfig/v1 Loading src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml +1 −1 Original line number Diff line number Diff line # Copyright (c) ETSI 2017. # Copyright (c) ETSI 2024. # https://forge.etsi.org/etsi-forge-copyright-notice.txt definitions: Loading Loading
docker/Dockerfile +2 −0 Original line number Diff line number Diff line Loading @@ -13,6 +13,8 @@ RUN apk add openjdk8 RUN apk add ca-certificates wget && update-ca-certificates RUN apk add openssl RUN gem install rdoc -v 6.3.3 || gem install rdoc -v 6.3.3 RUN gem install public_suffix -v 4.0.7 RUN gem install css_parser -v 1.12.00 RUN gem install asciidoctor-pdf-cjk RUN wget https://forge.etsi.org/swagger2markup-cli-1.3.2.jar RUN npm config set proxy $http_proxy Loading
src/SOL002/APIVersion/APIVersion.yaml +2 −2 Original line number Diff line number Diff line Loading @@ -19,8 +19,8 @@ info: version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: description: ETSI GS NFV-SOL 002 V4.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/04.05.01_60/gs_NFV-SOL002v040501p.pdf description: ETSI GS NFV-SOL 002 V5.1.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/05.01.01_60/gs_NFV-SOL002v050101p.pdf paths: /vnfconfig/api_versions: Loading
src/SOL002/General_Definitions/SOL002_def.yaml +371 −33 Original line number Diff line number Diff line # Copyright (c) ETSI 2017. # Copyright (c) ETSI 2024. # https://forge.etsi.org/etsi-forge-copyright-notice.txt definitions: Loading Loading @@ -131,7 +131,217 @@ definitions: structure, and whether or not this attribute is available, is dependent on the type of the PaaS Service. $ref: "#/definitions/KeyValuePairs" ResourceCapacityDefinition: description: > This type represents selected values for capacity related VDU attributes. * NOTE: Resource definitions not related to a VDU are not considered in this version of the present document. type: object required: - type properties: tag: description: Tag assigned by the issuer of a VNF LCM operation request that contains this data type with values to be applied to a VDU. It is used for tracking purposes. The tag is preserved in the run time record as long as at least one value of the capacity related attributes associated with that tag is still valid, i.e., it has not been modified by a later VNF LCM operation request. At most one tag can be included when the data type is used in a VNF LCM operation request. When the data type is used in the VnfInstance data type it may contain multiple tags, namely those provided in VNF LCM requests, if at least one of the values provided in that request associated to that tag is still applicable in the VNFCs created from this VDU, i.e., it has not been modified by a later request. type: array items: $ref: "#/definitions/String" type: description: Type of the resource definition referenced. VALUES • COMPUTE • STORAGE • OSCONTAINER type: string enum: - COMPUTE - STORAGE - OSCONTAINER vduId: description: Reference to the related Vdu applicable to this resource in the VNFD. It shall be present when the referenced resource definition is related to a VDU. See note. $ref: "#/definitions/IdentifierInVnfd" osContainerDescData: description: Indicates values for resource capacity related attributes in an OsContainerDesc. It shall be present when the attribute ‘type’ indicates OSCONTAINER and absent otherwise. type: array items: $ref: "#/definitions/OsContainerDescData" virtualComputeDescData: description: Indicates values for resource capacity related attributes in an OsContainerDesc. It shall be present when the attribute 'type' indicates OSCONTAINER and absent otherwise. $ref: "#/definitions/VirtualComputeDescData" virtualStorageDescData: description: > Indicates the value for the storage size related attribute in an VirtualStorageDesc. It shall be present when the attribute 'type' indicates STORAGE and absent otherwise. type: array items: $ref: "#/definitions/VirtualStorageDescData" OsContainerDescData: description: > This type represents selected values for capacity related VDU attributes of an OsContainer resource. * NOTE: At least one of the attributes shall be present. type: object required: - resourceTemplateId oneOf: - required: - resourceTemplateId - required: - requestedCpuResources - required: - requestedMemoryResources - required: - requestedEphemeralStorageResources - required: - extendedResourceRequests - required: - cpuResourceLimit - required: - memoryResourceLimit - required: - ephemeralStorageResourceLimit - required: - hugePageResources properties: resourceTemplateId: description: > Identifier of an osContainerDesc in the VNFD. $ref: "#/definitions/IdentifierInVnfd" requestedCpuResources: description: > Number of CPU resources requested for the container in milli-CPU. See note. type: integer requestedMemoryResources: description: > Amount of memory resources requested for the container expressed in the same units as specified in the requested_memory_resources_valid_values property in VNFD for this container descriptor. See note. type: array items: $ref: "#/definitions/Number" requestedEphemeralStorageResources: description: > Size of ephemeral storage resources requested for the container expressed in the same units as specified in the requested_ephemeral_storage_resources_valid_values property VNFD. $ref: "#/definitions/Number" extendedResourceRequests: description: > Map of the amount of extended resources of the type indicated in the key. The key is a string that identifies an extended resource indicated in the extended_resource_requests property in the VNFD for this container descriptor. The value is an integer that indicates the required amount for a particular extended resource.See note. type: object additionalProperties: type: integer cpuResourceLimit: description: > Number of CPU resources the container can maximally use in milli-CPU. See note. type: integer memoryResourceLimit: description: > Amount of memory resources the container can maximally use expressed in the same units as specified in the memory_resource_limit_valid_values property VNFD for this container descriptor. See note. $ref: "#/definitions/Number" ephemeralStorageResourceLimit: description: > Size of ephemeral storage resources the container can maximally use expressed in the same units as specified in the ephemeral_storage_resource_limit_valid_values property VNFD for this container descriptor. See note. $ref: "#/definitions/Number" hugePageResources: description: > Map of the total size values required for all the hugepages of the size indicated in the key. The key is a string and corresponds to one of the values of the hugepage sizes indicated in the huge_pages_resources property in the VNFD for this container descriptor. The value is a number that indicates the required total size expressed in the same units as in the huge_pages_resources_property in the VNFD that indicates the valid values for required total size for the particular hugepage size. See note. type: object additionalProperties: $ref: "#/definitions/Number" VirtualComputeDescData: description: > This type represents selected values for capacity related VDU attributes of the virtual compute resource of a VM. * NOTE: At least one of the attributes shall be present. type: object required: - resourceTemplateId oneOf: - required: - resourceTemplateId - required: - numVirtualCpu - required: - virtualMemSize - required: - sizeOfVirtualDisk - required: - hugePagesRequirements properties: resourceTemplateId: description: > Identifier of a VirtualComputeDesc in the VNFD. $ref: "#/definitions/IdentifierInVnfd" numVirtualCpu: description: > Number of virtual CPUs. See note. type: integer virtualMemSize: description: > Amount of virtual Memory expressed in the same units as specified in the virtual_mem_size_valid_values property in the VNFD for this virtual compute descriptor. See note. $ref: "#/definitions/Number" sizeOfVirtualDisk: description: > Size of virtualised storage resource expressed in the same units as specified in the size_of_storage_valid_values property in the VNFD for this virtual compute descriptor. See note. $ref: "#/definitions/Number" hugePagesRequirements: description: > Map of the total size values required for all the hugepages of the size indicated in the key. The key is a string and corresponds to one of the values of the hugepage sizes indicated in the huge_pages_requirements property in the VNFD for this virtual compute descriptor. The value is a number that indicates the required total size expressed in the same units as in the huge_pages_requirements property in the VNFD that indicates the valid values for required total size for the particular hugepage size. See note. type: object additionalProperties: $ref: "#/definitions/Number" VirtualStorageDescData: description: > This type represents selected values for capacity related VDU attributes of the virtual storage resource. type: object required: - resourceTemplateId - sizeOfStorage properties: resourceTemplateId: description: > Identifier of a VirtualStorageDesc in the VNFD. $ref: "#/definitions/IdentifierInVnfd" sizeOfStorage: description: > If the ‘typeOfStorage’ attribute in the VirtualStorageDesc referenced by the resourceTemplateId indicates BLOCK or FILE it is the size of the virtualized storage resource, expressed in the same units as specified in the size_of_storage_valid_values property in the VNFD. If the ‘typeOfStorage’ attribute in the VirtualStorageDesc referenced by the resourceTemplateId indicates OBJECT it is the maximum size of the virtualized storage resource expressed in the same units as specified in the max_size_of_storage_valid_values property in the VNFD. $ref: "#/definitions/Number" CmfInfo: description: > This type provides input information related to CMF for certificate management. Loading Loading @@ -236,7 +446,7 @@ definitions: anyOf: - oneOf: - required: - vnfdId - vnfdIds - required: - vnfProductsFromProviders - oneOf: Loading Loading @@ -319,6 +529,56 @@ definitions: items: type: string MonitoringConnection: description: > The MonitoringConnection shall follow the indications. * NOTE: The VNFM can be made aware of monitoring connection information, including their identifiers to be used by configuration means outside the scope of the present document (e.g. using relevant NFV-MANO management APIs as defined in ETSI GS NFV-SOL 009). type: object required: - id - monitoringType properties: id: description: > Identifier of the monitoring connection. See note. $ref: "#/definitions/Identifier" monitoringType: description: > Type of monitoring way. VALUES: • VIM_CISM • EXTERNAL • PAAS type: string enum: - VIM_CISM - EXTERNAL - PAAS vimId: description: > Information about VIM or CISM connection(s) for monitoring resources for the VNF instance. Can be set when MonitoringType is equal to “VIM_CISM”. $ref: "#/definitions/Identifier" paasServiceId: description: > Information about PaasAsset to be used. Can be set when MonitoringType is equal to “PAAS”. $ref: "#/definitions/Identifier" interfaceInfo: description: > Information about the interface(s) to the external monitoring tool, if available, including interface endpoint e.g. URL API version, and protocol type. Can be set when MonitoringType is equal to “EXTERNAL”. $ref: "#/definitions/KeyValuePairs" accessInfo: description: > Authentication credentials for accessing the external monitoring tool. Examples can include those to support different authentication schemes, e.g. OAuth, Token, Username/password, etc. Can be set when MonitoringType is equal to “EXTERNAL”. $ref: "#/definitions/KeyValuePairs" extra: description: > Type specific additional information, if applicable. $ref: "#/definitions/String" ResourceHandle: required: - resourceId Loading Loading @@ -680,8 +940,8 @@ definitions: description: > This type represents network address data for a virtual CP. * NOTE 1: If the container cluster is set up to be able to configure an external load balancer this address will be used, otherwise it will be ignored by the CISM. * NOTE 1: The loadBalancerIp and the loadBalancerSourceRanges attributes are only used if the CIS cluster is set up to be able to configure an external load balancer. Otherwise, it shall be ignored. * NOTE 2: In case the cluster can configure an external load balancer but no loadBalancerIp is provided the container cluster will assign an IP address. Loading @@ -690,7 +950,7 @@ definitions: address pools for virtual CPs. Otherwise it shall be ignored. MetalLB is an example of a solution for Kubernetes® that supports configuration of address pools for load balancer services. * NOTE 4: The loadBalancerIp and the addressPoolName attributes shall not be present at the same time. * NOTE 4: The loadBalancerIp, addressPoolName and the externalIp attributes shall not be present at the same time. type: object required: Loading @@ -709,12 +969,30 @@ definitions: Fixed address to assign to an external load balancer. See notes 1, 2 and 4. $ref: "#/definitions/IpAddress" externalIp: description: > An external IP address assigned to the virtual CP. This IP address is not managed by CISM. See note 4. $ref: "#/definitions/IpAddress" 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. Name of an address pool from which the CIS cluster will assign an IP address to the virtual CP. See notes 3 and 4. type: string loadBalancerSourceRanges: description: > List of client IP address ranges allowed to access an external load balancer. See note 1. type: object required: - minAddress - maxAddress properties: minAddress: description: > Lowest IP address belonging to the range. $ref: "#/definitions/IpAddress" maxAddress: description: > Highest IP address belonging to the range. $ref: "#/definitions/IpAddress" ExtVirtualLinkData: description: > Loading Loading @@ -1387,9 +1665,18 @@ definitions: SubscriptionAuthentication: description: > * NOTE: The clientId and clientPassword passed in a subscription shall not be the same as the clientId and * NOTE 1 : The clientId and clientPassword passed in a subscription shall not be the same as the clientId and clientPassword that are used to obtain authorization for API requests. Client credentials may differ between subscriptions. The value of clientPassword should be generated by a random process subscriptions. The value of clientPassword should be generated by a random process. * NOTE 2: As a less secure alternative to OAUTH2_CLIENT_CERT which uses mutual authentication based on X.509 certificates, this mode which uses client password to authenticate may be used in the access token request toward the authorization server (as defined by IETF RFC 6749 [7]), only to support legacy implementations (version 3.4.1 or earlier version of the present document). See clause 8.1 for more details. * NOTE 3: The following values that were included up to version 3.4.1 of the present document have been removed: "BASIC" (to signal the use of the basic HTTP authentication) has been removed because it is insecure. "TLS_CERT" to signal an alternative non-token based authorization method using TLS certificates has been removed because the method is no longer supported. * NOTE 4: The client certificate is established by means outside the scope of the present document. type: object required: - authType Loading @@ -1398,59 +1685,110 @@ definitions: description: > Defines the types of Authentication / Authorization which the API consumer is willing to accept when receiving a notification. Permitted values: * OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the notification endpoint, use an OAuth 2.0 Bearer token, obtained using the client credentials grant type. Permitted values (see note 3): * OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the notification endpoint, use an OAuth 2.0 token, obtained using the client credentials grant type after authenticating using client identifier and client password towards the token endpoint. * OAUTH2_CLIENT_CERT: In every HTTP request to the notification endpoint, use an OAuth 2.0 token, obtained using the client credentials grant type after mutually authenticating using client identifier and X.509 certificates towards the token endpoint. type: array items: type: string enum: - OAUTH2_CLIENT_CREDENTIALS paramsBasic: - OAUTH2_CLIENT_CERT paramsOauth2ClientCert: description: > Parameters for authentication/authorization using BASIC. Shall be present if authType is "BASIC" and the contained Parameters for authentication/authorization using OAUTH2_CLIENT_CERT. Shall be present if authType is "OAUTH2_CLIENT_CERT" and the contained information has not been provisioned out of band. Shall be absent otherwise. type: object required: - clientId - certificateRef - tokenEndpoint properties: userName: clientId: description: > Username to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band. Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type. The client identifier is unique in the scope of the tokenEndpoint. type: string password: certificateRef: description: > Password to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band. Fingerprint of the client certificate. The hash function shall use SHA256 or higher. See note 4. type: string required: - type - value properties: type: description: > The type of the fingerprint. Permitted values: - x5t#S256: The SHA-256 thumbprint of the X.509 certificate as defined in section 4.1.8 of IETF RFC 7515 [23]. $ref: "#/definitions/String" enum: - x5t#S256 value: description: > The fingerprint value as defined by the type. $ref: "#/definitions/String" tokenEndpoint: description: > The token endpoint from which the access token can be obtained. $ref: "#/definitions/Uri" paramsOauth2ClientCredentials: description: > Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS. Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the contained information has not been provisioned out of band. Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the contained information has not been provisioned out of band. Shall be absent otherwise. See note 2. type: object properties: clientId: description: > Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. See note. Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type. The client identifier is unique in the scope of the tokenEndpoint. Shall be present if it has not been provisioned out of band. See note 1. type: string clientPassword: description: > Client password to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. See note. Client password to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. See note 1. type: string tokenEndpoint: description: > The token endpoint from which the access token can be obtained. Shall be present if it has not been provisioned out of band. $ref: "#/definitions/Uri" LcmCoordResultType: description: > The enumeration LcmCoordResultType defines the permitted values Loading
src/SOL002/VNFConfiguration/VNFConfiguration.yaml +2 −2 Original line number Diff line number Diff line Loading @@ -19,8 +19,8 @@ info: version: 1.12.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: description: ETSI GS NFV-SOL 002 V4.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/04.05.01_60/gs_NFV-SOL002v040501p.pdf description: ETSI GS NFV-SOL 002 V5.1.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/05.01.01_60/gs_NFV-SOL002v050101p.pdf servers: - url: http://127.0.0.1/vnfconfig/v1 Loading
src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml +1 −1 Original line number Diff line number Diff line # Copyright (c) ETSI 2017. # Copyright (c) ETSI 2024. # https://forge.etsi.org/etsi-forge-copyright-notice.txt definitions: Loading
