Add an API concepts document and describe terminology and API chunking

_data/reference.yml

@@ -23,6 +23,7 @@ toc:
     - docs/admin/authorization/rbac.md
     - docs/admin/authorization/node.md
     - docs/admin/authorization/webhook.md
+  - docs/reference/api-concepts.md
   - docs/reference/deprecation-policy.md
   - docs/reference/workloads-18-19.md
 

docs/reference/api-concepts.md

@@ -0,0 +1,230 @@
+---
+title: Kubernetes API Concepts
+approvers:
+- bgrant0607
+- smarterclayton
+- lavalamp
+- liggitt
+---
+
+{% capture overview %}
+This page describes common concepts in the Kubernetes API. 
+{% endcapture %}
+
+{% capture body %}
+The Kubernetes API is a resource-based (RESTful) programatic interface provided via HTTP. It supports retrieving, creating,
+updating, and deleting primary resources via the standard HTTP verbs (POST, PUT, PATCH, DELETE, GET), includes additional subresources for many objects that allow fine grained authorization (such as binding a pod to a node), and can accept and serve those resources in different representations for convenience or efficiency. It also supports efficient change notifications on resources via "watches" and consistent lists to allow other components to effectively cache and synchronize the state of resources.
+
+## Standard API terminology
+
+Most Kubernetes API resource types are "objects" - they represent a concrete instance of a concept on the cluster, like a pod or namespace. A smaller number of API resource types are "virtual" - they often represent operations rather than objects, such as a permission check (use a POST with a JSON-encoded body of `SubjectAccessReview` to the `subjectaccessreviews` resource). All objects will have a unique name to allow idempotent creation and retrieval, but virtual resource types may not have unique names if they are not retrievable or do not rely on idempotency.
+
+Kubernetes generally leverages standard RESTful terminology to describe the API concepts:
+
+* A **resource type** is the name used in the URL (`pods`, `namespaces`, `services`)
+* All resource types have a concrete representation in JSON (their object schema) which is called a **kind**
+* A list of instances of a resource type is known as a **collection**
+* A single instance of the resource type is called a **resource**
+
+All resource types are either scoped by the cluster (`/apis/GROUP/VERSION/*`) or to a namespace (`/apis/GROUP/VERSION/namespaces/NAMESPACE/*`). A namespace-scoped resource type will be deleted when its namespace is deleted and access to that resource type is controlled by authorization checks on the namespace scope. The following paths are used to retrieve collections and resources:
+
+* Cluster-scoped resources: 
+  * `GET /apis/GROUP/VERSION/RESOURCETYPE` - return the collection of resources of the resource type
+  * `GET /apis/GROUP/VERSION/RESOURCETYPE/NAME` - return the resource with NAME under the resource type
+* Namespace-scoped resources: 
+  * `GET /apis/GROUP/VERSION/RESOURCETYPE` - return the collection of all instances of the resource type across all namespaces
+  * `GET /apis/GROUP/VERSION/namespaces/NAMESPACE/RESOURCETYPE` - return collection of all instances of the resource type in NAMESPACE
+  * `GET /apis/GROUP/VERSION/namespaces/NAMESPACE/RESOURCETYPE/NAME` - return the instance of the resource type with NAME in NAMESPACE
+
+Since a namespace is a cluster-scoped resource type, you can retrieve the list of all namespaces with `GET /api/v1/namespaces` and details about a particular namespace with `GET /api/v1/namespaces/NAME`.
+
+Almost all object resource types support the standard HTTP verbs - GET, POST, PUT, PATCH, and DELETE. Kubernetes uses the term **list** to describe returning a collection of resources to distinguish from retrieving a single resource which is usually called a **get**. 
+
+Some resource types will have one or more sub-resources, represented as sub paths below the resource:
+
+* Cluster-scoped subresource: `GET /apis/GROUP/VERSION/RESOURCETYPE/NAME/SUBRESOURCE`
+* Namespace-scoped subresource: `GET /apis/GROUP/VERSION/namespaces/NAMESPACE/RESOURCETYPE/NAME/SUBRESOURCE`
+
+The verbs supported for each subresource will differ depending on the object - see the API documentation more information. It is not possible to access sub-resources across multiple resources - generally a new virtual resource type would be used if that becomes necessary.
+
+
+## Efficient detection of changes
+
+To enable clients to build a model of the current state of a cluster, all Kubernetes object resource types are required to support consistent lists and an incremental change notification feed called a **watch**.  Every Kubernetes object has a `resourceVersion` field representing the version of that resource as stored in the underlying database. When retrieving a collection of resources (either namespace or cluster scoped), the response from the server will contain a `resourceVersion` value that can be used to initiate a watch against the server. The server will return all changes (creates, deletes, and updates) that occur after the supplied `resourceVersion`. This allows a client to fetch the current state and then watch for changes without missing any updates. If the client watch is disconnected they can restart a new watch from the last returned `resourceVersion`, or perform a new collection request and begin again.
+
+For example:
+
+1. List all of the pods in a given namespace.
+
+        GET /api/v1/namespaces/test/pods
+        ---
+        200 OK
+        Content-Type: application/json
+        {
+          "kind": "PodList",
+          "apiVersion": "v1",
+          "metadata": {"resourceVersion":"10245"},
+          "items": [...]
+        }
+
+2. Starting from resource version 10245, receive notifications of any creates, deletes, or updates as individual JSON objects.
+
+        GET /api/v1/namespaces/test/pods?watch=1&resourceVersion=10245
+        ---
+        200 OK
+        Transfer-Encoding: chunked
+        Content-Type: application/json
+        {
+          "type": "ADDED",
+          "object": {"kind": "Pod", "apiVersion": "v1", "metadata": {"resourceVersion": "10596", ...}, ...}
+        }
+        {
+          "type": "MODIFIED",
+          "object": {"kind": "Pod", "apiVersion": "v1", "metadata": {"resourceVersion": "11020", ...}, ...}
+        }
+        ...
+
+A given Kubernetes server will only preserve a historical list of changes for a limited time. Older clusters using etcd2 preserve a maximum of 1000 changes. Newer clusters using etcd3 preserve changes in the last 5 minutes by default.  When the requested watch operations fail because the historical version of that resource is not available, clients must handle the case by recognizing the status code `410 Gone`, clearing their local cache, performing a list operation, and starting the watch from the `resourceVersion` returned by that new list operation. Most client libraries offer some form of standard tool for this logic. (In Go this is called a `Reflector` and is located in the `k8s.io/client-go/cache` package.)
+
+## Retrieving large results sets in chunks
+
+On large clusters, retrieving the collection of some resource types may result in very large responses that can impact the server and client. For instance, a cluster may have tens of thousands of pods, each of which is 1-2kb of encoded JSON. Retrieving all pods across all namespaces may result in a very large response (10-20MB) and consume a large amount of server resources. Starting in Kubernetes 1.9 the server supports the ability to break a single large collection request into many smaller chunks while preserving the consistency of the total request. Each chunk can be returned sequentially which reduces both the total size of the request and allows user-oriented clients to display results incrementally to improve responsiveness.
+
+To retrieve a single list in chunks, two new parameters `limit` and `continue` are supported on collection requests and a new field `continue` is returned from all list operations in the list `metadata` field. A client should specify the maximum results they wish to receive in each chunk with `limit` and the server will return up to `limit` resources in the result and include a `continue` value if there are more resources in the collection. The client can then pass this `continue` value to the server on the next request to instruct the server to return the next chunk of results. By continuing until the server returns an empty `continue` value the client can consume the full set of results. 
+
+Like a watch operation, a `continue` token will expire after a short amount of time (by default 5 minutes) and return a `410 Gone` if more results cannot be returned. In this case, the client will need to start from the beginning or omit the `limit` parameter.
+
+For example, if there are 1,253 pods on the cluster and the client wants to receive chunks of 500 pods at a time, they would request those chunks as follows:
+
+1. List all of the pods on a cluster, retrieving up to 500 pods each time.
+
+        GET /api/v1/pods?limit=500
+        ---
+        200 OK
+        Content-Type: application/json
+        {
+          "kind": "PodList",
+          "apiVersion": "v1",
+          "metadata": {
+            "resourceVersion":"10245",
+            "continue": "ENCODED_CONTINUE_TOKEN",
+            ...
+          },
+          "items": [...] // returns pods 1-500
+        }
+
+2. Continue the previous call, retrieving the next set of 500 pods.
+
+        GET /api/v1/pods?limit=500&continue=ENCODED_CONTINUE_TOKEN
+        ---
+        200 OK
+        Content-Type: application/json
+        {
+          "kind": "PodList",
+          "apiVersion": "v1",
+          "metadata": {
+            "resourceVersion":"10245",
+            "continue": "ENCODED_CONTINUE_TOKEN_2",
+            ...
+          },
+          "items": [...] // returns pods 501-1000
+        }
+
+3. Continue the previous call, retrieving the last 253 pods.
+
+        GET /api/v1/pods?limit=500&continue=ENCODED_CONTINUE_TOKEN_2
+        ---
+        200 OK
+        Content-Type: application/json
+        {
+          "kind": "PodList",
+          "apiVersion": "v1",
+          "metadata": {
+            "resourceVersion":"10245",
+            "continue": "", // continue token is empty because we have reached the end of the list
+            ...
+          },
+          "items": [...] // returns pods 1001-1253
+        }
+
+Note that the `resourceVersion` of the list remains constant across each request, indicating the server is showing us a consistent snapshot of the pods. Pods that are created, updated, or deleted after version `10245` would not be shown unless the user makes a list request without the `continue` token.  This allows clients to break large requests into smaller chunks and then perform a watch operation on the full set without missing any updates.
+
+
+## Alternate representations of resources
+
+By default Kubernetes returns objects serialized to JSON with content type `application/json`. This is the default serialization format for the API. However, clients may request the more efficient Protobuf representation of these objects for better performance at scale. The Kubernetes API implements standard HTTP content type negotation: passing an `Accept` header with a `GET` call will request that the server return objects in the provided content type, while sending an object in Protobuf to the server for a `PUT` or `POST` call takes the `Content-Type` header. The server will return a `Content-Type` header if the requested format is supported, or the `406 Not acceptable` error if an invalid content type is provided.
+
+See the API documentation for a list of supported content types for each API.
+
+For example:
+
+1. List all of the pods on a cluster in Protobuf format.
+
+        GET /api/v1/pods
+        Accept: application/vnd.kubernetes.protobuf
+        ---
+        200 OK
+        Content-Type: application/vnd.kubernetes.protobuf
+        ... binary encoded PodList object
+
+2. Create a pod by sending Protobuf encoded data to the server, but request a response in JSON.
+
+        POST /api/v1/namespaces/test/pods
+        Content-Type: application/vnd.kubernetes.protobuf
+        Accept: application/json
+        ... binary encoded Pod object
+        ---
+        200 OK
+        Content-Type: application/json
+        {
+          "kind": "Pod",
+          "apiVersion": "v1",
+          ...
+        }
+
+Not all API resource types will support Protobuf, specifically those defined via Custom Resource Definitions or those that are API extensions. Clients that must work against all resource types should specify multiple content types in their `Accept` header to support fallback to JSON:
+
+```
+Accept: application/vnd.kubernetes.protobuf, application/json
+```
+
+
+### Protobuf encoding
+
+Kubernetes uses an envelope wrapper to encode Protobuf responses. That wrapper starts with a 4 byte magic number to help identify content in disk or in etcd as Protobuf (as opposed to JSON), and then is followed by a Protobuf encoded wrapper message, which describes the encoding and type of the underlying object and then contains the object.
+
+The wrapper format is:
+
+```
+A four byte magic number prefix:
+  Bytes 0-3: "k8s\x00" [0x6b, 0x38, 0x73, 0x00]
+
+An encoded Protobuf message with the following IDL:
+  message Unknown {
+    // typeMeta should have the string values for "kind" and "apiVersion" as set on the JSON object
+    optional TypeMeta typeMeta = 1;
+
+    // raw will hold the complete serialized object in protobuf. See the protobuf definitions in the client libraries for a given kind.
+    optional bytes raw = 2;
+
+    // contentEncoding is encoding used for the raw data. Unspecified means no encoding.
+    optional string contentEncoding = 3;
+
+    // contentType is the serialization method used to serialize 'raw'. Unspecified means application/vnd.kubernetes.protobuf and is usually
+    // omitted.
+    optional string contentType = 4;
+  }
+
+  message TypeMeta {
+    // apiVersion is the group/version for this type
+    optional string apiVersion = 1;
+    // kind is the name of the object schema. A protobuf definition should exist for this object.
+    optional string kind = 2;
+  }
+```
+
+Clients that receive a response in `application/vnd.kubernetes.protobuf` that does not match the expected prefix should reject the response, as future versions may need to alter the serialization format in an incompatible way and will do so by changing the prefix.
+
+{% endcapture %}
+
+{% include templates/concept.md %}