...
- provides instance-level key-value sets for the Helm Charts values file(s).
Terminate AS Instance Resource
The termination of an individual AS instance resource.
REST Interfaces
- POST .../as_instances/{asInstanceId}/terminate (TerminateAsRequest)
- 202 Accepted ()
- Send asLcmOperationOccurrenceNotification (STARTING/PROCESSING/COMPLETED)
200 OK (AsLcmOpOcc:operationState=COMPLETED)
TerminateAsRequest
| Attribute Name | Data Type | Cardinality | Description |
|---|---|---|---|
| terminationType | Enum | 1 |
|
| gracefulTerminationTimeout | Integer | 0..1 | The unit is seconds |
| additionalParams | KeyValuePairs | 0..1 | Additional input parameters for the Terminate AS process (this is a pace holder to hold any additional parameters for the orchestrator, such as CNFM) |
Delete AS Instance Resource
...
| 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 |
| asDeploymentName | String | 0..1 | name of the deployment in the namespace (e.g., helm release name) Note: once an app is deployed, the asDeploymentName is required |
| targetCluster | String | 0..1 | target cluster name |
datatype.instantiationAsInfo
...
GET /api/v1/nodes
with parameters
...
- labelSelector
- findSelector
- resourceVersion
Based on the node label (which is not unique), get a node list. To narrow it further, use the additional findSelector parameter.
Once we get target node(s), get node status.
Get Node Status
GET /api/v1/nodes/{name}/status
...
Allocatable capacity of CPU and Memory from the target cluster could be discovered by SO CNFM (later this function could be moved to NFVO) using the K8S API (GET /api/v1/nodes/{name}/status).
| Gliffy Diagram | ||||||||
|---|---|---|---|---|---|---|---|---|
|
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
| cluster_name | name of Kubernetes Cluster | true | String | |
| namespace | namespace | true | String | |
| node_name | name of Kubernetes node | true | String | |
| capacity | Capacity represents the total resources of a node. | false | object | |
| allocatable | Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity | false | object
| |
| conditions | Conditions is an array of current observed node conditions. | false | v1.NodeCondition array | |
| addresses | List of addresses reachable to the node. | false | v1.NodeAddresses array | |
| daemonEndpoints | Endpoints of daemons running on the Node. | false | v1.NodeDaemonEndpoints | |
| nodeInfo | Set of ids/uuids to uniquely identify the node. | false | v1.NodeSystemInfo | |
| images | List of container images on this node | false | v1.ContainerImage array | |
| volumesInUse | List of attachable volumes in use (mounted) by the node. | false | v1.UniqueVolumeName array | |
| volumesAttached | List of volumes that are attached to the node. | false | v1.AttachedVolume array |
Query Cluster POD by name
- kubectl get pods -o=name
- kubectl get pods -o=name | sed "s/^.\{4\}//" | grep <release name>
- kubectl get pods --no-headers -o custom-columns=":metadata.name" | grep <release name>
- kubectl get pod -A | grep <release name> | awk '{print $2}'. // find a POD by release name
- kubectl get --no-headers=true pods -o name | awk -F "/" '{print $2}'
Get PoD / container status
- kubectl get pods <pod name> --no-headers -o custom-columns=":status.phase". // check if pod is running or not
- kubectl get pod <pod name> --output="jsonpath={.status.containerStatuses[*].ready}". // check if the container is ready, which is true
Others
- kubectl get ns -A
- kubectl get pods - n <namespace>
- kubectl get pod -o=custom-columns=NAME:.metadata.name,NODE:.spec.nodeName
- kubectl get pod -o=custom-columns=NAME:.metadata.name,NODE:.spec.nodeName | awk '{print $2}'. // get the node name
- kubectl get pod -o=custom-columns=NAME:.metadata.name,NODE:.spec.nodeName | grep <release name>. // get the pod and node names for release name
- kubectl get pod -o=custom-columns=NAME:.metadata.name,NODE:.spec.nodeName | grep <release name> | awk '{print $2}'. // get the node name for release name
- kubectl describe pods <pod name> // get a pod description
- kubectl describe pods <pod name> | grep 'Container ID'. // get container id(s) from a pod
- kubectl get pod <pod name> -o="custom-columns=NAME:.metadata.name,INIT-CONTAINERS:.spec.initContainers[*].name,CONTAINERS:.spec.containers[*].name". // get pod, init-container and containers
- kubectl get pods <pod name> -o jsonpath='{range .spec.containers[*]}{.name}{"\n"}{end}'. // get container name(s) from the pod name
- kubectl exec -it <pod name> -c <container name> bash. // access pod