diff --git a/api/kubernetes.html b/api/kubernetes.html index eedc17e86eb..7223a540fa1 100644 --- a/api/kubernetes.html +++ b/api/kubernetes.html @@ -111,16 +111,16 @@

Overview

-

The Kubernetes API currently manages 3 main resources: tasks, -replicationControllers, and services. Tasks correspond to +

The Kubernetes API currently manages 3 main resources: pods, +replicationControllers, and services. Pods correspond to colocated groups of Docker containers with shared volumes, as supported by Google Cloud Platform's container-vm images. -Singleton tasks can be created directly via the /tasks -endpoint. Sets of tasks may created, maintained, and scaled using +Singleton pods can be created directly via the /pods +endpoint. Sets of pods may created, maintained, and scaled using replicationControllers. Services create load-balanced targets -for sets of tasks.

+for sets of pods.

Resource identifiers

@@ -131,7 +131,7 @@ is a map of string (key) to string (value). Each resource may have at most one label with a particular key. Individual labels are used to specify identifying metadata that can be used to define sets of resources by specifying required labels. Examples -of typical task label keys include stage, service, name, +of typical pod label keys include stage, service, name, tier, partition, and track, but you are free to develop your own conventions.

@@ -176,7 +176,7 @@ resource during a read/modify/write cycle. The correct client action at this point is to GET the resource again, apply the changes afresh and try submitting again.

Note that updates currently only work for replicationControllers -and services, but not for tasks. Label updates have not yet been +and services, but not for pods. Label updates have not yet been implemented, either.

@@ -185,7 +185,7 @@ implemented, either.

-

/tasks

+

/pods

@@ -195,28 +195,28 @@ implemented, either.

-

-
+
- + get - List all tasks on this cluster + List all pods on this cluster - + post - Create a new task. currentState is ignored if present. + Create a new pod. currentState is ignored if present.
@@ -224,35 +224,35 @@ implemented, either.

-
+
-

List all tasks on this cluster

+

List all pods on this cluster

-
+
@@ -261,7 +261,7 @@ implemented, either.

-
+

HTTP status code 200

@@ -278,7 +278,7 @@ implemented, either.

