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(KubernetesFactory factoryReadOnly, KubernetesFactory factoryWriteable)
KubernetesClient(String url)

Method Summary

Methods

Modifier and Type	Method and Description
String	createConfig(Object entity)
String	createPod(Pod entity) Create a new pod.
String	createPod(Pod entity, String namespace)
String	createReplicationController(ReplicationController entity) Create a new controller.
String	createReplicationController(ReplicationController entity, String namespace)
String	createService(Service entity) Create a new service
String	createService(Service entity, String namespace)
String	createTemplate(Object entity)
String	createTemplateConfig(Object entity)
void	deletePod(Pod entity)
String	deletePod(String podId) Delete a specific pod
String	deletePod(String podId, String namespace)
void	deleteReplicationController(ReplicationController entity)
String	deleteReplicationController(String controllerId) Delete a specific controller
String	deleteReplicationController(String controllerId, String namespace) Delete a specific controller
void	deleteService(Service entity)
String	deleteService(String serviceId) Delete a specific service
String	deleteService(String serviceId, String namespace)
Endpoints	endpointsForService(String serviceId, String namespace) List all endpoints for a service
String	getAddress()
EndpointsList	getEndpoints() List all service endpoints on this cluster
KubernetesFactory	getFactory(boolean writeable)
Kubernetes	getKubernetes()
Kubernetes	getKubernetes(boolean writeable)
KubernetesExtensions	getKubernetesExtensions()
MinionList	getMinions() List all the minions on this cluster
String	getNamespace()
Pod	getPod(String podId) Get a specific pod
Pod	getPod(String podId, String namespace) Get a specific pod
protected Collection<Pod>	getPodList()
PodList	getPods() List all pods on this cluster
PodList	getPods(String namespace) List all pods on this cluster
List<Pod>	getPodsForReplicationController(ReplicationController service)
List<Pod>	getPodsForReplicationController(String replicationControllerId)
List<Pod>	getPodsForService(Service service)
List<Pod>	getPodsForService(String serviceId)
ReplicationController	getReplicationController(String controllerId) Get a specific controller
ReplicationController	getReplicationController(String controllerId, String namespace) Get a specific controller
ReplicationController	getReplicationControllerForPod(Pod pod)
ReplicationController	getReplicationControllerForPod(String podId)
ReplicationControllerList	getReplicationControllers() List all replicationControllers on this cluster
ReplicationControllerList	getReplicationControllers(String namespace) List all replicationControllers on this cluster
Service	getService(String serviceId) Get a specific service
Service	getService(String serviceId, String namespace) Get a specific service
ServiceList	getServices() List all services on this cluster
ServiceList	getServices(String namespace) List all services on this cluster
String	getWriteableAddress()
protected Kubernetes	getWriteableKubernetes()
Minion	minion(String minionId) List all endpoints for a service
void	setFactory(KubernetesFactory factory)
void	setNamespace(String namespace)
void	setWriteableFactory(KubernetesFactory factory)
String	updatePod(String podId, Pod entity) Update a pod
String	updatePod(String podId, Pod entity, String namespace) Update a pod
String	updateReplicationController(String controllerId, ReplicationController entity) Update a controller
String	updateService(String serviceId, Service entity) Update a service
String	updateService(String serviceId, Service entity, String namespace) 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)

KubernetesClient

public KubernetesClient(KubernetesFactory factoryReadOnly,
                KubernetesFactory factoryWriteable)

Method Detail

getNamespace

public String getNamespace()

setNamespace

public void setNamespace(String namespace)

getKubernetes

public Kubernetes getKubernetes()

getKubernetes

public Kubernetes getKubernetes(boolean writeable)

getKubernetesExtensions

public KubernetesExtensions getKubernetesExtensions()

getFactory

public KubernetesFactory getFactory(boolean writeable)

setFactory

public void setFactory(KubernetesFactory factory)

setWriteableFactory

public void setWriteableFactory(KubernetesFactory factory)

getAddress

public String getAddress()

getWriteableAddress

public String getWriteableAddress()

getPods

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

Description copied from interface: Kubernetes

List all pods on this cluster

Specified by:

getPods in interface Kubernetes

getPods

public PodList getPods(@QueryParam(value="namespace")
              String namespace)

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 ReplicationController getReplicationController(@NotNull
                                                               String controllerId)

Description copied from interface: Kubernetes

Get a specific controller

Specified by:

getReplicationController in interface Kubernetes

getReplicationController

public ReplicationController getReplicationController(@PathParam(value="controllerId")@NotNull
                                             String controllerId,
                                             @QueryParam(value="namespace")
                                             String namespace)

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

