Represents a Photon Controller persistent disk resource.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
pdID
-
ID that identifies Photon Controller persistent disk
-
true
-
string
-
-
-
-
fsType
-
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.
-
false
-
string
-
-
-
-
-
-
-
-
versioned.Event
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
type
-
-
true
-
string
-
-
-
-
object
-
-
true
-
string
-
-
-
-
-
-
-
-
v1.Preconditions
-
-
Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
HTTPHeader describes a custom header to be used in HTTP probes
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
name
-
The header field name
-
true
-
string
-
-
-
-
value
-
The header field value
-
true
-
string
-
-
-
-
-
-
-
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
targetWWNs
-
Required: FC target worldwide names (WWNs)
-
true
-
string array
-
-
-
-
lun
-
Required: FC target lun number
-
true
-
integer (int32)
-
-
-
-
fsType
-
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.
-
false
-
string
-
-
-
-
readOnly
-
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
v1.DownwardAPIVolumeSource
-
-
DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.
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.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
unversioned.StatusCause
-
-
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
reason
-
A machine-readable description of the cause of the error. If this value is empty there is no information available.
-
false
-
string
-
-
-
-
message
-
A human-readable description of the cause of the error. This field may be presented as-is to a reader.
-
false
-
string
-
-
-
-
field
-
The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
-
-Examples:
- "name" - the field "name" on the current resource
- "items[0].name" - the field "name" on the first array entry in "items"
-
false
-
string
-
-
-
-
-
-
-
-
v1beta1.StatefulSetStatus
-
-
StatefulSetStatus represents the current state of a StatefulSet.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
observedGeneration
-
most recent generation observed by this autoscaler.
-
false
-
integer (int64)
-
-
-
-
replicas
-
Replicas is the number of actual replicas.
-
true
-
integer (int32)
-
-
-
-
-
-
-
-
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.
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
-
false
-
string
-
-
-
-
partition
-
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
TCPSocketAction describes an action based on opening a socket
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
port
-
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
-
true
-
string
-
-
-
-
-
-
-
-
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.
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 ...
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.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
unversioned.StatusDetails
-
-
StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
name
-
The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
-
false
-
string
-
-
-
-
group
-
The group attribute of the resource associated with the status StatusReason.
If specified, the time in seconds before the operation should be retried.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
repository
-
Repository URL
-
true
-
string
-
-
-
-
revision
-
Commit hash for the specified revision.
-
false
-
string
-
-
-
-
directory
-
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.
-
false
-
string
-
-
-
-
-
-
-
-
v1.HTTPGetAction
-
-
HTTPGetAction describes an action based on HTTP Get requests.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
path
-
Path to access on the HTTP server.
-
false
-
string
-
-
-
-
port
-
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
-
true
-
string
-
-
-
-
host
-
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
-
false
-
string
-
-
-
-
scheme
-
Scheme to use for connecting to the host. Defaults to HTTP.
-
false
-
string
-
-
-
-
httpHeaders
-
Custom headers to set in the request. HTTP allows repeated headers.
Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
-
false
-
string array
-
-
-
-
args
-
Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
-
false
-
string array
-
-
-
-
workingDir
-
Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.
-
false
-
string
-
-
-
-
ports
-
List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.
Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated.
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
-
false
-
boolean
-
false
-
-
-
stdinOnce
-
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
-
false
-
boolean
-
false
-
-
-
tty
-
Whether this container should allocate a TTY for itself, also requires stdin to be true. Default is false.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
v1.PodSecurityContext
-
-
PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
seLinuxOptions
-
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
-
false
-
integer (int64)
-
-
-
-
runAsNonRoot
-
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
-
false
-
boolean
-
false
-
-
-
supplementalGroups
-
A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.
-
false
-
integer (int32) array
-
-
-
-
fsGroup
-
A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
-
-1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR’d with rw-rw
-
false
-
integer (int64)
-
-
-
-
-
-
-
-
v1.ExecAction
-
-
ExecAction describes a "run in container" action.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
command
-
Command is the command line to execute inside the container, the working directory for the command is root (/) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('
-
', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
-
false
-
string array
-
-
-
-
-
-
-
v1beta1.StatefulSetSpec
-
-
A StatefulSetSpec is the specification of a StatefulSet.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
replicas
-
Replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
Template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
VolumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
ServiceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
-
true
-
string
-
-
-
-
-
-
-
-
v1.ObjectMeta
-
-
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
name
-
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
-
false
-
string
-
-
-
-
generateName
-
GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
-
-If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
-
-Applied only if Name is not specified. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency
-
false
-
string
-
-
-
-
namespace
-
Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
-
-Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
-
false
-
string
-
-
-
-
selfLink
-
SelfLink is a URL representing this object. Populated by the system. Read-only.
-
false
-
string
-
-
-
-
uid
-
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
-
-Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
-
false
-
string
-
-
-
-
resourceVersion
-
An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
-
-Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency
-
false
-
string
-
-
-
-
generation
-
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
-
false
-
integer (int64)
-
-
-
-
creationTimestamp
-
CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
-
-Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
-
false
-
string (date-time)
-
-
-
-
deletionTimestamp
-
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
-
-Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
-
false
-
string (date-time)
-
-
-
-
deletionGracePeriodSeconds
-
Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
-
false
-
integer (int64)
-
-
-
-
labels
-
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
-
false
-
object
-
-
-
-
annotations
-
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
-
false
-
object
-
-
-
-
ownerReferences
-
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
-
false
-
string array
-
-
-
-
clusterName
-
The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
-
false
-
string
-
-
-
-
-
-
-
-
v1.OwnerReference
-
-
OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
secretName
-
the name of secret that contains Azure Storage Account Name and Key
-
true
-
string
-
-
-
-
shareName
-
Share Name
-
true
-
string
-
-
-
-
readOnly
-
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
v1.ISCSIVolumeSource
-
-
Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
targetPortal
-
iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
-
true
-
string
-
-
-
-
iqn
-
Target iSCSI Qualified Name.
-
true
-
string
-
-
-
-
lun
-
iSCSI target lun number.
-
true
-
integer (int32)
-
-
-
-
iscsiInterface
-
Optional: Defaults to default (tcp). iSCSI interface name that uses an iSCSI transport.
-
false
-
string
-
-
-
-
fsType
-
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#iscsi
-
false
-
string
-
-
-
-
readOnly
-
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
v1.EmptyDirVolumeSource
-
-
Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
medium
-
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
-
false
-
string
-
-
-
-
-
-
-
-
unversioned.Patch
-
-
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
-
-
-
-
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.
SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
capabilities
-
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
-
false
-
boolean
-
false
-
-
-
seLinuxOptions
-
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
-
false
-
integer (int64)
-
-
-
-
runAsNonRoot
-
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
-
false
-
boolean
-
false
-
-
-
readOnlyRootFilesystem
-
Whether this container has a read-only root filesystem. Default is false.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
v1.PersistentVolumeClaimVolumeSource
-
-
PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).
Will force the ReadOnly setting in VolumeMounts. Default false.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
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.
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
-
false
-
string
-
-
-
-
partition
-
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).
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.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
datasetName
-
Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated
-
false
-
string
-
-
-
-
datasetUUID
-
UUID of the dataset. This is unique identifier of a Flocker dataset
-
false
-
string
-
-
-
-
-
-
-
-
unversioned.ListMeta
-
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
selfLink
-
SelfLink is a URL representing this object. Populated by the system. Read-only.
Represents the actual resources of the underlying volume.
-
false
-
object
-
-
-
-
-
-
-
-
v1.QuobyteVolumeSource
-
-
Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
registry
-
Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
-
true
-
string
-
-
-
-
volume
-
Volume is a string that references an already created Quobyte volume by name.
-
true
-
string
-
-
-
-
readOnly
-
ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
-
false
-
boolean
-
false
-
-
-
user
-
User to map volume access to Defaults to serivceaccount user
-
false
-
string
-
-
-
-
group
-
Group to map volume access to Default is no group
-
false
-
string
-
-
-
-
-
-
-
-
unversioned.LabelSelector
-
-
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
matchLabels
-
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
-
false
-
object
-
-
-
-
matchExpressions
-
matchExpressions is a list of label selector requirements. The requirements are ANDed.
The contents of the target Secret’s Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.
If unspecified, each key-value pair in the Data field of the referenced Secret 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 Secret, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...
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.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
v1.EnvVar
-
-
EnvVar represents an environment variable present in a Container.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
name
-
Name of the environment variable. Must be a C_IDENTIFIER.
-
true
-
string
-
-
-
-
value
-
Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
-
false
-
string
-
-
-
-
valueFrom
-
Source for the environment variable’s value. Cannot be used if value is not empty.
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.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
driver
-
Driver is the name of the driver to use for this volume.
-
true
-
string
-
-
-
-
fsType
-
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.
-
false
-
string
-
-
-
-
secretRef
-
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.
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
-
false
-
boolean
-
false
-
-
-
options
-
Optional: Extra command options if any.
-
false
-
object
-
-
-
-
-
-
-
-
v1.EnvVarSource
-
-
EnvVarSource represents a source for the value of an EnvVar.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
fieldRef
-
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
The relative path of the file to map the key to. May not be an absolute path. May not contain the path element ... May not start with the string ...
-
true
-
string
-
-
-
-
mode
-
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.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
v1.AzureDiskVolumeSource
-
-
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
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.
-
false
-
string
-
-
-
-
readOnly
-
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
v1.VsphereVirtualDiskVolumeSource
-
-
Represents a vSphere volume resource.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
volumePath
-
Path that identifies vSphere volume vmdk
-
true
-
string
-
-
-
-
fsType
-
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.
-
false
-
string
-
-
-
-
-
-
-
-
v1.DeleteOptions
-
-
DeleteOptions may be provided when deleting an API object
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.
-
false
-
integer (int64)
-
-
-
-
preconditions
-
Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
v1beta1.StatefulSet
-
-
StatefulSet represents a set of pods with consistent identities. Identities are defined as:
- - Network: A single stable DNS and hostname.
- - Storage: As many VolumeClaims as requested.
-The StatefulSet guarantees that a given network identity will always map to the same storage identity.
HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath
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.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
-
false
-
integer (int32)
-
-
-
-
successThreshold
-
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.
-
false
-
integer (int32)
-
-
-
-
failureThreshold
-
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
unversioned.LabelSelectorRequirement
-
-
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
key
-
key is the label key that the selector applies to.
-
true
-
string
-
-
-
-
operator
-
operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.
-
true
-
string
-
-
-
-
values
-
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
-
false
-
string array
-
-
-
-
-
-
-
-
unversioned.APIResourceList
-
-
APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.
A human-readable description of the status of this operation.
-
false
-
string
-
-
-
-
reason
-
A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
-
false
-
string
-
-
-
-
details
-
Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
Suggested HTTP return code for this status, 0 if not set.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
v1.Capability
-
-
-
-
unversioned.APIResource
-
-
APIResource specifies the name of a resource and whether it is namespaced.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
name
-
name is the name of the resource.
-
true
-
string
-
-
-
-
namespaced
-
namespaced indicates if a resource is namespaced or not.
-
true
-
boolean
-
false
-
-
-
kind
-
kind is the kind for the resource (e.g. Foo is the kind for a resource foo)
-
true
-
string
-
-
-
-
-
-
-
-
v1.DownwardAPIVolumeFile
-
-
DownwardAPIVolumeFile represents information to create the file containing the pod field
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
path
-
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 ..
-
true
-
string
-
-
-
-
fieldRef
-
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
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.
List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers
Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.
-
false
-
integer (int64)
-
-
-
-
activeDeadlineSeconds
-
Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.
-
false
-
integer (int64)
-
-
-
-
dnsPolicy
-
Set DNS policy for containers within the pod. One of ClusterFirst or Default. Defaults to "ClusterFirst".
-
false
-
string
-
-
-
-
nodeSelector
-
NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://kubernetes.io/docs/user-guide/node-selection
DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
-
false
-
string
-
-
-
-
nodeName
-
NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.
-
false
-
string
-
-
-
-
hostNetwork
-
Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false.
-
false
-
boolean
-
false
-
-
-
hostPID
-
Use the host’s pid namespace. Optional: Default to false.
-
false
-
boolean
-
false
-
-
-
hostIPC
-
Use the host’s ipc namespace. Optional: Default to false.
-
false
-
boolean
-
false
-
-
-
securityContext
-
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.
-
false
-
string
-
-
-
-
subdomain
-
If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.
-
false
-
string
-
-
-
-
-
-
-
-
v1.ContainerPort
-
-
ContainerPort represents a network port in a single container.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
name
-
If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
-
false
-
string
-
-
-
-
hostPort
-
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
-
false
-
integer (int32)
-
-
-
-
containerPort
-
Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.
-
true
-
integer (int32)
-
-
-
-
protocol
-
Protocol for port. Must be UDP or TCP. Defaults to "TCP".
-
false
-
string
-
-
-
-
hostIP
-
What host IP to bind the external port to.
-
false
-
string
-
-
-
-
-
-
-
-
v1.Lifecycle
-
-
Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.
PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks#hook-details
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#rbd
Represents a Photon Controller persistent disk resource.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
pdID
-
ID that identifies Photon Controller persistent disk
-
true
-
string
-
-
-
-
fsType
-
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.
-
false
-
string
-
-
-
-
-
-
-
-
versioned.Event
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
type
-
-
true
-
string
-
-
-
-
object
-
-
true
-
string
-
-
-
-
-
-
-
-
v1.Preconditions
-
-
Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
HTTPHeader describes a custom header to be used in HTTP probes
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
name
-
The header field name
-
true
-
string
-
-
-
-
value
-
The header field value
-
true
-
string
-
-
-
-
-
-
-
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
targetWWNs
-
Required: FC target worldwide names (WWNs)
-
true
-
string array
-
-
-
-
lun
-
Required: FC target lun number
-
true
-
integer (int32)
-
-
-
-
fsType
-
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.
-
false
-
string
-
-
-
-
readOnly
-
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
v1.DownwardAPIVolumeSource
-
-
DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.
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.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
unversioned.StatusCause
-
-
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
reason
-
A machine-readable description of the cause of the error. If this value is empty there is no information available.
-
false
-
string
-
-
-
-
message
-
A human-readable description of the cause of the error. This field may be presented as-is to a reader.
-
false
-
string
-
-
-
-
field
-
The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
-
-Examples:
- "name" - the field "name" on the current resource
- "items[0].name" - the field "name" on the first array entry in "items"
-
false
-
string
-
-
-
-
-
-
-
-
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.
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
-
false
-
string
-
-
-
-
partition
-
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
TCPSocketAction describes an action based on opening a socket
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
port
-
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
-
true
-
string
-
-
-
-
-
-
-
-
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.
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 ...
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.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
unversioned.StatusDetails
-
-
StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
name
-
The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
-
false
-
string
-
-
-
-
group
-
The group attribute of the resource associated with the status StatusReason.
If specified, the time in seconds before the operation should be retried.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
repository
-
Repository URL
-
true
-
string
-
-
-
-
revision
-
Commit hash for the specified revision.
-
false
-
string
-
-
-
-
directory
-
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.
-
false
-
string
-
-
-
-
-
-
-
-
v1.HTTPGetAction
-
-
HTTPGetAction describes an action based on HTTP Get requests.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
path
-
Path to access on the HTTP server.
-
false
-
string
-
-
-
-
port
-
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
-
true
-
string
-
-
-
-
host
-
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
-
false
-
string
-
-
-
-
scheme
-
Scheme to use for connecting to the host. Defaults to HTTP.
-
false
-
string
-
-
-
-
httpHeaders
-
Custom headers to set in the request. HTTP allows repeated headers.
Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
-
false
-
string array
-
-
-
-
args
-
Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
-
false
-
string array
-
-
-
-
workingDir
-
Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.
-
false
-
string
-
-
-
-
ports
-
List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.
Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated.
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
-
false
-
boolean
-
false
-
-
-
stdinOnce
-
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
-
false
-
boolean
-
false
-
-
-
tty
-
Whether this container should allocate a TTY for itself, also requires stdin to be true. Default is false.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
v1.PodSecurityContext
-
-
PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
seLinuxOptions
-
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
-
false
-
integer (int64)
-
-
-
-
runAsNonRoot
-
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
-
false
-
boolean
-
false
-
-
-
supplementalGroups
-
A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.
-
false
-
integer (int32) array
-
-
-
-
fsGroup
-
A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
-
-1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR’d with rw-rw
-
false
-
integer (int64)
-
-
-
-
-
-
-
-
v1.ExecAction
-
-
ExecAction describes a "run in container" action.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
command
-
Command is the command line to execute inside the container, the working directory for the command is root (/) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('
-
', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
StartTime represents time when the job was acknowledged by the Job Manager. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
-
false
-
string (date-time)
-
-
-
-
completionTime
-
CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
-
false
-
string (date-time)
-
-
-
-
active
-
Active is the number of actively running pods.
-
false
-
integer (int32)
-
-
-
-
succeeded
-
Succeeded is the number of pods which reached Phase Succeeded.
-
false
-
integer (int32)
-
-
-
-
failed
-
Failed is the number of pods which reached Phase Failed.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
v1.ObjectMeta
-
-
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
name
-
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
-
false
-
string
-
-
-
-
generateName
-
GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
-
-If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
-
-Applied only if Name is not specified. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency
-
false
-
string
-
-
-
-
namespace
-
Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
-
-Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
-
false
-
string
-
-
-
-
selfLink
-
SelfLink is a URL representing this object. Populated by the system. Read-only.
-
false
-
string
-
-
-
-
uid
-
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
-
-Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
-
false
-
string
-
-
-
-
resourceVersion
-
An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
-
-Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency
-
false
-
string
-
-
-
-
generation
-
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
-
false
-
integer (int64)
-
-
-
-
creationTimestamp
-
CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
-
-Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
-
false
-
string (date-time)
-
-
-
-
deletionTimestamp
-
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
-
-Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
-
false
-
string (date-time)
-
-
-
-
deletionGracePeriodSeconds
-
Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
-
false
-
integer (int64)
-
-
-
-
labels
-
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
-
false
-
object
-
-
-
-
annotations
-
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
-
false
-
object
-
-
-
-
ownerReferences
-
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
-
false
-
string array
-
-
-
-
clusterName
-
The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
-
false
-
string
-
-
-
-
-
-
-
-
v1.OwnerReference
-
-
OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
secretName
-
the name of secret that contains Azure Storage Account Name and Key
-
true
-
string
-
-
-
-
shareName
-
Share Name
-
true
-
string
-
-
-
-
readOnly
-
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
v1.ISCSIVolumeSource
-
-
Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
targetPortal
-
iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
-
true
-
string
-
-
-
-
iqn
-
Target iSCSI Qualified Name.
-
true
-
string
-
-
-
-
lun
-
iSCSI target lun number.
-
true
-
integer (int32)
-
-
-
-
iscsiInterface
-
Optional: Defaults to default (tcp). iSCSI interface name that uses an iSCSI transport.
-
false
-
string
-
-
-
-
fsType
-
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#iscsi
-
false
-
string
-
-
-
-
readOnly
-
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
v1.EmptyDirVolumeSource
-
-
Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
medium
-
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
-
false
-
string
-
-
-
-
-
-
-
-
unversioned.Patch
-
-
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
-
-
-
-
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.
SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
capabilities
-
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
-
false
-
boolean
-
false
-
-
-
seLinuxOptions
-
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
-
false
-
integer (int64)
-
-
-
-
runAsNonRoot
-
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
-
false
-
boolean
-
false
-
-
-
readOnlyRootFilesystem
-
Whether this container has a read-only root filesystem. Default is false.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
v1.PersistentVolumeClaimVolumeSource
-
-
PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).
Will force the ReadOnly setting in VolumeMounts. Default false.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
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.
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
-
false
-
string
-
-
-
-
partition
-
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).
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.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
datasetName
-
Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated
-
false
-
string
-
-
-
-
datasetUUID
-
UUID of the dataset. This is unique identifier of a Flocker dataset
-
false
-
string
-
-
-
-
-
-
-
-
unversioned.ListMeta
-
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
selfLink
-
SelfLink is a URL representing this object. Populated by the system. Read-only.
Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
registry
-
Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
-
true
-
string
-
-
-
-
volume
-
Volume is a string that references an already created Quobyte volume by name.
-
true
-
string
-
-
-
-
readOnly
-
ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
-
false
-
boolean
-
false
-
-
-
user
-
User to map volume access to Defaults to serivceaccount user
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
matchLabels
-
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
-
false
-
object
-
-
-
-
matchExpressions
-
matchExpressions is a list of label selector requirements. The requirements are ANDed.
The contents of the target Secret’s Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.
If unspecified, each key-value pair in the Data field of the referenced Secret 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 Secret, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...
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.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
v1.EnvVar
-
-
EnvVar represents an environment variable present in a Container.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
name
-
Name of the environment variable. Must be a C_IDENTIFIER.
-
true
-
string
-
-
-
-
value
-
Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
-
false
-
string
-
-
-
-
valueFrom
-
Source for the environment variable’s value. Cannot be used if value is not empty.
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.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
driver
-
Driver is the name of the driver to use for this volume.
-
true
-
string
-
-
-
-
fsType
-
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.
-
false
-
string
-
-
-
-
secretRef
-
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.
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
-
false
-
boolean
-
false
-
-
-
options
-
Optional: Extra command options if any.
-
false
-
object
-
-
-
-
-
-
-
-
v1.EnvVarSource
-
-
EnvVarSource represents a source for the value of an EnvVar.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
fieldRef
-
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
The relative path of the file to map the key to. May not be an absolute path. May not contain the path element ... May not start with the string ...
-
true
-
string
-
-
-
-
mode
-
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.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
v1.AzureDiskVolumeSource
-
-
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
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.
-
false
-
string
-
-
-
-
readOnly
-
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
v1.VsphereVirtualDiskVolumeSource
-
-
Represents a vSphere volume resource.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
volumePath
-
Path that identifies vSphere volume vmdk
-
true
-
string
-
-
-
-
fsType
-
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.
-
false
-
string
-
-
-
-
-
-
-
-
v1.JobSpec
-
-
JobSpec describes how the job execution will look like.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
parallelism
-
Parallelism specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs
-
false
-
integer (int32)
-
-
-
-
completions
-
Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs
-
false
-
integer (int32)
-
-
-
-
activeDeadlineSeconds
-
Optional duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer
ManualSelector controls generation of pod labels and pod selectors. Leave manualSelector unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see manualSelector=true in jobs that were created with the old extensions/v1beta1 API. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md
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.
-
false
-
integer (int64)
-
-
-
-
preconditions
-
Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath
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.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
-
false
-
integer (int32)
-
-
-
-
successThreshold
-
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.
-
false
-
integer (int32)
-
-
-
-
failureThreshold
-
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
unversioned.LabelSelectorRequirement
-
-
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
key
-
key is the label key that the selector applies to.
-
true
-
string
-
-
-
-
operator
-
operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.
-
true
-
string
-
-
-
-
values
-
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
-
false
-
string array
-
-
-
-
-
-
-
-
unversioned.APIResourceList
-
-
APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.
A human-readable description of the status of this operation.
-
false
-
string
-
-
-
-
reason
-
A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
-
false
-
string
-
-
-
-
details
-
Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
Suggested HTTP return code for this status, 0 if not set.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
v1.Capability
-
-
-
-
unversioned.APIResource
-
-
APIResource specifies the name of a resource and whether it is namespaced.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
name
-
name is the name of the resource.
-
true
-
string
-
-
-
-
namespaced
-
namespaced indicates if a resource is namespaced or not.
-
true
-
boolean
-
false
-
-
-
kind
-
kind is the kind for the resource (e.g. Foo is the kind for a resource foo)
-
true
-
string
-
-
-
-
-
-
-
-
v1.DownwardAPIVolumeFile
-
-
DownwardAPIVolumeFile represents information to create the file containing the pod field
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
path
-
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 ..
-
true
-
string
-
-
-
-
fieldRef
-
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
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.
List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers
Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.
-
false
-
integer (int64)
-
-
-
-
activeDeadlineSeconds
-
Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.
-
false
-
integer (int64)
-
-
-
-
dnsPolicy
-
Set DNS policy for containers within the pod. One of ClusterFirst or Default. Defaults to "ClusterFirst".
-
false
-
string
-
-
-
-
nodeSelector
-
NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://kubernetes.io/docs/user-guide/node-selection
DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
-
false
-
string
-
-
-
-
nodeName
-
NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.
-
false
-
string
-
-
-
-
hostNetwork
-
Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false.
-
false
-
boolean
-
false
-
-
-
hostPID
-
Use the host’s pid namespace. Optional: Default to false.
-
false
-
boolean
-
false
-
-
-
hostIPC
-
Use the host’s ipc namespace. Optional: Default to false.
-
false
-
boolean
-
false
-
-
-
securityContext
-
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.
-
false
-
string
-
-
-
-
subdomain
-
If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.
-
false
-
string
-
-
-
-
-
-
-
-
v1.ContainerPort
-
-
ContainerPort represents a network port in a single container.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
name
-
If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
-
false
-
string
-
-
-
-
hostPort
-
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
-
false
-
integer (int32)
-
-
-
-
containerPort
-
Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.
-
true
-
integer (int32)
-
-
-
-
protocol
-
Protocol for port. Must be UDP or TCP. Defaults to "TCP".
-
false
-
string
-
-
-
-
hostIP
-
What host IP to bind the external port to.
-
false
-
string
-
-
-
-
-
-
-
-
v1.Lifecycle
-
-
Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.
PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks#hook-details
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#rbd
DesiredNumberScheduled is the total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
-
true
-
integer (int32)
-
-
-
-
numberReady
-
NumberReady is the number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
-
true
-
integer (int32)
-
-
-
-
-
-
-
-
v1beta1.Job
-
-
Job represents the configuration of a single job. DEPRECATED: extensions/v1beta1.Job is deprecated, use batch/v1.Job instead.
ObjectFieldSelector selects an APIVersioned field of an object.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
apiVersion
-
Version of the schema the FieldPath is written in terms of, defaults to "v1".
-
false
-
string
-
-
-
-
fieldPath
-
Path of the field to select in the specified API version.
-
true
-
string
-
-
-
-
-
-
-
-
v1.SELinuxOptions
-
-
SELinuxOptions are the labels to be applied to the container
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
user
-
User is a SELinux user label that applies to the container.
-
false
-
string
-
-
-
-
role
-
Role is a SELinux role label that applies to the container.
-
false
-
string
-
-
-
-
type
-
Type is a SELinux type label that applies to the container.
-
false
-
string
-
-
-
-
level
-
Level is SELinux level label that applies to the container.
-
false
-
string
-
-
-
-
-
-
-
-
v1.VolumeMount
-
-
VolumeMount describes a mounting of a Volume within a container.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
name
-
This must match the Name of a Volume.
-
true
-
string
-
-
-
-
readOnly
-
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
-
false
-
boolean
-
false
-
-
-
mountPath
-
Path within the container at which the volume should be mounted. Must not contain :.
-
true
-
string
-
-
-
-
subPath
-
Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).
-
false
-
string
-
-
-
-
-
-
-
-
v1beta1.IngressSpec
-
-
IngressSpec describes the Ingress the user wishes to exist.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
backend
-
A default backend capable of servicing requests that don’t match any rule. At least one of backend or rules must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.
TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.
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.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
unversioned.StatusCause
-
-
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
reason
-
A machine-readable description of the cause of the error. If this value is empty there is no information available.
-
false
-
string
-
-
-
-
message
-
A human-readable description of the cause of the error. This field may be presented as-is to a reader.
-
false
-
string
-
-
-
-
field
-
The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
-
-Examples:
- "name" - the field "name" on the current resource
- "items[0].name" - the field "name" on the first array entry in "items"
-
false
-
string
-
-
-
-
-
-
-
-
v1beta1.ReplicaSetCondition
-
-
ReplicaSetCondition describes the state of a replica set at a certain point.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
type
-
Type of replica set condition.
-
true
-
string
-
-
-
-
status
-
Status of the condition, one of True, False, Unknown.
-
true
-
string
-
-
-
-
lastTransitionTime
-
The last time the condition transitioned from one status to another.
-
false
-
string (date-time)
-
-
-
-
reason
-
The reason for the condition’s last transition.
-
false
-
string
-
-
-
-
message
-
A human readable message indicating details about the transition.
-
false
-
string
-
-
-
-
-
-
-
-
v1beta1.NetworkPolicyList
-
-
Network Policy List is a list of NetworkPolicy objects.
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.
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
-
false
-
string
-
-
-
-
partition
-
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
Spec to control the desired behavior of rolling update.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
maxUnavailable
-
The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding up. This can not be 0 if MaxSurge is 0. By default, a fixed value of 1 is used. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.
-
false
-
string
-
-
-
-
maxSurge
-
The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. By default, a value of 1 is used. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods.
-
false
-
string
-
-
-
-
-
-
-
-
v1beta1.HTTPIngressRuleValue
-
-
HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> → backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last / and before the first ? or #.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
paths
-
A collection of paths that map requests to backends.
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.
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 ...
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.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
repository
-
Repository URL
-
true
-
string
-
-
-
-
revision
-
Commit hash for the specified revision.
-
false
-
string
-
-
-
-
directory
-
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.
StartTime represents time when the job was acknowledged by the Job Manager. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
-
false
-
string (date-time)
-
-
-
-
completionTime
-
CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
-
false
-
string (date-time)
-
-
-
-
active
-
Active is the number of actively running pods.
-
false
-
integer (int32)
-
-
-
-
succeeded
-
Succeeded is the number of pods which reached Phase Succeeded.
-
false
-
integer (int32)
-
-
-
-
failed
-
Failed is the number of pods which reached Phase Failed.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
v1.Capabilities
-
-
Adds and removes POSIX capabilities from running containers.
Command is the command line to execute inside the container, the working directory for the command is root (/) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('
-
', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
-
false
-
string array
-
-
-
-
-
-
-
v1.ObjectMeta
-
-
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
name
-
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
-
false
-
string
-
-
-
-
generateName
-
GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
-
-If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
-
-Applied only if Name is not specified. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency
-
false
-
string
-
-
-
-
namespace
-
Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
-
-Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
-
false
-
string
-
-
-
-
selfLink
-
SelfLink is a URL representing this object. Populated by the system. Read-only.
-
false
-
string
-
-
-
-
uid
-
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
-
-Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
-
false
-
string
-
-
-
-
resourceVersion
-
An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
-
-Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency
-
false
-
string
-
-
-
-
generation
-
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
-
false
-
integer (int64)
-
-
-
-
creationTimestamp
-
CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
-
-Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
-
false
-
string (date-time)
-
-
-
-
deletionTimestamp
-
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
-
-Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
-
false
-
string (date-time)
-
-
-
-
deletionGracePeriodSeconds
-
Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
-
false
-
integer (int64)
-
-
-
-
labels
-
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
-
false
-
object
-
-
-
-
annotations
-
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
-
false
-
object
-
-
-
-
ownerReferences
-
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
-
false
-
string array
-
-
-
-
clusterName
-
The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
-
false
-
string
-
-
-
-
-
-
-
-
v1beta1.ReplicaSetSpec
-
-
ReplicaSetSpec is the specification of a ReplicaSet.
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
-
false
-
integer (int32)
-
-
-
-
selector
-
Selector is a label query over pods that should match the replica count. If the selector is empty, it is defaulted to the labels present on the pod template. Label keys and values that must match in order to be controlled by this replica set. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
Template is the object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template’s node selector (or on every node if no node selector is specified). More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
secretName
-
the name of secret that contains Azure Storage Account Name and Key
-
true
-
string
-
-
-
-
shareName
-
Share Name
-
true
-
string
-
-
-
-
readOnly
-
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
types.UID
-
-
-
-
v1.ISCSIVolumeSource
-
-
Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
targetPortal
-
iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
-
true
-
string
-
-
-
-
iqn
-
Target iSCSI Qualified Name.
-
true
-
string
-
-
-
-
lun
-
iSCSI target lun number.
-
true
-
integer (int32)
-
-
-
-
iscsiInterface
-
Optional: Defaults to default (tcp). iSCSI interface name that uses an iSCSI transport.
-
false
-
string
-
-
-
-
fsType
-
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#iscsi
-
false
-
string
-
-
-
-
readOnly
-
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
v1.EmptyDirVolumeSource
-
-
Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
medium
-
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
desired number of instances for the scaled object.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
unversioned.Patch
-
-
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
-
-
-
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
datasetName
-
Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated
-
false
-
string
-
-
-
-
datasetUUID
-
UUID of the dataset. This is unique identifier of a Flocker dataset
-
false
-
string
-
-
-
-
-
-
-
-
v1.PersistentVolumeClaimVolumeSource
-
-
PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).
Will force the ReadOnly setting in VolumeMounts. Default false.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
unversioned.ListMeta
-
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
selfLink
-
SelfLink is a URL representing this object. Populated by the system. Read-only.
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
matchLabels
-
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
-
false
-
object
-
-
-
-
matchExpressions
-
matchExpressions is a list of label selector requirements. The requirements are ANDed.
The revision to rollback to. If set to 0, rollbck to the last revision.
-
false
-
integer (int64)
-
-
-
-
-
-
-
-
v1.SecretVolumeSource
-
-
Adapts a Secret into a volume.
-
-
-
The contents of the target Secret’s Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.
If unspecified, each key-value pair in the Data field of the referenced Secret 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 Secret, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...
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.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
v1.EnvVarSource
-
-
EnvVarSource represents a source for the value of an EnvVar.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
fieldRef
-
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
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.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
driver
-
Driver is the name of the driver to use for this volume.
-
true
-
string
-
-
-
-
fsType
-
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.
-
false
-
string
-
-
-
-
secretRef
-
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.
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.
-
false
-
string
-
-
-
-
readOnly
-
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
v1.KeyToPath
-
-
Maps a string key to a path within a volume.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
key
-
The key to project.
-
true
-
string
-
-
-
-
path
-
The relative path of the file to map the key to. May not be an absolute path. May not contain the path element ... May not start with the string ...
-
true
-
string
-
-
-
-
mode
-
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.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
v1.VsphereVirtualDiskVolumeSource
-
-
Represents a vSphere volume resource.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
volumePath
-
Path that identifies vSphere volume vmdk
-
true
-
string
-
-
-
-
fsType
-
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.
-
false
-
string
-
-
-
-
-
-
-
-
v1.DeleteOptions
-
-
DeleteOptions may be provided when deleting an API object
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.
-
false
-
integer (int64)
-
-
-
-
preconditions
-
Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath
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.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
-
false
-
integer (int32)
-
-
-
-
successThreshold
-
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.
-
false
-
integer (int32)
-
-
-
-
failureThreshold
-
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
v1beta1.DeploymentSpec
-
-
DeploymentSpec is the specification of the desired behavior of the Deployment.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
replicas
-
Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
-
false
-
integer (int32)
-
-
-
-
selector
-
Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
-
false
-
integer (int32)
-
-
-
-
revisionHistoryLimit
-
The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified.
-
false
-
integer (int32)
-
-
-
-
paused
-
Indicates that the deployment is paused and will not be processed by the deployment controller.
-
false
-
boolean
-
false
-
-
-
rollbackTo
-
The config this deployment is rolling back to. Will be cleared after rollback is done.
The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Once autoRollback is implemented, the deployment controller will automatically rollback failed deployments. Note that progress will not be estimated during the time a deployment is paused. This is not set by default.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
unversioned.APIResourceList
-
-
APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.
The key of the secret to select from. Must be a valid secret key.
-
true
-
string
-
-
-
-
-
-
-
-
v1.Capability
-
-
-
-
unversioned.APIResource
-
-
APIResource specifies the name of a resource and whether it is namespaced.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
name
-
name is the name of the resource.
-
true
-
string
-
-
-
-
namespaced
-
namespaced indicates if a resource is namespaced or not.
-
true
-
boolean
-
false
-
-
-
kind
-
kind is the kind for the resource (e.g. Foo is the kind for a resource foo)
-
true
-
string
-
-
-
-
-
-
-
-
v1.DownwardAPIVolumeFile
-
-
DownwardAPIVolumeFile represents information to create the file containing the pod field
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
path
-
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 ..
-
true
-
string
-
-
-
-
fieldRef
-
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
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.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
v1.ContainerPort
-
-
ContainerPort represents a network port in a single container.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
name
-
If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
-
false
-
string
-
-
-
-
hostPort
-
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
-
false
-
integer (int32)
-
-
-
-
containerPort
-
Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.
-
true
-
integer (int32)
-
-
-
-
protocol
-
Protocol for port. Must be UDP or TCP. Defaults to "TCP".
List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers
Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.
-
false
-
integer (int64)
-
-
-
-
activeDeadlineSeconds
-
Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.
-
false
-
integer (int64)
-
-
-
-
dnsPolicy
-
Set DNS policy for containers within the pod. One of ClusterFirst or Default. Defaults to "ClusterFirst".
-
false
-
string
-
-
-
-
nodeSelector
-
NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://kubernetes.io/docs/user-guide/node-selection
DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
-
false
-
string
-
-
-
-
nodeName
-
NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.
-
false
-
string
-
-
-
-
hostNetwork
-
Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false.
-
false
-
boolean
-
false
-
-
-
hostPID
-
Use the host’s pid namespace. Optional: Default to false.
-
false
-
boolean
-
false
-
-
-
hostIPC
-
Use the host’s ipc namespace. Optional: Default to false.
-
false
-
boolean
-
false
-
-
-
securityContext
-
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.
-
false
-
string
-
-
-
-
subdomain
-
If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.
-
false
-
string
-
-
-
-
-
-
-
-
v1.Lifecycle
-
-
Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.
PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://kubernetes.io//docs/concepts/containers/container-lifecycle-hooks#hook-details
IngressTLS describes the transport layer security associated with an Ingress.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
hosts
-
Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified.
-
false
-
string array
-
-
-
-
secretName
-
SecretName is the name of the secret used to terminate SSL traffic on 443. Field is left optional to allow SSL routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing.
-
false
-
string
-
-
-
-
-
-
-
-
v1beta1.SubresourceReference
-
-
SubresourceReference contains enough information to let you inspect or modify the referred subresource.
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#rbd
Represents a Photon Controller persistent disk resource.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
pdID
-
ID that identifies Photon Controller persistent disk
-
true
-
string
-
-
-
-
fsType
-
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.
label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
-
false
-
string
-
-
-
-
-
-
-
-
v1beta1.NetworkPolicySpec
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
podSelector
-
Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.
List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if namespace.networkPolicy.ingress.isolation is undefined and cluster policy allows it, OR if the traffic source is the pod’s local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not affect ingress isolation. If this field is present and contains at least one rule, this policy allows any traffic which matches at least one of the ingress rules in this list.
HTTPHeader describes a custom header to be used in HTTP probes
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
name
-
The header field name
-
true
-
string
-
-
-
-
value
-
The header field value
-
true
-
string
-
-
-
-
-
-
-
-
v1beta1.HorizontalPodAutoscalerStatus
-
-
current status of a horizontal pod autoscaler
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
observedGeneration
-
most recent generation observed by this autoscaler.
-
false
-
integer (int64)
-
-
-
-
lastScaleTime
-
last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed.
-
false
-
string (date-time)
-
-
-
-
currentReplicas
-
current number of replicas of pods managed by this autoscaler.
-
true
-
integer (int32)
-
-
-
-
desiredReplicas
-
desired number of replicas of pods managed by this autoscaler.
-
true
-
integer (int32)
-
-
-
-
currentCPUUtilizationPercentage
-
current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU.
-
false
-
integer (int32)
-
-
-
-
-
-
-
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
targetWWNs
-
Required: FC target worldwide names (WWNs)
-
true
-
string array
-
-
-
-
lun
-
Required: FC target lun number
-
true
-
integer (int32)
-
-
-
-
fsType
-
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.
-
false
-
string
-
-
-
-
readOnly
-
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
v1beta1.ThirdPartyResource
-
-
A ThirdPartyResource is a generic representation of a resource, it is used by add-ons and plugins to add new resource types to the API. It consists of one or more Versions of the api.
IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
host
-
Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in the RFC: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the
- IP in the Spec of the parent Ingress.
-2. The : delimiter is not respected because ports are not allowed.
- Currently the port of an Ingress is implicitly :80 for http and
- :443 for https.
-Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue.
This is a label selector which selects Pods in this namespace. This field follows standard label selector semantics. If not provided, this selector selects no pods. If present but empty, this selector selects all pods in this namespace.
Selects Namespaces using cluster scoped-labels. This matches all pods in all namespaces selected by this label selector. This field follows standard label selector semantics. If omitted, this selector selects no namespaces. If present but empty, this selector selects all namespaces.
StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
name
-
The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
-
false
-
string
-
-
-
-
group
-
The group attribute of the resource associated with the status StatusReason.
Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
-
false
-
string array
-
-
-
-
args
-
Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
-
false
-
string array
-
-
-
-
workingDir
-
Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.
-
false
-
string
-
-
-
-
ports
-
List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.
Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated.
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
-
false
-
boolean
-
false
-
-
-
stdinOnce
-
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
-
false
-
boolean
-
false
-
-
-
tty
-
Whether this container should allocate a TTY for itself, also requires stdin to be true. Default is false.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
v1.PodSecurityContext
-
-
PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
seLinuxOptions
-
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
-
false
-
integer (int64)
-
-
-
-
runAsNonRoot
-
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
-
false
-
boolean
-
false
-
-
-
supplementalGroups
-
A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.
-
false
-
integer (int32) array
-
-
-
-
fsGroup
-
A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
-
-1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR’d with rw-rw
-
false
-
integer (int64)
-
-
-
-
-
-
-
-
v1beta1.NetworkPolicyIngressRule
-
-
This NetworkPolicyIngressRule matches traffic if and only if the traffic matches both ports AND from.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
ports
-
List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is not provided, this rule matches all ports (traffic not restricted by port). If this field is empty, this rule matches no ports (no traffic matches). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is not provided, this rule matches all sources (traffic not restricted by source). If this field is empty, this rule matches no sources (no traffic matches). If this field is present and contains at least on item, this rule allows traffic only if the traffic matches at least one item in the from list.
OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.
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.
SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
capabilities
-
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
-
false
-
boolean
-
false
-
-
-
seLinuxOptions
-
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
-
false
-
integer (int64)
-
-
-
-
runAsNonRoot
-
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
-
false
-
boolean
-
false
-
-
-
readOnlyRootFilesystem
-
Whether this container has a read-only root filesystem. Default is false.
-
false
-
boolean
-
false
-
-
-
-
-
-
-
v1.Protocol
-
-
-
-
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.
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
-
false
-
string
-
-
-
-
partition
-
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).
reference to Scale subresource; horizontal pod autoscaler will learn the current resource consumption from its status, and will set the desired number of pods by modifying its spec.
lower limit for the number of pods that can be set by the autoscaler, default 1.
-
false
-
integer (int32)
-
-
-
-
maxReplicas
-
upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.
-
true
-
integer (int32)
-
-
-
-
cpuUtilization
-
target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified it defaults to the target CPU utilization at 80% of the requested resources.
Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
registry
-
Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
-
true
-
string
-
-
-
-
volume
-
Volume is a string that references an already created Quobyte volume by name.
-
true
-
string
-
-
-
-
readOnly
-
ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
-
false
-
boolean
-
false
-
-
-
user
-
User to map volume access to Defaults to serivceaccount user
-
false
-
string
-
-
-
-
group
-
Group to map volume access to Default is no group
-
false
-
string
-
-
-
-
-
-
-
-
v1.EnvVar
-
-
EnvVar represents an environment variable present in a Container.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
name
-
Name of the environment variable. Must be a C_IDENTIFIER.
-
true
-
string
-
-
-
-
value
-
Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
-
false
-
string
-
-
-
-
valueFrom
-
Source for the environment variable’s value. Cannot be used if value is not empty.
If specified, the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.
-
false
-
string
-
-
-
-
-
-
-
-
v1beta1.DeploymentCondition
-
-
DeploymentCondition describes the state of a deployment at a certain point.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
type
-
Type of deployment condition.
-
true
-
string
-
-
-
-
status
-
Status of the condition, one of True, False, Unknown.
-
true
-
string
-
-
-
-
lastUpdateTime
-
The last time this condition was updated.
-
false
-
string (date-time)
-
-
-
-
lastTransitionTime
-
Last time the condition transitioned from one status to another.
-
false
-
string (date-time)
-
-
-
-
reason
-
The reason for the condition’s last transition.
-
false
-
string
-
-
-
-
message
-
A human readable message indicating details about the transition.
-
false
-
string
-
-
-
-
-
-
-
-
v1beta1.JobSpec
-
-
JobSpec describes how the job execution will look like.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
parallelism
-
Parallelism specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs
-
false
-
integer (int32)
-
-
-
-
completions
-
Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs
-
false
-
integer (int32)
-
-
-
-
activeDeadlineSeconds
-
Optional duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer
AutoSelector controls generation of pod labels and pod selectors. It was not present in the original extensions/v1beta1 Job definition, but exists to allow conversion from batch/v1 Jobs, where it corresponds to, but has the opposite meaning as, ManualSelector. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
key
-
key is the label key that the selector applies to.
-
true
-
string
-
-
-
-
operator
-
operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.
-
true
-
string
-
-
-
-
values
-
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
-
false
-
string array
-
-
-
-
-
-
-
-
unversioned.Status
-
-
Status is a return value for calls that don’t return other objects.
A human-readable description of the status of this operation.
-
false
-
string
-
-
-
-
reason
-
A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
-
false
-
string
-
-
-
-
details
-
Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
HTTPIngressPath associates a path regex with a backend. Incoming urls matching the path are forwarded to the backend.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
path
-
Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e. this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a /. If unspecified, the path defaults to a catch all sending traffic to the backend.
-
false
-
string
-
-
-
-
backend
-
Backend defines the referenced service endpoint to which the traffic will be forwarded to.
Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.
Welcome to the Kubernetes API. You can use the Kubernetes API to read
-and write Kubernetes resource objects via a Kubernetes API endpoint.
-
Resource Categories
-
This is a high-level overview of the basic types of resources provide by the Kubernetes API and their primary functions.
-
Workloads are objects you use to manage and run your containers on the cluster.
-
Discovery & LB resources are objects you use to "stitch" your workloads together into an externally accessible, load-balanced Service.
-
Config & Storage resources are objects you use to inject initialization data into your applications, and to persist data that is external to your container.
-
Cluster resources objects define how the cluster itself is configured; these are typically used only by cluster operators.
-
Metadata resources are objects you use to configure the behavior of other resources within the cluster, such as HorizontalPodAutoscaler for scaling workloads.
-
-
Resource Objects
-
Resource objects typically have 3 components:
-
-
ResourceSpec: This is defined by the user and describes the desired state of system. Fill this in when creating or updating an
-object.
-
ResourceStatus: This is filled in by the server and reports the current state of the system. Only kubernetes components should fill
-this in
-
Resource ObjectMeta: This is metadata about the resource, such as its name, type, api version, annotations, and labels. This contains
-fields that maybe updated both by the end user and the system (e.g. annotations)
-
-
-
Resource Operations
-
Most resources provide the following Operations:
-
Create:
-
Create operations will create the resource in the storage backend. After a resource is create the system will apply
-the desired state.
-
Update:
-
Updates come in 2 forms: Replace and Patch
-
Replace:
-Replacing a resource object will update the resource by replacing the existing spec with the provided one. For
-read-then-write operations this is safe because an optimistic lock failure will occur if the resource was modified
-between the read and write. Note: The ResourceStatus will be ignored by the system and will not be updated.
-To update the status, one must invoke the specific status update operation.
-
Note: Replacing a resource object may not result immediately in changes being propagated to downstream objects. For instance
-replacing a ConfigMap or Secret resource will not result in all Pods seeing the changes unless the Pods are
-restarted out of band.
-
Patch:
-Patch will apply a change to a specific field. How the change is merged is defined per field. Lists may either be
-replaced or merged. Merging lists will not preserve ordering.
-
Patches will never cause optimistic locking failures, and the last write will win. Patches are recommended
- when the full state is not read before an update, or when failing on optimistic locking is undesirable. When patching
- complex types, arrays and maps, how the patch is applied is defined on a per-field basis and may either replace
- the field's current value, or merge the contents into the current value.
-
Read
-
Reads come in 3 forms: Get, List and Watch
-
Get: Get will retrieve a specific resource object by name.
-
List: List will retrieve all resource objects of a specific type within a namespace, and the results can be restricted to resources matching a selector query.
-
List All Namespaces: Like List but retrieves resources across all namespaces.
-
Watch: Watch will stream results for an object(s) as it is updated. Similar to a callback, watch is used to respond to resource changes.
-
Delete
-
Delete will delete a resource. Depending on the specific resource, child objects may or may not be garbage collected by the server. See
-notes on specific resource objects for details.
-
Additional Operations
-
Resources may define additional operations specific to that resource type.
-
Rollback: Rollback a PodTemplate to a previous version. Only available for some resource types.
-
Read / Write Scale: Read or Update the number of replicas for the given resource. Only available for some resource types.
-
Read / Write Status: Read or Update the Status for a resource object. The Status can only changed through these update operations.
-
-
WORKLOADS
-
Worloads resources are responsible for managing and running your containers on the cluster. Containers are created
-by Controllers through Pods. Pods run Containers and provide environmental dependencies such as shared or
-persistent storage Volumes and Configuration or Secret data injected into the
-container.
-
The most common Controllers are:
-
-
Deployments for stateless persistent apps (e.g. http servers)
-
StatefulSets for stateful persistent apps (e.g. databases)
-
Jobs for run-to-completion apps (e.g. batch jobs).
-
-
-
-
Container v1 core
-
-
Container Config to run nginx (must be embedded in a PodSpec to run).
-
-
-name:nginx
-# Run the nginx:1.10 image
-image:nginx:1.10
-
-
-
Container Config to run nginx (must be embedded in a PodSpec to run).
-
-
-name:nginx
-# Run the nginx:1.10 image
-image:nginx:1.10
-
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
Container
-
-
-
-
-
-
-
-
-
-
A single application container that you want to run within a pod.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
args string array
-
Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
-
-
-
command string array
-
Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
-
-
-
env EnvVar array patch type: merge patch merge key: name
-
List of environment variables to set in the container. Cannot be updated.
List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
-
-
-
image string
-
Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
-
-
-
stdinOnce boolean
-
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
-
-
-
terminationMessagePath string
-
Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
-
-
-
terminationMessagePolicy string
-
Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
-
-
-
tty boolean
-
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
Pod volumes to mount into the container's filesystem. Cannot be updated.
-
-
-
workingDir string
-
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
Details about the container's last termination condition.
-
-
-
name string
-
This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
-
-
-
ready boolean
-
Specifies whether the container has passed its readiness probe.
-
-
-
restartCount integer
-
The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC.
Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one
-
-
-
failedJobsHistoryLimit integer
-
The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind CronJob
-
HTTP Request
-
GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind CronJob
-
HTTP Request
-
GET /apis/batch/v1beta1/cronjobs
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind CronJob
-
HTTP Request
-
GET /apis/batch/v1beta1/watch/namespaces/{namespace}/cronjobs/{name}
-
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
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of CronJob
-
HTTP Request
-
GET /apis/batch/v1beta1/watch/namespaces/{namespace}/cronjobs
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of CronJob
-
HTTP Request
-
GET /apis/batch/v1beta1/watch/cronjobs
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready).
-
-
-
revisionHistoryLimit integer
-
The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
An update strategy to replace existing DaemonSet pods with new pods.
-
-
-
-
DaemonSetStatus v1beta2 apps
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
collisionCount integer
-
Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
-
-
-
conditions DaemonSetCondition array patch type: merge patch merge key: type
-
Represents the latest available observations of a DaemonSet's current state.
The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds)
The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
-
-
-
numberUnavailable integer
-
The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds)
-
-
-
observedGeneration integer
-
The most recent generation observed by the daemon set controller.
-
-
-
updatedNumberScheduled integer
-
The total number of nodes that are running updated daemon pod
The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind DaemonSet
-
HTTP Request
-
GET /apis/apps/v1beta2/namespaces/{namespace}/daemonsets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind DaemonSet
-
HTTP Request
-
GET /apis/apps/v1beta2/daemonsets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind DaemonSet
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/daemonsets/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the DaemonSet
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of DaemonSet
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/daemonsets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of DaemonSet
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/daemonsets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
-
-
-
paused boolean
-
Indicates that the deployment is paused.
-
-
-
progressDeadlineSeconds integer
-
The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.
-
-
-
replicas integer
-
Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
-
-
-
revisionHistoryLimit integer
-
The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels.
Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
-
-
-
collisionCount integer
-
Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
-
-
-
conditions DeploymentCondition array patch type: merge patch merge key: type
-
Represents the latest available observations of a deployment's current state.
-
-
-
observedGeneration integer
-
The generation observed by the deployment controller.
-
-
-
readyReplicas integer
-
Total number of ready pods targeted by this deployment.
-
-
-
replicas integer
-
Total number of non-terminated pods targeted by this deployment (their labels match the selector).
-
-
-
unavailableReplicas integer
-
Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
-
-
-
updatedReplicas integer
-
Total number of non-terminated pods targeted by this deployment that have the desired template spec.
Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
-
-
-
type string
-
Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
-
-
-
-
RollingUpdateDeployment v1beta2 apps
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
maxSurge
-
The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods.
-
-
-
maxUnavailable
-
The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
GET /apis/apps/v1beta2/namespaces/{namespace}/deployments
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Deployment
-
HTTP Request
-
GET /apis/apps/v1beta2/deployments
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/deployments/{name}
-
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
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Deployment
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/deployments
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Deployment
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/deployments
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer
-
-
-
backoffLimit integer
-
Specifies the number of retries before marking this job failed. Defaults to 6
-
-
-
completions integer
-
Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
-
-
-
manualSelector boolean
-
manualSelector controls generation of pod labels and pod selectors. Leave manualSelector unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see manualSelector=true in jobs that were created with the old extensions/v1beta1 API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector
-
-
-
parallelism integer
-
Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
-
-
-
conditions JobCondition array patch type: merge patch merge key: type
Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
delete collection of Job
-
HTTP Request
-
DELETE /apis/batch/v1/namespaces/{namespace}/jobs
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Job
-
HTTP Request
-
GET /apis/batch/v1/jobs
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
GET /apis/batch/v1/watch/namespaces/{namespace}/jobs/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Job
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Job
-
HTTP Request
-
GET /apis/batch/v1/watch/namespaces/{namespace}/jobs
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Job
-
HTTP Request
-
GET /apis/batch/v1/watch/jobs
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.
AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
-
-
-
containers Container array patch type: merge patch merge key: name
-
List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.
Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. This is an alpha feature introduced in v1.9 and CustomPodDNS feature gate must be enabled to use it.
-
-
-
dnsPolicy string
-
Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. Note that 'None' policy is an alpha feature introduced in v1.9 and CustomPodDNS feature gate must be enabled to use it.
-
-
-
hostAliases HostAlias array patch type: merge patch merge key: ip
-
HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.
-
-
-
hostIPC boolean
-
Use the host's ipc namespace. Optional: Default to false.
-
-
-
hostNetwork boolean
-
Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.
-
-
-
hostPID boolean
-
Use the host's pid namespace. Optional: Default to false.
-
-
-
hostname string
-
Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.
-
-
-
imagePullSecrets LocalObjectReference array patch type: merge patch merge key: name
-
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
-
-
-
initContainers Container array patch type: merge patch merge key: name
-
List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, or Liveness probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
-
-
-
nodeName string
-
NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.
The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.
-
-
-
priorityClassName string
-
If specified, indicates the pod's priority. "SYSTEM" is a special keyword which indicates the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
-
-
-
serviceAccount string
-
DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all.
-
-
-
terminationGracePeriodSeconds integer
-
Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
delete a Pod
-
HTTP Request
-
DELETE /api/v1/namespaces/{namespace}/pods/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Pod
-
-
-
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.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
delete collection of Pod
-
HTTP Request
-
DELETE /api/v1/namespaces/{namespace}/pods
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Pod
-
HTTP Request
-
GET /api/v1/namespaces/{namespace}/pods
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Pod
-
HTTP Request
-
GET /api/v1/pods
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind Pod
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/pods/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Pod
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Pod
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/pods
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Pod
-
HTTP Request
-
GET /api/v1/watch/pods
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
object name and auth scope, such as for teams and projects
-
-
-
path
-
path to the resource
-
-
-
-
Response
-
-
-
-
Code
-
Description
-
-
-
-
-
200 string
-
OK
-
-
-
-
Get Connect Portforward
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
connect GET requests to portforward of Pod
-
HTTP Request
-
GET /api/v1/namespaces/{namespace}/pods/{name}/portforward
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Pod
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
ports
-
List of ports to forward Required when using WebSockets
-
-
-
-
Response
-
-
-
-
Code
-
Description
-
-
-
-
-
200 string
-
OK
-
-
-
-
Get Connect Proxy
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
connect GET requests to proxy of Pod
-
HTTP Request
-
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Pod
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
path
-
Path is the URL path to use for the current proxy request to pod.
-
-
-
-
Response
-
-
-
-
Code
-
Description
-
-
-
-
-
200 string
-
OK
-
-
-
-
Get Connect Proxy Path
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
connect GET requests to proxy of Pod
-
HTTP Request
-
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Pod
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
path
-
path to the resource
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
path
-
Path is the URL path to use for the current proxy request to pod.
-
-
-
-
Response
-
-
-
-
Code
-
Description
-
-
-
-
-
200 string
-
OK
-
-
-
-
Get Proxy
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
proxy GET requests to Pod
-
HTTP Request
-
GET /api/v1/proxy/namespaces/{namespace}/pods/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Pod
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Response
-
-
-
-
Code
-
Description
-
-
-
-
-
200 string
-
OK
-
-
-
-
Get Proxy Path
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
proxy GET requests to Pod
-
HTTP Request
-
GET /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Pod
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
path
-
path to the resource
-
-
-
-
Response
-
-
-
-
Code
-
Description
-
-
-
-
-
200 string
-
OK
-
-
-
-
Head Connect Proxy
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
connect HEAD requests to proxy of Pod
-
HTTP Request
-
HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Pod
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
path
-
Path is the URL path to use for the current proxy request to pod.
-
-
-
-
Response
-
-
-
-
Code
-
Description
-
-
-
-
-
200 string
-
OK
-
-
-
-
Head Connect Proxy Path
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
connect HEAD requests to proxy of Pod
-
HTTP Request
-
HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Pod
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
path
-
path to the resource
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
path
-
Path is the URL path to use for the current proxy request to pod.
-
-
-
-
Response
-
-
-
-
Code
-
Description
-
-
-
-
-
200 string
-
OK
-
-
-
-
Replace Connect Proxy
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
connect PUT requests to proxy of Pod
-
HTTP Request
-
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Pod
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
path
-
Path is the URL path to use for the current proxy request to pod.
-
-
-
-
Response
-
-
-
-
Code
-
Description
-
-
-
-
-
200 string
-
OK
-
-
-
-
Replace Connect Proxy Path
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
connect PUT requests to proxy of Pod
-
HTTP Request
-
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Pod
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
path
-
path to the resource
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
path
-
Path is the URL path to use for the current proxy request to pod.
-
-
-
-
Response
-
-
-
-
Code
-
Description
-
-
-
-
-
200 string
-
OK
-
-
-
-
Replace Proxy
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
proxy PUT requests to Pod
-
HTTP Request
-
PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Pod
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Response
-
-
-
-
Code
-
Description
-
-
-
-
-
200 string
-
OK
-
-
-
-
Replace Proxy Path
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
proxy PUT requests to Pod
-
HTTP Request
-
PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Pod
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
path
-
path to the resource
-
-
-
-
Response
-
-
-
-
Code
-
Description
-
-
-
-
-
200 string
-
OK
-
-
-
-
Misc Operations
-
See supported operations below...
-
Read Log
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
read log of the specified Pod
-
HTTP Request
-
GET /api/v1/namespaces/{namespace}/pods/{name}/log
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Pod
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
container
-
The container for which to stream logs. Defaults to only container if there is one container in the pod.
-
-
-
follow
-
Follow the log stream of the pod. Defaults to false.
-
-
-
limitBytes
-
If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
previous
-
Return previous terminated container logs. Defaults to false.
-
-
-
sinceSeconds
-
A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.
-
-
-
tailLines
-
If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime
-
-
-
timestamps
-
If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.
-
-
-
-
Response
-
-
-
-
Code
-
Description
-
-
-
-
-
200 string
-
OK
-
-
-
-
-
ReplicaSet v1beta2 apps
-
-
ReplicaSet Config to run 3 nginx instances.
-
-
-apiVersion:extensions/v1beta1
-kind:ReplicaSet
-metadata:
- # Unique key of the ReplicaSet instance
- name:replicaset-example
-spec:
- # 3 Pods should exist at all times.
- replicas:3
- template:
- metadata:
- labels:
- app:nginx
- spec:
- containers:
- # Run the nginx image
- - name:nginx
- image:nginx:1.10
-
-
-
ReplicaSet Config to run 3 nginx instances.
-
-
-apiVersion:extensions/v1beta1
-kind:ReplicaSet
-metadata:
- # Unique key of the ReplicaSet instance
- name:replicaset-example
-spec:
- # 3 Pods should exist at all times.
- replicas:3
- template:
- metadata:
- labels:
- app:nginx
- spec:
- containers:
- # Run the nginx image
- - name:nginx
- image:nginx:1.10
-
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
apps
-
v1beta2
-
ReplicaSet
-
-
-
-
-
-
-
-
-
-
ReplicaSet ensures that a specified number of pod replicas are running at any given time.
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ReplicaSet
-
HTTP Request
-
GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ReplicaSet
-
HTTP Request
-
GET /apis/apps/v1beta2/replicasets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind ReplicaSet
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/replicasets/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the ReplicaSet
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ReplicaSet
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/replicasets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ReplicaSet
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/replicasets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ReplicationController
-
HTTP Request
-
GET /api/v1/namespaces/{namespace}/replicationcontrollers
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ReplicationController
-
HTTP Request
-
GET /api/v1/replicationcontrollers
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind ReplicationController
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the ReplicationController
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ReplicationController
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ReplicationController
-
HTTP Request
-
GET /api/v1/watch/replicationcontrollers
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.
-
-
-
-
StatefulSetSpec v1beta2 apps
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
podManagementPolicy string
-
podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
-
-
-
replicas integer
-
replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
-
-
-
revisionHistoryLimit integer
-
revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
-
-
-
-
StatefulSetStatus v1beta2 apps
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
collisionCount integer
-
collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
Represents the latest available observations of a statefulset's current state.
-
-
-
currentReplicas integer
-
currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
-
-
-
currentRevision string
-
currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
-
-
-
observedGeneration integer
-
observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server.
-
-
-
readyReplicas integer
-
readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
-
-
-
replicas integer
-
replicas is the number of Pods created by the StatefulSet controller.
-
-
-
updateRevision string
-
updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
-
-
-
updatedReplicas integer
-
updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind StatefulSet
-
HTTP Request
-
GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind StatefulSet
-
HTTP Request
-
GET /apis/apps/v1beta2/statefulsets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind StatefulSet
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/statefulsets/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the StatefulSet
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of StatefulSet
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/statefulsets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of StatefulSet
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/statefulsets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
Discovery and Load Balancing resources are responsible for stitching your workloads together into an accessible Loadbalanced Service. By default,
-Workloads are only accessible within the cluster, and they must be exposed externally using a either
-a LoadBalancer or NodePortService. For development, internally accessible
-Workloads can be accessed via proxy through the api master using the kubectl proxy command.
-
Common resource types:
-
-
Services for providing a single ip endpoint loadbalanced across multiple Workload replicas.
-
Ingress for providing a https(s) endpoint http(s) routed to one or more Services
-
-
-
-
Endpoints v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
Endpoints
-
-
-
-
Endpoints is a collection of endpoints that implement the actual service. Example:
- Name: "mysvc",
- Subsets: [
- {
- Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
- Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
- },
- {
- Addresses: [{"ip": "10.10.3.3"}],
- Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}]
- },
- ]
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.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
delete collection of Endpoints
-
HTTP Request
-
DELETE /api/v1/namespaces/{namespace}/endpoints
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Endpoints
-
HTTP Request
-
GET /api/v1/namespaces/{namespace}/endpoints
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Endpoints
-
HTTP Request
-
GET /api/v1/endpoints
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind Endpoints
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Endpoints
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-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
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Endpoints
-
HTTP Request
-
GET /api/v1/watch/endpoints
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.
A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.
TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Ingress
-
HTTP Request
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Ingress
-
HTTP Request
-
GET /apis/extensions/v1beta1/ingresses
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind Ingress
-
HTTP Request
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Ingress
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Ingress
-
HTTP Request
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Ingress
-
HTTP Request
-
GET /apis/extensions/v1beta1/watch/ingresses
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
Service Config to load balance traffic across all Pods with the app=nginx label. Receives on and sends to port 80. Exposes an externally accessible endpoint.
-
-
-kind: Service
-apiVersion: v1
-metadata:
- # Unique key of the Service instance
- name: service-example
-spec:
- ports:
- # Accept traffic sent to port 80
- - name: http
- port: 80
- targetPort: 80
- selector:
- # Loadbalance traffic across Pods matching
- # this label selector
- app: nginx
- # Create an HA proxy in the cloud provider
- # with an External IP address - *Only supported
- # by some cloud providers*
- type: LoadBalancer
-
-
-
Service Config to load balance traffic across all Pods with the app=nginx label. Receives on and sends to port 80. Exposes an externally accessible endpoint.
-
-
-kind: Service
-apiVersion: v1
-metadata:
- # Unique key of the Service instance
- name: service-example
-spec:
- ports:
- # Accept traffic sent to port 80
- - name: http
- port: 80
- targetPort: 80
- selector:
- # Loadbalance traffic across Pods matching
- # this label selector
- app: nginx
- # Create an HA proxy in the cloud provider
- # with an External IP address - *Only supported
- # by some cloud providers*
- type: LoadBalancer
-
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
Service
-
-
-
-
Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.
clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
-
-
-
externalIPs string array
-
externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system.
-
-
-
externalName string
-
externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires Type to be ExternalName.
-
-
-
externalTrafficPolicy string
-
externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.
-
-
-
healthCheckNodePort integer
-
healthCheckNodePort specifies the healthcheck nodePort for the service. If not specified, HealthCheckNodePort is created by the service api backend with the allocated nodePort. Will use user-specified nodePort value if specified by the client. Only effects when Type is set to LoadBalancer and ExternalTrafficPolicy is set to Local.
-
-
-
loadBalancerIP string
-
Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature.
publishNotReadyAddresses, when set to true, indicates that DNS implementations must publish the notReadyAddresses of subsets for the Endpoints associated with the Service. The default value is false. The primary use case for setting this field is to use a StatefulSet's Headless Service to propagate SRV records for its Pods without respect to their readiness for purpose of peer discovery. This field will replace the service.alpha.kubernetes.io/tolerate-unready-endpoints when that annotation is deprecated and all clients have been converted to use this field.
-
-
-
selector object
-
Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/
sessionAffinityConfig contains the configurations of session affinity.
-
-
-
type string
-
type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services---service-types
curl Command (requires kubectl proxy to be running)
-
-
-$ kubectl proxy
-$ curl -X GET 'http://127.0.0.1:8001/api/v1/namespaces/default/services'
-
-
-
Output
-
-
-
-
-
Response Body
-
-
-
-
list or watch objects of kind Service
-
HTTP Request
-
GET /api/v1/namespaces/{namespace}/services
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Service
-
HTTP Request
-
GET /api/v1/services
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
GET /api/v1/watch/namespaces/{namespace}/services/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Service
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Service
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/services
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Service
-
HTTP Request
-
GET /api/v1/watch/services
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
proxy PUT requests to Service
-
HTTP Request
-
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Service
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Response
-
-
-
-
Code
-
Description
-
-
-
-
-
200 string
-
OK
-
-
-
-
Replace Proxy Path
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
proxy PUT requests to Service
-
HTTP Request
-
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Service
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
path
-
path to the resource
-
-
-
-
Response
-
-
-
-
Code
-
Description
-
-
-
-
-
200 string
-
OK
-
-
-
-
CONFIG & STORAGE
-
Config and Storage resources are responsible for injecting data into your applications and persisting data externally to your container.
-
Common resource types:
-
-
ConfigMaps for providing text key value pairs injected into the application through environment variables, command line arguments, or files
-
Secrets for providing binary data injected into the application through files
-
Volumes for providing a filesystem external to the Container. Maybe shared across Containers within the same Pod and have a lifetime persisting beyond a Container or Pod.
-
-
-
-
ConfigMap v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
ConfigMap
-
-
-
-
ConfigMap holds configuration data for pods to consume.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
delete collection of ConfigMap
-
HTTP Request
-
DELETE /api/v1/namespaces/{namespace}/configmaps
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ConfigMap
-
HTTP Request
-
GET /api/v1/namespaces/{namespace}/configmaps
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ConfigMap
-
HTTP Request
-
GET /api/v1/configmaps
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind ConfigMap
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the ConfigMap
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ConfigMap
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/configmaps
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ConfigMap
-
HTTP Request
-
GET /api/v1/watch/configmaps
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4
stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.
-
-
-
type string
-
Used to facilitate programmatic handling of secret data.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
delete collection of Secret
-
HTTP Request
-
DELETE /api/v1/namespaces/{namespace}/secrets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Secret
-
HTTP Request
-
GET /api/v1/namespaces/{namespace}/secrets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Secret
-
HTTP Request
-
GET /api/v1/secrets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind Secret
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/secrets/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Secret
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Secret
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/secrets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Secret
-
HTTP Request
-
GET /api/v1/watch/secrets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is an alpha feature and may change in the future.
-
-
-
volumeName string
-
VolumeName is the binding reference to the PersistentVolume backing this claim.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind PersistentVolumeClaim
-
HTTP Request
-
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind PersistentVolumeClaim
-
HTTP Request
-
GET /api/v1/persistentvolumeclaims
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind PersistentVolumeClaim
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the PersistentVolumeClaim
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of PersistentVolumeClaim
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of PersistentVolumeClaim
-
HTTP Request
-
GET /api/v1/watch/persistentvolumeclaims
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
-
-
-
parameters object
-
Parameters holds the parameters for the provisioner that should create volumes of this storage class.
-
-
-
provisioner string
-
Provisioner indicates the type of the provisioner.
-
-
-
reclaimPolicy string
-
Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.
-
-
-
volumeBindingMode string
-
VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is alpha-level and is only honored by servers that enable the VolumeScheduling feature.
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
delete collection of StorageClass
-
HTTP Request
-
DELETE /apis/storage.k8s.io/v1/storageclasses
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind StorageClass
-
HTTP Request
-
GET /apis/storage.k8s.io/v1/storageclasses
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind StorageClass
-
HTTP Request
-
GET /apis/storage.k8s.io/v1/watch/storageclasses/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the StorageClass
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of StorageClass
-
HTTP Request
-
GET /apis/storage.k8s.io/v1/watch/storageclasses
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
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.
HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
-
-
-
-
METADATA
-
Metadata resources are responsible for configuring behavior of your other Resources within the Cluster.
-
Common resource types:
-
-
HorizontalPodAutoscaler (HPA) for automatically scaling the replicacount of your workloads in response to load
-
PodDisruptionBudget for configuring how many replicas in a given workload maybe made concurrently unavailable when performing maintenance.
-
ThirdPartyResource for extending the Kubernetes APIs with your own types
-
Event for notification of resource lifecycle events in the cluster.
-
-
-
-
ControllerRevision v1beta2 apps
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
apps
-
v1beta2
-
ControllerRevision
-
-
-
-
-
-
-
ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ControllerRevision
-
HTTP Request
-
GET /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ControllerRevision
-
HTTP Request
-
GET /apis/apps/v1beta2/controllerrevisions
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind ControllerRevision
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/controllerrevisions/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the ControllerRevision
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ControllerRevision
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/controllerrevisions
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ControllerRevision
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/controllerrevisions
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind CustomResourceDefinition
-
HTTP Request
-
GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind CustomResourceDefinition
-
HTTP Request
-
GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the CustomResourceDefinition
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of CustomResourceDefinition
-
HTTP Request
-
GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
delete collection of Event
-
HTTP Request
-
DELETE /api/v1/namespaces/{namespace}/events
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Event
-
HTTP Request
-
GET /api/v1/namespaces/{namespace}/events
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Event
-
HTTP Request
-
GET /api/v1/events
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind Event
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/events/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Event
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Event
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/events
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Event
-
HTTP Request
-
GET /api/v1/watch/events
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
delete collection of LimitRange
-
HTTP Request
-
DELETE /api/v1/namespaces/{namespace}/limitranges
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind LimitRange
-
HTTP Request
-
GET /api/v1/namespaces/{namespace}/limitranges
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind LimitRange
-
HTTP Request
-
GET /api/v1/limitranges
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind LimitRange
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the LimitRange
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of LimitRange
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/limitranges
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of LimitRange
-
HTTP Request
-
GET /api/v1/watch/limitranges
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource.
-
-
-
targetCPUUtilizationPercentage integer
-
target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used.
-
-
-
-
HorizontalPodAutoscalerStatus v1 autoscaling
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
currentCPUUtilizationPercentage integer
-
current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU.
-
-
-
currentReplicas integer
-
current number of replicas of pods managed by this autoscaler.
-
-
-
desiredReplicas integer
-
desired number of replicas of pods managed by this autoscaler.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind HorizontalPodAutoscaler
-
HTTP Request
-
GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind HorizontalPodAutoscaler
-
HTTP Request
-
GET /apis/autoscaling/v1/horizontalpodautoscalers
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind HorizontalPodAutoscaler
-
HTTP Request
-
GET /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the HorizontalPodAutoscaler
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of HorizontalPodAutoscaler
-
HTTP Request
-
GET /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of HorizontalPodAutoscaler
-
HTTP Request
-
GET /apis/autoscaling/v1/watch/horizontalpodautoscalers
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
initializers Initializer array patch type: merge patch merge key: name
-
Initializers is a list of resources and their default initializers Order-sensitive. When merging multiple InitializerConfigurations, we sort the initializers from different InitializerConfigurations by the name of the InitializerConfigurations; the order of the initializers from the same InitializerConfiguration is preserved.
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind InitializerConfiguration
-
HTTP Request
-
GET /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind InitializerConfiguration
-
HTTP Request
-
GET /apis/admissionregistration.k8s.io/v1alpha1/watch/initializerconfigurations/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the InitializerConfiguration
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of InitializerConfiguration
-
HTTP Request
-
GET /apis/admissionregistration.k8s.io/v1alpha1/watch/initializerconfigurations
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind PodTemplate
-
HTTP Request
-
GET /api/v1/namespaces/{namespace}/podtemplates
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind PodTemplate
-
HTTP Request
-
GET /api/v1/podtemplates
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind PodTemplate
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the PodTemplate
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of PodTemplate
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/podtemplates
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of PodTemplate
-
HTTP Request
-
GET /api/v1/watch/podtemplates
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
Most recently observed status of the PodDisruptionBudget.
-
-
-
-
PodDisruptionBudgetSpec v1beta1 policy
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
maxUnavailable
-
An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".
-
-
-
minAvailable
-
An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%".
Label query over pods whose evictions are managed by the disruption budget.
-
-
-
-
PodDisruptionBudgetStatus v1beta1 policy
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
currentHealthy integer
-
current number of healthy pods
-
-
-
desiredHealthy integer
-
minimum desired number of healthy pods
-
-
-
disruptedPods object
-
DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions.
-
-
-
disruptionsAllowed integer
-
Number of pod disruptions that are currently allowed.
-
-
-
expectedPods integer
-
total number of pods counted by this disruption budget
-
-
-
observedGeneration integer
-
Most recent generation observed when updating this PDB status. PodDisruptionsAllowed and other status informatio is valid only if observedGeneration equals to PDB's object generation.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind PodDisruptionBudget
-
HTTP Request
-
GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind PodDisruptionBudget
-
HTTP Request
-
GET /apis/policy/v1beta1/poddisruptionbudgets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind PodDisruptionBudget
-
HTTP Request
-
GET /apis/policy/v1beta1/watch/namespaces/{namespace}/poddisruptionbudgets/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the PodDisruptionBudget
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of PodDisruptionBudget
-
HTTP Request
-
GET /apis/policy/v1beta1/watch/namespaces/{namespace}/poddisruptionbudgets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of PodDisruptionBudget
-
HTTP Request
-
GET /apis/policy/v1beta1/watch/poddisruptionbudgets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind PriorityClass
-
HTTP Request
-
GET /apis/scheduling.k8s.io/v1alpha1/priorityclasses
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind PriorityClass
-
HTTP Request
-
GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the PriorityClass
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of PriorityClass
-
HTTP Request
-
GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind PodPreset
-
HTTP Request
-
GET /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind PodPreset
-
HTTP Request
-
GET /apis/settings.k8s.io/v1alpha1/podpresets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind PodPreset
-
HTTP Request
-
GET /apis/settings.k8s.io/v1alpha1/watch/namespaces/{namespace}/podpresets/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the PodPreset
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of PodPreset
-
HTTP Request
-
GET /apis/settings.k8s.io/v1alpha1/watch/namespaces/{namespace}/podpresets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of PodPreset
-
HTTP Request
-
GET /apis/settings.k8s.io/v1alpha1/watch/podpresets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
AllowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.
-
-
-
allowedCapabilities string array
-
AllowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field may be added at the pod author's discretion. You must not list a capability in both AllowedCapabilities and RequiredDropCapabilities.
AllowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes is allowed in the "Volumes" field.
is a white list of allowed host paths. Empty indicates that all host paths may be used.
-
-
-
defaultAddCapabilities string array
-
DefaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capability in both DefaultAddCapabilities and RequiredDropCapabilities. Capabilities added here are implicitly allowed, and need not be included in the AllowedCapabilities list.
-
-
-
defaultAllowPrivilegeEscalation boolean
-
DefaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process.
hostPorts determines which host port ranges are allowed to be exposed.
-
-
-
privileged boolean
-
privileged determines if a pod can request to be run as privileged.
-
-
-
readOnlyRootFilesystem boolean
-
ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the PSP should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to.
-
-
-
requiredDropCapabilities string array
-
RequiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind PodSecurityPolicy
-
HTTP Request
-
GET /apis/extensions/v1beta1/podsecuritypolicies
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind PodSecurityPolicy
-
HTTP Request
-
GET /apis/extensions/v1beta1/watch/podsecuritypolicies/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the PodSecurityPolicy
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of PodSecurityPolicy
-
HTTP Request
-
GET /apis/extensions/v1beta1/watch/podsecuritypolicies
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
Status contains derived information about an API server
-
-
-
-
APIServiceSpec v1beta1 apiregistration
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
caBundle string
-
CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate.
-
-
-
group string
-
Group is the API group name this server hosts
-
-
-
groupPriorityMinimum integer
-
GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s
-
-
-
insecureSkipTLSVerify boolean
-
InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead.
Service is a reference to the service for this API server. It must communicate on port 443 If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled.
-
-
-
version string
-
Version is the API version this server hosts. For example, "v1"
-
-
-
versionPriority integer
-
VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) Since it's inside of a group, the number can be small, probably in the 10s.
-
-
-
-
APIServiceStatus v1beta1 apiregistration
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
conditions APIServiceCondition array patch type: merge patch merge key: type
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind APIService
-
HTTP Request
-
GET /apis/apiregistration.k8s.io/v1beta1/apiservices
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind APIService
-
HTTP Request
-
GET /apis/apiregistration.k8s.io/v1beta1/watch/apiservices/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the APIService
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of APIService
-
HTTP Request
-
GET /apis/apiregistration.k8s.io/v1beta1/watch/apiservices
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead.
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind CertificateSigningRequest
-
HTTP Request
-
GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind CertificateSigningRequest
-
HTTP Request
-
GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the CertificateSigningRequest
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of CertificateSigningRequest
-
HTTP Request
-
GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ClusterRole
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/clusterroles
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind ClusterRole
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the ClusterRole
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ClusterRole
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ClusterRoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind ClusterRoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the ClusterRoleBinding
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ClusterRoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list objects of kind ComponentStatus
-
HTTP Request
-
GET /api/v1/componentstatuses
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.
Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
delete a Namespace
-
HTTP Request
-
DELETE /api/v1/namespaces/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Namespace
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Namespace
-
HTTP Request
-
GET /api/v1/namespaces
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind Namespace
-
HTTP Request
-
GET /api/v1/watch/namespaces/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Namespace
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Namespace
-
HTTP Request
-
GET /api/v1/watch/namespaces
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
delete a Node
-
HTTP Request
-
DELETE /api/v1/nodes/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Node
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
delete collection of Node
-
HTTP Request
-
DELETE /api/v1/nodes
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Node
-
HTTP Request
-
GET /api/v1/nodes
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind Node
-
HTTP Request
-
GET /api/v1/watch/nodes/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Node
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Node
-
HTTP Request
-
GET /api/v1/watch/nodes
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
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.
Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running
HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. This is an alpha feature and may change in the future.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
delete a PersistentVolume
-
HTTP Request
-
DELETE /api/v1/persistentvolumes/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the PersistentVolume
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
delete collection of PersistentVolume
-
HTTP Request
-
DELETE /api/v1/persistentvolumes
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind PersistentVolume
-
HTTP Request
-
GET /api/v1/persistentvolumes
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind PersistentVolume
-
HTTP Request
-
GET /api/v1/watch/persistentvolumes/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the PersistentVolume
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of PersistentVolume
-
HTTP Request
-
GET /api/v1/watch/persistentvolumes
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ResourceQuota
-
HTTP Request
-
GET /api/v1/namespaces/{namespace}/resourcequotas
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ResourceQuota
-
HTTP Request
-
GET /api/v1/resourcequotas
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind ResourceQuota
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the ResourceQuota
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ResourceQuota
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/resourcequotas
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ResourceQuota
-
HTTP Request
-
GET /api/v1/watch/resourcequotas
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Role
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Role
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/roles
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind Role
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Role
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Role
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Role
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/watch/roles
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.
RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind RoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind RoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/rolebindings
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind RoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the RoleBinding
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of RoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of RoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/watch/rolebindings
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action
SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.
ServiceAccount binds together: a name, understood by users, and perhaps by peripheral systems, for an identity a principal that can be authenticated and authorized * a set of secrets
AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level.
ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ServiceAccount
-
HTTP Request
-
GET /api/v1/namespaces/{namespace}/serviceaccounts
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ServiceAccount
-
HTTP Request
-
GET /api/v1/serviceaccounts
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind ServiceAccount
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the ServiceAccount
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ServiceAccount
-
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ServiceAccount
-
HTTP Request
-
GET /api/v1/watch/serviceaccounts
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
ResourceAuthorizationAttributes describes information for a resource access request
-
-
-
uid string
-
UID information about the requesting user.
-
-
-
user string
-
User is the user you're testing for. If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups
-
-
-
-
SubjectAccessReviewStatus v1 authorization
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
allowed boolean
-
Allowed is required. True if the action would be allowed, false otherwise.
-
-
-
denied boolean
-
Denied is optional. True if the action would be denied, otherwise false. If both allowed is false and denied is false, then the authorizer has no opinion on whether to authorize the action. Denied may not be true if Allowed is true.
-
-
-
evaluationError string
-
EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request.
-
-
-
reason string
-
Reason is optional. It indicates why a request was allowed or denied.
-
-
-
-
Write Operations
-
See supported operations below...
-
Create
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
create a SubjectAccessReview
-
HTTP Request
-
POST /apis/authorization.k8s.io/v1/subjectaccessreviews
TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.
List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8
List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default)
Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.
-
-
-
policyTypes string array
-
List of rule types that the NetworkPolicy relates to. Valid options are Ingress, Egress, or Ingress,Egress. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind NetworkPolicy
-
HTTP Request
-
GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind NetworkPolicy
-
HTTP Request
-
GET /apis/networking.k8s.io/v1/networkpolicies
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind NetworkPolicy
-
HTTP Request
-
GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the NetworkPolicy
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of NetworkPolicy
-
HTTP Request
-
GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of NetworkPolicy
-
HTTP Request
-
GET /apis/networking.k8s.io/v1/watch/networkpolicies
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
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 are the versions supported in this group.
-
-
-
-
APIResource v1 meta
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
meta
-
v1
-
APIResource
-
-
-
-
APIResource specifies the name of a resource and whether it is namespaced.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
categories string array
-
categories is a list of the grouped resources this resource belongs to (e.g. 'all')
-
-
-
group string
-
group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale".
-
-
-
kind string
-
kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
-
-
-
name string
-
name is the plural name of the resource.
-
-
-
namespaced boolean
-
namespaced indicates if a resource is namespaced or not.
-
-
-
shortNames string array
-
shortNames is a list of suggested short names of the resource.
-
-
-
singularName string
-
singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.
-
-
-
verbs string array
-
verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)
-
-
-
version string
-
version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)".
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 string array
-
versions are the api versions that are available.
-
-
-
-
AWSElasticBlockStoreVolumeSource v1 core
-
-
-
-
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.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
fsType 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: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
-
-
-
partition 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).
ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
-
-
-
-
AllowedFlexVolume v1beta1 extensions
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
extensions
-
v1beta1
-
AllowedFlexVolume
-
-
-
-
AllowedFlexVolume represents a single Flexvolume that is allowed to be used.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
driver string
-
Driver is the name of the Flexvolume driver.
-
-
-
-
AllowedHostPath v1beta1 extensions
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
extensions
-
v1beta1
-
AllowedHostPath
-
-
-
-
defines the host volume conditions that will be enabled by a policy for pods to use. It requires the path prefix to be defined.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
pathPrefix string
-
is the path prefix that the host volume must match. It does not support *. Trailing slashes are trimmed when validating the path prefix with a host path. Examples: /foo would allow /foo, /foo/ and /foo/bar/foo would not allow /food or /etc/foo
-
-
-
-
AttachedVolume v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
AttachedVolume
-
-
-
-
AttachedVolume describes a volume attached to a node
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
devicePath string
-
DevicePath represents the device path where the volume should be available
-
-
-
name string
-
Name of the attached volume
-
-
-
-
AzureDiskVolumeSource v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
AzureDiskVolumeSource
-
-
-
-
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
cachingMode string
-
Host Caching mode: None, Read Only, Read Write.
-
-
-
diskName string
-
The Name of the data disk in the blob storage
-
-
-
diskURI string
-
The URI the data disk in the blob storage
-
-
-
fsType 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.
-
-
-
kind string
-
Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
-
-
-
readOnly boolean
-
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
-
-
-
-
AzureFilePersistentVolumeSource v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
AzureFilePersistentVolumeSource
-
-
-
-
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
readOnly boolean
-
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
-
-
-
secretName string
-
the name of secret that contains Azure Storage Account Name and Key
-
-
-
secretNamespace string
-
the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod
-
-
-
shareName string
-
Share Name
-
-
-
-
AzureFileVolumeSource v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
AzureFileVolumeSource
-
-
-
-
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
readOnly boolean
-
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
-
-
-
secretName string
-
the name of secret that contains Azure Storage Account Name and Key
-
-
-
shareName string
-
Share Name
-
-
-
-
CSIPersistentVolumeSource v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
CSIPersistentVolumeSource
-
-
-
-
Represents storage that is managed by an external CSI volume driver
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
driver string
-
Driver is the name of the driver to use for this volume. Required.
-
-
-
readOnly boolean
-
Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
-
-
-
volumeHandle string
-
VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.
-
-
-
-
Capabilities v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
Capabilities
-
-
-
-
Adds and removes POSIX capabilities from running containers.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
add string array
-
Added capabilities
-
-
-
drop string array
-
Removed capabilities
-
-
-
-
CephFSPersistentVolumeSource v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
CephFSPersistentVolumeSource
-
-
-
-
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
human readable message with details about the request state
-
-
-
reason string
-
brief reason for the request state
-
-
-
type string
-
request approval state, currently Approved or Denied.
-
-
-
-
CinderVolumeSource v1 core
-
-
-
-
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.
ClientIPConfig represents the configurations of Client IP based session affinity.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
timeoutSeconds integer
-
timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours).
-
-
-
-
ComponentCondition v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
ComponentCondition
-
-
-
-
Information about the condition of a component.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
error string
-
Condition error code for a component. For example, a health check error code.
-
-
-
message string
-
Message about the condition for a component. For example, information about a health check.
-
-
-
status string
-
Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".
-
-
-
type string
-
Type of condition for a component. Valid value: "Healthy"
-
-
-
-
ConfigMapEnvSource v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
ConfigMapEnvSource
-
-
-
-
ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.
-
The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.
Specify whether the ConfigMap or it's key must be defined
-
-
-
-
ConfigMapProjection v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
ConfigMapProjection
-
-
-
-
Adapts a ConfigMap into a projected volume.
-
The contents of the target ConfigMap's Data field will be presented in a projected 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. Note that this is identical to a configmap volume source without the default mode.
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 unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
Specify whether the ConfigMap or it's keys must be defined
-
-
-
-
ConfigMapVolumeSource v1 core
-
-
-
-
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.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
defaultMode 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.
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 unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
Specify whether the ConfigMap or it's keys must be defined
-
-
-
-
ContainerImage v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
ContainerImage
-
-
-
-
Describe a container image
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
names string array
-
Names by which this image is known. e.g. ["k8s.gcr.io/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]
-
-
-
sizeBytes integer
-
The size of the image in bytes.
-
-
-
-
ContainerPort v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
ContainerPort
-
-
-
-
ContainerPort represents a network port in a single container.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
containerPort integer
-
Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
-
-
-
hostIP string
-
What host IP to bind the external port to.
-
-
-
hostPort integer
-
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
-
-
-
name string
-
If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
-
-
-
protocol string
-
Protocol for port. Must be UDP or TCP. Defaults to "TCP".
-
-
-
-
ContainerState v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
ContainerState
-
-
-
-
ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.
Time at which previous execution of the container started
-
-
-
-
ContainerStateWaiting v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
ContainerStateWaiting
-
-
-
-
ContainerStateWaiting is a waiting state of a container.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
message string
-
Message regarding why the container is not yet running.
-
-
-
reason string
-
(brief) reason the container is not yet running.
-
-
-
-
ControllerRevision v1 apps
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
apps
-
v1
-
ControllerRevision
-
-
-
-
-
-
ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.
CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
kind string
-
Kind is the serialized kind of the resource. It is normally CamelCase and singular.
-
-
-
listKind string
-
ListKind is the serialized kind of the list for this resource. Defaults to List.
-
-
-
plural string
-
Plural is the plural name of the resource to serve. It must match the name of the CustomResourceDefinition-registration too: plural.group and it must be all lowercase.
-
-
-
shortNames string array
-
ShortNames are short names for the resource. It must be all lowercase.
-
-
-
singular string
-
Singular is the singular name of the resource. It must be all lowercase Defaults to lowercased
-
-
-
-
CustomResourceValidation v1beta1 apiextensions
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
apiextensions
-
v1beta1
-
CustomResourceValidation
-
-
-
-
CustomResourceValidation is a list of validation methods for CustomResources.
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.
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
-
-
-
propagationPolicy string
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
-
-
-
-
Deployment v1 apps
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
apps
-
v1
-
Deployment
-
-
-
-
-
-
Deployment enables declarative updates for Pods and ReplicaSets.
A human readable message indicating details about the transition.
-
-
-
reason string
-
The reason for the condition's last transition.
-
-
-
status string
-
Status of the condition, one of True, False, Unknown.
-
-
-
type string
-
Type of deployment condition.
-
-
-
-
DownwardAPIProjection v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
DownwardAPIProjection
-
-
-
-
Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
-
-
-
mode 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 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 '..'
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
-
-
-
-
DownwardAPIVolumeSource v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
DownwardAPIVolumeSource
-
-
-
-
DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
defaultMode 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.
Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir
-
-
-
-
EndpointAddress v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
EndpointAddress
-
-
-
-
EndpointAddress is a tuple that describes single IP address.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
hostname string
-
The Hostname of this endpoint
-
-
-
ip string
-
The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready.
-
-
-
nodeName string
-
Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.
EndpointPort is a tuple that describes a single port.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
name string
-
The name of this port (corresponds to ServicePort.Name). Must be a DNS_LABEL. Optional only if one port is defined.
-
-
-
port integer
-
The port number of the endpoint.
-
-
-
protocol string
-
The IP protocol for this port. Must be UDP or TCP. Default is TCP.
-
-
-
-
EndpointSubset v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
EndpointSubset
-
-
-
-
EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given:
- {
- Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
- Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
- }
-The resulting set of endpoints can be viewed as:
- a: [ 10.10.1.1:8675, 10.10.2.2:8675 ],
- b: [ 10.10.1.1:309, 10.10.2.2:309 ]
IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.
IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check.
EnvVar represents an environment variable present in a Container.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
name string
-
Name of the environment variable. Must be a C_IDENTIFIER.
-
-
-
value string
-
Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods//evictions.
ObjectMeta describes the pod that is being evicted.
-
-
-
-
ExecAction v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
ExecAction
-
-
-
-
ExecAction describes a "run in container" action.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
command string array
-
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('
-
', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
-
-
-
-
ExternalDocumentation v1beta1 apiextensions
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
apiextensions
-
v1beta1
-
ExternalDocumentation
-
-
-
-
ExternalDocumentation allows referencing an external resource for extended documentation.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
description string
-
-
-
-
url string
-
-
-
-
-
FCVolumeSource v1 core
-
-
-
-
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.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
fsType 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 integer
-
Optional: FC target lun number
-
-
-
readOnly boolean
-
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
-
-
-
targetWWNs string array
-
Optional: FC target worldwide names (WWNs)
-
-
-
wwids string array
-
Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
-
-
-
-
FSGroupStrategyOptions v1beta1 extensions
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
extensions
-
v1beta1
-
FSGroupStrategyOptions
-
-
-
-
FSGroupStrategyOptions defines the strategy type and options used to create the strategy.
Ranges are the allowed ranges of fs groups. If you would like to force a single fs group then supply a single range with the same start and end.
-
-
-
rule string
-
Rule is the strategy that will dictate what FSGroup is used in the SecurityContext.
-
-
-
-
FlexVolumeSource v1 core
-
-
-
-
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.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
driver string
-
Driver is the name of the driver to use for this volume.
-
-
-
fsType 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 object
-
Optional: Extra command options if any.
-
-
-
readOnly boolean
-
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
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.
-
-
-
-
FlockerVolumeSource v1 core
-
-
-
-
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.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
datasetName string
-
Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
-
-
-
datasetUUID string
-
UUID of the dataset. This is unique identifier of a Flocker dataset
-
-
-
-
GCEPersistentDiskVolumeSource v1 core
-
-
-
-
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.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
fsType 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: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
-
-
-
partition 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: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
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.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
directory 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 string
-
Repository URL
-
-
-
revision string
-
Commit hash for the specified revision.
-
-
-
-
GlusterfsVolumeSource v1 core
-
-
-
-
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.
Backend defines the referenced service endpoint to which the traffic will be forwarded to.
-
-
-
path string
-
Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/'. If unspecified, the path defaults to a catch all sending traffic to the backend.
-
-
-
-
HTTPIngressRuleValue v1beta1 extensions
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
extensions
-
v1beta1
-
HTTPIngressRuleValue
-
-
-
-
HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http:///? -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'.
Host Port Range defines a range of host ports that will be enabled by a policy for pods to use. It requires both the start and end to be defined.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
max integer
-
max is the end of the range, inclusive.
-
-
-
min integer
-
min is the start of the range, inclusive.
-
-
-
-
IDRange v1beta1 extensions
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
extensions
-
v1beta1
-
IDRange
-
-
-
-
ID Range provides a min/max of an allowed range of IDs.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
max integer
-
Max is the end of the range, inclusive.
-
-
-
min integer
-
Min is the start of the range, inclusive.
-
-
-
-
IPBlock v1 networking
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
networking
-
v1
-
IPBlock
-
-
-
-
-
-
IPBlock describes a particular CIDR (Ex. "192.168.1.1/24") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
cidr string
-
CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24"
-
-
-
except string array
-
Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" Except values will be rejected if they are outside the CIDR range
-
-
-
-
ISCSIPersistentVolumeSource v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
ISCSIPersistentVolumeSource
-
-
-
-
ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
chapAuthDiscovery boolean
-
whether support iSCSI Discovery CHAP authentication
-
-
-
chapAuthSession boolean
-
whether support iSCSI Session CHAP authentication
-
-
-
fsType 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: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
-
-
-
initiatorName string
-
Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.
-
-
-
iqn string
-
Target iSCSI Qualified Name.
-
-
-
iscsiInterface string
-
iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
-
-
-
lun integer
-
iSCSI Target Lun number.
-
-
-
portals string array
-
iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
-
-
-
readOnly boolean
-
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
CHAP Secret for iSCSI target and initiator authentication
-
-
-
targetPortal string
-
iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
-
-
-
-
ISCSIVolumeSource v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
ISCSIVolumeSource
-
-
-
-
Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
chapAuthDiscovery boolean
-
whether support iSCSI Discovery CHAP authentication
-
-
-
chapAuthSession boolean
-
whether support iSCSI Session CHAP authentication
-
-
-
fsType 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: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
-
-
-
initiatorName string
-
Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.
-
-
-
iqn string
-
Target iSCSI Qualified Name.
-
-
-
iscsiInterface string
-
iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
-
-
-
lun integer
-
iSCSI Target Lun number.
-
-
-
portals string array
-
iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
-
-
-
readOnly boolean
-
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
CHAP Secret for iSCSI target and initiator authentication
-
-
-
targetPortal string
-
iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
-
-
-
-
IngressBackend v1beta1 extensions
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
extensions
-
v1beta1
-
IngressBackend
-
-
-
-
IngressBackend describes all endpoints for a given service and port.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
serviceName string
-
Specifies the name of the referenced service.
-
-
-
servicePort
-
Specifies the port of the referenced service.
-
-
-
-
IngressRule v1beta1 extensions
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
extensions
-
v1beta1
-
IngressRule
-
-
-
-
IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
host string
-
Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in the RFC: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the IP in the Spec of the parent Ingress. 2. The : delimiter is not respected because ports are not allowed. Currently the port of an Ingress is implicitly :80 for http and :443 for https. Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue.
IngressTLS describes the transport layer security associated with an Ingress.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
hosts string array
-
Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified.
-
-
-
secretName string
-
SecretName is the name of the secret used to terminate SSL traffic on 443. Field is left optional to allow SSL routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing.
-
-
-
-
Initializer v1 meta
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
meta
-
v1
-
Initializer
-
-
-
-
-
-
Initializer is information about an initializer that has not yet completed.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
name string
-
name of the process that is responsible for initializing this object.
-
-
-
-
Initializers v1 meta
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
meta
-
v1
-
Initializers
-
-
-
-
Initializers tracks the progress of initialization.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
pending Initializer array patch type: merge patch merge key: name
-
Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.
If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion.
-
-
-
-
JSON v1beta1 apiextensions
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
apiextensions
-
v1beta1
-
JSON
-
-
-
-
JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
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 string
-
The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
-
-
-
-
LabelSelector v1 meta
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
meta
-
v1
-
LabelSelector
-
-
-
-
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
-
-
-
matchLabels object
-
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
-
-
-
-
LabelSelectorRequirement v1 meta
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
meta
-
v1
-
LabelSelectorRequirement
-
-
-
-
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
key string patch type: merge patch merge key: key
-
key is the label key that the selector applies to.
-
-
-
operator string
-
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
-
-
-
values string array
-
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
-
-
-
-
Lifecycle v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
Lifecycle
-
-
-
-
Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.
PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
-
-
-
-
LimitRangeItem v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
LimitRangeItem
-
-
-
-
LimitRangeItem defines a min/max usage limit for any resource that matches on kind.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
default object
-
Default resource requirement limit value by resource name if resource limit is omitted.
-
-
-
defaultRequest object
-
DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.
-
-
-
max object
-
Max usage constraints on this kind by resource name.
-
-
-
maxLimitRequestRatio object
-
MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource.
-
-
-
min object
-
Min usage constraints on this kind by resource name.
-
-
-
type string
-
Type of resource that this limit applies to.
-
-
-
-
ListMeta v1 meta
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
meta
-
v1
-
ListMeta
-
-
-
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
continue string
-
continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response.
Local represents directly-attached storage with node affinity
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
path string
-
The full path to the volume on the node For alpha, this path must be a directory Once block as a source is supported, then this path can point to a block device
-
-
-
-
MetricSpec v2beta1 autoscaling
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
autoscaling
-
v2beta1
-
MetricSpec
-
-
-
-
MetricSpec specifies how to scale based on a single metric (only type and one other matching field should be set at once).
pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
-
-
-
type string
-
type is the type of metric source. It should match one of the fields below.
-
-
-
-
MetricStatus v2beta1 autoscaling
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
autoscaling
-
v2beta1
-
MetricStatus
-
-
-
-
MetricStatus describes the last-read state of a single metric.
pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
-
-
-
type string
-
type is the type of metric source. It will match one of the fields below.
NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8
List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.
-
-
-
-
NetworkPolicyIngressRule v1 networking
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
networking
-
v1
-
NetworkPolicyIngressRule
-
-
-
-
-
-
NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.
List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least on item, this rule allows traffic only if the traffic matches at least one item in the from list.
List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
-
-
-
-
NetworkPolicyPeer v1 networking
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
networking
-
v1
-
NetworkPolicyPeer
-
-
-
-
-
-
NetworkPolicyPeer describes a peer to allow traffic from. Exactly one of its fields must be specified.
Selects Namespaces using cluster scoped-labels. This matches all pods in all namespaces selected by this label selector. This field follows standard label selector semantics. If present but empty, this selector selects all namespaces.
This is a label selector which selects Pods in this namespace. This field follows standard label selector semantics. If present but empty, this selector selects all pods in this namespace.
-
-
-
-
NetworkPolicyPort v1 networking
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
networking
-
v1
-
NetworkPolicyPort
-
-
-
-
-
-
NetworkPolicyPort describes a port to allow traffic on
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
port
-
The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers.
-
-
-
protocol string
-
The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.
-
-
-
-
NodeAddress v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
NodeAddress
-
-
-
-
NodeAddress contains information for the node's address.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
address string
-
The node address.
-
-
-
type string
-
Node address type, one of Hostname, ExternalIP or InternalIP.
-
-
-
-
NodeAffinity v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
NodeAffinity
-
-
-
-
Node affinity is a group of node affinity scheduling rules.
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
-
-
-
-
NodeCondition v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
NodeCondition
-
-
-
-
NodeCondition contains condition information for a node.
A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.
Required. A list of node selector terms. The terms are ORed.
-
-
-
-
NodeSelectorRequirement v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
NodeSelectorRequirement
-
-
-
-
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
key string
-
The label key that the selector applies to.
-
-
-
operator string
-
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
-
-
-
values string array
-
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
-
-
-
-
NodeSelectorTerm v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
NodeSelectorTerm
-
-
-
-
A null or empty node selector term matches no objects.
NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
path string
-
Path is the URL path of the request
-
-
-
verb string
-
Verb is the standard HTTP verb
-
-
-
-
NonResourceRule v1 authorization
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
authorization
-
v1
-
NonResourceRule
-
-
-
-
-
-
NonResourceRule holds information that describes a rule for the non-resource
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
nonResourceURLs string array
-
NonResourceURLs is a set of partial urls that a user should have access to. s are allowed, but only as the full, final step in the path. "" means all.
-
-
-
verbs string array
-
Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all.
-
-
-
-
ObjectFieldSelector v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
ObjectFieldSelector
-
-
-
-
ObjectFieldSelector selects an APIVersioned field of an object.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
apiVersion string
-
Version of the schema the FieldPath is written in terms of, defaults to "v1".
-
-
-
fieldPath string
-
Path of the field to select in the specified API version.
-
-
-
-
ObjectMeta v1 meta
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
meta
-
v1
-
ObjectMeta
-
-
-
-
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
annotations object
-
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
-
-
-
clusterName string
-
The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
-
-
-
deletionGracePeriodSeconds integer
-
Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
-
-
-
finalizers string array patch type: merge
-
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
-
-
-
generateName string
-
GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
-
-
-
generation integer
-
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects. When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.
-
-
-
labels object
-
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
-
-
-
name string
-
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
-
-
-
namespace string
-
Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
-
-
-
resourceVersion string
-
An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
-
-
-
selfLink string
-
SelfLink is a URL representing this object. Populated by the system. Read-only.
-
-
-
uid string
-
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
-
-
-
-
ObjectMetricSource v2beta1 autoscaling
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
autoscaling
-
v2beta1
-
ObjectMetricSource
-
-
-
-
ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).
ObjectReference contains enough information to let you inspect or modify the referred object.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
apiVersion string
-
API version of the referent.
-
-
-
fieldPath string
-
If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
apiVersion string
-
API version of the referent.
-
-
-
blockOwnerDeletion boolean
-
If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
-
-
-
controller boolean
-
If true, this reference points to the managing controller.
Last time the condition transitioned from one status to another.
-
-
-
message string
-
Human-readable message indicating details about last transition.
-
-
-
reason string
-
Unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized.
-
-
-
status string
-
-
-
-
type string
-
-
-
-
-
PersistentVolumeClaimVolumeSource v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
PersistentVolumeClaimVolumeSource
-
-
-
-
PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).
Will force the ReadOnly setting in VolumeMounts. Default false.
-
-
-
-
PhotonPersistentDiskVolumeSource v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
PhotonPersistentDiskVolumeSource
-
-
-
-
Represents a Photon Controller persistent disk resource.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
fsType 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.
-
-
-
pdID string
-
ID that identifies Photon Controller persistent disk
-
-
-
-
PodAffinity v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
PodAffinity
-
-
-
-
Pod affinity is a group of inter pod affinity scheduling rules.
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
-
-
-
-
PodAffinityTerm v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
PodAffinityTerm
-
-
-
-
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running
A label query over a set of resources, in this case pods.
-
-
-
namespaces string array
-
namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
-
-
-
topologyKey string
-
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
-
-
-
-
PodAntiAffinity v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
PodAntiAffinity
-
-
-
-
Pod anti affinity is a group of inter pod anti affinity scheduling rules.
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
-
-
-
-
PodCondition v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
PodCondition
-
-
-
-
PodCondition contains details for the current condition of this pod.
PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
nameservers string array
-
A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.
-
-
-
searches string array
-
A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.
-
-
-
-
PodDNSConfigOption v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
PodDNSConfigOption
-
-
-
-
PodDNSConfigOption defines DNS resolver options of a pod.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
name string
-
Required.
-
-
-
value string
-
-
-
-
-
PodSecurityContext v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
PodSecurityContext
-
-
-
-
PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
fsGroup integer
-
A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume.
-
-
-
runAsNonRoot boolean
-
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
-
-
-
runAsUser integer
-
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
-
-
-
supplementalGroups integer array
-
A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.
-
-
-
-
PodsMetricSource v2beta1 autoscaling
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
autoscaling
-
v2beta1
-
PodsMetricSource
-
-
-
-
PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
targetAverageValue is the target value of the average of the metric across all relevant pods (as a quantity)
-
-
-
-
PodsMetricStatus v2beta1 autoscaling
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
autoscaling
-
v2beta1
-
PodsMetricStatus
-
-
-
-
PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).
currentAverageValue is the current value of the average of the metric across all relevant pods (as a quantity)
-
-
-
metricName string
-
metricName is the name of the metric in question
-
-
-
-
PolicyRule v1 rbac
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
rbac
-
v1
-
PolicyRule
-
-
-
-
-
-
PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
apiGroups string array
-
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
-
-
-
nonResourceURLs string array
-
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
-
-
-
resourceNames string array
-
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
-
-
-
resources string array
-
Resources is a list of resources this rule applies to. ResourceAll represents all resources.
-
-
-
verbs string array
-
Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
-
-
-
-
PortworxVolumeSource v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
PortworxVolumeSource
-
-
-
-
PortworxVolumeSource represents a Portworx volume resource.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
fsType string
-
FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
-
-
-
readOnly boolean
-
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
-
-
-
volumeID string
-
VolumeID uniquely identifies a Portworx volume
-
-
-
-
Preconditions v1 meta
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
meta
-
v1
-
Preconditions
-
-
-
-
Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
uid string
-
Specifies the target UID.
-
-
-
-
PreferredSchedulingTerm v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
PreferredSchedulingTerm
-
-
-
-
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
-
-
-
successThreshold integer
-
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.
Mode bits to use on created files by default. Must be a value between 0 and 0777. 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.
Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
group string
-
Group to map volume access to Default is no group
-
-
-
readOnly boolean
-
ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
-
-
-
registry string
-
Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
-
-
-
user string
-
User to map volume access to Defaults to serivceaccount user
-
-
-
volume string
-
Volume is a string that references an already created Quobyte volume by name.
-
-
-
-
RBDPersistentVolumeSource v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
RBDPersistentVolumeSource
-
-
-
-
Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
fsType 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: https://kubernetes.io/docs/concepts/storage/volumes#rbd
Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
fsType 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: https://kubernetes.io/docs/concepts/storage/volumes#rbd
The last time the condition transitioned from one status to another.
-
-
-
message string
-
A human readable message indicating details about the transition.
-
-
-
reason string
-
The reason for the condition's last transition.
-
-
-
status string
-
Status of the condition, one of True, False, Unknown.
-
-
-
type string
-
Type of replication controller condition.
-
-
-
-
ResourceAttributes v1 authorization
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
authorization
-
v1
-
ResourceAttributes
-
-
-
-
-
-
ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
group string
-
Group is the API Group of the Resource. "*" means all.
-
-
-
name string
-
Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.
-
-
-
namespace string
-
Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview
-
-
-
resource string
-
Resource is one of the existing resource types. "*" means all.
-
-
-
subresource string
-
Subresource is one of the existing resource types. "" means none.
-
-
-
verb string
-
Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all.
-
-
-
version string
-
Version is the API Version of the Resource. "*" means all.
-
-
-
-
ResourceFieldSelector v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
ResourceFieldSelector
-
-
-
-
ResourceFieldSelector represents container resources (cpu, memory) and their output format
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
containerName string
-
Container name: required for volumes, optional for env vars
Specifies the output format of the exposed resources, defaults to "1"
-
-
-
resource string
-
Required: resource to select
-
-
-
-
ResourceMetricSource v2beta1 autoscaling
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
autoscaling
-
v2beta1
-
ResourceMetricSource
-
-
-
-
ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
name string
-
name is the name of the resource in question.
-
-
-
targetAverageUtilization integer
-
targetAverageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
targetAverageValue is the target value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type.
-
-
-
-
ResourceMetricStatus v2beta1 autoscaling
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
autoscaling
-
v2beta1
-
ResourceMetricStatus
-
-
-
-
ResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
currentAverageUtilization integer
-
currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. It will only be present if targetAverageValue was set in the corresponding metric specification.
currentAverageValue is the current value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. It will always be set, regardless of the corresponding metric specification.
-
-
-
name string
-
name is the name of the resource in question.
-
-
-
-
ResourceRequirements v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
ResourceRequirements
-
-
-
-
ResourceRequirements describes the compute resource requirements.
ResourceRule is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
apiGroups string array
-
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all.
-
-
-
resourceNames string array
-
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all.
-
-
-
resources string array
-
Resources is a list of resources this rule applies to. "" means all in the specified apiGroups. "/foo" represents the subresource 'foo' for all resources in the specified apiGroups.
-
-
-
verbs string array
-
Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all.
-
-
-
-
RoleRef v1 rbac
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
rbac
-
v1
-
RoleRef
-
-
-
-
-
-
RoleRef contains information that points to the role being used
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
apiGroup string
-
APIGroup is the group for the resource being referenced
-
-
-
kind string
-
Kind is the type of resource being referenced
-
-
-
name string
-
Name is the name of resource being referenced
-
-
-
-
RollbackConfig v1beta1 apps
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
apps
-
v1beta1
-
RollbackConfig
-
-
-
-
DEPRECATED.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
revision integer
-
The revision to rollback to. If set to 0, rollback to the last revision.
-
-
-
-
RollingUpdateStatefulSetStrategy v1 apps
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
apps
-
v1
-
RollingUpdateStatefulSetStrategy
-
-
-
-
-
-
RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
partition integer
-
Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0.
-
-
-
-
Rule v1alpha1 admissionregistration
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
admissionregistration
-
v1alpha1
-
Rule
-
-
-
-
Rule is a tuple of APIGroups, APIVersion, and Resources.It is recommended to make sure that all the tuple expansions are valid.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
apiGroups string array
-
APIGroups is the API groups the resources belong to. '' is all groups. If '' is present, the length of the slice must be one. Required.
-
-
-
apiVersions string array
-
APIVersions is the API versions the resources belong to. '' is all versions. If '' is present, the length of the slice must be one. Required.
-
-
-
resources string array
-
Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '' means all resources, but not subresources. 'pods/' means all subresources of pods. '/scale' means all scale subresources. '/*' means all resources and their subresources. If wildcard is present, the validation rule will ensure resources do not overlap with each other. Depending on the enclosing object, subresources might not be allowed. Required.
-
-
-
-
RuleWithOperations v1beta1 admissionregistration
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
admissionregistration
-
v1beta1
-
RuleWithOperations
-
-
-
-
RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
apiGroups string array
-
APIGroups is the API groups the resources belong to. '' is all groups. If '' is present, the length of the slice must be one. Required.
-
-
-
apiVersions string array
-
APIVersions is the API versions the resources belong to. '' is all versions. If '' is present, the length of the slice must be one. Required.
-
-
-
operations string array
-
Operations is the operations the admission hook cares about - CREATE, UPDATE, or for all operations. If '' is present, the length of the slice must be one. Required.
-
-
-
resources string array
-
Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '' means all resources, but not subresources. 'pods/' means all subresources of pods. '/scale' means all scale subresources. '/*' means all resources and their subresources. If wildcard is present, the validation rule will ensure resources do not overlap with each other. Depending on the enclosing object, subresources might not be allowed. Required.
-
-
-
-
RunAsUserStrategyOptions v1beta1 extensions
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
extensions
-
v1beta1
-
RunAsUserStrategyOptions
-
-
-
-
Run A sUser Strategy Options defines the strategy type and any options used to create the strategy.
ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
fsType 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.
-
-
-
gateway string
-
The host address of the ScaleIO API Gateway.
-
-
-
protectionDomain string
-
The name of the ScaleIO Protection Domain for the configured storage.
-
-
-
readOnly boolean
-
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
-
-
-
sslEnabled boolean
-
Flag to enable/disable SSL communication with Gateway, default false
-
-
-
storageMode string
-
Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
-
-
-
storagePool string
-
The ScaleIO Storage Pool associated with the protection domain.
-
-
-
system string
-
The name of the storage system as configured in ScaleIO.
-
-
-
volumeName string
-
The name of a volume already created in the ScaleIO system that is associated with this volume source.
-
-
-
-
ScaleIOVolumeSource v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
ScaleIOVolumeSource
-
-
-
-
ScaleIOVolumeSource represents a persistent ScaleIO volume
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
fsType 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.
-
-
-
gateway string
-
The host address of the ScaleIO API Gateway.
-
-
-
protectionDomain string
-
The name of the ScaleIO Protection Domain for the configured storage.
-
-
-
readOnly boolean
-
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
Specify whether the Secret or it's key must be defined
-
-
-
-
SecretProjection v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
SecretProjection
-
-
-
-
Adapts a secret into a projected volume.
-
The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.
If unspecified, each key-value pair in the Data field of the referenced Secret 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 Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
Specify whether the Secret or its key must be defined
-
-
-
-
SecretReference v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
SecretReference
-
-
-
-
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
name string
-
Name is unique within a namespace to reference a secret resource.
-
-
-
namespace string
-
Namespace defines the space within which the secret name must be unique.
-
-
-
-
SecretVolumeSource v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
SecretVolumeSource
-
-
-
-
Adapts a Secret into a volume.
-
The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
defaultMode 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.
If unspecified, each key-value pair in the Data field of the referenced Secret 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 Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
-
-
-
optional boolean
-
Specify whether the Secret or it's keys must be defined
SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
allowPrivilegeEscalation boolean
-
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
-
-
-
privileged boolean
-
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
-
-
-
readOnlyRootFilesystem boolean
-
Whether this container has a read-only root filesystem. Default is false.
-
-
-
runAsNonRoot boolean
-
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
-
-
-
runAsUser integer
-
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
-
-
-
-
ServerAddressByClientCIDR v1 meta
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
meta
-
v1
-
ServerAddressByClientCIDR
-
-
-
-
ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
clientCIDR string
-
The CIDR with which clients can match their IP to figure out the server address that they should use.
-
-
-
serverAddress string
-
Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.
-
-
-
-
ServicePort v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
ServicePort
-
-
-
-
ServicePort contains information on service's port.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
name string
-
The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the 'Name' field in EndpointPort objects. Optional if only one ServicePort is defined on this service.
-
-
-
nodePort integer
-
The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
-
-
-
port integer
-
The port that will be exposed by this service.
-
-
-
protocol string
-
The IP protocol for this port. Supports "TCP" and "UDP". Default is TCP.
-
-
-
targetPort
-
Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
-
-
-
-
ServiceReference v1beta1 admissionregistration
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
admissionregistration
-
v1beta1
-
ServiceReference
-
-
-
-
ServiceReference holds a reference to Service.legacy.k8s.io
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
name string
-
name is the name of the service. Required
-
-
-
namespace string
-
namespace is the namespace of the service. Required
-
-
-
path string
-
path is an optional URL path which will be sent in any request to this service.
-
-
-
-
SessionAffinityConfig v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
SessionAffinityConfig
-
-
-
-
SessionAffinityConfig represents the configurations of session affinity.
Last time the condition transitioned from one status to another.
-
-
-
message string
-
A human readable message indicating details about the transition.
-
-
-
reason string
-
The reason for the condition's last transition.
-
-
-
status string
-
Status of the condition, one of True, False, Unknown.
-
-
-
type string
-
Type of statefulset condition.
-
-
-
-
StatefulSetUpdateStrategy v1 apps
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
apps
-
v1
-
StatefulSetUpdateStrategy
-
-
-
-
-
-
StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.
Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
field string
-
The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"
-
-
-
message string
-
A human-readable description of the cause of the error. This field may be presented as-is to a reader.
-
-
-
reason string
-
A machine-readable description of the cause of the error. If this value is empty there is no information available.
-
-
-
-
StatusDetails v1 meta
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
meta
-
v1
-
StatusDetails
-
-
-
-
StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.
The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
-
-
-
retryAfterSeconds integer
-
If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
Represents a StorageOS persistent volume resource.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
fsType 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 boolean
-
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
-
-
-
volumeName string
-
VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
-
-
-
volumeNamespace string
-
VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
-
-
-
-
StorageOSVolumeSource v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
StorageOSVolumeSource
-
-
-
-
Represents a StorageOS persistent volume resource.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
fsType 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 boolean
-
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
-
-
-
volumeName string
-
VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
-
-
-
volumeNamespace string
-
VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
-
-
-
-
Subject v1 rbac
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
rbac
-
v1
-
Subject
-
-
-
-
-
-
Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
apiGroup string
-
APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
-
-
-
kind string
-
Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
-
-
-
name string
-
Name of the object being referenced.
-
-
-
namespace string
-
Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
-
-
-
-
SubjectRulesReviewStatus v1 authorization
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
authorization
-
v1
-
SubjectRulesReviewStatus
-
-
-
-
-
-
SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it's safe to assume the subject has that permission, even if that list is incomplete.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
evaluationError string
-
EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete.
-
-
-
incomplete boolean
-
Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation.
NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
Ranges are the allowed ranges of supplemental groups. If you would like to force a single supplemental group then supply a single range with the same start and end.
-
-
-
rule string
-
Rule is the strategy that will dictate what supplemental groups is used in the SecurityContext.
-
-
-
-
TCPSocketAction v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
TCPSocketAction
-
-
-
-
TCPSocketAction describes an action based on opening a socket
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
host string
-
Optional: Host name to connect to, defaults to the pod IP.
-
-
-
port
-
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
-
-
-
-
Taint v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
Taint
-
-
-
-
The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
effect string
-
Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.
-
-
-
value string
-
Required. The taint value corresponding to the taint key.
-
-
-
-
Time v1 meta
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
meta
-
v1
-
Time
-
-
-
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
-
-
-
-
Toleration v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
Toleration
-
-
-
-
The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
effect string
-
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
-
-
-
key string
-
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
-
-
-
operator string
-
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
-
-
-
tolerationSeconds integer
-
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
-
-
-
value string
-
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
-
-
-
-
UserInfo v1 authentication
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
authentication
-
v1
-
UserInfo
-
-
-
-
-
-
UserInfo holds the information about the user needed to implement the user.Info interface.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
extra object
-
Any additional information provided by the authenticator.
-
-
-
groups string array
-
The names of groups this user is a part of.
-
-
-
uid string
-
A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs.
-
-
-
username string
-
The name that uniquely identifies this user among all active users.
Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.
-
-
-
-
VolumeAttachmentSource v1alpha1 storage
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
storage
-
v1alpha1
-
VolumeAttachmentSource
-
-
-
-
VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
persistentVolumeName string
-
Name of the persistent volume to attach.
-
-
-
-
VolumeDevice v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
VolumeDevice
-
-
-
-
volumeDevice describes a mapping of a raw block device within a container.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
devicePath string
-
devicePath is the path inside of the container that the device will be mapped to.
-
-
-
name string
-
name must match the name of a persistentVolumeClaim in the pod
-
-
-
-
VolumeError v1alpha1 storage
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
storage
-
v1alpha1
-
VolumeError
-
-
-
-
VolumeError captures an error encountered during a volume operation.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
message string
-
String detailing the error encountered during Attach or Detach operation. This string maybe logged, so it should not contain sensitive information.
VolumeMount describes a mounting of a Volume within a container.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
mountPath string
-
Path within the container at which the volume should be mounted. Must not contain ':'.
-
-
-
mountPropagation string
-
mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationHostToContainer is used. This field is alpha in 1.8 and can be reworked or removed in a future release.
-
-
-
name string
-
This must match the Name of a Volume.
-
-
-
readOnly boolean
-
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
-
-
-
subPath string
-
Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
-
-
-
-
VolumeProjection v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
VolumeProjection
-
-
-
-
Projection that may be projected along with other supported volume types
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.
-
-
-
storagePolicyID string
-
Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
-
-
-
storagePolicyName string
-
Storage Policy Based Management (SPBM) profile name.
-
-
-
volumePath string
-
Path that identifies vSphere volume vmdk
-
-
-
-
WatchEvent v1 meta
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
meta
-
v1
-
WatchEvent
-
-
-
-
Event represents a single event to a watched resource.
-
-
-
-
Field
-
Description
-
-
-
-
-
object
-
Object is: If Type is Added or Modified: the new state of the object. If Type is Deleted: the state of the object immediately before deletion. If Type is Error: Status is recommended; other types may make sense depending on context.
-
-
-
type string
-
-
-
-
-
Webhook v1beta1 admissionregistration
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
admissionregistration
-
v1beta1
-
Webhook
-
-
-
-
Webhook describes an admission webhook and the resources and operations it applies to.
ClientConfig defines how to communicate with the hook. Required
-
-
-
failurePolicy string
-
FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Ignore.
-
-
-
name string
-
The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required.
NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is other cluster scoped resource, it is not subjected to the webhook. For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "runlevel", "operator": "NotIn", "values": [ "0", "1" ] } ] } If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "environment", "operator": "In", "values": [ "prod", "staging" ] } ] } See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors. Default to the empty LabelSelector, which matches everything.
service is a reference to the service for this webhook. Either service or url must be specified. If the webhook is running within the cluster, then you should use service. If there is only one port open for the service, that port will be used. If there are multiple ports open, port 443 will be used if it is open, otherwise it is an error.
-
-
-
url string
-
url gives the location of the webhook, in standard URL form ([scheme://]host:port/path). Exactly one of url or service must be specified. The host should not refer to a service running in the cluster; use the service field instead. The host might be resolved via external DNS in some apiservers (e.g., kube-apiserver cannot resolve in-cluster DNS as that would be a layering violation). host may also be an IP address. Please note that using localhost or 127.0.0.1 as a host is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be "https"; the URL must begin with "https://". A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
-
-
-
-
WeightedPodAffinityTerm v1 core
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
Core
-
v1
-
WeightedPodAffinityTerm
-
-
-
-
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
-
-
-
-
-
AggregationRule v1alpha1 rbac
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
rbac
-
v1alpha1
-
AggregationRule
-
-
-
-
-
-
-
AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole
ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
-
-
-
-
-
ClusterRole v1beta1 rbac
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
rbac
-
v1beta1
-
ClusterRole
-
-
-
-
-
-
-
ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.
AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ClusterRole
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/clusterroles
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind ClusterRole
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterroles/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the ClusterRole
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ClusterRole
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterroles
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ClusterRole
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind ClusterRole
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the ClusterRole
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-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
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ClusterRoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind ClusterRoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterrolebindings/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the ClusterRoleBinding
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ClusterRoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterrolebindings
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ClusterRoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind ClusterRoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the ClusterRoleBinding
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-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
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ControllerRevision
-
HTTP Request
-
GET /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ControllerRevision
-
HTTP Request
-
GET /apis/apps/v1beta2/controllerrevisions
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind ControllerRevision
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/controllerrevisions/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the ControllerRevision
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ControllerRevision
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/controllerrevisions
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ControllerRevision
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/controllerrevisions
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
DEPRECATED - This group version of ControllerRevision is deprecated by apps/v1beta2/ControllerRevision. See the release notes for more information. ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ControllerRevision
-
HTTP Request
-
GET /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ControllerRevision
-
HTTP Request
-
GET /apis/apps/v1beta1/controllerrevisions
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind ControllerRevision
-
HTTP Request
-
GET /apis/apps/v1beta1/watch/namespaces/{namespace}/controllerrevisions/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the ControllerRevision
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ControllerRevision
-
HTTP Request
-
GET /apis/apps/v1beta1/watch/namespaces/{namespace}/controllerrevisions
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ControllerRevision
-
HTTP Request
-
GET /apis/apps/v1beta1/watch/controllerrevisions
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one
-
-
-
failedJobsHistoryLimit integer
-
The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind CronJob
-
HTTP Request
-
GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind CronJob
-
HTTP Request
-
GET /apis/batch/v2alpha1/cronjobs
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind CronJob
-
HTTP Request
-
GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs/{name}
-
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
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-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
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of CronJob
-
HTTP Request
-
GET /apis/batch/v2alpha1/watch/cronjobs
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready).
-
-
-
revisionHistoryLimit integer
-
The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
An update strategy to replace existing DaemonSet pods with new pods.
-
-
-
-
DaemonSetStatus v1beta2 apps
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
collisionCount integer
-
Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
-
-
-
conditions DaemonSetCondition array patch type: merge patch merge key: type
-
Represents the latest available observations of a DaemonSet's current state.
The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds)
The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
-
-
-
numberUnavailable integer
-
The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds)
-
-
-
observedGeneration integer
-
The most recent generation observed by the daemon set controller.
-
-
-
updatedNumberScheduled integer
-
The total number of nodes that are running updated daemon pod
The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind DaemonSet
-
HTTP Request
-
GET /apis/apps/v1beta2/namespaces/{namespace}/daemonsets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind DaemonSet
-
HTTP Request
-
GET /apis/apps/v1beta2/daemonsets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind DaemonSet
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/daemonsets/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the DaemonSet
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of DaemonSet
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/daemonsets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of DaemonSet
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/daemonsets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
DEPRECATED - This group version of DaemonSet is deprecated by apps/v1beta2/DaemonSet. See the release notes for more information. DaemonSet represents the configuration of a daemon set.
The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready).
-
-
-
revisionHistoryLimit integer
-
The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
An update strategy to replace existing DaemonSet pods with new pods.
-
-
-
-
DaemonSetStatus v1beta1 extensions
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
collisionCount integer
-
Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
-
-
-
conditions DaemonSetCondition array patch type: merge patch merge key: type
-
Represents the latest available observations of a DaemonSet's current state.
The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds)
The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
-
-
-
numberUnavailable integer
-
The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds)
-
-
-
observedGeneration integer
-
The most recent generation observed by the daemon set controller.
-
-
-
updatedNumberScheduled integer
-
The total number of nodes that are running updated daemon pod
The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind DaemonSet
-
HTTP Request
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind DaemonSet
-
HTTP Request
-
GET /apis/extensions/v1beta1/daemonsets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind DaemonSet
-
HTTP Request
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the DaemonSet
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-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
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of DaemonSet
-
HTTP Request
-
GET /apis/extensions/v1beta1/watch/daemonsets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
-
-
-
paused boolean
-
Indicates that the deployment is paused.
-
-
-
progressDeadlineSeconds integer
-
The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.
-
-
-
replicas integer
-
Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
-
-
-
revisionHistoryLimit integer
-
The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels.
Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
-
-
-
collisionCount integer
-
Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
-
-
-
conditions DeploymentCondition array patch type: merge patch merge key: type
-
Represents the latest available observations of a deployment's current state.
-
-
-
observedGeneration integer
-
The generation observed by the deployment controller.
-
-
-
readyReplicas integer
-
Total number of ready pods targeted by this deployment.
-
-
-
replicas integer
-
Total number of non-terminated pods targeted by this deployment (their labels match the selector).
-
-
-
unavailableReplicas integer
-
Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
-
-
-
updatedReplicas integer
-
Total number of non-terminated pods targeted by this deployment that have the desired template spec.
Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
-
-
-
type string
-
Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
-
-
-
-
RollingUpdateDeployment v1beta2 apps
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
maxSurge
-
The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods.
-
-
-
maxUnavailable
-
The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
GET /apis/apps/v1beta2/namespaces/{namespace}/deployments
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Deployment
-
HTTP Request
-
GET /apis/apps/v1beta2/deployments
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/deployments/{name}
-
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
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Deployment
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/deployments
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Deployment
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/deployments
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
DEPRECATED - This group version of Deployment is deprecated by apps/v1beta2/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets.
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
-
-
-
paused boolean
-
Indicates that the deployment is paused.
-
-
-
progressDeadlineSeconds integer
-
The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.
-
-
-
replicas integer
-
Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
-
-
-
revisionHistoryLimit integer
-
The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 2.
Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
-
-
-
collisionCount integer
-
Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
-
-
-
conditions DeploymentCondition array patch type: merge patch merge key: type
-
Represents the latest available observations of a deployment's current state.
-
-
-
observedGeneration integer
-
The generation observed by the deployment controller.
-
-
-
readyReplicas integer
-
Total number of ready pods targeted by this deployment.
-
-
-
replicas integer
-
Total number of non-terminated pods targeted by this deployment (their labels match the selector).
-
-
-
unavailableReplicas integer
-
Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
-
-
-
updatedReplicas integer
-
Total number of non-terminated pods targeted by this deployment that have the desired template spec.
The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods.
-
-
-
maxUnavailable
-
The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
GET /apis/apps/v1beta1/namespaces/{namespace}/deployments
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Deployment
-
HTTP Request
-
GET /apis/apps/v1beta1/deployments
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
GET /apis/apps/v1beta1/watch/namespaces/{namespace}/deployments/{name}
-
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
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Deployment
-
HTTP Request
-
GET /apis/apps/v1beta1/watch/namespaces/{namespace}/deployments
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Deployment
-
HTTP Request
-
GET /apis/apps/v1beta1/watch/deployments
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
DEPRECATED - This group version of Deployment is deprecated by apps/v1beta2/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets.
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
-
-
-
paused boolean
-
Indicates that the deployment is paused and will not be processed by the deployment controller.
-
-
-
progressDeadlineSeconds integer
-
The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. This is not set by default.
-
-
-
replicas integer
-
Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
-
-
-
revisionHistoryLimit integer
-
The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified.
Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
-
-
-
collisionCount integer
-
Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
-
-
-
conditions DeploymentCondition array patch type: merge patch merge key: type
-
Represents the latest available observations of a deployment's current state.
-
-
-
observedGeneration integer
-
The generation observed by the deployment controller.
-
-
-
readyReplicas integer
-
Total number of ready pods targeted by this deployment.
-
-
-
replicas integer
-
Total number of non-terminated pods targeted by this deployment (their labels match the selector).
-
-
-
unavailableReplicas integer
-
Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
-
-
-
updatedReplicas integer
-
Total number of non-terminated pods targeted by this deployment that have the desired template spec.
The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. By default, a value of 1 is used. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods.
-
-
-
maxUnavailable
-
The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. By default, a fixed value of 1 is used. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Deployment
-
HTTP Request
-
GET /apis/extensions/v1beta1/deployments
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments/{name}
-
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
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Deployment
-
HTTP Request
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Deployment
-
HTTP Request
-
GET /apis/extensions/v1beta1/watch/deployments
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
Optional. A human-readable description of the status of this operation. Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB.
The object this Event is about. In most cases it's an Object reporting controller implements. E.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Event
-
HTTP Request
-
GET /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Event
-
HTTP Request
-
GET /apis/events.k8s.io/v1beta1/events
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind Event
-
HTTP Request
-
GET /apis/events.k8s.io/v1beta1/watch/namespaces/{namespace}/events/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Event
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Event
-
HTTP Request
-
GET /apis/events.k8s.io/v1beta1/watch/namespaces/{namespace}/events
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Event
-
HTTP Request
-
GET /apis/events.k8s.io/v1beta1/watch/events
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
Time when last Event from the series was seen before last heartbeat.
-
-
-
state string
-
Information whether this series is ongoing or finished.
-
-
-
-
-
HorizontalPodAutoscaler v2beta1 autoscaling
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
autoscaling
-
v2beta1
-
HorizontalPodAutoscaler
-
-
-
-
-
-
-
HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.
metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond.
-
-
-
minReplicas integer
-
minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod.
scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count.
lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed.
-
-
-
observedGeneration integer
-
observedGeneration is the most recent generation observed by this autoscaler.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind HorizontalPodAutoscaler
-
HTTP Request
-
GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind HorizontalPodAutoscaler
-
HTTP Request
-
GET /apis/autoscaling/v2beta1/horizontalpodautoscalers
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind HorizontalPodAutoscaler
-
HTTP Request
-
GET /apis/autoscaling/v2beta1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the HorizontalPodAutoscaler
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of HorizontalPodAutoscaler
-
HTTP Request
-
GET /apis/autoscaling/v2beta1/watch/namespaces/{namespace}/horizontalpodautoscalers
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of HorizontalPodAutoscaler
-
HTTP Request
-
GET /apis/autoscaling/v2beta1/watch/horizontalpodautoscalers
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
DEPRECATED 1.9 - This group version of IPBlock is deprecated by networking/v1/IPBlock. IPBlock describes a particular CIDR (Ex. "192.168.1.1/24") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
cidr string
-
CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24"
-
-
-
except string array
-
Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" Except values will be rejected if they are outside the CIDR range
-
-
-
-
-
Initializer v1alpha1 admissionregistration
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
admissionregistration
-
v1alpha1
-
Initializer
-
-
-
-
-
-
-
Initializer describes the name and the failure policy of an initializer, and what resources it applies to.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
name string
-
Name is the identifier of the initializer. It will be added to the object that needs to be initialized. Name should be fully qualified, e.g., alwayspullimages.kubernetes.io, where "alwayspullimages" is the name of the webhook, and kubernetes.io is the name of the organization. Required
Rules describes what resources/subresources the initializer cares about. The initializer cares about an operation if it matches any Rule. Rule.Resources must not include subresources.
-
-
-
-
-
JobTemplateSpec v2alpha1 batch
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
batch
-
v2alpha1
-
JobTemplateSpec
-
-
-
-
-
-
-
JobTemplateSpec describes the data a Job should have when created from a template
LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.
Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted.
DEPRECATED 1.9 - This group version of NetworkPolicy is deprecated by networking/v1/NetworkPolicy. NetworkPolicy describes what network traffic is allowed for a set of Pods
List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8
List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default).
Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.
-
-
-
policyTypes string array
-
List of rule types that the NetworkPolicy relates to. Valid options are Ingress, Egress, or Ingress,Egress. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind NetworkPolicy
-
HTTP Request
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind NetworkPolicy
-
HTTP Request
-
GET /apis/extensions/v1beta1/networkpolicies
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind NetworkPolicy
-
HTTP Request
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the NetworkPolicy
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of NetworkPolicy
-
HTTP Request
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of NetworkPolicy
-
HTTP Request
-
GET /apis/extensions/v1beta1/watch/networkpolicies
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
DEPRECATED 1.9 - This group version of NetworkPolicyEgressRule is deprecated by networking/v1/NetworkPolicyEgressRule. NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8
List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.
-
-
-
-
-
NetworkPolicyIngressRule v1beta1 extensions
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
extensions
-
v1beta1
-
NetworkPolicyIngressRule
-
-
-
-
-
-
-
DEPRECATED 1.9 - This group version of NetworkPolicyIngressRule is deprecated by networking/v1/NetworkPolicyIngressRule. This NetworkPolicyIngressRule matches traffic if and only if the traffic matches both ports AND from.
List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least on item, this rule allows traffic only if the traffic matches at least one item in the from list.
List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
-
-
-
-
-
NetworkPolicyPeer v1beta1 extensions
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
extensions
-
v1beta1
-
NetworkPolicyPeer
-
-
-
-
-
-
-
DEPRECATED 1.9 - This group version of NetworkPolicyPeer is deprecated by networking/v1/NetworkPolicyPeer.
Selects Namespaces using cluster scoped-labels. This matches all pods in all namespaces selected by this label selector. This field follows standard label selector semantics. If present but empty, this selector selects all namespaces.
This is a label selector which selects Pods in this namespace. This field follows standard label selector semantics. If present but empty, this selector selects all pods in this namespace.
-
-
-
-
-
NetworkPolicyPort v1beta1 extensions
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
extensions
-
v1beta1
-
NetworkPolicyPort
-
-
-
-
-
-
-
DEPRECATED 1.9 - This group version of NetworkPolicyPort is deprecated by networking/v1/NetworkPolicyPort.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
port
-
If specified, the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.
-
-
-
protocol string
-
Optional. The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.
-
-
-
-
-
NonResourceAttributes v1beta1 authorization
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
authorization
-
v1beta1
-
NonResourceAttributes
-
-
-
-
-
-
-
NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
path string
-
Path is the URL path of the request
-
-
-
verb string
-
Verb is the standard HTTP verb
-
-
-
-
-
NonResourceRule v1beta1 authorization
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
authorization
-
v1beta1
-
NonResourceRule
-
-
-
-
-
-
-
NonResourceRule holds information that describes a rule for the non-resource
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
nonResourceURLs string array
-
NonResourceURLs is a set of partial urls that a user should have access to. s are allowed, but only as the full, final step in the path. "" means all.
-
-
-
verbs string array
-
Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all.
-
-
-
-
-
PolicyRule v1beta1 rbac
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
rbac
-
v1beta1
-
PolicyRule
-
-
-
-
-
-
-
PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
apiGroups string array
-
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
-
-
-
nonResourceURLs string array
-
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
-
-
-
resourceNames string array
-
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
-
-
-
resources string array
-
Resources is a list of resources this rule applies to. '' represents all resources in the specified apiGroups. '/foo' represents the subresource 'foo' for all resources in the specified apiGroups.
-
-
-
verbs string array
-
Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
-
-
-
-
-
PolicyRule v1alpha1 rbac
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
rbac
-
v1alpha1
-
PolicyRule
-
-
-
-
-
-
-
PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
apiGroups string array
-
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
-
-
-
nonResourceURLs string array
-
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path This name is intentionally different than the internal type so that the DefaultConvert works nicely and because the ordering may be different. Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
-
-
-
resourceNames string array
-
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
-
-
-
resources string array
-
Resources is a list of resources this rule applies to. ResourceAll represents all resources.
-
-
-
verbs string array
-
Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
-
-
-
-
-
ReplicaSet v1beta2 apps
-
-
ReplicaSet Config to run 3 nginx instances.
-
-
-apiVersion:extensions/v1beta1
-kind:ReplicaSet
-metadata:
- # Unique key of the ReplicaSet instance
- name:replicaset-example
-spec:
- # 3 Pods should exist at all times.
- replicas:3
- template:
- metadata:
- labels:
- app:nginx
- spec:
- containers:
- # Run the nginx image
- - name:nginx
- image:nginx:1.10
-
-
-
ReplicaSet Config to run 3 nginx instances.
-
-
-apiVersion:extensions/v1beta1
-kind:ReplicaSet
-metadata:
- # Unique key of the ReplicaSet instance
- name:replicaset-example
-spec:
- # 3 Pods should exist at all times.
- replicas:3
- template:
- metadata:
- labels:
- app:nginx
- spec:
- containers:
- # Run the nginx image
- - name:nginx
- image:nginx:1.10
-
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
apps
-
v1beta2
-
ReplicaSet
-
-
-
-
-
-
-
-
-
-
ReplicaSet ensures that a specified number of pod replicas are running at any given time.
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ReplicaSet
-
HTTP Request
-
GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ReplicaSet
-
HTTP Request
-
GET /apis/apps/v1beta2/replicasets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind ReplicaSet
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/replicasets/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the ReplicaSet
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ReplicaSet
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/replicasets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ReplicaSet
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/replicasets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
DEPRECATED - This group version of ReplicaSet is deprecated by apps/v1beta2/ReplicaSet. See the release notes for more information. ReplicaSet ensures that a specified number of pod replicas are running at any given time.
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ReplicaSet
-
HTTP Request
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ReplicaSet
-
HTTP Request
-
GET /apis/extensions/v1beta1/replicasets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind ReplicaSet
-
HTTP Request
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the ReplicaSet
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ReplicaSet
-
HTTP Request
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ReplicaSet
-
HTTP Request
-
GET /apis/extensions/v1beta1/watch/replicasets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
The last time the condition transitioned from one status to another.
-
-
-
message string
-
A human readable message indicating details about the transition.
-
-
-
reason string
-
The reason for the condition's last transition.
-
-
-
status string
-
Status of the condition, one of True, False, Unknown.
-
-
-
type string
-
Type of replica set condition.
-
-
-
-
-
ResourceAttributes v1beta1 authorization
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
authorization
-
v1beta1
-
ResourceAttributes
-
-
-
-
-
-
-
ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
group string
-
Group is the API Group of the Resource. "*" means all.
-
-
-
name string
-
Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.
-
-
-
namespace string
-
Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview
-
-
-
resource string
-
Resource is one of the existing resource types. "*" means all.
-
-
-
subresource string
-
Subresource is one of the existing resource types. "" means none.
-
-
-
verb string
-
Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all.
-
-
-
version string
-
Version is the API Version of the Resource. "*" means all.
-
-
-
-
-
ResourceRule v1beta1 authorization
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
authorization
-
v1beta1
-
ResourceRule
-
-
-
-
-
-
-
ResourceRule is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
apiGroups string array
-
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all.
-
-
-
resourceNames string array
-
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all.
-
-
-
resources string array
-
Resources is a list of resources this rule applies to. "" means all in the specified apiGroups. "/foo" represents the subresource 'foo' for all resources in the specified apiGroups.
-
-
-
verbs string array
-
Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all.
-
-
-
-
-
Role v1beta1 rbac
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
rbac
-
v1beta1
-
Role
-
-
-
-
-
-
-
Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Role
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Role
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/roles
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind Role
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Role
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Role
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Role
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/roles
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Role
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind Role
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/roles
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind Role
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Role
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Role
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of Role
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/roles
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.
RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind RoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind RoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/rolebindings
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind RoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the RoleBinding
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of RoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of RoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/rolebindings
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.
RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind RoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind RoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/rolebindings
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind RoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the RoleBinding
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of RoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of RoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/rolebindings
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
-
-
-
-
-
Scale v1beta1 apps
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
apps
-
v1beta1
-
Scale
-
-
-
-
-
-
-
Scale represents a scaling request for a resource.
label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
-
-
-
-
-
SelfSubjectAccessReview v1beta1 authorization
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
authorization
-
v1beta1
-
SelfSubjectAccessReview
-
-
-
-
-
-
-
SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action
SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.
Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.
-
-
-
-
StatefulSetSpec v1beta2 apps
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
podManagementPolicy string
-
podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
-
-
-
replicas integer
-
replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
-
-
-
revisionHistoryLimit integer
-
revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
-
-
-
-
StatefulSetStatus v1beta2 apps
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
collisionCount integer
-
collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
Represents the latest available observations of a statefulset's current state.
-
-
-
currentReplicas integer
-
currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
-
-
-
currentRevision string
-
currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
-
-
-
observedGeneration integer
-
observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server.
-
-
-
readyReplicas integer
-
readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
-
-
-
replicas integer
-
replicas is the number of Pods created by the StatefulSet controller.
-
-
-
updateRevision string
-
updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
-
-
-
updatedReplicas integer
-
updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind StatefulSet
-
HTTP Request
-
GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind StatefulSet
-
HTTP Request
-
GET /apis/apps/v1beta2/statefulsets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind StatefulSet
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/statefulsets/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the StatefulSet
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of StatefulSet
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/statefulsets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of StatefulSet
-
HTTP Request
-
GET /apis/apps/v1beta2/watch/statefulsets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
DEPRECATED - This group version of StatefulSet is deprecated by apps/v1beta2/StatefulSet. See the release notes for more information. StatefulSet represents a set of pods with consistent identities. Identities are defined as:
-
-
Network: A single stable DNS and hostname.
-
Storage: As many VolumeClaims as requested.
-The StatefulSet guarantees that a given network identity will always map to the same storage identity.
Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.
-
-
-
-
StatefulSetSpec v1beta1 apps
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
podManagementPolicy string
-
podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
-
-
-
replicas integer
-
replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
-
-
-
revisionHistoryLimit integer
-
revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
-
-
-
-
StatefulSetStatus v1beta1 apps
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
collisionCount integer
-
collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
Represents the latest available observations of a statefulset's current state.
-
-
-
currentReplicas integer
-
currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
-
-
-
currentRevision string
-
currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
-
-
-
observedGeneration integer
-
observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server.
-
-
-
readyReplicas integer
-
readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
-
-
-
replicas integer
-
replicas is the number of Pods created by the StatefulSet controller.
-
-
-
updateRevision string
-
updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
-
-
-
updatedReplicas integer
-
updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind StatefulSet
-
HTTP Request
-
GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind StatefulSet
-
HTTP Request
-
GET /apis/apps/v1beta1/statefulsets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind StatefulSet
-
HTTP Request
-
GET /apis/apps/v1beta1/watch/namespaces/{namespace}/statefulsets/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the StatefulSet
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of StatefulSet
-
HTTP Request
-
GET /apis/apps/v1beta1/watch/namespaces/{namespace}/statefulsets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of StatefulSet
-
HTTP Request
-
GET /apis/apps/v1beta1/watch/statefulsets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
Last time the condition transitioned from one status to another.
-
-
-
message string
-
A human readable message indicating details about the transition.
-
-
-
reason string
-
The reason for the condition's last transition.
-
-
-
status string
-
Status of the condition, one of True, False, Unknown.
-
-
-
type string
-
Type of statefulset condition.
-
-
-
-
-
StatefulSetUpdateStrategy v1beta2 apps
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
apps
-
v1beta2
-
StatefulSetUpdateStrategy
-
-
-
-
-
-
-
StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.
RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
-
-
-
type string
-
Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.
-
-
-
-
-
StatefulSetUpdateStrategy v1beta1 apps
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
apps
-
v1beta1
-
StatefulSetUpdateStrategy
-
-
-
-
-
-
-
StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.
Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
-
-
-
parameters object
-
Parameters holds the parameters for the provisioner that should create volumes of this storage class.
-
-
-
provisioner string
-
Provisioner indicates the type of the provisioner.
-
-
-
reclaimPolicy string
-
Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.
-
-
-
volumeBindingMode string
-
VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is alpha-level and is only honored by servers that enable the VolumeScheduling feature.
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind StorageClass
-
HTTP Request
-
GET /apis/storage.k8s.io/v1beta1/storageclasses
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind StorageClass
-
HTTP Request
-
GET /apis/storage.k8s.io/v1beta1/watch/storageclasses/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the StorageClass
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of StorageClass
-
HTTP Request
-
GET /apis/storage.k8s.io/v1beta1/watch/storageclasses
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
continue
-
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
-
-
-
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
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.
Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
apiGroup string
-
APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
-
-
-
kind string
-
Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
-
-
-
name string
-
Name of the object being referenced.
-
-
-
namespace string
-
Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
-
-
-
-
-
Subject v1alpha1 rbac
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
rbac
-
v1alpha1
-
Subject
-
-
-
-
-
-
-
Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
apiVersion string
-
APIVersion holds the API group and version of the referenced subject. Defaults to "v1" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io/v1alpha1" for User and Group subjects.
-
-
-
kind string
-
Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
-
-
-
name string
-
Name of the object being referenced.
-
-
-
namespace string
-
Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
-
-
-
-
-
SubjectAccessReview v1beta1 authorization
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
authorization
-
v1beta1
-
SubjectAccessReview
-
-
-
-
-
-
-
SubjectAccessReview checks whether or not a user or group can perform an action.
ResourceAuthorizationAttributes describes information for a resource access request
-
-
-
uid string
-
UID information about the requesting user.
-
-
-
user string
-
User is the user you're testing for. If you specify "User" but not "Group", then is it interpreted as "What if User were not a member of any groups
-
-
-
-
SubjectAccessReviewStatus v1beta1 authorization
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
allowed boolean
-
Allowed is required. True if the action would be allowed, false otherwise.
-
-
-
denied boolean
-
Denied is optional. True if the action would be denied, otherwise false. If both allowed is false and denied is false, then the authorizer has no opinion on whether to authorize the action. Denied may not be true if Allowed is true.
-
-
-
evaluationError string
-
EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request.
-
-
-
reason string
-
Reason is optional. It indicates why a request was allowed or denied.
-
-
-
-
Write Operations
-
See supported operations below...
-
Create
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
create a SubjectAccessReview
-
HTTP Request
-
POST /apis/authorization.k8s.io/v1beta1/subjectaccessreviews
SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it's safe to assume the subject has that permission, even if that list is incomplete.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
evaluationError string
-
EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete.
-
-
-
incomplete boolean
-
Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation.
NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
-
-
-
-
-
TokenReview v1beta1 authentication
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
authentication
-
v1beta1
-
TokenReview
-
-
-
-
-
-
-
TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.
UserInfo holds the information about the user needed to implement the user.Info interface.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
extra object
-
Any additional information provided by the authenticator.
-
-
-
groups string array
-
The names of groups this user is a part of.
-
-
-
uid string
-
A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs.
-
-
-
username string
-
The name that uniquely identifies this user among all active users.