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: https://git.k8s.io/community/contributors/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: https://git.k8s.io/community/contributors/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.NamespaceList
NamespaceList is a list of Namespaces.
| 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: https://git.k8s.io/community/contributors/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: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
false |
||
items |
Items is the list of Namespace objects in the list. More info: /docs/concepts/overview/working-with-objects/namespaces/ |
true |
v1.Namespace array |
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: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
false |
string |
|
continue |
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. |
false |
string |
v1.Namespace
Namespace provides a scope for Names. Use of multiple namespaces is optional.
| 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: https://git.k8s.io/community/contributors/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: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
false |
||
spec |
Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
false |
||
status |
Status describes the current status of a Namespace. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
false |
v1.Initializers
Initializers tracks the progress of initialization.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
pending |
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. |
true |
v1.Initializer array |
|
result |
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. |
false |
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: https://git.k8s.io/community/contributors/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: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
false |
||
status |
Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/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.ServiceStatus
ServiceStatus represents the current status of a service.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
loadBalancer |
LoadBalancer contains the current status of the load-balancer, if one is present. |
false |
v1.Secret
Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.
| 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: https://git.k8s.io/community/contributors/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: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
false |
||
data |
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 |
false |
object |
|
stringData |
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. |
false |
object |
|
type |
Used to facilitate programmatic handling of secret data. |
false |
string |
v1.WatchEvent
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
true |
string |
||
object |
true |
string |
v1.Event
Event is a report of an event somewhere in the cluster.
| 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: https://git.k8s.io/community/contributors/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: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
true |
||
involvedObject |
The object that this event is about. |
true |
||
reason |
This should be a short, machine understandable string that gives the reason for the transition into the object’s current status. |
false |
string |
|
message |
A human-readable description of the status of this operation. |
false |
string |
|
source |
The component reporting this event. Should be a short machine understandable string. |
false |
||
firstTimestamp |
The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) |
false |
string |
|
lastTimestamp |
The time at which the most recent occurrence of this event was recorded. |
false |
string |
|
count |
The number of times this event has occurred. |
false |
integer (int32) |
|
type |
Type of this event (Normal, Warning), new types could be added in the future |
false |
string |
|
eventTime |
Time when this Event was first observed. |
false |
string |
|
series |
Data about the Event series this event represents or nil if it’s a singleton Event. |
false |
||
action |
What action was taken/failed regarding to the Regarding object. |
false |
string |
|
related |
Optional secondary object for more complex actions. |
false |
||
reportingComponent |
Name of the controller that emitted this Event, e.g. |
true |
string |
|
reportingInstance |
ID of the controller instance, e.g. |
true |
string |
v1.LoadBalancerIngress
LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
ip |
IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers) |
false |
string |
|
hostname |
Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers) |
false |
string |
v1.DeletionPropagation
v1.NamespaceStatus
NamespaceStatus is information about the current status of a Namespace.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
phase |
Phase is the current lifecycle phase of the namespace. More info: /docs/tasks/administer-cluster/namespaces/ |
false |
string |
v1.ServiceList
ServiceList holds a list of services.
| 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: https://git.k8s.io/community/contributors/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: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
false |
||
items |
List of services |
true |
v1.Service array |
v1.NamespaceSpec
NamespaceSpec describes the attributes on a Namespace.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
finalizers |
Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: /docs/tasks/administer-cluster/namespaces/ |
false |
v1.FinalizerName array |
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.
| 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: https://git.k8s.io/community/contributors/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: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
false |
||
spec |
Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
false |
||
status |
Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
false |
v1.Patch
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
v1.ConfigMapList
ConfigMapList is a resource containing a list of ConfigMap 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: https://git.k8s.io/community/contributors/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: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
false |
string |
|
metadata |
More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
false |
||
items |
Items is the list of ConfigMaps. |
true |
v1.ConfigMap 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: https://git.k8s.io/community/contributors/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: https://git.k8s.io/community/contributors/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 |
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. |
false |
boolean |
false |
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. |
false |
v1.EventSeries
EventSeries contain information on series of events, i.e. thing that was/is happening continously for some time.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
count |
Number of occurrences in this series up to the last heartbeat time |
false |
integer (int32) |
|
lastObservedTime |
Time of the last occurence observed |
false |
string |
|
state |
State of this Series: Ongoing or Finished |
false |
string |
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: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
false |
string |
|
uid |
UID of the resource. (when there is a single resource which can be described). More info: /docs/user-guide/identifiers#uids |
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. 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. |
false |
integer (int32) |
v1.ConfigMap
ConfigMap holds configuration data for pods to consume.
| 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: https://git.k8s.io/community/contributors/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: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
false |
||
data |
Data contains the configuration data. Each key must consist of alphanumeric characters, -, _ or .. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process. |
false |
object |
|
binaryData |
BinaryData contains the binary data. Each key must consist of alphanumeric characters, -, _ or .. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet. |
false |
object |
v1.Initializer
Initializer is information about an initializer that has not yet completed.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
name of the process that is responsible for initializing this object. |
true |
string |
v1.ObjectReference
ObjectReference contains enough information to let you inspect or modify the referred object.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
false |
string |
|
namespace |
Namespace of the referent. More info: /docs/concepts/overview/working-with-objects/namespaces/ |
false |
string |
|
name |
Name of the referent. More info: /docs/concepts/overview/working-with-objects/names/#names |
false |
string |
|
uid |
UID of the referent. More info: /docs/concepts/overview/working-with-objects/names/#uids |
false |
string |
|
apiVersion |
API version of the referent. |
false |
string |
|
resourceVersion |
Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
false |
string |
|
fieldPath |
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. |
false |
string |
v1.LoadBalancerStatus
LoadBalancerStatus represents the status of a load-balancer.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
ingress |
Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points. |
false |
v1.LoadBalancerIngress array |
v1.SecretList
SecretList is a list of Secret.
| 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: https://git.k8s.io/community/contributors/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: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
false |
||
items |
Items is a list of secret objects. More info: /docs/concepts/configuration/secret |
true |
v1.Secret array |
v1.FinalizerName
v1.ServicePort
ServicePort contains information on service’s port.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
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. |
false |
string |
|
protocol |
The IP protocol for this port. Supports "TCP" and "UDP". Default is TCP. |
false |
string |
|
port |
The port that will be exposed by this service. |
true |
integer (int32) |
|
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: /docs/concepts/services-networking/service/#defining-a-service |
false |
string |
|
nodePort |
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: /docs/concepts/services-networking/service/#type-nodeport |
false |
integer (int32) |
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: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
true |
string |
|
name |
Name of the referent. More info: /docs/user-guide/identifiers#names |
true |
string |
|
uid |
UID of the referent. More info: /docs/user-guide/identifiers#uids |
true |
string |
|
controller |
If true, this reference points to the managing controller. |
false |
boolean |
false |
blockOwnerDeletion |
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. |
false |
boolean |
false |
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: /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 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. |
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: /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: /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 |
|
initializers |
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. |
false |
||
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.EventList
EventList is a list of events.
| 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: https://git.k8s.io/community/contributors/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: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
false |
||
items |
List of events |
true |
v1.Event array |
v1.ClientIPConfig
ClientIPConfig represents the configurations of Client IP based session affinity.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
timeoutSeconds |
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). |
false |
integer (int32) |
v1.APIResource
APIResource specifies the name of a resource and whether it is namespaced.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
name is the plural name of the resource. |
true |
string |
|
singularName |
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. |
true |
string |
|
namespaced |
namespaced indicates if a resource is namespaced or not. |
true |
boolean |
false |
group |
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". |
false |
string |
|
version |
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)". |
false |
string |
|
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 |
|
shortNames |
shortNames is a list of suggested short names of the resource. |
false |
string array |
|
categories |
categories is a list of the grouped resources this resource belongs to (e.g. all) |
false |
string array |
v1.ServiceSpec
ServiceSpec describes the attributes that a user creates on a service.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
ports |
The list of ports that are exposed by this service. More info: /docs/concepts/services-networking/service/#virtual-ips-and-service-proxies |
false |
v1.ServicePort array |
|
selector |
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: /docs/concepts/services-networking/service/ |
false |
object |
|
clusterIP |
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: /docs/concepts/services-networking/service/#virtual-ips-and-service-proxies |
false |
string |
|
type |
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: /docs/concepts/services-networking/service/#publishing-services |
false |
string |
|
externalIPs |
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. |
false |
string array |
|
sessionAffinity |
Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: /docs/concepts/services-networking/service/#virtual-ips-and-service-proxies |
false |
string |
|
loadBalancerIP |
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. |
false |
string |
|
loadBalancerSourceRanges |
If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: /docs/tasks/access-application-cluster/configure-cloud-provider-firewall/ |
false |
string array |
|
externalName |
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. |
false |
string |
|
externalTrafficPolicy |
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. |
false |
string |
|
healthCheckNodePort |
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. |
false |
integer (int32) |
|
publishNotReadyAddresses |
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. |
false |
boolean |
false |
sessionAffinityConfig |
sessionAffinityConfig contains the configurations of session affinity. |
false |
v1.EventSource
EventSource contains information for an event.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
component |
Component from which the event is generated. |
false |
string |
|
host |
Node name on which the event is generated. |
false |
string |
types.UID
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 |
v1.SessionAffinityConfig
SessionAffinityConfig represents the configurations of session affinity.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
clientIP |
clientIP contains the configurations of Client IP based session affinity. |
false |
any
Represents an untyped JSON map - see the description of the field for more info about the structure of this object.