Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagetext
titleControl loop Update
https://<CL Runtime IP> : <Port> /onap/controlloop/v2/command

Request body:

Code Block
languagetext
titleCL Update
Elite soft json viewer
{
  "orderedState": "PASSIVE",
  "controlLoopIdentifierList": [
      {
          "name": "K8SInstance0",
          "version": "1.0.1"
      }
    ]
  }

...

Under the UNINITIALISED state, all the helm deployments under a control loop will be uninstalled from the cluster.

Code Block
languagetext
titleControl loop Update
https://<CL Runtime IP> : <Port> /onap/controlloop/v2/command

Request body:

Elite soft json viewer
{
  "orderedState": "UNINITIALISED",
  "controlLoopIdentifierList": [
      {
          "name": "K8SInstance0",
          "version": "1.0.1"
      }
    ]  
}



K8s-particpant as a standalone application:

The participant can be deployed as a standalone application in docker by configuring the kubernetes cluster manually as mentioned in the first step.

It supports various REST end points for onboarding, installing, uninstalling and retrieval of helm charts from local chart repository. The following REST endpoints are exposed for the various helm operations. The participant maintains the helm charts in its local chart repository with the provision to add/delete charts.

Image Added


POST: Onboard a chart to the k8s-participant’s local file system:

Helm charts can be onboarded along with its overrides yaml file to the participant’s local chart repository. Accepts the .tgz files in form-data for helm chart and overrides.yaml files, we are also expected to pass the json input describing the chart info. Sample input below:

Code Block
languagetext
titleOnboard a chart
https://<K8s-participant ip> : <port> /onap/k8sparticipant/helm/onboard/chart

Request body:

Elite soft json viewer
{
  "chartName" : "dcae-pmsh",
 "version" : "8.0",
 "namespace" : "onap",
 "releaseName" : "dcae-pmsh-svc",
 }  



POST: Install a pre onboarded chart from local chart repository:

The onboarded helm charts can be installed to the Kubernetes cluster. It accepts a json input specifying the chart name and version that needs to be installed. The deployment information will be gathered from the chart info that was provided while onboarding. Sample json input:


Code Block
languagetext
titleInstall chart
https://<K8s-participant ip> : <port> /onap/k8sparticipant/helm/install

Request body:

Elite soft json viewer
{
  "name": "dcae-pmsh",
  "version": "8.0"
}



GET: Retrieve all the available local charts :

This API helps to retrieve all the charts along with the version from the local chart repository.


Code Block
languagetext
titleRetrieve charts
https://<K8s-participant ip> : <port> /onap/k8sparticipant/helm/charts


DELETE: Delete a helm chart from local repository:

Deletes a helm chart from the local chart repository of Kubernetes participant.

Code Block
languagetext
titleDelete a chart
https://<K8s-participant ip> : <port> /onap/k8sparticipant/helm/chart/{name}/{version}


DELETE: Uninstall a helm chart from Kubernetes cluster:

Any installed helm chart can be uninstalled from the cluster.

Code Block
languagetext
titleUninstall a chart
https://<K8s-participant ip> : <port> /onap/k8sparticipant/helm/uninstall/{name}/{version}


Add a remote repository to the k8s-participant:

Remote helm repositories can be added via both TOSCA/ REST API. Once the remote helm repository is configured on the participant, any helm charts from the repository can be installed by k8s-particpant. Sample json body for adding a remote repository:

Code Block
languagetext
titleAdd a repository
https://<K8s-participant ip> : <port> /onap/k8sparticipant/helm/repo

Request body:

Elite soft json viewer
{
  "repoName": "chartmuseum",
  "address": "172.125.16.20",
  "protocol": "http",
  "port": "8080",
  "username": "onapinitializer",
  "password": "demo123456!"
}