Top Level API Objects
+-
+
- + + +
- + + +
- + + +
- + + +
- + + +
- + + +
- + + +
- + + +
Definitions
+v1.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.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
groupVersion |
+groupVersion is the group and version this APIResourceList is for. |
+true |
+string |
++ |
resources |
+resources contains the name of the resources and if they are namespaced. |
+true |
+v1.APIResource array |
++ |
v1.Patch
+Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
+v1beta1.ClusterRole
+ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+Standard object’s metadata. |
+false |
++ | + |
rules |
+Rules holds all the PolicyRules for this ClusterRole |
+true |
+v1beta1.PolicyRule array |
++ |
v1.DeleteOptions
+DeleteOptions may be provided when deleting an API object
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
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. |
+false |
+integer (int64) |
++ |
preconditions |
+Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. |
+false |
++ | + |
orphanDependents |
+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 |
+
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}.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
selfLink |
+SelfLink is a URL representing this object. Populated by the system. Read-only. |
+false |
+string |
++ |
resourceVersion |
+String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency |
+false |
+string |
++ |
v1beta1.ClusterRoleBinding
+ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+Standard object’s metadata. |
+false |
++ | + |
subjects |
+Subjects holds references to the objects the role applies to. |
+true |
+v1beta1.Subject array |
++ |
roleRef |
+RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. |
+true |
++ | + |
v1beta1.ClusterRoleBindingList
+ClusterRoleBindingList is a collection of ClusterRoleBindings
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+Standard object’s metadata. |
+false |
++ | + |
items |
+Items is a list of ClusterRoleBindings |
+true |
++ | + |
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.
+| 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. |
+false |
+string |
++ |
kind |
+The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
causes |
+The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. |
+false |
+v1.StatusCause array |
++ |
retryAfterSeconds |
+If specified, the time in seconds before the operation should be retried. |
+false |
+integer (int32) |
++ |
v1beta1.ClusterRoleList
+ClusterRoleList is a collection of ClusterRoles
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+Standard object’s metadata. |
+false |
++ | + |
items |
+Items is a list of ClusterRoles |
+true |
+v1beta1.ClusterRole array |
++ |
v1.Preconditions
+Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
uid |
+Specifies the target UID. |
+false |
++ | + |
v1.Status
+Status is a return value for calls that don’t return other objects.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
++ | + |
status |
+Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
+false |
+string |
++ |
message |
+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. |
+false |
++ | + |
code |
+Suggested HTTP return code for this status, 0 if not set. |
+false |
+integer (int32) |
++ |
v1.WatchEvent
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
type |
++ | true |
+string |
++ |
object |
++ | true |
+string |
++ |
v1beta1.RoleList
+RoleList is a collection of Roles
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+Standard object’s metadata. |
+false |
++ | + |
items |
+Items is a list of Roles |
+true |
+v1beta1.Role 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. |
+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. |
+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. |
+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. |
+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. |
+false |
+string |
++ |
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. |
+false |
+string |
++ |
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. |
+false |
+v1.OwnerReference array |
++ |
finalizers |
+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.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
apiVersion |
+API version of the referent. |
+true |
+string |
++ |
kind |
+Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+true |
+string |
++ |
name |
+Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
+true |
+string |
++ |
uid |
+UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
+true |
+string |
++ |
controller |
+If true, this reference points to the managing controller. |
+false |
+boolean |
+false |
+
v1beta1.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.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+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. |
+true |
+string |
++ |
apiVersion |
+APIVersion holds the API group and version of the referenced object. |
+false |
+string |
++ |
name |
+Name of the object being referenced. |
+true |
+string |
++ |
namespace |
+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. |
+false |
+string |
++ |
v1.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 |
++ |
verbs |
+verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy) |
+true |
+string array |
++ |
types.UID
+ +v1beta1.Role
+Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+Standard object’s metadata. |
+false |
++ | + |
rules |
+Rules holds all the PolicyRules for this Role |
+true |
+v1beta1.PolicyRule array |
++ |
v1.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. |
+false |
+string |
++ |
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.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
verbs |
+Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds. |
+true |
+string array |
++ |
apiGroups |
+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. |
+false |
+string array |
++ |
resources |
+Resources is a list of resources this rule applies to. ResourceAll represents all resources. |
+false |
+string array |
++ |
resourceNames |
+ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. |
+false |
+string array |
++ |
nonResourceURLs |
+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. |
+false |
+string array |
++ |
v1beta1.RoleRef
+RoleRef contains information that points to the role being used
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
apiGroup |
+APIGroup is the group for the resource being referenced |
+true |
+string |
++ |
kind |
+Kind is the type of resource being referenced |
+true |
+string |
++ |
name |
+Name is the name of resource being referenced |
+true |
+string |
++ |
v1beta1.RoleBinding
+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.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+Standard object’s metadata. |
+false |
++ | + |
subjects |
+Subjects holds references to the objects the role applies to. |
+true |
+v1beta1.Subject array |
++ |
roleRef |
+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. |
+true |
++ | + |
v1beta1.RoleBindingList
+RoleBindingList is a collection of RoleBindings
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+Standard object’s metadata. |
+false |
++ | + |
items |
+Items is a list of RoleBindings |
+true |
+v1beta1.RoleBinding array |
++ |
any
+Represents an untyped JSON map - see the description of the field for more info about the structure of this object.
+