Work in Progress

Lifecycle Management Interface

This interface allows the CNF Manager (CNFM) client to invoke AS-CNF lifecycle management operations of AS-CNF instances towards the CNFM.

The operations provide through this interface are:

• Create AS Identifier

• Instantiate AS

• Terminate AS

• Delete AS Identifier

• Update AS

note: register and unregister of K8S cluster(s) are under consideration. May use existing AAI interface??? TBD.

Create AS Instance Resource

The creation of an "individual" AS instance resource.

REST Interfaces

• POST  .../as_instances (CreateAsRequest)

• 201 Created (AsInstance)

• // Send AsIdentifierCreationNotification

     post condition: upon successful completion, AS instance is created in NOT_INSTANTIATED state.

For the response AsInstance structure, see the AsInstance section below, AsInstanceforCreateandQuery .

The caller of SO CNFM (in this case, BPMN Infra) need to use the return asInstanceId for invoking an AS Instance Instantiate.

Note: KeyValuePairs data type is typically realized as Hashmap or Hashtable

CreateAsRequest

Note: 

1. The 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.

2. The target cluster name could be passed thru additionalParams if the client wants to select the target cluster.

AsInstance (response)

see the AsInstance section below, AsInstanceforCreateandQuery . 

Instantiate AS Instance Resource

Before SO CNFM invokes As Instance Instantiate, SO CNFM may need to query for an asInstance based on the asInstanceId parameter.

REST Interfaces

• POST .../as_instances/{asInstanceId}/instantiate (InstantiateAsRequest)

• 202 Accepted ()

• Send asLcmOperationOccurrenceNotification (STARTING/PROCESSING/COMPLETED)

• 200 OK (AsLcmOpOcc:operationState=COMPLETED)

InstantiateAsRequest

Note: 

1. The 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.

2. The target cluster name could be passed thru additionalParams if the client wants to select the target cluster.

ExtCpdParams

DeploymentItems

Note: 

1. 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

Delete AS Instance Resource

The deletion of an individual AS instance resource.

REST Interfaces

• DELETE .../as_instances/{asInstanceId}

• 204 No Content

• // Send AsIdentifierDeletionNotification to Client

Update AS

TBD

Query Individual AS

REST Interfaces

• GET .../as_instances/{asInstanceId}

• 200 OK (AsInstance)

AsInstance for Create and Query

datatype.instantiationAsInfo

datatype._links

Register K8S Clusters

To instantiate an AS on an non-ONAP K8S cluster, a cluster configuration file that is specific to the cluster must be uploaded.

To add a cluster configuration file of a cluster, create a POST request .../aslcm/v1/clusterconfigs will be performed.

• CNFM receives the clusterconfigs info and creates a cluster configuration file (cluster name + "." + "config" to the ./kube directory.

The kubectl configuration file is used to the body of the request to define external K8S clusters.

The cluster configuration file for a particular cluster must be retrieved from the cluster administrator.

Should the cluster configuration file change for any reason, e.g., CA certificate rotation on the target cluster or client key expires, then the cluster file registered in SO CNFM/AAI shall need to be updated.

The target cluster server and port must be reachable from the SO CNFM.

• to verify the connectdion to the target cluster, run the following command from the ONAP K8S cluster

  • kubectl --kubeconfig ${PATH_TO_TARGET_CLUSTER_CONFIGURATION_FILE} get namespaces

Deregister K8S Clusters

To remove a cluster configruation file, create a DELETE request. .../aslcm/v1/clusterconfig/{configName}

CNFM will remove the "configName" + "." + "config" file from the .kube directory.

The command returns the HTTP status code 204 No Content

List Registered K8S Clusters

To get details about registered clusters, create a GET request .../aslcm/v1/clusterconfigs

The API returns a paginated response, but if a customized response is needed, additional parameters for page, size, sor and filtering could be applied.

Swagger File

The following is ASD LCM Restful API Swagger file (work in progress)

Kubernetes Resource Query

Get Nodes

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

Query Cluster Capacity

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).

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