io.fabric8.kubernetes.api

Interface Kubernetes

All Known Implementing Classes:

KubernetesClient

@Path(value="api/v1beta2")
@Produces(value="application/json")
@Consumes(value="application/json")
public interface Kubernetes

Represents the Remote API to working with Kubernetes providing a facade over the generated JAXRS client.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAMESPACE_ALL
static String	NAMESPACE_DEFAULT

Method Summary

Methods

Modifier and Type	Method and Description
String	createPod(Pod entity, String namespace)
String	createReplicationController(ReplicationController entity, String namespace)
String	createService(Service entity, String namespace)
String	deletePod(String podId, String namespace)
String	deleteReplicationController(String controllerId, String namespace) Delete a specific controller
String	deleteService(String serviceId, String namespace)
Endpoints	endpointsForService(String serviceId, String namespace) List all endpoints for a service
EndpointsList	getEndpoints(String namespace) List all service endpoints on this cluster
MinionList	getMinions() List all the minions on this cluster
Pod	getPod(String podId, String namespace) Get a specific pod
PodList	getPods(String namespace) List all pods on this cluster
ReplicationController	getReplicationController(String controllerId, String namespace) Get a specific controller
ReplicationControllerList	getReplicationControllers(String namespace) List all replicationControllers on this cluster
Service	getService(String serviceId, String namespace) Get a specific service
ServiceList	getServices(String namespace) List all services on this cluster
Minion	minion(String minionId) List all endpoints for a service
String	updatePod(String podId, Pod entity, String namespace) Update a pod
String	updateReplicationController(String controllerId, ReplicationController entity, String namespace)
String	updateService(String serviceId, Service entity, String namespace) Update a service

Field Detail

NAMESPACE_ALL

static final String NAMESPACE_ALL

See Also:

Constant Field Values

NAMESPACE_DEFAULT

static final String NAMESPACE_DEFAULT

See Also:

Constant Field Values

Method Detail

getPods

@GET
@Path(value="pods")
PodList getPods(@QueryParam(value="namespace")
                       String namespace)

List all pods on this cluster

Parameters:

namespace -

createPod

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

Throws:

Exception

getPod

@GET
@Path(value="pods/{podId}")
Pod getPod(@PathParam(value="podId")@NotNull
                  String podId,
                  @QueryParam(value="namespace")
                  String namespace)

Get a specific pod

Parameters:

podId -

namespace -

updatePod

@PUT
@Path(value="pods/{podId}")
@Consumes(value="application/json")
String updatePod(@PathParam(value="podId")@NotNull
                                 String podId,
                                 Pod entity,
                                 @QueryParam(value="namespace")
                                 String namespace)
                 throws Exception

Update a pod

Parameters:

podId -

entity -

namespace -

Throws:

Exception

deletePod

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

Throws:

Exception

getServices

@Path(value="services")
@GET
@Produces(value="application/json")
ServiceList getServices(@QueryParam(value="namespace")
                                        String namespace)

List all services on this cluster

Parameters:

namespace -

createService

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

Throws:

Exception

getService

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

Get a specific service

Parameters:

serviceId -

namespace -

updateService

@PUT
@Path(value="services/{serviceId}")
@Consumes(value="application/json")
String updateService(@PathParam(value="serviceId")@NotNull
                                     String serviceId,
                                     Service entity,
                                     @QueryParam(value="namespace")
                                     String namespace)
                     throws Exception

Update a service

Throws:

Exception

deleteService

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

Throws:

Exception

getReplicationControllers

@Path(value="replicationControllers")
@GET
@Produces(value="application/json")
ReplicationControllerList getReplicationControllers(@QueryParam(value="namespace")
                                                                    String namespace)

List all replicationControllers on this cluster

Parameters:

namespace -

createReplicationController

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

Throws:

Exception

updateReplicationController

@PUT
@Path(value="replicationControllers/{controllerId}")
@Consumes(value="application/json")
String updateReplicationController(@PathParam(value="controllerId")@NotNull
                                                   String controllerId,
                                                   ReplicationController entity,
                                                   @QueryParam(value="namespace")
                                                   String namespace)
                                   throws Exception

Throws:

Exception

getReplicationController

@GET
@Path(value="replicationControllers/{controllerId}")
@Produces(value="application/json")
ReplicationController getReplicationController(@PathParam(value="controllerId")@NotNull
                                                               String controllerId,
                                                               @QueryParam(value="namespace")
                                                               String namespace)

Get a specific controller

Parameters:

controllerId -

namespace -

deleteReplicationController

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

Delete a specific controller

Parameters:

controllerId -

Throws:

Exception

getEndpoints

@GET
@Path(value="endpoints")
EndpointsList getEndpoints(@QueryParam(value="namespace")
                                  String namespace)

List all service endpoints on this cluster

endpointsForService

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

List all endpoints for a service

getMinions

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

List all the minions on this cluster

minion

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

List all endpoints for a service