{
     "items": [
         {
-            "id": "my-task-1",
+            "id": "my-pod-1",
             "labels": {
                 "name": "testRun",
                 "replicationController": "testRun"
@@ -299,7 +299,7 @@ implemented, either.

             }
         },
         {
-            "id": "my-task-2",
+            "id": "my-pod-2",
             "labels": {
                 "name": "testRun",
                 "replicationController": "testRun"
@@ -333,31 +333,31 @@ implemented, either.
-
+
-

Create a new task. currentState is ignored if present.

+

Create a new pod. currentState is ignored if present.

-
+
@@ -373,7 +373,7 @@ implemented, either.

"$schema": "http://json-schema.org/draft-03/schema", "type": "object", "required": false, - "description": "Task resource. A task corresponds to a colocated group of [Docker containers](http://docker.io).", + "description": "Pod resource. A pod corresponds to a colocated group of [Docker containers](http://docker.io).", "properties": { "kind": { "type": "string", @@ -394,7 +394,7 @@ implemented, either.

"desiredState": { "type": "object", "required": false, - "description": "The desired configuration of the task", + "description": "The desired configuration of the pod", "properties": { "manifest": { "type": "object", @@ -426,7 +426,7 @@ implemented, either.

"currentState": { "type": "object", "required": false, - "description": "The current configuration and status of the task. Fields in common with desiredState have the same meaning.", + "description": "The current configuration and status of the pod. Fields in common with desiredState have the same meaning.", "properties": { "manifest": { "type": "object", @@ -497,7 +497,7 @@ implemented, either.

-

-
+
- + get - Get a specific task + Get a specific pod - + put - Update a task + Update a pod - + delete - Delete a specific task + Delete a specific pod
@@ -533,40 +533,40 @@ implemented, either.

-
+
-

Get a specific task

+

Get a specific pod

-
+

URI Parameters

    -
  • taskId: string
    • +
  • podId: string
@@ -577,7 +577,7 @@ implemented, either.

-
+

HTTP status code 200

@@ -622,36 +622,36 @@ implemented, either.

-
+
-

Update a task

+

Update a pod

-
+

URI Parameters

    -
  • taskId: string
    • +
  • podId: string
@@ -669,7 +669,7 @@ implemented, either.

"$schema": "http://json-schema.org/draft-03/schema", "type": "object", "required": false, - "description": "Task resource. A task corresponds to a colocated group of [Docker containers](http://docker.io).", + "description": "Pod resource. A pod corresponds to a colocated group of [Docker containers](http://docker.io).", "properties": { "kind": { "type": "string", @@ -690,7 +690,7 @@ implemented, either.

"desiredState": { "type": "object", "required": false, - "description": "The desired configuration of the task", + "description": "The desired configuration of the pod", "properties": { "manifest": { "type": "object", @@ -722,7 +722,7 @@ implemented, either.

"currentState": { "type": "object", "required": false, - "description": "The current configuration and status of the task. Fields in common with desiredState have the same meaning.", + "description": "The current configuration and status of the pod. Fields in common with desiredState have the same meaning.", "properties": { "manifest": { "type": "object", @@ -787,40 +787,40 @@ implemented, either.

-
+
-

Delete a specific task

+

Delete a specific pod

-
+

URI Parameters

    -
  • taskId: string
    • +
  • podId: string
@@ -831,7 +831,7 @@ implemented, either.

-
+

HTTP status code 200

@@ -972,7 +972,7 @@ implemented, either.

"replicasInSet": { "name": "testRun" }, - "taskTemplate": { + "podTemplate": { "desiredState": { "image": "dockerfile/nginx", "networkPorts": [ @@ -1045,7 +1045,7 @@ implemented, either.

"$schema": "http://json-schema.org/draft-03/schema", "type": "object", "required": false, - "description": "A replicationController resource. A replicationController helps to create and manage a set of tasks. It acts as a factory to create new tasks based on a template. It ensures that there are a specific number of tasks running. If fewer tasks are running than `replicas` then the needed tasks are generated using `taskTemplate`. If more tasks are running than `replicas`, then excess tasks are deleted.", + "description": "A replicationController resource. A replicationController helps to create and manage a set of pods. It acts as a factory to create new pods based on a template. It ensures that there are a specific number of pods running. If fewer pods are running than `replicas` then the needed pods are generated using `podTemplate`. If more pods are running than `replicas`, then excess pods are deleted.", "properties": { "kind": { "type": "string", @@ -1071,17 +1071,17 @@ implemented, either.

"replicas": { "type": "number", "required": false, - "description": "Number of tasks desired in the set" + "description": "Number of pods desired in the set" }, "replicasInSet": { "type": "object", "required": false, - "description": "Required labels used to identify tasks in the set" + "description": "Required labels used to identify pods in the set" }, - "taskTemplate": { + "podTemplate": { "type": "object", "required": false, - "description": "Template from which to create new tasks, as necessary. Identical to task schema." + "description": "Template from which to create new pods, as necessary. Identical to pod schema." } } }, @@ -1100,7 +1100,7 @@ implemented, either.

"desiredState": { "replicas": 2, "replicasInSet": {"name": "nginx"}, - "taskTemplate": { + "podTemplate": { "desiredState": { "manifest": { "containers": [{ @@ -1231,7 +1231,7 @@ implemented, either.

"desiredState": { "replicas": 2, "replicasInSet": {"name": "nginx"}, - "taskTemplate": { + "podTemplate": { "desiredState": { "manifest": { "containers": [{ @@ -1304,7 +1304,7 @@ implemented, either.

"$schema": "http://json-schema.org/draft-03/schema", "type": "object", "required": false, - "description": "A replicationController resource. A replicationController helps to create and manage a set of tasks. It acts as a factory to create new tasks based on a template. It ensures that there are a specific number of tasks running. If fewer tasks are running than `replicas` then the needed tasks are generated using `taskTemplate`. If more tasks are running than `replicas`, then excess tasks are deleted.", + "description": "A replicationController resource. A replicationController helps to create and manage a set of pods. It acts as a factory to create new pods based on a template. It ensures that there are a specific number of pods running. If fewer pods are running than `replicas` then the needed pods are generated using `podTemplate`. If more pods are running than `replicas`, then excess pods are deleted.", "properties": { "kind": { "type": "string", @@ -1330,17 +1330,17 @@ implemented, either.

"replicas": { "type": "number", "required": false, - "description": "Number of tasks desired in the set" + "description": "Number of pods desired in the set" }, "replicasInSet": { "type": "object", "required": false, - "description": "Required labels used to identify tasks in the set" + "description": "Required labels used to identify pods in the set" }, - "taskTemplate": { + "podTemplate": { "type": "object", "required": false, - "description": "Template from which to create new tasks, as necessary. Identical to task schema." + "description": "Template from which to create new pods, as necessary. Identical to pod schema." } } }, @@ -1359,7 +1359,7 @@ implemented, either.

"desiredState": { "replicas": 2, "replicasInSet": {"name": "nginx"}, - "taskTemplate": { + "podTemplate": { "desiredState": { "manifest": { "containers": [{ @@ -2002,7 +2002,7 @@ implemented, either.