github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-30 15:05:27 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #14522 from lavalamp/3p-api-group

Browse Source 
Auto commit by PR queue bot
This commit is contained in:
k8s-merge-robot 2015-10-08 21:15:11 -07:00
commit 219294623e
1 changed files with 15 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/design/extending-api.md
View File

@ -73,11 +73,11 @@ Kubernetes API server to provide the following features:
The `Kind` for an instance of a third-party object (e.g. CronTab) below is expected to be The `Kind` for an instance of a third-party object (e.g. CronTab) below is expected to be
programmatically convertible to the name of the resource using programmatically convertible to the name of the resource using
the following conversion. Kinds are expected to be of the form `<CamelCaseKind>`, the the following conversion. Kinds are expected to be of the form `<CamelCaseKind>`, the
`APIVersion` for the object is expected to be `<domain-name>/<api-group>/<api-version>`. `APIVersion` for the object is expected to be `<api-group>/<api-version>`. To
prevent collisions, it's expected that you'll use a fulling qualified domain
name for the API group, e.g. `example.com`.
For example `example.com/stable/v1` For example `stable.example.com/v1`
`domain-name` is expected to be a fully qualified domain name.
'CamelCaseKind' is the specific type name. 'CamelCaseKind' is the specific type name.
@ -113,18 +113,17 @@ For example, if a user creates:
```yaml ```yaml
metadata: metadata:
name: cron-tab.example.com name: cron-tab.stable.example.com
apiVersion: experimental/v1alpha1 apiVersion: experimental/v1alpha1
kind: ThirdPartyResource kind: ThirdPartyResource
description: "A specification of a Pod to run on a cron style schedule" description: "A specification of a Pod to run on a cron style schedule"
versions: versions:
- name: stable/v1 - name: v1
- name: experimental/v2 - name: v2
``` ```
Then the API server will program in two new RESTful resource paths: Then the API server will program in the new RESTful resource path:
* `/thirdparty/example.com/stable/v1/namespaces/<namespace>/crontabs/...` * `/apis/stable.example.com/v1/namespaces/<namespace>/crontabs/...`
* `/thirdparty/example.com/experimental/v2/namespaces/<namespace>/crontabs/...`
Now that this schema has been created, a user can `POST`: Now that this schema has been created, a user can `POST`:
@ -134,19 +133,19 @@ Now that this schema has been created, a user can `POST`:
"metadata": { "metadata": {
"name": "my-new-cron-object" "name": "my-new-cron-object"
}, },
"apiVersion": "example.com/stable/v1", "apiVersion": "stable.example.com/v1",
"kind": "CronTab", "kind": "CronTab",
"cronSpec": "* * * * /5", "cronSpec": "* * * * /5",
"image": "my-awesome-chron-image" "image": "my-awesome-chron-image"
} }
``` ```
to: `/third-party/example.com/stable/v1/namespaces/default/crontabs/my-new-cron-object` to: `/apis/stable.example.com/v1/namespaces/default/crontabs`
and the corresponding data will be stored into etcd by the APIServer, so that when the user issues: and the corresponding data will be stored into etcd by the APIServer, so that when the user issues:
``` ```
GET /third-party/example.com/stable/v1/namespaces/default/crontabs/my-new-cron-object` GET /apis/stable.example.com/v1/namespaces/default/crontabs/my-new-cron-object`
``` ```
And when they do that, they will get back the same data, but with additional Kubernetes metadata And when they do that, they will get back the same data, but with additional Kubernetes metadata
@ -155,21 +154,21 @@ And when they do that, they will get back the same data, but with additional Kub
Likewise, to list all resources, a user can issue: Likewise, to list all resources, a user can issue:
``` ```
GET /third-party/example.com/stable/v1/namespaces/default/crontabs GET /apis/stable.example.com/v1/namespaces/default/crontabs
``` ```
and get back: and get back:
```json ```json
{ {
"apiVersion": "example.com/stable/v1", "apiVersion": "stable.example.com/v1",
"kind": "CronTabList", "kind": "CronTabList",
"items": [ "items": [
{ {
"metadata": { "metadata": {
"name": "my-new-cron-object" "name": "my-new-cron-object"
}, },
"apiVersion": "example.com/stable/v1", "apiVersion": "stable.example.com/v1",
"kind": "CronTab", "kind": "CronTab",
"cronSpec": "* * * * /5", "cronSpec": "* * * * /5",
"image": "my-awesome-chron-image" "image": "my-awesome-chron-image"