io.fabric8.kubernetes.api

Interface Kubernetes

All Known Implementing Classes:

KubernetesClient

@Path(value="api/v1")
@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
static String	ROOT_API_PATH
static String	SERVICE_ACCOUNT_TOKEN_FILE

Method Summary

Methods

Modifier and Type	Method and Description
String	createNamespace(io.fabric8.kubernetes.api.model.Namespace entity)
String	createPod(io.fabric8.kubernetes.api.model.Pod entity, String namespace)
String	createReplicationController(io.fabric8.kubernetes.api.model.ReplicationController entity, String namespace)
String	createSecret(io.fabric8.kubernetes.api.model.Secret entity, String namespace)
String	createService(io.fabric8.kubernetes.api.model.Service entity, String namespace)
String	deleteNamespace(String name)
String	deletePod(String podId, String namespace)
String	deleteReplicationController(String controllerId, String namespace) Delete a specific controller
String	deleteSecret(String secretId, String namespace)
String	deleteService(String serviceId, String namespace)
io.fabric8.kubernetes.api.model.Endpoints	endpointsForService(String serviceId, String namespace) List all endpoints for a service
io.fabric8.kubernetes.api.model.EndpointsList	getEndpoints(String namespace) List all service endpoints on this cluster
io.fabric8.kubernetes.api.model.Namespace	getNamespace(String name) Get a specific Namespace
io.fabric8.kubernetes.api.model.NamespaceList	getNamespaces() List all namespaces on this cluster
io.fabric8.kubernetes.api.model.NodeList	getNodes() List all the minions on this cluster
io.fabric8.kubernetes.api.model.Pod	getPod(String podId, String namespace) Get a specific pod
io.fabric8.kubernetes.api.model.PodList	getPods(String namespace) List all pods on this cluster
io.fabric8.kubernetes.api.model.ReplicationController	getReplicationController(String controllerId, String namespace) Get a specific controller
io.fabric8.kubernetes.api.model.ReplicationControllerList	getReplicationControllers(String namespace) List all replicationControllers on this cluster
io.fabric8.kubernetes.api.model.Secret	getSecret(String secretId, String namespace) Get a specific secret
io.fabric8.kubernetes.api.model.SecretList	getSecrets(String namespace) List all secrets on this cluster
io.fabric8.kubernetes.api.model.Service	getService(String serviceId, String namespace) Get a specific service
io.fabric8.kubernetes.api.model.ServiceList	getServices(String namespace) List all services on this cluster
io.fabric8.kubernetes.api.model.Node	node(String nodeId) List all endpoints for a service
String	updateNamespace(String namespaceId, io.fabric8.kubernetes.api.model.Namespace entity) Update a namespace
String	updatePod(String podId, io.fabric8.kubernetes.api.model.Pod entity, String namespace) Update a pod
String	updateReplicationController(String controllerId, io.fabric8.kubernetes.api.model.ReplicationController entity, String namespace)
String	updateSecret(String secretId, io.fabric8.kubernetes.api.model.Secret entity, String namespace) Update a secret
String	updateService(String serviceId, io.fabric8.kubernetes.api.model.Service entity, String namespace) Update a service

Field Detail

ROOT_API_PATH

static final String ROOT_API_PATH

See Also:

Constant Field Values

NAMESPACE_ALL

static final String NAMESPACE_ALL

See Also:

Constant Field Values

NAMESPACE_DEFAULT

static final String NAMESPACE_DEFAULT

See Also:

Constant Field Values

SERVICE_ACCOUNT_TOKEN_FILE

static final String SERVICE_ACCOUNT_TOKEN_FILE

See Also:

Constant Field Values

Method Detail

getNamespaces

@GET
@Path(value="namespaces")
io.fabric8.kubernetes.api.model.NamespaceList getNamespaces()

List all namespaces on this cluster

createNamespace

@POST
@Path(value="namespaces")
@Consumes(value="application/json")
String createNamespace(io.fabric8.kubernetes.api.model.Namespace entity)
                       throws Exception

