Merge pull request #2237 from pwittrock/update-ref
Update reference docs to fix issues with query vs path paramspull/2192/head^2
commit
53b571f6b7
|
@ -22,3 +22,5 @@ Session.vim
|
|||
*~
|
||||
# auto-generated tag files
|
||||
tags
|
||||
|
||||
kubernetes.github.io.iml
|
||||
|
|
|
@ -22,6 +22,8 @@ Appears In <a href="#apigrouplist-unversioned">APIGroupList</a> </aside>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
name <br /> *string* | name is the name of the group.
|
||||
preferredVersion <br /> *[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned)* | preferredVersion is the version preferred by the API server, which probably is the storage version.
|
||||
serverAddressByClientCIDRs <br /> *[ServerAddressByClientCIDR](#serveraddressbyclientcidr-unversioned) array* | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
|
||||
|
@ -34,7 +36,9 @@ versions <br /> *[GroupVersionForDiscovery](#groupversionfordiscovery-unversione
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
groups <br /> *[APIGroup](#apigroup-unversioned) array* | groups is a list of APIGroup.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -13,6 +13,8 @@ Appears In <a href="#apigrouplist-unversioned">APIGroupList</a> </aside>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
name <br /> *string* | name is the name of the group.
|
||||
preferredVersion <br /> *[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned)* | preferredVersion is the version preferred by the API server, which probably is the storage version.
|
||||
serverAddressByClientCIDRs <br /> *[ServerAddressByClientCIDR](#serveraddressbyclientcidr-unversioned) array* | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
|
||||
|
|
|
@ -21,7 +21,9 @@ APIGroupList is a list of APIGroup, to allow clients to discover the API at /api
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
groups <br /> *[APIGroup](#apigroup-unversioned) array* | groups is a list of APIGroup.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -12,5 +12,7 @@ APIGroupList is a list of APIGroup, to allow clients to discover the API at /api
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
groups <br /> *[APIGroup](#apigroup-unversioned) array* | groups is a list of APIGroup.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
|
|
|
@ -33,7 +33,9 @@ namespaced <br /> *boolean* | namespaced indicates if a resource is namespaced
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
groupVersion <br /> *string* | groupVersion is the group and version this APIResourceList is for.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
resources <br /> *[APIResource](#apiresource-unversioned) array* | resources contains the name of the resources and if they are namespaced.
|
||||
|
||||
|
||||
|
|
|
@ -21,7 +21,9 @@ APIResourceList is a list of APIResource, it is used to expose the name of the r
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
groupVersion <br /> *string* | groupVersion is the group and version this APIResourceList is for.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
resources <br /> *[APIResource](#apiresource-unversioned) array* | resources contains the name of the resources and if they are namespaced.
|
||||
|
||||
|
||||
|
|
|
@ -12,6 +12,8 @@ APIResourceList is a list of APIResource, it is used to expose the name of the r
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
groupVersion <br /> *string* | groupVersion is the group and version this APIResourceList is for.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
resources <br /> *[APIResource](#apiresource-unversioned) array* | resources contains the name of the resources and if they are namespaced.
|
||||
|
||||
|
|
|
@ -21,6 +21,8 @@ APIVersions lists the versions that are available, to allow clients to discover
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
serverAddressByClientCIDRs <br /> *[ServerAddressByClientCIDR](#serveraddressbyclientcidr-unversioned) array* | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
|
||||
versions <br /> *string array* | versions are the api versions that are available.
|
||||
|
||||
|
|
|
@ -12,6 +12,8 @@ APIVersions lists the versions that are available, to allow clients to discover
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
serverAddressByClientCIDRs <br /> *[ServerAddressByClientCIDR](#serveraddressbyclientcidr-unversioned) array* | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
|
||||
versions <br /> *string array* | versions are the api versions that are available.
|
||||
|
||||
|
|
|
@ -0,0 +1,36 @@
|
|||
|
||||
|
||||
-----------
|
||||
# AWSElasticBlockStoreVolumeSource v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | AWSElasticBlockStoreVolumeSource
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Represents a Persistent Disk resource in AWS.
|
||||
|
||||
An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#persistentvolumespec-v1">PersistentVolumeSpec</a> <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
fsType <br /> *string* | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
|
||||
partition <br /> *integer* | The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
|
||||
readOnly <br /> *boolean* | Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
|
||||
volumeID <br /> *string* | Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
## AWSElasticBlockStoreVolumeSource v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | AWSElasticBlockStoreVolumeSource
|
||||
|
||||
|
||||
|
||||
Represents a Persistent Disk resource in AWS.
|
||||
|
||||
An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#persistentvolumespec-v1">PersistentVolumeSpec</a> <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
fsType <br /> *string* | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
|
||||
partition <br /> *integer* | The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
|
||||
readOnly <br /> *boolean* | Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
|
||||
volumeID <br /> *string* | Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
|
||||
|
||||
-----------
|
||||
# AzureDiskVolumeSource v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | AzureDiskVolumeSource
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#persistentvolumespec-v1">PersistentVolumeSpec</a> <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
cachingMode <br /> *string* | Host Caching mode: None, Read Only, Read Write.
|
||||
diskName <br /> *string* | The Name of the data disk in the blob storage
|
||||
diskURI <br /> *string* | The URI the data disk in the blob storage
|
||||
fsType <br /> *string* | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
|
||||
readOnly <br /> *boolean* | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
## AzureDiskVolumeSource v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | AzureDiskVolumeSource
|
||||
|
||||
|
||||
|
||||
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#persistentvolumespec-v1">PersistentVolumeSpec</a> <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
cachingMode <br /> *string* | Host Caching mode: None, Read Only, Read Write.
|
||||
diskName <br /> *string* | The Name of the data disk in the blob storage
|
||||
diskURI <br /> *string* | The URI the data disk in the blob storage
|
||||
fsType <br /> *string* | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
|
||||
readOnly <br /> *boolean* | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
|
||||
|
||||
-----------
|
||||
# AzureFileVolumeSource v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | AzureFileVolumeSource
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#persistentvolumespec-v1">PersistentVolumeSpec</a> <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
readOnly <br /> *boolean* | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
secretName <br /> *string* | the name of secret that contains Azure Storage Account Name and Key
|
||||
shareName <br /> *string* | Share Name
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
## AzureFileVolumeSource v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | AzureFileVolumeSource
|
||||
|
||||
|
||||
|
||||
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#persistentvolumespec-v1">PersistentVolumeSpec</a> <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
readOnly <br /> *boolean* | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
secretName <br /> *string* | the name of secret that contains Azure Storage Account Name and Key
|
||||
shareName <br /> *string* | Share Name
|
||||
|
|
@ -21,6 +21,8 @@ Binding ties one object to another. For example, a pod is bound to a node by a s
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
target <br /> *[ObjectReference](#objectreference-v1)* | The target object that you want to bind to the standard object.
|
||||
|
||||
|
@ -77,10 +79,19 @@ create a Binding
|
|||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Binding](#binding-v1)* |
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Binding](#binding-v1)* |
|
||||
|
||||
### Response
|
||||
|
||||
|
|
|
@ -12,6 +12,8 @@ Binding ties one object to another. For example, a pod is bound to a node by a s
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
target <br /> *[ObjectReference](#objectreference-v1)* | The target object that you want to bind to the standard object.
|
||||
|
||||
|
|
|
@ -0,0 +1,36 @@
|
|||
|
||||
|
||||
-----------
|
||||
# CephFSVolumeSource v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | CephFSVolumeSource
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#persistentvolumespec-v1">PersistentVolumeSpec</a> <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
monitors <br /> *string array* | Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
|
||||
path <br /> *string* | Optional: Used as the mounted root, rather than the full Ceph tree, default is /
|
||||
readOnly <br /> *boolean* | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
|
||||
secretFile <br /> *string* | Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
|
||||
secretRef <br /> *[LocalObjectReference](#localobjectreference-v1)* | Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
|
||||
user <br /> *string* | Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
## CephFSVolumeSource v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | CephFSVolumeSource
|
||||
|
||||
|
||||
|
||||
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#persistentvolumespec-v1">PersistentVolumeSpec</a> <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
monitors <br /> *string array* | Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
|
||||
path <br /> *string* | Optional: Used as the mounted root, rather than the full Ceph tree, default is /
|
||||
readOnly <br /> *boolean* | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
|
||||
secretFile <br /> *string* | Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
|
||||
secretRef <br /> *[LocalObjectReference](#localobjectreference-v1)* | Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
|
||||
user <br /> *string* | Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
|
||||
|
|
@ -22,6 +22,8 @@ Appears In <a href="#certificatesigningrequestlist-v1alpha1">CertificateSigningR
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* |
|
||||
spec <br /> *[CertificateSigningRequestSpec](#certificatesigningrequestspec-v1alpha1)* | The certificate request itself and any additional information.
|
||||
status <br /> *[CertificateSigningRequestStatus](#certificatesigningrequeststatus-v1alpha1)* | Derived information about the request.
|
||||
|
@ -55,7 +57,9 @@ conditions <br /> *[CertificateSigningRequestCondition](#certificatesigningreque
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1) array* |
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* |
|
||||
|
||||
|
||||
|
@ -106,13 +110,14 @@ create a CertificateSigningRequest
|
|||
|
||||
`POST /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
@ -171,10 +176,15 @@ replace the specified CertificateSigningRequest
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CertificateSigningRequest
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* |
|
||||
|
@ -232,10 +242,15 @@ partially update the specified CertificateSigningRequest
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CertificateSigningRequest
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
@ -293,16 +308,21 @@ delete a CertificateSigningRequest
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CertificateSigningRequest
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
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 | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -351,22 +371,19 @@ delete collection of CertificateSigningRequest
|
|||
|
||||
`DELETE /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -425,15 +442,16 @@ read the specified CertificateSigningRequest
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CertificateSigningRequest
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
|
||||
export | Should this value be exported. Export strips fields that a user can not specify.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -482,22 +500,19 @@ list or watch objects of kind CertificateSigningRequest
|
|||
|
||||
`GET /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -548,11 +563,16 @@ watch changes to an object of kind CertificateSigningRequest
|
|||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CertificateSigningRequest
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the CertificateSigningRequest
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
|
|
|
@ -13,6 +13,8 @@ Appears In <a href="#certificatesigningrequestlist-v1alpha1">CertificateSigning
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* |
|
||||
spec <br /> *[CertificateSigningRequestSpec](#certificatesigningrequestspec-v1alpha1)* | The certificate request itself and any additional information.
|
||||
status <br /> *[CertificateSigningRequestStatus](#certificatesigningrequeststatus-v1alpha1)* | Derived information about the request.
|
||||
|
|
|
@ -21,7 +21,9 @@ Certificates | v1alpha1 | CertificateSigningRequestList
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1) array* |
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* |
|
||||
|
||||
|
||||
|
@ -73,7 +75,8 @@ watch individual changes to a list of CertificateSigningRequest
|
|||
|
||||
`GET /apis/certificates.k8s.io/v1alpha1/watch/certificatesigningrequests`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
|
|
@ -12,6 +12,8 @@ Certificates | v1alpha1 | CertificateSigningRequestList
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1) array* |
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* |
|
||||
|
||||
|
|
|
@ -78,10 +78,19 @@ replace status of the specified CertificateSigningRequest
|
|||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* |
|
||||
name | name of the CertificateSigningRequest
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* |
|
||||
|
||||
### Response
|
||||
|
||||
|
|
|
@ -0,0 +1,33 @@
|
|||
|
||||
|
||||
-----------
|
||||
# CinderVolumeSource v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | CinderVolumeSource
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#persistentvolumespec-v1">PersistentVolumeSpec</a> <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
fsType <br /> *string* | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
|
||||
readOnly <br /> *boolean* | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
|
||||
volumeID <br /> *string* | volume id used to identify the volume in cinder More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
## CinderVolumeSource v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | CinderVolumeSource
|
||||
|
||||
|
||||
|
||||
Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#persistentvolumespec-v1">PersistentVolumeSpec</a> <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
fsType <br /> *string* | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
|
||||
readOnly <br /> *boolean* | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
|
||||
volumeID <br /> *string* | volume id used to identify the volume in cinder More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
|
||||
|
|
@ -22,6 +22,8 @@ Appears In <a href="#clusterrolelist-v1alpha1">ClusterRoleList</a> </aside>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata.
|
||||
rules <br /> *[PolicyRule](#policyrule-v1alpha1) array* | Rules holds all the PolicyRules for this ClusterRole
|
||||
|
||||
|
@ -32,7 +34,9 @@ rules <br /> *[PolicyRule](#policyrule-v1alpha1) array* | Rules holds all the P
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[ClusterRole](#clusterrole-v1alpha1) array* | Items is a list of ClusterRoles
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard object's metadata.
|
||||
|
||||
|
||||
|
@ -83,13 +87,14 @@ create a ClusterRole
|
|||
|
||||
`POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
@ -148,10 +153,15 @@ replace the specified ClusterRole
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRole
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[ClusterRole](#clusterrole-v1alpha1)* |
|
||||
|
@ -209,10 +219,15 @@ partially update the specified ClusterRole
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRole
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
@ -270,16 +285,21 @@ delete a ClusterRole
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRole
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
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 | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -328,22 +348,19 @@ delete collection of ClusterRole
|
|||
|
||||
`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -402,6 +419,11 @@ read the specified ClusterRole
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRole
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
|
@ -453,22 +475,19 @@ list or watch objects of kind ClusterRole
|
|||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -521,64 +540,9 @@ watch changes to an object of kind ClusterRole
|
|||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the ClusterRole
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
## Watch List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of ClusterRole
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles`
|
||||
|
||||
### Path Parameters
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
|
|
@ -13,6 +13,8 @@ Appears In <a href="#clusterrolelist-v1alpha1">ClusterRoleList</a> </aside>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata.
|
||||
rules <br /> *[PolicyRule](#policyrule-v1alpha1) array* | Rules holds all the PolicyRules for this ClusterRole
|
||||
|
||||
|
|
|
@ -22,6 +22,8 @@ Appears In <a href="#clusterrolebindinglist-v1alpha1">ClusterRoleBindingList</a>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata.
|
||||
roleRef <br /> *[RoleRef](#roleref-v1alpha1)* | RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
|
||||
subjects <br /> *[Subject](#subject-v1alpha1) array* | Subjects holds references to the objects the role applies to.
|
||||
|
@ -33,7 +35,9 @@ subjects <br /> *[Subject](#subject-v1alpha1) array* | Subjects holds reference
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1) array* | Items is a list of ClusterRoleBindings
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard object's metadata.
|
||||
|
||||
|
||||
|
@ -84,13 +88,14 @@ create a ClusterRoleBinding
|
|||
|
||||
`POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
@ -149,10 +154,15 @@ replace the specified ClusterRoleBinding
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRoleBinding
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* |
|
||||
|
@ -210,10 +220,15 @@ partially update the specified ClusterRoleBinding
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRoleBinding
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
@ -271,16 +286,21 @@ delete a ClusterRoleBinding
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRoleBinding
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
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 | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -329,22 +349,19 @@ delete collection of ClusterRoleBinding
|
|||
|
||||
`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -403,6 +420,11 @@ read the specified ClusterRoleBinding
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRoleBinding
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
|
@ -454,22 +476,19 @@ list or watch objects of kind ClusterRoleBinding
|
|||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -520,11 +539,77 @@ watch changes to an object of kind ClusterRoleBinding
|
|||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRoleBinding
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
## Watch List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of ClusterRoleBinding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings`
|
||||
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the ClusterRoleBinding
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
|
|
|
@ -13,6 +13,8 @@ Appears In <a href="#clusterrolebindinglist-v1alpha1">ClusterRoleBindingList</a
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata.
|
||||
roleRef <br /> *[RoleRef](#roleref-v1alpha1)* | RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
|
||||
subjects <br /> *[Subject](#subject-v1alpha1) array* | Subjects holds references to the objects the role applies to.
|
||||
|
|
|
@ -7,7 +7,7 @@
|
|||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
RbacAuthorization | v1alpha1 | ClusterRoleBindingList
|
||||
Core | v1alpha1 | ClusterRoleBindingList
|
||||
|
||||
|
||||
|
||||
|
@ -21,76 +21,13 @@ ClusterRoleBindingList is a collection of ClusterRoleBindings
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1) array* | Items is a list of ClusterRoleBindings
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard object's metadata.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Watch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of ClusterRoleBinding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
RbacAuthorization | v1alpha1 | ClusterRoleBindingList
|
||||
Core | v1alpha1 | ClusterRoleBindingList
|
||||
|
||||
|
||||
|
||||
|
@ -12,6 +12,8 @@ ClusterRoleBindingList is a collection of ClusterRoleBindings
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1) array* | Items is a list of ClusterRoleBindings
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard object's metadata.
|
||||
|
||||
|
|
|
@ -7,7 +7,7 @@
|
|||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1alpha1 | ClusterRoleList
|
||||
RbacAuthorization | v1alpha1 | ClusterRoleList
|
||||
|
||||
|
||||
|
||||
|
@ -21,11 +21,79 @@ ClusterRoleList is a collection of ClusterRoles
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[ClusterRole](#clusterrole-v1alpha1) array* | Items is a list of ClusterRoles
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard object's metadata.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Watch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of ClusterRole
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles`
|
||||
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1alpha1 | ClusterRoleList
|
||||
RbacAuthorization | v1alpha1 | ClusterRoleList
|
||||
|
||||
|
||||
|
||||
|
@ -12,6 +12,8 @@ ClusterRoleList is a collection of ClusterRoles
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[ClusterRole](#clusterrole-v1alpha1) array* | Items is a list of ClusterRoles
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard object's metadata.
|
||||
|
||||
|
|
|
@ -22,7 +22,9 @@ Appears In <a href="#componentstatuslist-v1">ComponentStatusList</a> </aside>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
conditions <br /> *[ComponentCondition](#componentcondition-v1) array* | List of component conditions observed
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
|
@ -32,7 +34,9 @@ metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. Mo
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[ComponentStatus](#componentstatus-v1) array* | List of ComponentStatus objects.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
|
||||
|
@ -88,6 +92,11 @@ read the specified ComponentStatus
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ComponentStatus
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
|
@ -139,7 +148,8 @@ list objects of kind ComponentStatus
|
|||
|
||||
`GET /api/v1/componentstatuses`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
|
|
@ -13,6 +13,8 @@ Appears In <a href="#componentstatuslist-v1">ComponentStatusList</a> </aside>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
conditions <br /> *[ComponentCondition](#componentcondition-v1) array* | List of component conditions observed
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
|
|
@ -21,7 +21,9 @@ Status of all the conditions for the component as a list of ComponentStatus obje
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[ComponentStatus](#componentstatus-v1) array* | List of ComponentStatus objects.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
|
||||
|
|
|
@ -12,6 +12,8 @@ Status of all the conditions for the component as a list of ComponentStatus obje
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[ComponentStatus](#componentstatus-v1) array* | List of ComponentStatus objects.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
|
|
|
@ -22,7 +22,9 @@ Appears In <a href="#configmaplist-v1">ConfigMapList</a> </aside>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
data <br /> *object* | Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
|
@ -32,7 +34,9 @@ metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. Mo
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[ConfigMap](#configmap-v1) array* | Items is the list of ConfigMaps.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
|
@ -88,10 +92,15 @@ create a ConfigMap
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[ConfigMap](#configmap-v1)* |
|
||||
|
@ -150,10 +159,15 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the ConfigMap
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[ConfigMap](#configmap-v1)* |
|
||||
|
@ -212,10 +226,15 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the ConfigMap
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
@ -274,16 +293,21 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the ConfigMap
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
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 | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -337,18 +361,19 @@ delete collection of ConfigMap
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -408,15 +433,16 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the ConfigMap
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
|
||||
export | Should this value be exported. Export strips fields that a user can not specify.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -470,18 +496,19 @@ list or watch objects of kind ConfigMap
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -530,7 +557,8 @@ list or watch objects of kind ConfigMap
|
|||
|
||||
`GET /api/v1/configmaps`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
@ -594,10 +622,15 @@ watch changes to an object of kind ConfigMap
|
|||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the ConfigMap
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
|
@ -652,7 +685,8 @@ watch individual changes to a list of ConfigMap
|
|||
|
||||
`GET /api/v1/watch/configmaps`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
|
|
@ -13,6 +13,8 @@ Appears In <a href="#configmaplist-v1">ConfigMapList</a> </aside>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
data <br /> *object* | Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
|
|
@ -23,6 +23,7 @@ Appears In <a href="#envvarsource-v1">EnvVarSource</a> </aside>
|
|||
Field | Description
|
||||
------------ | -----------
|
||||
key <br /> *string* | The key to select.
|
||||
name <br /> *string* | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -14,4 +14,5 @@ Appears In <a href="#envvarsource-v1">EnvVarSource</a> </aside>
|
|||
Field | Description
|
||||
------------ | -----------
|
||||
key <br /> *string* | The key to select.
|
||||
name <br /> *string* | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
|
||||
|
|
|
@ -21,7 +21,9 @@ ConfigMapList is a resource containing a list of ConfigMap objects.
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[ConfigMap](#configmap-v1) array* | Items is the list of ConfigMaps.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
|
@ -75,11 +77,16 @@ watch individual changes to a list of ConfigMap
|
|||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
|
|
|
@ -12,6 +12,8 @@ ConfigMapList is a resource containing a list of ConfigMap objects.
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[ConfigMap](#configmap-v1) array* | Items is the list of ConfigMaps.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
|
|
@ -0,0 +1,35 @@
|
|||
|
||||
|
||||
-----------
|
||||
# ConfigMapVolumeSource v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ConfigMapVolumeSource
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Adapts a ConfigMap into a volume.
|
||||
|
||||
The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
defaultMode <br /> *integer* | Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
|
||||
items <br /> *[KeyToPath](#keytopath-v1) array* | If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the '..' path or start with '..'.
|
||||
name <br /> *string* | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
## ConfigMapVolumeSource v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ConfigMapVolumeSource
|
||||
|
||||
|
||||
|
||||
Adapts a ConfigMap into a volume.
|
||||
|
||||
The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
defaultMode <br /> *integer* | Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
|
||||
items <br /> *[KeyToPath](#keytopath-v1) array* | If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the '..' path or start with '..'.
|
||||
name <br /> *string* | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
|
|
@ -22,6 +22,8 @@ Appears In <a href="#cronjoblist-v2alpha1">CronJobList</a> </aside>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
spec <br /> *[CronJobSpec](#cronjobspec-v2alpha1)* | Spec is a structure defining the expected behavior of a job, including the schedule. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
|
||||
status <br /> *[CronJobStatus](#cronjobstatus-v2alpha1)* | Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
|
||||
|
@ -56,7 +58,9 @@ lastScheduleTime <br /> *[Time](#time-unversioned)* | LastScheduleTime keeps in
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[CronJob](#cronjob-v2alpha1) array* | Items is the list of CronJob.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
|
@ -112,10 +116,15 @@ create a CronJob
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[CronJob](#cronjob-v2alpha1)* |
|
||||
|
@ -174,10 +183,15 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the CronJob
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[CronJob](#cronjob-v2alpha1)* |
|
||||
|
@ -236,10 +250,15 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the CronJob
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
@ -298,16 +317,21 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the CronJob
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
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 | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -361,18 +385,19 @@ delete collection of CronJob
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -432,15 +457,16 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the CronJob
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
|
||||
export | Should this value be exported. Export strips fields that a user can not specify.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -494,18 +520,19 @@ list or watch objects of kind CronJob
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -554,7 +581,8 @@ list or watch objects of kind CronJob
|
|||
|
||||
`GET /apis/batch/v2alpha1/cronjobs`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
@ -618,10 +646,81 @@ watch changes to an object of kind CronJob
|
|||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the CronJob
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
## Watch List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
|
@ -676,7 +775,8 @@ watch individual changes to a list of CronJob
|
|||
|
||||
`GET /apis/batch/v2alpha1/watch/cronjobs`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
@ -696,4 +796,205 @@ Code | Description
|
|||
|
||||
|
||||
|
||||
## <strong>Status Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Patch Status
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
partially update status of the specified CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CronJob
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CronJob](#cronjob-v2alpha1)* | OK
|
||||
|
||||
|
||||
## Read Status
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
read status of the specified CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CronJob
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CronJob](#cronjob-v2alpha1)* | OK
|
||||
|
||||
|
||||
## Replace Status
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
replace status of the specified CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CronJob
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[CronJob](#cronjob-v2alpha1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CronJob](#cronjob-v2alpha1)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -13,6 +13,8 @@ Appears In <a href="#cronjoblist-v2alpha1">CronJobList</a> </aside>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
spec <br /> *[CronJobSpec](#cronjobspec-v2alpha1)* | Spec is a structure defining the expected behavior of a job, including the schedule. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
|
||||
status <br /> *[CronJobStatus](#cronjobstatus-v2alpha1)* | Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
|
||||
|
|
|
@ -7,7 +7,7 @@
|
|||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Batch | v2alpha1 | CronJobList
|
||||
Core | v2alpha1 | CronJobList
|
||||
|
||||
|
||||
|
||||
|
@ -21,77 +21,13 @@ CronJobList is a collection of cron jobs.
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[CronJob](#cronjob-v2alpha1) array* | Items is the list of CronJob.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Watch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Batch | v2alpha1 | CronJobList
|
||||
Core | v2alpha1 | CronJobList
|
||||
|
||||
|
||||
|
||||
|
@ -12,6 +12,8 @@ CronJobList is a collection of cron jobs.
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[CronJob](#cronjob-v2alpha1) array* | Items is the list of CronJob.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
|
|
@ -7,7 +7,7 @@
|
|||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Batch | v2alpha1 | CronJobStatus
|
||||
Core | v2alpha1 | CronJobStatus
|
||||
|
||||
|
||||
|
||||
|
@ -29,195 +29,4 @@ lastScheduleTime <br /> *[Time](#time-unversioned)* | LastScheduleTime keeps in
|
|||
|
||||
|
||||
|
||||
## <strong>Write Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Replace
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
replace status of the specified CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CronJob
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[CronJob](#cronjob-v2alpha1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CronJob](#cronjob-v2alpha1)* | OK
|
||||
|
||||
|
||||
## Patch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
partially update status of the specified CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CronJob
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CronJob](#cronjob-v2alpha1)* | OK
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Read
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
read status of the specified CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CronJob
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CronJob](#cronjob-v2alpha1)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Batch | v2alpha1 | CronJobStatus
|
||||
Core | v2alpha1 | CronJobStatus
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -84,6 +84,8 @@ Appears In <a href="#daemonsetlist-v1beta1">DaemonSetList</a> </aside>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
spec <br /> *[DaemonSetSpec](#daemonsetspec-v1beta1)* | Spec defines the desired behavior of this daemon set. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
|
||||
status <br /> *[DaemonSetStatus](#daemonsetstatus-v1beta1)* | Status is the current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
|
||||
|
@ -117,7 +119,9 @@ numberReady <br /> *integer* | NumberReady is the number of nodes that should b
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[DaemonSet](#daemonset-v1beta1) array* | Items is a list of daemon sets.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
|
@ -276,10 +280,15 @@ create a DaemonSet
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DaemonSet](#daemonset-v1beta1)* |
|
||||
|
@ -338,10 +347,15 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the DaemonSet
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DaemonSet](#daemonset-v1beta1)* |
|
||||
|
@ -400,10 +414,15 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the DaemonSet
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
@ -473,16 +492,21 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the DaemonSet
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
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 | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -536,18 +560,19 @@ delete collection of DaemonSet
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -608,15 +633,16 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the DaemonSet
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
|
||||
export | Should this value be exported. Export strips fields that a user can not specify.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -670,18 +696,19 @@ list or watch objects of kind DaemonSet
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -730,7 +757,8 @@ list or watch objects of kind DaemonSet
|
|||
|
||||
`GET /apis/extensions/v1beta1/daemonsets`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
@ -794,71 +822,15 @@ watch changes to an object of kind DaemonSet
|
|||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the DaemonSet
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
## Watch List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of DaemonSet
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets`
|
||||
|
||||
### Path Parameters
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
|
@ -913,7 +885,8 @@ watch individual changes to a list of DaemonSet
|
|||
|
||||
`GET /apis/extensions/v1beta1/watch/daemonsets`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
@ -984,10 +957,15 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the DaemonSet
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
@ -1046,6 +1024,11 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the DaemonSet
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
|
@ -1103,10 +1086,15 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the DaemonSet
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DaemonSet](#daemonset-v1beta1)* |
|
||||
|
|
|
@ -13,6 +13,8 @@ Appears In <a href="#daemonsetlist-v1beta1">DaemonSetList</a> </aside>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
spec <br /> *[DaemonSetSpec](#daemonsetspec-v1beta1)* | Spec defines the desired behavior of this daemon set. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
|
||||
status <br /> *[DaemonSetStatus](#daemonsetstatus-v1beta1)* | Status is the current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
|
||||
|
|
|
@ -7,7 +7,7 @@
|
|||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | DaemonSetList
|
||||
Extensions | v1beta1 | DaemonSetList
|
||||
|
||||
|
||||
|
||||
|
@ -21,11 +21,84 @@ DaemonSetList is a collection of daemon sets.
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[DaemonSet](#daemonset-v1beta1) array* | Items is a list of daemon sets.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Watch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of DaemonSet
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | DaemonSetList
|
||||
Extensions | v1beta1 | DaemonSetList
|
||||
|
||||
|
||||
|
||||
|
@ -12,6 +12,8 @@ DaemonSetList is a collection of daemon sets.
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[DaemonSet](#daemonset-v1beta1) array* | Items is a list of daemon sets.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
|
|
@ -22,7 +22,9 @@ Appears In <a href="#eviction-v1beta1">Eviction</a> </aside>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
gracePeriodSeconds <br /> *integer* | 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.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
orphanDependents <br /> *boolean* | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
preconditions <br /> *[Preconditions](#preconditions-v1)* | Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
|
||||
|
||||
|
|
|
@ -13,7 +13,9 @@ Appears In <a href="#eviction-v1beta1">Eviction</a> </aside>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
gracePeriodSeconds <br /> *integer* | 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.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
orphanDependents <br /> *boolean* | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
preconditions <br /> *[Preconditions](#preconditions-v1)* | Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
|
||||
|
||||
|
|
|
@ -15,8 +15,8 @@ metadata:
|
|||
spec:
|
||||
# 3 Pods should exist at all times.
|
||||
replicas: 3
|
||||
# Keep record of 10 revisions for rollback
|
||||
revisionHistoryLimit: 10
|
||||
# Keep record of 2 revisions for rollback
|
||||
revisionHistoryLimit: 2
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
|
@ -43,8 +43,8 @@ metadata:
|
|||
spec:
|
||||
# 3 Pods should exist at all times.
|
||||
replicas: 3
|
||||
# Keep record of 10 revisions for rollback
|
||||
revisionHistoryLimit: 10
|
||||
# Keep record of 2 revisions for rollback
|
||||
revisionHistoryLimit: 2
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
|
@ -78,6 +78,8 @@ Appears In <a href="#deploymentlist-v1beta1">DeploymentList</a> </aside>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object metadata.
|
||||
spec <br /> *[DeploymentSpec](#deploymentspec-v1beta1)* | Specification of the desired behavior of the Deployment.
|
||||
status <br /> *[DeploymentStatus](#deploymentstatus-v1beta1)* | Most recently observed status of the Deployment.
|
||||
|
@ -120,7 +122,9 @@ updatedReplicas <br /> *integer* | Total number of non-terminated pods targeted
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[Deployment](#deployment-v1beta1) array* | Items is the list of Deployments.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata.
|
||||
|
||||
### DeploymentStrategy v1beta1
|
||||
|
@ -139,6 +143,8 @@ type <br /> *string* | Type of deployment. Can be "Recreate" or "RollingUpdate"
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
name <br /> *string* | Required: This must match the Name of a deployment.
|
||||
rollbackTo <br /> *[RollbackConfig](#rollbackconfig-v1beta1)* | The config of this deployment rollback.
|
||||
updatedAnnotations <br /> *object* | The annotations to be updated to a deployment
|
||||
|
@ -303,10 +309,15 @@ create a Deployment
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Deployment](#deployment-v1beta1)* |
|
||||
|
@ -468,10 +479,15 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the Deployment
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Deployment](#deployment-v1beta1)* |
|
||||
|
@ -604,10 +620,15 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the Deployment
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
@ -677,16 +698,21 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the Deployment
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
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 | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -740,18 +766,19 @@ delete collection of Deployment
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -950,15 +977,16 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the Deployment
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
|
||||
export | Should this value be exported. Export strips fields that a user can not specify.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -1295,18 +1323,19 @@ list or watch objects of kind Deployment
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -1355,7 +1384,8 @@ list or watch objects of kind Deployment
|
|||
|
||||
`GET /apis/extensions/v1beta1/deployments`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
@ -1566,10 +1596,15 @@ watch changes to an object of kind Deployment
|
|||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the Deployment
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
|
@ -1626,11 +1661,16 @@ watch individual changes to a list of Deployment
|
|||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
|
@ -1685,7 +1725,8 @@ watch individual changes to a list of Deployment
|
|||
|
||||
`GET /apis/extensions/v1beta1/watch/deployments`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
@ -1705,6 +1746,207 @@ Code | Description
|
|||
|
||||
|
||||
|
||||
## <strong>Status Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Patch Status
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
partially update status of the specified Deployment
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the Deployment
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Deployment](#deployment-v1beta1)* | OK
|
||||
|
||||
|
||||
## Read Status
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
read status of the specified Deployment
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the Deployment
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Deployment](#deployment-v1beta1)* | OK
|
||||
|
||||
|
||||
## Replace Status
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
replace status of the specified Deployment
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the Deployment
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Deployment](#deployment-v1beta1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Deployment](#deployment-v1beta1)* | OK
|
||||
|
||||
|
||||
|
||||
## <strong>Misc Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
@ -1756,6 +1998,11 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the Scale
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
|
@ -1813,10 +2060,15 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the Scale
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Scale](#scale-v1beta1)* |
|
||||
|
@ -1875,10 +2127,15 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the Scale
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
@ -1935,11 +2192,20 @@ create rollback of a DeploymentRollback
|
|||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeploymentRollback](#deploymentrollback-v1beta1)* |
|
||||
name | name of the DeploymentRollback
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeploymentRollback](#deploymentrollback-v1beta1)* |
|
||||
|
||||
### Response
|
||||
|
||||
|
|
|
@ -13,6 +13,8 @@ Appears In <a href="#deploymentlist-v1beta1">DeploymentList</a> </aside>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object metadata.
|
||||
spec <br /> *[DeploymentSpec](#deploymentspec-v1beta1)* | Specification of the desired behavior of the Deployment.
|
||||
status <br /> *[DeploymentStatus](#deploymentstatus-v1beta1)* | Most recently observed status of the Deployment.
|
||||
|
|
|
@ -21,7 +21,9 @@ DeploymentList is a list of Deployments.
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[Deployment](#deployment-v1beta1) array* | Items is the list of Deployments.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata.
|
||||
|
||||
|
||||
|
|
|
@ -12,6 +12,8 @@ DeploymentList is a list of Deployments.
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[Deployment](#deployment-v1beta1) array* | Items is the list of Deployments.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata.
|
||||
|
||||
|
|
|
@ -21,6 +21,8 @@ DeploymentRollback stores the information required to rollback a deployment.
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
name <br /> *string* | Required: This must match the Name of a deployment.
|
||||
rollbackTo <br /> *[RollbackConfig](#rollbackconfig-v1beta1)* | The config of this deployment rollback.
|
||||
updatedAnnotations <br /> *object* | The annotations to be updated to a deployment
|
||||
|
|
|
@ -12,6 +12,8 @@ DeploymentRollback stores the information required to rollback a deployment.
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
name <br /> *string* | Required: This must match the Name of a deployment.
|
||||
rollbackTo <br /> *[RollbackConfig](#rollbackconfig-v1beta1)* | The config of this deployment rollback.
|
||||
updatedAnnotations <br /> *object* | The annotations to be updated to a deployment
|
||||
|
|
|
@ -7,7 +7,7 @@
|
|||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Extensions | v1beta1 | DeploymentStatus
|
||||
Core | v1beta1 | DeploymentStatus
|
||||
|
||||
|
||||
|
||||
|
@ -33,195 +33,4 @@ updatedReplicas <br /> *integer* | Total number of non-terminated pods targeted
|
|||
|
||||
|
||||
|
||||
## <strong>Write Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Replace
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
replace status of the specified Deployment
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the Deployment
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Deployment](#deployment-v1beta1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Deployment](#deployment-v1beta1)* | OK
|
||||
|
||||
|
||||
## Patch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
partially update status of the specified Deployment
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the Deployment
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Deployment](#deployment-v1beta1)* | OK
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Read
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
read status of the specified Deployment
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the Deployment
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Deployment](#deployment-v1beta1)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Extensions | v1beta1 | DeploymentStatus
|
||||
Core | v1beta1 | DeploymentStatus
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -0,0 +1,34 @@
|
|||
|
||||
|
||||
-----------
|
||||
# DownwardAPIVolumeFile v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | DownwardAPIVolumeFile
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
DownwardAPIVolumeFile represents information to create the file containing the pod field
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#downwardapivolumesource-v1">DownwardAPIVolumeSource</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
fieldRef <br /> *[ObjectFieldSelector](#objectfieldselector-v1)* | Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
|
||||
mode <br /> *integer* | Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
|
||||
path <br /> *string* | Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
|
||||
resourceFieldRef <br /> *[ResourceFieldSelector](#resourcefieldselector-v1)* | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
## DownwardAPIVolumeFile v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | DownwardAPIVolumeFile
|
||||
|
||||
|
||||
|
||||
DownwardAPIVolumeFile represents information to create the file containing the pod field
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#downwardapivolumesource-v1">DownwardAPIVolumeSource</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
fieldRef <br /> *[ObjectFieldSelector](#objectfieldselector-v1)* | Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
|
||||
mode <br /> *integer* | Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
|
||||
path <br /> *string* | Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
|
||||
resourceFieldRef <br /> *[ResourceFieldSelector](#resourcefieldselector-v1)* | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
|
||||
|
||||
-----------
|
||||
# DownwardAPIVolumeSource v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | DownwardAPIVolumeSource
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
defaultMode <br /> *integer* | Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
|
||||
items <br /> *[DownwardAPIVolumeFile](#downwardapivolumefile-v1) array* | Items is a list of downward API volume file
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
## DownwardAPIVolumeSource v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | DownwardAPIVolumeSource
|
||||
|
||||
|
||||
|
||||
DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
defaultMode <br /> *integer* | Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
|
||||
items <br /> *[DownwardAPIVolumeFile](#downwardapivolumefile-v1) array* | Items is a list of downward API volume file
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
|
||||
|
||||
-----------
|
||||
# EmptyDirVolumeSource v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | EmptyDirVolumeSource
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
medium <br /> *string* | What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
## EmptyDirVolumeSource v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | EmptyDirVolumeSource
|
||||
|
||||
|
||||
|
||||
Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
medium <br /> *string* | What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir
|
||||
|
|
@ -33,6 +33,8 @@ Appears In <a href="#endpointslist-v1">EndpointsList</a> </aside>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
subsets <br /> *[EndpointSubset](#endpointsubset-v1) array* | The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service.
|
||||
|
||||
|
@ -43,7 +45,9 @@ subsets <br /> *[EndpointSubset](#endpointsubset-v1) array* | The set of all en
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[Endpoints](#endpoints-v1) array* | List of endpoints.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
|
||||
|
@ -99,10 +103,15 @@ create Endpoints
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Endpoints](#endpoints-v1)* |
|
||||
|
@ -161,10 +170,15 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the Endpoints
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Endpoints](#endpoints-v1)* |
|
||||
|
@ -223,10 +237,15 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the Endpoints
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
@ -285,16 +304,21 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the Endpoints
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
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 | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -348,18 +372,19 @@ delete collection of Endpoints
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -419,15 +444,16 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the Endpoints
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
|
||||
export | Should this value be exported. Export strips fields that a user can not specify.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -481,18 +507,19 @@ list or watch objects of kind Endpoints
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -541,7 +568,8 @@ list or watch objects of kind Endpoints
|
|||
|
||||
`GET /api/v1/endpoints`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
@ -605,10 +633,81 @@ watch changes to an object of kind Endpoints
|
|||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the Endpoints
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
## Watch List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of Endpoints
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/v1/watch/namespaces/{namespace}/endpoints`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
|
@ -663,7 +762,8 @@ watch individual changes to a list of Endpoints
|
|||
|
||||
`GET /api/v1/watch/endpoints`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
|
|
@ -24,6 +24,8 @@ Appears In <a href="#endpointslist-v1">EndpointsList</a> </aside>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
subsets <br /> *[EndpointSubset](#endpointsubset-v1) array* | The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service.
|
||||
|
||||
|
|
|
@ -21,77 +21,13 @@ EndpointsList is a list of endpoints.
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[Endpoints](#endpoints-v1) array* | List of endpoints.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Watch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of Endpoints
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/v1/watch/namespaces/{namespace}/endpoints`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -12,6 +12,8 @@ EndpointsList is a list of endpoints.
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[Endpoints](#endpoints-v1) array* | List of endpoints.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
|
|
|
@ -22,9 +22,11 @@ Appears In <a href="#eventlist-v1">EventList</a> </aside>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
count <br /> *integer* | The number of times this event has occurred.
|
||||
firstTimestamp <br /> *[Time](#time-unversioned)* | The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)
|
||||
involvedObject <br /> *[ObjectReference](#objectreference-v1)* | The object that this event is about.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
lastTimestamp <br /> *[Time](#time-unversioned)* | The time at which the most recent occurrence of this event was recorded.
|
||||
message <br /> *string* | A human-readable description of the status of this operation.
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
@ -39,7 +41,9 @@ type <br /> *string* | Type of this event (Normal, Warning), new types could be
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[Event](#event-v1) array* | List of events
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
|
||||
|
@ -95,10 +99,15 @@ create an Event
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Event](#event-v1)* |
|
||||
|
@ -157,10 +166,15 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the Event
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Event](#event-v1)* |
|
||||
|
@ -219,10 +233,15 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the Event
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
@ -281,16 +300,21 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the Event
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
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 | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -344,18 +368,19 @@ delete collection of Event
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -415,15 +440,16 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the Event
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
|
||||
export | Should this value be exported. Export strips fields that a user can not specify.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -477,18 +503,19 @@ list or watch objects of kind Event
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -537,7 +564,8 @@ list or watch objects of kind Event
|
|||
|
||||
`GET /api/v1/events`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
@ -601,10 +629,15 @@ watch changes to an object of kind Event
|
|||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the Event
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
|
@ -659,7 +692,8 @@ watch individual changes to a list of Event
|
|||
|
||||
`GET /api/v1/watch/events`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
|
|
@ -13,9 +13,11 @@ Appears In <a href="#eventlist-v1">EventList</a> </aside>
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
count <br /> *integer* | The number of times this event has occurred.
|
||||
firstTimestamp <br /> *[Time](#time-unversioned)* | The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)
|
||||
involvedObject <br /> *[ObjectReference](#objectreference-v1)* | The object that this event is about.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
lastTimestamp <br /> *[Time](#time-unversioned)* | The time at which the most recent occurrence of this event was recorded.
|
||||
message <br /> *string* | A human-readable description of the status of this operation.
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
|
|
@ -21,7 +21,9 @@ EventList is a list of events.
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[Event](#event-v1) array* | List of events
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
|
||||
|
@ -75,11 +77,16 @@ watch individual changes to a list of Event
|
|||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
|
|
|
@ -12,6 +12,8 @@ EventList is a list of events.
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[Event](#event-v1) array* | List of events
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
|
|
|
@ -21,7 +21,9 @@ Eviction evicts a pod from its node subject to certain policies and safety const
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
deleteOptions <br /> *[DeleteOptions](#deleteoptions-v1)* | DeleteOptions may be provided
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | ObjectMeta describes the pod that is being evicted.
|
||||
|
||||
|
||||
|
|
|
@ -12,6 +12,8 @@ Eviction evicts a pod from its node subject to certain policies and safety const
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
deleteOptions <br /> *[DeleteOptions](#deleteoptions-v1)* | DeleteOptions may be provided
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | ObjectMeta describes the pod that is being evicted.
|
||||
|
||||
|
|
|
@ -18,7 +18,7 @@ Core | v1 | ExecAction
|
|||
ExecAction describes a "run in container" action.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#handler-v1">Handler</a> </aside>
|
||||
Appears In <a href="#handler-v1">Handler</a> <a href="#probe-v1">Probe</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
|
|
|
@ -9,7 +9,7 @@ Core | v1 | ExecAction
|
|||
ExecAction describes a "run in container" action.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#handler-v1">Handler</a> </aside>
|
||||
Appears In <a href="#handler-v1">Handler</a> <a href="#probe-v1">Probe</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
|
|
|
@ -0,0 +1,34 @@
|
|||
|
||||
|
||||
-----------
|
||||
# FCVolumeSource v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | FCVolumeSource
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#persistentvolumespec-v1">PersistentVolumeSpec</a> <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
fsType <br /> *string* | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
|
||||
lun <br /> *integer* | Required: FC target lun number
|
||||
readOnly <br /> *boolean* | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
targetWWNs <br /> *string array* | Required: FC target worldwide names (WWNs)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
## FCVolumeSource v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | FCVolumeSource
|
||||
|
||||
|
||||
|
||||
Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#persistentvolumespec-v1">PersistentVolumeSpec</a> <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
fsType <br /> *string* | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
|
||||
lun <br /> *integer* | Required: FC target lun number
|
||||
readOnly <br /> *boolean* | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
targetWWNs <br /> *string array* | Required: FC target worldwide names (WWNs)
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
|
||||
|
||||
-----------
|
||||
# FlexVolumeSource v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | FlexVolumeSource
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#persistentvolumespec-v1">PersistentVolumeSpec</a> <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
driver <br /> *string* | Driver is the name of the driver to use for this volume.
|
||||
fsType <br /> *string* | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
|
||||
options <br /> *object* | Optional: Extra command options if any.
|
||||
readOnly <br /> *boolean* | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
secretRef <br /> *[LocalObjectReference](#localobjectreference-v1)* | Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
## FlexVolumeSource v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | FlexVolumeSource
|
||||
|
||||
|
||||
|
||||
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#persistentvolumespec-v1">PersistentVolumeSpec</a> <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
driver <br /> *string* | Driver is the name of the driver to use for this volume.
|
||||
fsType <br /> *string* | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
|
||||
options <br /> *object* | Optional: Extra command options if any.
|
||||
readOnly <br /> *boolean* | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
secretRef <br /> *[LocalObjectReference](#localobjectreference-v1)* | Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
|
||||
|
||||
-----------
|
||||
# FlockerVolumeSource v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | FlockerVolumeSource
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#persistentvolumespec-v1">PersistentVolumeSpec</a> <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
datasetName <br /> *string* | Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
|
||||
datasetUUID <br /> *string* | UUID of the dataset. This is unique identifier of a Flocker dataset
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
## FlockerVolumeSource v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | FlockerVolumeSource
|
||||
|
||||
|
||||
|
||||
Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#persistentvolumespec-v1">PersistentVolumeSpec</a> <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
datasetName <br /> *string* | Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
|
||||
datasetUUID <br /> *string* | UUID of the dataset. This is unique identifier of a Flocker dataset
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
|
||||
|
||||
-----------
|
||||
# GCEPersistentDiskVolumeSource v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | GCEPersistentDiskVolumeSource
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Represents a Persistent Disk resource in Google Compute Engine.
|
||||
|
||||
A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#persistentvolumespec-v1">PersistentVolumeSpec</a> <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
fsType <br /> *string* | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
|
||||
partition <br /> *integer* | The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
|
||||
pdName <br /> *string* | Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
|
||||
readOnly <br /> *boolean* | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
## GCEPersistentDiskVolumeSource v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | GCEPersistentDiskVolumeSource
|
||||
|
||||
|
||||
|
||||
Represents a Persistent Disk resource in Google Compute Engine.
|
||||
|
||||
A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#persistentvolumespec-v1">PersistentVolumeSpec</a> <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
fsType <br /> *string* | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
|
||||
partition <br /> *integer* | The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
|
||||
pdName <br /> *string* | Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
|
||||
readOnly <br /> *boolean* | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
|
||||
|
||||
-----------
|
||||
# GitRepoVolumeSource v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | GitRepoVolumeSource
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
directory <br /> *string* | Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
|
||||
repository <br /> *string* | Repository URL
|
||||
revision <br /> *string* | Commit hash for the specified revision.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
## GitRepoVolumeSource v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | GitRepoVolumeSource
|
||||
|
||||
|
||||
|
||||
Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
directory <br /> *string* | Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
|
||||
repository <br /> *string* | Repository URL
|
||||
revision <br /> *string* | Commit hash for the specified revision.
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
|
||||
|
||||
-----------
|
||||
# GlusterfsVolumeSource v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | GlusterfsVolumeSource
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#persistentvolumespec-v1">PersistentVolumeSpec</a> <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
endpoints <br /> *string* | EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
|
||||
path <br /> *string* | Path is the Glusterfs volume path. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
|
||||
readOnly <br /> *boolean* | ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
## GlusterfsVolumeSource v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | GlusterfsVolumeSource
|
||||
|
||||
|
||||
|
||||
Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#persistentvolumespec-v1">PersistentVolumeSpec</a> <a href="#volume-v1">Volume</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
endpoints <br /> *string* | EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
|
||||
path <br /> *string* | Path is the Glusterfs volume path. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
|
||||
readOnly <br /> *boolean* | ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
|
||||
|
|
@ -22,6 +22,8 @@ Appears In <a href="#horizontalpodautoscalerlist-v1">HorizontalPodAutoscalerList
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
spec <br /> *[HorizontalPodAutoscalerSpec](#horizontalpodautoscalerspec-v1)* | behaviour of autoscaler. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status.
|
||||
status <br /> *[HorizontalPodAutoscalerStatus](#horizontalpodautoscalerstatus-v1)* | current information about the autoscaler.
|
||||
|
@ -58,7 +60,9 @@ observedGeneration <br /> *integer* | most recent generation observed by this a
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[HorizontalPodAutoscaler](#horizontalpodautoscaler-v1) array* | list of horizontal pod autoscaler objects.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata.
|
||||
|
||||
|
||||
|
@ -114,10 +118,15 @@ create a HorizontalPodAutoscaler
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[HorizontalPodAutoscaler](#horizontalpodautoscaler-v1)* |
|
||||
|
@ -176,10 +185,15 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the HorizontalPodAutoscaler
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[HorizontalPodAutoscaler](#horizontalpodautoscaler-v1)* |
|
||||
|
@ -238,10 +252,15 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the HorizontalPodAutoscaler
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
@ -300,16 +319,21 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the HorizontalPodAutoscaler
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
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 | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -363,18 +387,19 @@ delete collection of HorizontalPodAutoscaler
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -434,15 +459,16 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the HorizontalPodAutoscaler
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
|
||||
export | Should this value be exported. Export strips fields that a user can not specify.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -496,18 +522,19 @@ list or watch objects of kind HorizontalPodAutoscaler
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -556,7 +583,8 @@ list or watch objects of kind HorizontalPodAutoscaler
|
|||
|
||||
`GET /apis/autoscaling/v1/horizontalpodautoscalers`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
@ -620,10 +648,15 @@ watch changes to an object of kind HorizontalPodAutoscaler
|
|||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the HorizontalPodAutoscaler
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
|
@ -678,7 +711,8 @@ watch individual changes to a list of HorizontalPodAutoscaler
|
|||
|
||||
`GET /apis/autoscaling/v1/watch/horizontalpodautoscalers`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
|
|
@ -13,6 +13,8 @@ Appears In <a href="#horizontalpodautoscalerlist-v1">HorizontalPodAutoscalerLis
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
spec <br /> *[HorizontalPodAutoscalerSpec](#horizontalpodautoscalerspec-v1)* | behaviour of autoscaler. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status.
|
||||
status <br /> *[HorizontalPodAutoscalerStatus](#horizontalpodautoscalerstatus-v1)* | current information about the autoscaler.
|
||||
|
|
|
@ -22,6 +22,8 @@ Appears In <a href="#horizontalpodautoscalerlist-v1beta1">HorizontalPodAutoscale
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
spec <br /> *[HorizontalPodAutoscalerSpec](#horizontalpodautoscalerspec-v1beta1)* | behaviour of autoscaler. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status.
|
||||
status <br /> *[HorizontalPodAutoscalerStatus](#horizontalpodautoscalerstatus-v1beta1)* | current information about the autoscaler.
|
||||
|
@ -58,7 +60,9 @@ observedGeneration <br /> *integer* | most recent generation observed by this a
|
|||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[HorizontalPodAutoscaler](#horizontalpodautoscaler-v1beta1) array* | list of horizontal pod autoscaler objects.
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata.
|
||||
|
||||
|
||||
|
@ -114,10 +118,15 @@ create a HorizontalPodAutoscaler
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[HorizontalPodAutoscaler](#horizontalpodautoscaler-v1beta1)* |
|
||||
|
@ -176,10 +185,15 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the HorizontalPodAutoscaler
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[HorizontalPodAutoscaler](#horizontalpodautoscaler-v1beta1)* |
|
||||
|
@ -238,10 +252,15 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the HorizontalPodAutoscaler
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
@ -300,16 +319,21 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the HorizontalPodAutoscaler
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
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 | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -363,18 +387,19 @@ delete collection of HorizontalPodAutoscaler
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -434,15 +459,16 @@ Parameter | Description
|
|||
------------ | -----------
|
||||
name | name of the HorizontalPodAutoscaler
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
|
||||
export | Should this value be exported. Export strips fields that a user can not specify.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -496,18 +522,19 @@ list or watch objects of kind HorizontalPodAutoscaler
|
|||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
|
@ -556,7 +583,8 @@ list or watch objects of kind HorizontalPodAutoscaler
|
|||
|
||||
`GET /apis/extensions/v1beta1/horizontalpodautoscalers`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
@ -620,71 +648,15 @@ watch changes to an object of kind HorizontalPodAutoscaler
|
|||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the HorizontalPodAutoscaler
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
## Watch List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of HorizontalPodAutoscaler
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/horizontalpodautoscalers`
|
||||
|
||||
### Path Parameters
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
|
@ -739,7 +711,8 @@ watch individual changes to a list of HorizontalPodAutoscaler
|
|||
|
||||
`GET /apis/extensions/v1beta1/watch/horizontalpodautoscalers`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
@ -759,190 +732,4 @@ Code | Description
|
|||
|
||||
|
||||
|
||||
## <strong>Status Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Patch Status
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
partially update status of the specified HorizontalPodAutoscaler
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the HorizontalPodAutoscaler
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[HorizontalPodAutoscaler](#horizontalpodautoscaler-v1beta1)* | OK
|
||||
|
||||
|
||||
## Read Status
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
read status of the specified HorizontalPodAutoscaler
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the HorizontalPodAutoscaler
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[HorizontalPodAutoscaler](#horizontalpodautoscaler-v1beta1)* | OK
|
||||
|
||||
|
||||
## Replace Status
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
replace status of the specified HorizontalPodAutoscaler
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PUT /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the HorizontalPodAutoscaler
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[HorizontalPodAutoscaler](#horizontalpodautoscaler-v1beta1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[HorizontalPodAutoscaler](#horizontalpodautoscaler-v1beta1)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue