io.fabric8.kubernetes.api

Class KubernetesClient

java.lang.Object

io.fabric8.kubernetes.api.KubernetesClient

All Implemented Interfaces:

Kubernetes, KubernetesExtensions

public class KubernetesClient
extends Object
implements Kubernetes, KubernetesExtensions

A simple client interface abstracting away the details of working with the KubernetesFactory and the differences between the core Kubernetes API and the KubernetesExtensions

Constructor Summary

Constructors

Constructor and Description
KubernetesClient()
KubernetesClient(KubernetesFactory factory)
KubernetesClient(String url)

Method Summary

Methods

Modifier and Type	Method and Description
String	createConfig(Object entity)
String	createPod(PodSchema entity) Create a new pod.
String	createReplicationController(ReplicationControllerSchema entity) Create a new controller.
String	createService(ServiceSchema entity) Create a new service
String	createTemplate(Object entity)
String	createTemplateConfig(Object entity)
String	deletePod(String podId) Delete a specific pod
String	deleteReplicationController(String controllerId) Delete a specific controller
String	deleteService(String serviceId) Delete a specific service
String	getAddress()
KubernetesFactory	getFactory()
Kubernetes	getKubernetes()
KubernetesExtensions	getKubernetesExtensions()
PodSchema	getPod(String podId) Get a specific pod
PodListSchema	getPods() List all pods on this cluster
ReplicationControllerSchema	getReplicationController(String controllerId) Get a specific controller
ReplicationControllerSchema	getReplicationControllerForPod(PodSchema pod)
ReplicationControllerSchema	getReplicationControllerForPod(String podId)
ReplicationControllerListSchema	getReplicationControllers() List all replicationControllers on this cluster
ServiceSchema	getService(String serviceId) Get a specific service
ServiceListSchema	getServices() List all services on this cluster
void	setFactory(KubernetesFactory factory)
String	updatePod(String podId, PodSchema entity) Update a pod
String	updateReplicationController(String controllerId, ReplicationControllerSchema entity) Update a controller
String	updateService(String serviceId, ServiceSchema entity) Update a service

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KubernetesClient

public KubernetesClient()

KubernetesClient

public KubernetesClient(String url)

KubernetesClient

public KubernetesClient(KubernetesFactory factory)

Method Detail

getKubernetes

public Kubernetes getKubernetes()

getKubernetesExtensions

public KubernetesExtensions getKubernetesExtensions()

getFactory

public KubernetesFactory getFactory()

setFactory

public void setFactory(KubernetesFactory factory)

getAddress

public String getAddress()

getPods

@GET
@Path(value="pods")
public PodListSchema getPods()

Description copied from interface: Kubernetes

List all pods on this cluster

Specified by:

getPods in interface Kubernetes

deletePod

@DELETE
@Path(value="pods/{podId}")
public String deletePod(@NotNull
                           String podId)
                 throws Exception

Description copied from interface: Kubernetes

Delete a specific pod

Specified by:

deletePod in interface Kubernetes

Throws:

Exception

getReplicationController

@GET
@Path(value="replicationControllers/{controllerId}")
@Produces(value="application/json")
public ReplicationControllerSchema getReplicationController(@NotNull
                                                                     String controllerId)

Description copied from interface: Kubernetes

Get a specific controller

Specified by:

getReplicationController in interface Kubernetes

deleteReplicationController

@DELETE
@Path(value="replicationControllers/{controllerId}")
@Produces(value="application/json")
public String deleteReplicationController(@NotNull
                                                      String controllerId)
                                   throws Exception

Description copied from interface: Kubernetes

Delete a specific controller

Specified by:

deleteReplicationController in interface Kubernetes

Throws:

Exception

getReplicationControllers

@Path(value="replicationControllers")
@GET
@Produces(value="application/json")
public ReplicationControllerListSchema getReplicationControllers()

Description copied from interface: Kubernetes

List all replicationControllers on this cluster

Specified by:

getReplicationControllers in interface Kubernetes

updateReplicationController

@PUT
@Path(value="replicationControllers/{controllerId}")
@Consumes(value="application/json")
public String updateReplicationController(@NotNull
                                                   String controllerId,
                                                   ReplicationControllerSchema entity)
                                   throws Exception

Description copied from interface: Kubernetes

Update a controller

Specified by:

updateReplicationController in interface Kubernetes

entity - e.g. { "id": "nginxController", "apiVersion": "v1beta1", "kind": "ReplicationController", "desiredState": { "replicas": 2, "replicaSelector": {"name": "nginx"}, "podTemplate": { "desiredState": { "manifest": { "version": "v1beta1", "id": "nginxController", "containers": [{ "name": "nginx", "image": "dockerfile/nginx", "ports": [{"containerPort": 80, "hostPort": 8080}] }] } }, "labels": {"name": "nginx"} }}, "labels": {"name": "nginx"} }

Throws:

Exception

updateService

@PUT
@Path(value="services/{serviceId}")
@Consumes(value="application/json")
public String updateService(@NotNull
                                     String serviceId,
                                     ServiceSchema entity)
                     throws Exception

Description copied from interface: Kubernetes

Update a service