deletePod

@DELETE
@Path(value="pods/{podId}")
@Consumes(value="text/plain")
public String deletePod(@NotNull
                                    String podId,
                                    String namespace)
                 throws Exception

Specified by:

deletePod in interface Kubernetes

Throws:

Exception

deleteReplicationController

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

Description copied from interface: Kubernetes

Delete a specific controller

Specified by:

deleteReplicationController in interface Kubernetes

Throws:

Exception

deleteService

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

Specified by:

deleteService in interface Kubernetes

Throws:

Exception

getReplicationControllers

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

Description copied from interface: Kubernetes

List all replicationControllers on this cluster

Specified by:

getReplicationControllers in interface Kubernetes

getReplicationControllers

public ReplicationControllerList getReplicationControllers(@QueryParam(value="namespace")
                                                  String namespace)

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,
                                                   ReplicationController 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,
                                     Service 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

updateService

public String updateService(@PathParam(value="serviceId")@NotNull
                   String serviceId,
                   Service entity,
                   @QueryParam(value="namespace")
                   String namespace)
                     throws Exception

Description copied from interface: Kubernetes

Update a service

Specified by:

updateService in interface Kubernetes

Throws:

Exception

getService

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

Description copied from interface: Kubernetes

Get a specific service

Specified by:

getService in interface Kubernetes

getService

public Service getService(@PathParam(value="serviceId")@NotNull
                 String serviceId,
                 @QueryParam(value="namespace")
                 String namespace)

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(Service 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 Pod getPod(@NotNull
                  String podId)

Description copied from interface: Kubernetes

Get a specific pod

Specified by:

getPod in interface Kubernetes

getPod

public Pod getPod(@PathParam(value="podId")@NotNull
         String podId,
         @QueryParam(value="namespace")
         String namespace)

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,
                                 Pod 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

updatePod

public String updatePod(@PathParam(value="podId")@NotNull
               String podId,
               Pod entity,
               @QueryParam(value="namespace")
               String namespace)
                 throws Exception

Description copied from interface: Kubernetes

Update a pod

Specified by:

updatePod in interface Kubernetes

Throws:

Exception

getServices

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

Description copied from interface: Kubernetes

List all services on this cluster

Specified by:

getServices in interface Kubernetes

getServices

public ServiceList getServices(@QueryParam(value="namespace")
                      String namespace)

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(Pod 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

createPod

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

Specified by:

createPod in interface Kubernetes

Throws:

Exception

createReplicationController

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

Specified by:

createReplicationController in interface Kubernetes

Throws:

Exception

createService

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

Specified by:

createService in interface Kubernetes

Throws:

Exception

createReplicationController

@Path(value="replicationControllers")
@POST
@Consumes(value="application/json")
public String createReplicationController(ReplicationController 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

getEndpoints

@GET
@Path(value="endpoints")
public EndpointsList getEndpoints()

Description copied from interface: Kubernetes

List all service endpoints on this cluster

Specified by:

getEndpoints in interface Kubernetes

endpointsForService

@GET
@Path(value="endpoints/{serviceId}")
public Endpoints endpointsForService(@NotNull
                                     String serviceId,
                                     String namespace)

Description copied from interface: Kubernetes

List all endpoints for a service

Specified by:

endpointsForService in interface Kubernetes

getMinions

@GET
@Path(value="minions")
public MinionList getMinions()

Description copied from interface: Kubernetes

List all the minions on this cluster

Specified by:

getMinions in interface Kubernetes

minion

@GET
@Path(value="minions/{minionId}")
public Minion minion(@NotNull
                     String minionId)

Description copied from interface: Kubernetes

List all endpoints for a service

Specified by:

minion in interface Kubernetes

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

deletePod

public void deletePod(Pod entity)
               throws Exception

Throws:

Exception

deleteService

public void deleteService(Service entity)
                   throws Exception

Throws:

Exception

deleteReplicationController

public void deleteReplicationController(ReplicationController entity)
                                 throws Exception

Throws:

Exception

getReplicationControllerForPod

public ReplicationController getReplicationControllerForPod(String podId)

getReplicationControllerForPod

public ReplicationController getReplicationControllerForPod(Pod pod)

getPodsForReplicationController

public List<Pod> getPodsForReplicationController(ReplicationController service)

getPodsForReplicationController

public List<Pod> getPodsForReplicationController(String replicationControllerId)

getPodsForService

public List<Pod> getPodsForService(Service service)

getPodsForService

public List<Pod> getPodsForService(String serviceId)

getWriteableKubernetes

protected Kubernetes getWriteableKubernetes()

getPodList

protected Collection<Pod> getPodList()