io.fabric8.kubernetes.api

Interface Kubernetes

All Known Implementing Classes:

KubernetesClient

@Path(value="api/v1beta1")
@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.

Method Summary

Methods

Modifier and Type	Method and Description
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	deletePod(String podId) Delete a specific pod
String	deleteReplicationController(String controllerId) Delete a specific controller
String	deleteService(String serviceId) Delete a specific service
PodSchema	getPod(String podId) Get a specific pod
PodListSchema	getPods() List all pods on this cluster
ReplicationControllerSchema	getReplicationController(String controllerId) Get a specific controller
ReplicationControllerListSchema	getReplicationControllers() List all replicationControllers on this cluster
ServiceSchema	getService(String serviceId) Get a specific service
ServiceListSchema	getServices() List all services on this cluster
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

Method Detail

getPods

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

List all pods on this cluster

createPod

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

Create a new pod. currentState is ignored if present.

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

getPod

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

Get a specific pod

Parameters:

podId -

updatePod

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

Update a pod

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" } }

podId -

Throws:

Exception

deletePod

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

Delete a specific pod

Parameters:

podId -

Throws:

Exception

getServices

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

List all services on this cluster

createService

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

Create a new service

Parameters:

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")
ServiceSchema getService(@PathParam(value="serviceId")@NotNull
                                         String serviceId)

Get a specific service

Parameters:

serviceId -

updateService

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

Update a service

Parameters:

serviceId -

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

Throws:

Exception

deleteService

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

Delete a specific service

Parameters:

serviceId -

Throws:

Exception

getReplicationControllers

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

List all replicationControllers on this cluster

createReplicationController

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

Create a new controller. currentState is ignored if present.

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

getReplicationController

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

Get a specific controller

Parameters:

controllerId -

updateReplicationController

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

Update a controller

Parameters:

controllerId -

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

deleteReplicationController

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

Delete a specific controller

Parameters:

controllerId -

Throws:

Exception