||
Skip to end of metadata
Go to start of metadata

You can get details of a Kubernetes-CoreOS group using the CLI tool, REST API or the PPaaS Console as shown below:

 

Getting details of a Kubernetes-CoreOS cluster via the CLI

Overview
CLI command

describe-kubernetes-cluster

DescriptionRetrieve details of a Kubernetes-CoreOS Cluster.
Command format
describe-kubernetes-cluster <CLUSTER_ID>
Parameter definition
Short optionLong optionDescriptionRequiredExample value
N/AN/AUnique ID of the Kubernetes-CoreOS ClusterYes
kubernetes-cluster-1
Example

Retrieving the details of the Kubernetes-CoreOS Cluster with the id: kubernetes-cluster-1.

describe-kubernetes-cluster kubernetes-cluster-1
Sample output
{
  "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": {
    "upper": 32767,
    "lower": 30000
  },
  "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"
    }
  ]
}

Getting details of a Kubernetes-CoreOS cluster via the REST API

Overview
DescriptionRetrieve detailed information on a specific Kubernetes-CoreOS group.
Resource Path/kubernetesClusters/{kubernetesClusterId}
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/{kubernetesClusterId}
  • 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

Retrieving the details of the Kubernetes-CoreOS Cluster with the id:  kubernetes-cluster-1 .

curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/kubernetesClusters/kubernetes-cluster-1
Sample output
> GET /api/kubernetesClusters/kubernetes-cluster-1 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: Thu, 01 Oct 2015 08:52:32 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 a Kubernetes-CoreOS cluster:

HTTP status code

201, 400, 409, 500

See the descriptions of the HTTP status codes here.

Get details of a Kubernetes-CoreOS cluster via the PPaaS Console

Follow the instructions below to get details of a Kubernetes-CoreOS Cluster:

  1. Click Configurations on the home page.
  2. Click Kubernetes Clusters. The Kubernetes Clusters page will appear.
  3. Click Details to view the details of the selected Kubernetes Cluster. 
    1. Hover your mouse pointer over the Kubernetes Cluster that you wish to view, for the Details button to appear.
    2. Click Details. The Kubernetes Cluster details appears.
      The selected Kubernetes Cluster definition is as follows:
  • No labels