Throws:

Exception

getNamespace

@GET
@Path(value="namespaces/{name}")
io.fabric8.kubernetes.api.model.Namespace getNamespace(@PathParam(value="name")@NotNull
                                                              String name)

Get a specific Namespace

updateNamespace

@PUT
@Path(value="namespaces/{name}")
@Consumes(value="application/json")
String updateNamespace(@PathParam(value="name")@NotNull
                                       String namespaceId,
                                       io.fabric8.kubernetes.api.model.Namespace entity)
                       throws Exception

Update a namespace

Parameters:

namespaceId -

entity -

Throws:

Exception

deleteNamespace

@DELETE
@Path(value="namespaces/{name}")
@Consumes(value="text/plain")
String deleteNamespace(@PathParam(value="name")@NotNull
                                          String name)
                       throws Exception

Throws:

Exception

getPods

@GET
@Path(value="namespaces/{namespace}/pods")
io.fabric8.kubernetes.api.model.PodList getPods(@PathParam(value="namespace")
                                                       String namespace)

List all pods on this cluster

Parameters:

namespace -

createPod

@POST
@Path(value="namespaces/{namespace}/pods")
@Consumes(value="application/json")
String createPod(io.fabric8.kubernetes.api.model.Pod entity,
                                  @PathParam(value="namespace")
                                  String namespace)
                 throws Exception

Throws:

Exception

getPod

@GET
@Path(value="namespaces/{namespace}/pods/{podId}")
io.fabric8.kubernetes.api.model.Pod getPod(@PathParam(value="podId")@NotNull
                                                  String podId,
                                                  @PathParam(value="namespace")
                                                  String namespace)

Get a specific pod

Parameters:

podId -

namespace -

updatePod

@PUT
@Path(value="namespaces/{namespace}/pods/{podId}")
@Consumes(value="application/json")
String updatePod(@PathParam(value="podId")@NotNull
                                 String podId,
                                 io.fabric8.kubernetes.api.model.Pod entity,
                                 @PathParam(value="namespace")
                                 String namespace)
                 throws Exception

Update a pod

Parameters:

podId -

entity -

namespace -

Throws:

Exception

deletePod

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

Throws:

Exception

getServices

@Path(value="namespaces/{namespace}/services")
@GET
@Produces(value="application/json")
io.fabric8.kubernetes.api.model.ServiceList getServices(@PathParam(value="namespace")
                                                                        String namespace)

List all services on this cluster

Parameters:

namespace -

createService

@Path(value="namespaces/{namespace}/services")
@POST
@Consumes(value="application/json")
String createService(io.fabric8.kubernetes.api.model.Service entity,
                                      @PathParam(value="namespace")
                                      String namespace)
                     throws Exception

Throws:

Exception

getService

@GET
@Path(value="namespaces/{namespace}/services/{serviceId}")
@Produces(value="application/json")
io.fabric8.kubernetes.api.model.Service getService(@PathParam(value="serviceId")@NotNull
                                                                   String serviceId,
                                                                   @PathParam(value="namespace")
                                                                   String namespace)

Get a specific service

Parameters:

serviceId -

namespace -

updateService

@PUT
@Path(value="namespaces/{namespace}/services/{serviceId}")
@Consumes(value="application/json")
String updateService(@PathParam(value="serviceId")@NotNull
                                     String serviceId,
                                     io.fabric8.kubernetes.api.model.Service entity,
                                     @PathParam(value="namespace")
                                     String namespace)
                     throws Exception

Update a service

Throws:

Exception

deleteService

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

Throws:

Exception

getReplicationControllers

@Path(value="namespaces/{namespace}/replicationcontrollers")
@GET
@Produces(value="application/json")
io.fabric8.kubernetes.api.model.ReplicationControllerList getReplicationControllers(@PathParam(value="namespace")
                                                                                                    String namespace)

List all replicationControllers on this cluster

Parameters:

namespace -

createReplicationController

