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

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

 

Getting details of all the hosts in a Kubernetes-CoreOS cluster via the CLI

Overview
CLI command

list-kubernetes-hosts

DescriptionRetrieve all host details of a specific Kubernetes-CoreOS Cluster.
Command format
list-kubernetes-hosts -c <CLUSTER_ID>
Parameter definition
Short optionLong optionDescriptionRequiredExample value

-c

--cluster-idID of the Kubernetes-CoreOS Cluster.Yeskubernetes-cluster-1
Example

Retrieve all host details of the Kubernetes-CoreOS Cluster with the cluster ID: kubernetes-cluster-1.

list-kubernetes-hosts -c kubernetes-cluster-1
Sample output
Kubernetes hosts found:
+----------+-----------------------------+--------------------+-------------------+
| Host ID  | Hostname                    | Private IP Address | Public IP Address |
+----------+-----------------------------+--------------------+-------------------+
| minion-1 | minion-1.dev.kubernetes.org | 172.17.8.105       | 172.17.8.105      |
+----------+-----------------------------+--------------------+-------------------+
| minion-2 | minion-2.dev.kubernetes.org | 172.17.8.103       | 172.17.8.103      |
+----------+-----------------------------+--------------------+-------------------+
| minion-3 | minion-3.dev.kubernetes.org | 172.17.8.104       | 172.17.8.104      |
+----------+-----------------------------+--------------------+-------------------+

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

Overview
DescriptionRetrieve detailed information of all the hosts (slave nodes) in a specific Kubernetes-CoreOS Cluster.
Resource Path/kubernetesClusters/{kubernetesClusterId}/hosts
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/kubernetesCluster/{kubernetesClusterId}/hosts
  • 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 all host details of the Kubernetes-CoreOS Cluster with the cluster 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/hosts
Sample output
> GET /api/kubernetesClusters/kubernetes-cluster-1/hosts 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 09:21:00 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
< 
[{"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"}] 

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

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

 


 

  • No labels