...
Note: KeyValuePairs data type is typically realized as Hashmap or Hashtable
CreateAsRequest
| Attribute Name | Data Type | Cardinality | Description |
|---|---|---|---|
asdId | Identifier (UUID) | 1 | Identifier that identifies the ASD which defines the AS instance to be created. |
asInstanceName | String | 0..1 | Human-readable name of the AS instance to be created. |
asInstanceDescription | String | 0..1 | Human-readable description of the AS instance to be created. |
additionalParams1, |
2 | KeyValuePairs | 0..1 | Additional input parameters for the |
| Create AS process (this is a pace holder to hold any additional parameters for the |
| orchestrator, such as CNFM) |
Note:
- additional parameters can be passed to define custom values. All keys that are separated by dots are handled as separate values. Passing a value file content is under consideration. Special characters are allowed to represent \n, \., etc.If some of the parameters required for instantiation are complex and cannot fit into the additionalParams section of the JSON request body, In this case, the deploymentItems can be used.
- the target cluster name could be passed thru additionalParams if the client wants to select the target cluster.
...
| Attribute Name | Data Type | Cardinality | Description |
|---|---|---|---|
asdExtCpdInputParams | ExtCpdParams | 0..N | contains ext cpd parameter instance-level values |
deploymentItems2 | DeploymentItems | 1..N | contains lifecycle parameters for deploymentItems |
additionalParams1, 3 | KeyValuePairs | 0..1 | Additional input parameters for the instantiation Instantiate AS process (this is a pace holder to hold any additional parameters for the serverorchestrator, such as CNFM) |
Note:
- additional parameters can be passed to define custom values. All keys that are separated by dots are handled as separate values. Passing a value file content is under consideration. Special characters are allowed to represent \n, \., etc.
- If some of the parameters required for instantiation are complex and cannot fit into the additionalParams section of the JSON request body, In this case, the deploymentItems can be used.
- the target cluster name could be passed thru additionalParams if the client wants to select the target cluster.
...
| Attribute Name | Data Type | Cardinality | Description |
|---|---|---|---|
| deploymentItemId | Identifier | 1 | Identifies which deploymentItem |
lifecycleParameterKeyValues1 | KeyValuesPairs | 0..N | provides lifecycle parameter keys and values |
Note:
- provides instance-level key-value sets for the Helm Charts values file(s).
Terminate AS Instance Resource
...
POST .../as_instances/{asInstanceId}/instantiate terminate (InstantiateAsRequestTerminateAsRequest)202 Accepted ()Send asLcmOperationOccurrenceNotification (STARTING/PROCESSING/COMPLETED)200 OK (AsLcmOpOcc:operationState=COMPLETED)
TerminateAsRequest
| |||
Delete AS Instance Resource
...
AsInstance for Create and Query
| Attribute Name | Data Type | Cardinality | Description |
|---|---|---|---|
| asInstanceId | Identifier | 1 | Identifier of the AS instance |
| asInstanceName | String | 0..1 | Name of the AS instance. This attribute can be modified with the PATCH (i.e., update) method. |
| asInstanceDescription | String | 0..1 | Human-readable description of the AS instance. This attribute can be modified with the PATCH method. |
| asdId | Identifier | 1 | Identifier of the |
ASD on which the |
CNF instance is based. |
| asVersion |
| Version | 1 |
Specifies the version of the |
Application. | |||
asSchemaVersion | Version | 1 | Specifies the version of the ASD’s schema. The value is copied from the ASD. |
asProvider | String | 1 |
Provider of the AS |
instance. |
The value is copied from the ASD |
. | |||
asApplicationName | String | 1 | Name to identify the AS instance. |
The value is copied from the ASD. | |
asApplicationVersion | String |
1 | Specifies the version of the Application |
. The value is copied from the ASD. | |||
| asApplicationInfoName | String | 0..1 | Human readable name for the Application service instance. The value is copied from the ASD. |
| asInfoDescription | String | 0..1 | Human readable description of the AS instance. The value is copied from the ASD. |
asdExtCpd | datatype.ExtCpd | 0..N |
Contains the externally exposed “instance-level” connection points of the application. | ||
| enhancedClusterCapabilities | datatype. enhancedClusterCapabilities | 0..N |
Contains a list of “instance-level” expected capabilities of the target Kubernetes cluster to aid placement of the application service on a suitable cluster. | |||
| deploymentItems | DeploymentItems | 1..N | Contains Deployment artifacts with “instance-level” lifecylceparmaeterKeyValues |
| instantiationState | String of Enum;
| 0..1 | Indicates the current Instantiation State |
| instantiationAsInfo | datatype.instantiationAsInfo | 0..1 | Information specific to an instantiated AS Instance, such as STARTED, STOPPED |
| metadata | object (key value pair) | 0..1 | represents a list of “instance-level” metadata key-value pairs |
| extensions | object (key value pair) | 0..1 | Additional AS-specific “instance-level” attributes that affect the lifecycle management of this AS instance |
| _links | datatype._links | 0..1 | Links to resources related to this resource, such as self, indicators, instantiate, terminate and operate URIs |
datatype.instantiationAsInfo
...