@Path(value="namespaces/{namespace}/replicationcontrollers")
@POST
@Consumes(value="application/json")
String createReplicationController(io.fabric8.kubernetes.api.model.ReplicationController entity,
                                                    @PathParam(value="namespace")
                                                    String namespace)
                                   throws Exception

Throws:

Exception

updateReplicationController

@PUT
@Path(value="namespaces/{namespace}/replicationcontrollers/{controllerId}")
@Consumes(value="application/json")
String updateReplicationController(@PathParam(value="controllerId")@NotNull
                                                   String controllerId,
                                                   io.fabric8.kubernetes.api.model.ReplicationController entity,
                                                   @PathParam(value="namespace")
                                                   String namespace)
                                   throws Exception

Throws:

Exception

getReplicationController

@GET
@Path(value="namespaces/{namespace}/replicationcontrollers/{controllerId}")
@Produces(value="application/json")
io.fabric8.kubernetes.api.model.ReplicationController getReplicationController(@PathParam(value="controllerId")@NotNull
                                                                                               String controllerId,
                                                                                               @PathParam(value="namespace")
                                                                                               String namespace)

Get a specific controller

Parameters:

controllerId -

namespace -

deleteReplicationController

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

Delete a specific controller

Parameters:

controllerId -

Throws:

Exception

getEndpoints

@GET
@Path(value="namespaces/{namespace}/endpoints")
io.fabric8.kubernetes.api.model.EndpointsList getEndpoints(@PathParam(value="namespace")
                                                                  String namespace)

List all service endpoints on this cluster

endpointsForService

@GET
@Path(value="namespaces/{namespace}/endpoints/{serviceId}")
io.fabric8.kubernetes.api.model.Endpoints endpointsForService(@PathParam(value="serviceId")@NotNull
                                                                     String serviceId,
                                                                     @PathParam(value="namespace")
                                                                     String namespace)

List all endpoints for a service

getSecrets

@Path(value="namespaces/{namespace}/secrets")
@GET
@Produces(value="application/json")
io.fabric8.kubernetes.api.model.SecretList getSecrets(@PathParam(value="namespace")
                                                                      String namespace)

List all secrets on this cluster

Parameters:

namespace -

createSecret

@Path(value="namespaces/{namespace}/secrets")
@POST
@Consumes(value="application/json")
String createSecret(io.fabric8.kubernetes.api.model.Secret entity,
                                     @PathParam(value="namespace")
                                     String namespace)
                    throws Exception

Throws:

Exception

getSecret

@GET
@Path(value="namespaces/{namespace}/secrets/{secretId}")
@Produces(value="application/json")
io.fabric8.kubernetes.api.model.Secret getSecret(@PathParam(value="secretId")@NotNull
                                                                 String secretId,
                                                                 @PathParam(value="namespace")
                                                                 String namespace)

Get a specific secret

Parameters:

secretId -

namespace -

updateSecret

@PUT
@Path(value="namespaces/{namespace}/secrets/{secretId}")
@Consumes(value="application/json")
String updateSecret(@PathParam(value="secretId")@NotNull
                                    String secretId,
                                    io.fabric8.kubernetes.api.model.Secret entity,
                                    @PathParam(value="namespace")
                                    String namespace)
                    throws Exception

Update a secret

Throws:

Exception

deleteSecret

@DELETE
@Path(value="namespaces/{namespace}/secrets/{secretId}")
@Produces(value="application/json")
@Consumes(value="text/plain")
String deleteSecret(@PathParam(value="secretId")@NotNull
                                                String secretId,
                                                @PathParam(value="namespace")
                                                String namespace)
                    throws Exception

Throws:

Exception

getNodes

@GET
@Path(value="nodes")
io.fabric8.kubernetes.api.model.NodeList getNodes()

List all the minions on this cluster

node

@GET
@Path(value="nodes/{nodeId}")
io.fabric8.kubernetes.api.model.Node node(@PathParam(value="nodeId")@NotNull
                                                 String nodeId)

List all endpoints for a service