Specified by:

updateService in interface Kubernetes

entity - e.g. { "kind": "Service", "apiVersion": "v1beta1", "id": "example", "port": 8000, "labels": { "name": "nginx" }, "selector": { "name": "nginx" } }

Throws:

Exception

getService

@GET
@Path(value="services/{serviceId}")
@Produces(value="application/json")
public ServiceSchema getService(@NotNull
                                         String serviceId)

Description copied from interface: Kubernetes

Get a specific service

Specified by:

getService in interface Kubernetes

deleteService

@DELETE
@Path(value="services/{serviceId}")
@Produces(value="application/json")
public String deleteService(@NotNull
                                        String serviceId)
                     throws Exception

Description copied from interface: Kubernetes

Delete a specific service

Specified by:

deleteService in interface Kubernetes

Throws:

Exception

createService

@Path(value="services")
@POST
@Consumes(value="application/json")
public String createService(ServiceSchema entity)
                     throws Exception

Description copied from interface: Kubernetes

Create a new service

Specified by:

createService in interface Kubernetes

Parameters:

entity - e.g. { "kind": "Service", "apiVersion": "v1beta1", "id": "example", "port": 8000, "labels": { "name": "nginx" }, "selector": { "name": "nginx" } }

Throws:

Exception

getPod

@GET
@Path(value="pods/{podId}")
public PodSchema getPod(@NotNull
                        String podId)

Description copied from interface: Kubernetes

Get a specific pod

Specified by:

getPod in interface Kubernetes

updatePod

@PUT
@Path(value="pods/{podId}")
@Consumes(value="application/json")
public String updatePod(@NotNull
                                 String podId,
                                 PodSchema entity)
                 throws Exception

Description copied from interface: Kubernetes

Update a pod

Specified by:

updatePod in interface Kubernetes

entity - e.g. { "kind": "Pod", "apiVersion": "v1beta1", "id": "php", "desiredState": { "manifest": { "version": "v1beta1", "id": "php", "containers": [{ "name": "nginx", "image": "dockerfile/nginx", "ports": [{ "containerPort": 80, "hostPort": 8080 }], "livenessProbe": { "enabled": true, "type": "http", "initialDelaySeconds": 30, "httpGet": { "path": "/index.html", "port": "8080" } } }] } }, "labels": { "name": "foo" } }

Throws:

Exception

getServices

@Path(value="services")
@GET
@Produces(value="application/json")
public ServiceListSchema getServices()

Description copied from interface: Kubernetes

List all services on this cluster

Specified by:

getServices in interface Kubernetes

createPod

@POST
@Path(value="pods")
@Consumes(value="application/json")
public String createPod(PodSchema entity)
                 throws Exception

Description copied from interface: Kubernetes

Create a new pod. currentState is ignored if present.

Specified by:

createPod in interface Kubernetes

Parameters:

entity - e.g. { "kind": "Pod", "apiVersion": "v1beta1", "id": "php", "desiredState": { "manifest": { "version": "v1beta1", "id": "php", "containers": [{ "name": "nginx", "image": "dockerfile/nginx", "ports": [{ "containerPort": 80, "hostPort": 8080 }], "livenessProbe": { "enabled": true, "type": "http", "initialDelaySeconds": 30, "httpGet": { "path": "/index.html", "port": "8080" } } }] } }, "labels": { "name": "foo" } }

Throws:

Exception

createReplicationController

@Path(value="replicationControllers")
@POST
@Consumes(value="application/json")
public String createReplicationController(ReplicationControllerSchema entity)
                                   throws Exception

Description copied from interface: Kubernetes

Create a new controller. currentState is ignored if present.

Specified by:

createReplicationController in interface Kubernetes

Parameters:

entity - e.g. { "id": "nginxController", "apiVersion": "v1beta1", "kind": "ReplicationController", "desiredState": { "replicas": 2, "replicaSelector": {"name": "nginx"}, "podTemplate": { "desiredState": { "manifest": { "version": "v1beta1", "id": "nginxController", "containers": [{ "name": "nginx", "image": "dockerfile/nginx", "ports": [{"containerPort": 80, "hostPort": 8080}] }] } }, "labels": {"name": "nginx"} }}, "labels": {"name": "nginx"} }

Throws:

Exception

createConfig

@POST
@Path(value="configs")
@Consumes(value="application/json")
public String createConfig(Object entity)
                    throws Exception

Specified by:

createConfig in interface KubernetesExtensions

Throws:

Exception

createTemplate

@POST
@Path(value="template")
@Consumes(value="application/json")
public String createTemplate(Object entity)
                      throws Exception

Specified by:

createTemplate in interface KubernetesExtensions

Throws:

Exception

createTemplateConfig

@POST
@Path(value="templateConfigs")
@Consumes(value="application/json")
public String createTemplateConfig(Object entity)
                            throws Exception

Specified by:

createTemplateConfig in interface KubernetesExtensions

Throws:

Exception

getReplicationControllerForPod

public ReplicationControllerSchema getReplicationControllerForPod(String podId)

getReplicationControllerForPod

public ReplicationControllerSchema getReplicationControllerForPod(PodSchema pod)