This documentation is for WSO2 Private PaaS 4.1.0. View documentation for the latest release.
Getting Details of All Kubernetes-CoreOS Clusters - WSO2 Private PaaS 4.1.0 - WSO2 Documentation
WSO2 Private PaaS 4.1.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
||
Skip to end of metadata
Go to start of metadata

You can get details of all Kubernetes-CoreOS cluster using the CLI tool or REST API, as shown below:

 

Get details of all Kubernetes-CoreOS clusters via the CLI

Overview
CLI command
list-kubernetes-clusters
DescriptionRetrieve details of all Kubernetes-CoreOS Clusters.
Example

Retrieve details of all available Kubernetes-CoreOS Clusters.

list-kubernetes-clusters
Sample output
Kubernetes clusters found:
+----------------------+----------------------+
| Group ID             | Description          |
+----------------------+----------------------+
| kubernetes-cluster-1 | Kubernetes Cluster 1 |
+----------------------+----------------------+

Get details of all Kubernetes-CoreOS cluster via the REST API

Overview
DescriptionRetrieve detailed information on all Kubernetes-CoreOS Clusters.
Resource Path/kubernetesClusters
HTTP MethodGET
Request/Response Formatapplication/json
Command format
curl -X GET -H "Content-Type: application/json" -k -v -u <USERNAME>:<PASSWORD> https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/kubernetesClusters
  • By default, <USERNAME>:<PASSWORD> is admin:admin.
  • By default, <PRIVATE_PAAS_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
  • By default, <PRIVATE_PAAS_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.
Example

Retrieve details of all available Kubernetes-CoreOS Clusters.

curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/kubernetesClusters/
Sample output
> GET /api/kubernetesClusters/ HTTP/1.1
> Host: localhost:9443
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> 
< HTTP/1.1 200 OK
< Date: Wed, 30 Sep 2015 12:50:12 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
< 
[{"clusterId":"kubernetes-cluster-1","description":"Kubernetes Cluster 1","kubernetesHosts":[{"hostId":"minion-1","hostname":"minion-1.dev.kubernetes.org","privateIPAddress":"172.17.8.105","publicIPAddress":"172.17.8.105"},{"hostId":"minion-2","hostname":"minion-2.dev.kubernetes.org","privateIPAddress":"172.17.8.103","publicIPAddress":"172.17.8.103"},{"hostId":"minion-3","hostname":"minion-3.dev.kubernetes.org","privateIPAddress":"172.17.8.104","publicIPAddress":"172.17.8.104"}],"kubernetesMaster":{"hostId":"master","hostname":"master.dev.kubernetes.org","privateIPAddress":"172.17.8.101","publicIPAddress":"172.17.8.101"},"portRange":{"lower":30000,"upper":32767},"property":[{"name":"payload_parameter.MB_IP","value":"172.17.8.1"},{"name":"payload_parameter.MB_PORT","value":1883},{"name":"payload_parameter.CEP_URLS","value":"172.17.8.1:7711"},{"name":"payload_parameter.LOG_LEVEL","value":"DEBUG"},{"name":"payload_parameter.METADATA_SERVICE_URL","value":"https:\/\/172.17.8.1:9443"}]}]

Following are the HTTP status codes you will come across while getting details of all Kubernetes-CoreOS cluster:

HTTP status code

200, 500

See the descriptions of the HTTP status codes here.

 

 

Sample Kubernetes-CoreOS cluster JSON
{
  "clusterId": "kubernetes-cluster-1",
  "description": "Kubernetes Cluster 1",
  "kubernetesMaster": {
    "hostId": "master",
    "hostname": "master.dev.kubernetes.org",
    "privateIPAddress": "172.17.8.101",
    "publicIPAddress": "172.17.8.101",
    "property": [
      
    ]
  },
  "portRange": {
    "upper": "32767",
    "lower": "30000"
  },
  "kubernetesHosts": [
    {
      "hostId": "minion-1",
      "hostname": "minion-1.dev.kubernetes.org",
      "privateIPAddress": "172.17.8.102",
      "publicIPAddress": "172.17.8.102",
      "property": [
        
      ]
    }
  ],
  "property": [
    {
      "name": "payload_parameter.MB_IP",
      "value": "172.17.8.1"
    },
    {
      "name": "payload_parameter.MB_PORT",
      "value": "1883"
    },
    {
      "name": "payload_parameter.CEP_IP",
      "value": "172.17.8.1"
    },
    {
      "name": "payload_parameter.CEP_PORT",
      "value": "7711"
    },
    {
      "name": "payload_parameter.LOG_LEVEL",
      "value": "DEBUG"
    },
    {
      "name": "payload_parameter.METADATA_SERVICE_URL",
      "value": "https://172.17.8.1:9443"
    }
  ]
}
  • No labels
||