Skip to content

Commit

Permalink
generated
Browse files Browse the repository at this point in the history
  • Loading branch information
deads2k committed Dec 13, 2017
1 parent 6c58566 commit d4ee63c
Show file tree
Hide file tree
Showing 287 changed files with 48,435 additions and 21,724 deletions.
25 changes: 25 additions & 0 deletions api/docs/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,19 @@
File: v1.APIGroup
- Name: v1.APIGroupList
File: v1.APIGroupList
- Name: /apis/apps/v1
Dir: apis-apps
Topics:
- Name: v1.ControllerRevision
File: v1.ControllerRevision
- Name: v1.DaemonSet
File: v1.DaemonSet
- Name: v1.Deployment
File: v1.Deployment
- Name: v1.ReplicaSet
File: v1.ReplicaSet
- Name: v1.StatefulSet
File: v1.StatefulSet
- Name: /apis/apps/v1beta1
Dir: apis-apps
Topics:
Expand Down Expand Up @@ -115,6 +128,13 @@
Topics:
- Name: v1beta1.PodDisruptionBudget
File: v1beta1.PodDisruptionBudget
- Name: /apis/admissionregistration.k8s.io/v1beta1
Dir: apis-admissionregistration.k8s.io
Topics:
- Name: v1beta1.MutatingWebhookConfiguration
File: v1beta1.MutatingWebhookConfiguration
- Name: v1beta1.ValidatingWebhookConfiguration
File: v1beta1.ValidatingWebhookConfiguration
- Name: /apis/authentication.k8s.io/v1
Dir: apis-authentication.k8s.io
Topics:
Expand Down Expand Up @@ -174,6 +194,11 @@
Topics:
- Name: v1beta1.CertificateSigningRequest
File: v1beta1.CertificateSigningRequest
- Name: /apis/events.k8s.io/v1beta1
Dir: apis-events.k8s.io
Topics:
- Name: v1beta1.Event
File: v1beta1.Event
- Name: /apis/networking.k8s.io/v1
Dir: apis-networking.k8s.io
Topics:
Expand Down
123 changes: 123 additions & 0 deletions api/docs/api/v1.APIResourceList.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,88 @@ $ curl -k \
* application/vnd.kubernetes.protobuf


[[Get-apis-admissionregistration.k8s.io-v1beta1]]
=== Get all APIResourceLists
Get available resources

==== HTTP request
----
GET /apis/admissionregistration.k8s.io/v1beta1/ HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
----

==== Curl request
----
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/admissionregistration.k8s.io/v1beta1/
----

==== Responses
[cols="1,5", options="header"]
|===
|HTTP Code|Schema
|200 OK|v1.APIResourceList
|401 Unauthorized|
|===

==== Consumes

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf


[[Get-apis-apps-v1]]
=== Get all APIResourceLists
Get available resources

==== HTTP request
----
GET /apis/apps/v1/ HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
----

==== Curl request
----
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/apps/v1/
----

==== Responses
[cols="1,5", options="header"]
|===
|HTTP Code|Schema
|200 OK|v1.APIResourceList
|401 Unauthorized|
|===

==== Consumes

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf


[[Get-apis-apps-v1beta1]]
=== Get all APIResourceLists
Get available resources
Expand Down Expand Up @@ -573,6 +655,47 @@ $ curl -k \
* application/vnd.kubernetes.protobuf


[[Get-apis-events.k8s.io-v1beta1]]
=== Get all APIResourceLists
Get available resources

==== HTTP request
----
GET /apis/events.k8s.io/v1beta1/ HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
----

==== Curl request
----
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/events.k8s.io/v1beta1/
----

==== Responses
[cols="1,5", options="header"]
|===
|HTTP Code|Schema
|200 OK|v1.APIResourceList
|401 Unauthorized|
|===

==== Consumes

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf


[[Get-apis-extensions-v1beta1]]
=== Get all APIResourceLists
Get available resources
Expand Down
6 changes: 5 additions & 1 deletion api/docs/api/v1.Binding.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Expand or mouse-over a field for more information about it.
Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata">creationTimestamp</span>:
</div><div style="margin-left:13px;"> <span title="(integer) Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.">deletionGracePeriodSeconds</span>:
</div><div style="margin-left:13px;"> <span title="(v1.Time) DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
</div><div style="margin-left:13px;"> <span title="(v1.Time) DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata">deletionTimestamp</span>:
</div><details><summary> <span title="(array) Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.">finalizers</span>:
Expand Down Expand Up @@ -159,6 +159,8 @@ EOF
|===
|HTTP Code|Schema
|200 OK|v1.Binding
|201 Created|v1.Binding
|202 Accepted|v1.Binding
|401 Unauthorized|
|===

Expand Down Expand Up @@ -236,6 +238,8 @@ EOF
|===
|HTTP Code|Schema
|200 OK|v1.Binding
|201 Created|v1.Binding
|202 Accepted|v1.Binding
|401 Unauthorized|
|===

Expand Down
2 changes: 1 addition & 1 deletion api/docs/api/v1.ComponentStatus.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Expand or mouse-over a field for more information about it.
Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata">creationTimestamp</span>:
</div><div style="margin-left:13px;"> <span title="(integer) Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.">deletionGracePeriodSeconds</span>:
</div><div style="margin-left:13px;"> <span title="(v1.Time) DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
</div><div style="margin-left:13px;"> <span title="(v1.Time) DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata">deletionTimestamp</span>:
</div><details><summary> <span title="(array) Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.">finalizers</span>:
Expand Down
9 changes: 7 additions & 2 deletions api/docs/api/v1.ConfigMap.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Expand or mouse-over a field for more information about it.
Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata">creationTimestamp</span>:
</div><div style="margin-left:13px;"> <span title="(integer) Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.">deletionGracePeriodSeconds</span>:
</div><div style="margin-left:13px;"> <span title="(v1.Time) DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
</div><div style="margin-left:13px;"> <span title="(v1.Time) DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata">deletionTimestamp</span>:
</div><details><summary> <span title="(array) Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.">finalizers</span>:
Expand Down Expand Up @@ -153,6 +153,8 @@ EOF
|===
|HTTP Code|Schema
|200 OK|v1.ConfigMap
|201 Created|v1.ConfigMap
|202 Accepted|v1.ConfigMap
|401 Unauthorized|
|===

Expand Down Expand Up @@ -230,6 +232,8 @@ EOF
|===
|HTTP Code|Schema
|200 OK|v1.ConfigMap
|201 Created|v1.ConfigMap
|202 Accepted|v1.ConfigMap
|401 Unauthorized|
|===

Expand Down Expand Up @@ -676,6 +680,7 @@ EOF
|===
|HTTP Code|Schema
|200 OK|v1.ConfigMap
|201 Created|v1.ConfigMap
|401 Unauthorized|
|===

Expand Down Expand Up @@ -821,7 +826,7 @@ EOF
|pretty|If 'true', then the output is pretty printed.
|gracePeriodSeconds|The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
|orphanDependents|Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
|propagationPolicy|Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.
|propagationPolicy|Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
|===

==== Responses
Expand Down
Loading

0 comments on commit d4ee63c

Please sign in to comment.