New API Reference presentation on /content/en/docs/reference/kubernetes-api
This commit is contained in:
Philippe Martin
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Common Definitions"
|
||||
weight: 9
|
||||
---
|
||||
@@ -0,0 +1,63 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
kind: "DeleteOptions"
|
||||
content_type: "api_reference"
|
||||
description: "DeleteOptions may be provided when deleting an API object."
|
||||
title: "DeleteOptions"
|
||||
weight: 1
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/apimachinery/pkg/apis/meta/v1"`
|
||||
|
||||
|
||||
DeleteOptions may be provided when deleting an API object.
|
||||
|
||||
<hr>
|
||||
|
||||
- **apiVersion** (string)
|
||||
|
||||
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
|
||||
|
||||
- **dryRun** ([]string)
|
||||
|
||||
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
|
||||
|
||||
- **gracePeriodSeconds** (int64)
|
||||
|
||||
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
|
||||
|
||||
- **kind** (string)
|
||||
|
||||
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
- **orphanDependents** (boolean)
|
||||
|
||||
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.
|
||||
|
||||
- **preconditions** (Preconditions)
|
||||
|
||||
Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
|
||||
|
||||
<a name="Preconditions"></a>
|
||||
*Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.*
|
||||
|
||||
- **preconditions.resourceVersion** (string)
|
||||
|
||||
Specifies the target ResourceVersion
|
||||
|
||||
- **preconditions.uid** (string)
|
||||
|
||||
Specifies the target UID.
|
||||
|
||||
- **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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
+40
@@ -0,0 +1,40 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/api/core/v1"
|
||||
kind: "DownwardAPIVolumeFile"
|
||||
content_type: "api_reference"
|
||||
description: "DownwardAPIVolumeFile represents information to create the file containing the pod field."
|
||||
title: "DownwardAPIVolumeFile"
|
||||
weight: 2
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/api/core/v1"`
|
||||
|
||||
|
||||
DownwardAPIVolumeFile represents information to create the file containing the pod field
|
||||
|
||||
<hr>
|
||||
|
||||
- **path** (string), required
|
||||
|
||||
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 '..'
|
||||
|
||||
- **fieldRef** (<a href="{{< ref "../common-definitions/object-field-selector#ObjectFieldSelector" >}}">ObjectFieldSelector</a>)
|
||||
|
||||
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
|
||||
|
||||
- **mode** (int32)
|
||||
|
||||
Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. 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.
|
||||
|
||||
- **resourceFieldRef** (<a href="{{< ref "../common-definitions/resource-field-selector#ResourceFieldSelector" >}}">ResourceFieldSelector</a>)
|
||||
|
||||
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/api/core/v1"
|
||||
kind: "ExecAction"
|
||||
content_type: "api_reference"
|
||||
description: "ExecAction describes a \"run in container\" action."
|
||||
title: "ExecAction"
|
||||
weight: 3
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/api/core/v1"`
|
||||
|
||||
|
||||
ExecAction describes a "run in container" action.
|
||||
|
||||
<hr>
|
||||
|
||||
- **command** ([]string)
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/api/core/v1"
|
||||
kind: "HTTPGetAction"
|
||||
content_type: "api_reference"
|
||||
description: "HTTPGetAction describes an action based on HTTP Get requests."
|
||||
title: "HTTPGetAction"
|
||||
weight: 4
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/api/core/v1"`
|
||||
|
||||
|
||||
HTTPGetAction describes an action based on HTTP Get requests.
|
||||
|
||||
<hr>
|
||||
|
||||
- **port** (IntOrString), required
|
||||
|
||||
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.
|
||||
|
||||
<a name="IntOrString"></a>
|
||||
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
|
||||
|
||||
- **host** (string)
|
||||
|
||||
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
|
||||
|
||||
- **httpHeaders** ([]HTTPHeader)
|
||||
|
||||
Custom headers to set in the request. HTTP allows repeated headers.
|
||||
|
||||
<a name="HTTPHeader"></a>
|
||||
*HTTPHeader describes a custom header to be used in HTTP probes*
|
||||
|
||||
- **httpHeaders.name** (string), required
|
||||
|
||||
The header field name
|
||||
|
||||
- **httpHeaders.value** (string), required
|
||||
|
||||
The header field value
|
||||
|
||||
- **path** (string)
|
||||
|
||||
Path to access on the HTTP server.
|
||||
|
||||
- **scheme** (string)
|
||||
|
||||
Scheme to use for connecting to the host. Defaults to HTTP.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,226 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
|
||||
kind: "JSONSchemaProps"
|
||||
content_type: "api_reference"
|
||||
description: "JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema."
|
||||
title: "JSONSchemaProps"
|
||||
weight: 5
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"`
|
||||
|
||||
|
||||
JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).
|
||||
|
||||
<hr>
|
||||
|
||||
- **$ref** (string)
|
||||
|
||||
|
||||
- **$schema** (string)
|
||||
|
||||
|
||||
- **additionalItems** (JSONSchemaPropsOrBool)
|
||||
|
||||
|
||||
<a name="JSONSchemaPropsOrBool"></a>
|
||||
*JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.*
|
||||
|
||||
- **additionalProperties** (JSONSchemaPropsOrBool)
|
||||
|
||||
|
||||
<a name="JSONSchemaPropsOrBool"></a>
|
||||
*JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.*
|
||||
|
||||
- **allOf** ([]<a href="{{< ref "../common-definitions/json-schema-props#JSONSchemaProps" >}}">JSONSchemaProps</a>)
|
||||
|
||||
|
||||
- **anyOf** ([]<a href="{{< ref "../common-definitions/json-schema-props#JSONSchemaProps" >}}">JSONSchemaProps</a>)
|
||||
|
||||
|
||||
- **default** (JSON)
|
||||
|
||||
default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false.
|
||||
|
||||
<a name="JSON"></a>
|
||||
*JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.*
|
||||
|
||||
- **definitions** (map[string]<a href="{{< ref "../common-definitions/json-schema-props#JSONSchemaProps" >}}">JSONSchemaProps</a>)
|
||||
|
||||
|
||||
- **dependencies** (map[string]JSONSchemaPropsOrStringArray)
|
||||
|
||||
|
||||
<a name="JSONSchemaPropsOrStringArray"></a>
|
||||
*JSONSchemaPropsOrStringArray represents a JSONSchemaProps or a string array.*
|
||||
|
||||
- **description** (string)
|
||||
|
||||
|
||||
- **enum** ([]JSON)
|
||||
|
||||
|
||||
<a name="JSON"></a>
|
||||
*JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.*
|
||||
|
||||
- **example** (JSON)
|
||||
|
||||
|
||||
<a name="JSON"></a>
|
||||
*JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.*
|
||||
|
||||
- **exclusiveMaximum** (boolean)
|
||||
|
||||
|
||||
- **exclusiveMinimum** (boolean)
|
||||
|
||||
|
||||
- **externalDocs** (ExternalDocumentation)
|
||||
|
||||
|
||||
<a name="ExternalDocumentation"></a>
|
||||
*ExternalDocumentation allows referencing an external resource for extended documentation.*
|
||||
|
||||
- **externalDocs.description** (string)
|
||||
|
||||
|
||||
- **externalDocs.url** (string)
|
||||
|
||||
|
||||
- **format** (string)
|
||||
|
||||
format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
|
||||
|
||||
- bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
|
||||
|
||||
- **id** (string)
|
||||
|
||||
|
||||
- **items** (JSONSchemaPropsOrArray)
|
||||
|
||||
|
||||
<a name="JSONSchemaPropsOrArray"></a>
|
||||
*JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes.*
|
||||
|
||||
- **maxItems** (int64)
|
||||
|
||||
|
||||
- **maxLength** (int64)
|
||||
|
||||
|
||||
- **maxProperties** (int64)
|
||||
|
||||
|
||||
- **maximum** (double)
|
||||
|
||||
|
||||
- **minItems** (int64)
|
||||
|
||||
|
||||
- **minLength** (int64)
|
||||
|
||||
|
||||
- **minProperties** (int64)
|
||||
|
||||
|
||||
- **minimum** (double)
|
||||
|
||||
|
||||
- **multipleOf** (double)
|
||||
|
||||
|
||||
- **not** (<a href="{{< ref "../common-definitions/json-schema-props#JSONSchemaProps" >}}">JSONSchemaProps</a>)
|
||||
|
||||
|
||||
- **nullable** (boolean)
|
||||
|
||||
|
||||
- **oneOf** ([]<a href="{{< ref "../common-definitions/json-schema-props#JSONSchemaProps" >}}">JSONSchemaProps</a>)
|
||||
|
||||
|
||||
- **pattern** (string)
|
||||
|
||||
|
||||
- **patternProperties** (map[string]<a href="{{< ref "../common-definitions/json-schema-props#JSONSchemaProps" >}}">JSONSchemaProps</a>)
|
||||
|
||||
|
||||
- **properties** (map[string]<a href="{{< ref "../common-definitions/json-schema-props#JSONSchemaProps" >}}">JSONSchemaProps</a>)
|
||||
|
||||
|
||||
- **required** ([]string)
|
||||
|
||||
|
||||
- **title** (string)
|
||||
|
||||
|
||||
- **type** (string)
|
||||
|
||||
|
||||
- **uniqueItems** (boolean)
|
||||
|
||||
|
||||
- **x-kubernetes-embedded-resource** (boolean)
|
||||
|
||||
x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata).
|
||||
|
||||
- **x-kubernetes-int-or-string** (boolean)
|
||||
|
||||
x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns:
|
||||
|
||||
1) anyOf:
|
||||
- type: integer
|
||||
- type: string
|
||||
2) allOf:
|
||||
- anyOf:
|
||||
- type: integer
|
||||
- type: string
|
||||
- ... zero or more
|
||||
|
||||
- **x-kubernetes-list-map-keys** ([]string)
|
||||
|
||||
x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map.
|
||||
|
||||
This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported).
|
||||
|
||||
The properties specified must either be required or have a default value, to ensure those properties are present for all list items.
|
||||
|
||||
- **x-kubernetes-list-type** (string)
|
||||
|
||||
x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values:
|
||||
|
||||
1) `atomic`: the list is treated as a single entity, like a scalar.
|
||||
Atomic lists will be entirely replaced when updated. This extension
|
||||
may be used on any type of list (struct, scalar, ...).
|
||||
2) `set`:
|
||||
Sets are lists that must not have multiple items with the same value. Each
|
||||
value must be a scalar, an object with x-kubernetes-map-type `atomic` or an
|
||||
array with x-kubernetes-list-type `atomic`.
|
||||
3) `map`:
|
||||
These lists are like maps in that their elements have a non-index key
|
||||
used to identify them. Order is preserved upon merge. The map tag
|
||||
must only be used on a list with elements of type object.
|
||||
Defaults to atomic for arrays.
|
||||
|
||||
- **x-kubernetes-map-type** (string)
|
||||
|
||||
x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values:
|
||||
|
||||
1) `granular`:
|
||||
These maps are actual maps (key-value pairs) and each fields are independent
|
||||
from each other (they can each be manipulated by separate actors). This is
|
||||
the default behaviour for all maps.
|
||||
2) `atomic`: the list is treated as a single entity, like a scalar.
|
||||
Atomic maps will be entirely replaced when updated.
|
||||
|
||||
- **x-kubernetes-preserve-unknown-fields** (boolean)
|
||||
|
||||
x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/api/core/v1"
|
||||
kind: "KeyToPath"
|
||||
content_type: "api_reference"
|
||||
description: "Maps a string key to a path within a volume."
|
||||
title: "KeyToPath"
|
||||
weight: 6
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/api/core/v1"`
|
||||
|
||||
|
||||
Maps a string key to a path within a volume.
|
||||
|
||||
<hr>
|
||||
|
||||
- **key** (string), required
|
||||
|
||||
The key to project.
|
||||
|
||||
- **path** (string), required
|
||||
|
||||
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 '..'.
|
||||
|
||||
- **mode** (int32)
|
||||
|
||||
Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. 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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
kind: "LabelSelector"
|
||||
content_type: "api_reference"
|
||||
description: "A label selector is a label query over a set of resources."
|
||||
title: "LabelSelector"
|
||||
weight: 7
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/apimachinery/pkg/apis/meta/v1"`
|
||||
|
||||
|
||||
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.
|
||||
|
||||
<hr>
|
||||
|
||||
- **matchExpressions** ([]LabelSelectorRequirement)
|
||||
|
||||
matchExpressions is a list of label selector requirements. The requirements are ANDed.
|
||||
|
||||
<a name="LabelSelectorRequirement"></a>
|
||||
*A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.*
|
||||
|
||||
- **matchExpressions.key** (string), required
|
||||
|
||||
*Patch strategy: merge on key `key`*
|
||||
|
||||
key is the label key that the selector applies to.
|
||||
|
||||
- **matchExpressions.operator** (string), required
|
||||
|
||||
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
|
||||
|
||||
- **matchExpressions.values** ([]string)
|
||||
|
||||
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.
|
||||
|
||||
- **matchLabels** (map[string]string)
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
kind: "ListMeta"
|
||||
content_type: "api_reference"
|
||||
description: "ListMeta describes metadata that synthetic resources must have, including lists and various status objects."
|
||||
title: "ListMeta"
|
||||
weight: 8
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/apimachinery/pkg/apis/meta/v1"`
|
||||
|
||||
|
||||
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
|
||||
|
||||
<hr>
|
||||
|
||||
- **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 consistent 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, unless you have received this token from an error message.
|
||||
|
||||
- **remainingItemCount** (int64)
|
||||
|
||||
remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.
|
||||
|
||||
- **resourceVersion** (string)
|
||||
|
||||
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/sig-architecture/api-conventions.md#concurrency-control-and-consistency
|
||||
|
||||
- **selfLink** (string)
|
||||
|
||||
selfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
|
||||
DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/api/core/v1"
|
||||
kind: "LocalObjectReference"
|
||||
content_type: "api_reference"
|
||||
description: "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace."
|
||||
title: "LocalObjectReference"
|
||||
weight: 9
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/api/core/v1"`
|
||||
|
||||
|
||||
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
|
||||
|
||||
<hr>
|
||||
|
||||
- **name** (string)
|
||||
|
||||
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,72 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/api/core/v1"
|
||||
kind: "NodeAffinity"
|
||||
content_type: "api_reference"
|
||||
description: "Node affinity is a group of node affinity scheduling rules."
|
||||
title: "NodeAffinity"
|
||||
weight: 10
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/api/core/v1"`
|
||||
|
||||
|
||||
Node affinity is a group of node affinity scheduling rules.
|
||||
|
||||
<hr>
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution** ([]PreferredSchedulingTerm)
|
||||
|
||||
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.
|
||||
|
||||
<a name="PreferredSchedulingTerm"></a>
|
||||
*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).*
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution.preference** (NodeSelectorTerm), required
|
||||
|
||||
A node selector term, associated with the corresponding weight.
|
||||
|
||||
<a name="NodeSelectorTerm"></a>
|
||||
*A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.*
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions** ([]<a href="{{< ref "../common-definitions/node-selector-requirement#NodeSelectorRequirement" >}}">NodeSelectorRequirement</a>)
|
||||
|
||||
A list of node selector requirements by node's labels.
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields** ([]<a href="{{< ref "../common-definitions/node-selector-requirement#NodeSelectorRequirement" >}}">NodeSelectorRequirement</a>)
|
||||
|
||||
A list of node selector requirements by node's fields.
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution.weight** (int32), required
|
||||
|
||||
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
|
||||
|
||||
- **requiredDuringSchedulingIgnoredDuringExecution** (NodeSelector)
|
||||
|
||||
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.
|
||||
|
||||
<a name="NodeSelector"></a>
|
||||
*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.*
|
||||
|
||||
- **requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms** ([]NodeSelectorTerm), required
|
||||
|
||||
Required. A list of node selector terms. The terms are ORed.
|
||||
|
||||
<a name="NodeSelectorTerm"></a>
|
||||
*A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.*
|
||||
|
||||
- **requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions** ([]<a href="{{< ref "../common-definitions/node-selector-requirement#NodeSelectorRequirement" >}}">NodeSelectorRequirement</a>)
|
||||
|
||||
A list of node selector requirements by node's labels.
|
||||
|
||||
- **requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields** ([]<a href="{{< ref "../common-definitions/node-selector-requirement#NodeSelectorRequirement" >}}">NodeSelectorRequirement</a>)
|
||||
|
||||
A list of node selector requirements by node's fields.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
+36
@@ -0,0 +1,36 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/api/core/v1"
|
||||
kind: "NodeSelectorRequirement"
|
||||
content_type: "api_reference"
|
||||
description: "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values."
|
||||
title: "NodeSelectorRequirement"
|
||||
weight: 11
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/api/core/v1"`
|
||||
|
||||
|
||||
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
<hr>
|
||||
|
||||
- **key** (string), required
|
||||
|
||||
The label key that the selector applies to.
|
||||
|
||||
- **operator** (string), required
|
||||
|
||||
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
|
||||
|
||||
- **values** ([]string)
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/api/core/v1"
|
||||
kind: "ObjectFieldSelector"
|
||||
content_type: "api_reference"
|
||||
description: "ObjectFieldSelector selects an APIVersioned field of an object."
|
||||
title: "ObjectFieldSelector"
|
||||
weight: 12
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/api/core/v1"`
|
||||
|
||||
|
||||
ObjectFieldSelector selects an APIVersioned field of an object.
|
||||
|
||||
<hr>
|
||||
|
||||
- **fieldPath** (string), required
|
||||
|
||||
Path of the field to select in the specified API version.
|
||||
|
||||
- **apiVersion** (string)
|
||||
|
||||
Version of the schema the FieldPath is written in terms of, defaults to "v1".
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,185 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
kind: "ObjectMeta"
|
||||
content_type: "api_reference"
|
||||
description: "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."
|
||||
title: "ObjectMeta"
|
||||
weight: 13
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/apimachinery/pkg/apis/meta/v1"`
|
||||
|
||||
|
||||
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
|
||||
|
||||
<hr>
|
||||
|
||||
- **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
|
||||
|
||||
- **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/sig-architecture/api-conventions.md#idempotency
|
||||
|
||||
- **namespace** (string)
|
||||
|
||||
Namespace defines the space within which 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
|
||||
|
||||
- **labels** (map[string]string)
|
||||
|
||||
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
|
||||
|
||||
- **annotations** (map[string]string)
|
||||
|
||||
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
|
||||
|
||||
|
||||
|
||||
### System {#System}
|
||||
|
||||
|
||||
- **finalizers** ([]string)
|
||||
|
||||
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
|
||||
|
||||
- **managedFields** ([]ManagedFieldsEntry)
|
||||
|
||||
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
|
||||
|
||||
<a name="ManagedFieldsEntry"></a>
|
||||
*ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.*
|
||||
|
||||
- **managedFields.apiVersion** (string)
|
||||
|
||||
APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
|
||||
|
||||
- **managedFields.fieldsType** (string)
|
||||
|
||||
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
|
||||
|
||||
- **managedFields.fieldsV1** (FieldsV1)
|
||||
|
||||
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
|
||||
|
||||
<a name="FieldsV1"></a>
|
||||
*FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.
|
||||
|
||||
Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.
|
||||
|
||||
The exact format is defined in sigs.k8s.io/structured-merge-diff*
|
||||
|
||||
- **managedFields.manager** (string)
|
||||
|
||||
Manager is an identifier of the workflow managing these fields.
|
||||
|
||||
- **managedFields.operation** (string)
|
||||
|
||||
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
|
||||
|
||||
- **managedFields.time** (Time)
|
||||
|
||||
Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'
|
||||
|
||||
<a name="Time"></a>
|
||||
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
|
||||
|
||||
- **ownerReferences** ([]OwnerReference)
|
||||
|
||||
*Patch strategy: merge on key `uid`*
|
||||
|
||||
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.
|
||||
|
||||
<a name="OwnerReference"></a>
|
||||
*OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.*
|
||||
|
||||
- **ownerReferences.apiVersion** (string), required
|
||||
|
||||
API version of the referent.
|
||||
|
||||
- **ownerReferences.kind** (string), required
|
||||
|
||||
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
- **ownerReferences.name** (string), required
|
||||
|
||||
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
|
||||
- **ownerReferences.uid** (string), required
|
||||
|
||||
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
|
||||
|
||||
- **ownerReferences.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.
|
||||
|
||||
- **ownerReferences.controller** (boolean)
|
||||
|
||||
If true, this reference points to the managing controller.
|
||||
|
||||
### Read-only {#Read-only}
|
||||
|
||||
|
||||
- **creationTimestamp** (Time)
|
||||
|
||||
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/sig-architecture/api-conventions.md#metadata
|
||||
|
||||
<a name="Time"></a>
|
||||
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
|
||||
|
||||
- **deletionGracePeriodSeconds** (int64)
|
||||
|
||||
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** (Time)
|
||||
|
||||
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
|
||||
|
||||
Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
|
||||
<a name="Time"></a>
|
||||
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
|
||||
|
||||
- **generation** (int64)
|
||||
|
||||
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
|
||||
|
||||
- **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/sig-architecture/api-conventions.md#concurrency-control-and-consistency
|
||||
|
||||
- **selfLink** (string)
|
||||
|
||||
SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
|
||||
DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
|
||||
|
||||
- **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
|
||||
|
||||
### Ignored {#Ignored}
|
||||
|
||||
|
||||
- **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.
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/api/core/v1"
|
||||
kind: "ObjectReference"
|
||||
content_type: "api_reference"
|
||||
description: "ObjectReference contains enough information to let you inspect or modify the referred object."
|
||||
title: "ObjectReference"
|
||||
weight: 14
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/api/core/v1"`
|
||||
|
||||
|
||||
ObjectReference contains enough information to let you inspect or modify the referred object.
|
||||
|
||||
<hr>
|
||||
|
||||
- **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.
|
||||
|
||||
- **kind** (string)
|
||||
|
||||
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
- **name** (string)
|
||||
|
||||
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||||
|
||||
- **namespace** (string)
|
||||
|
||||
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
|
||||
|
||||
- **resourceVersion** (string)
|
||||
|
||||
Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
|
||||
|
||||
- **uid** (string)
|
||||
|
||||
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
kind: "Patch"
|
||||
content_type: "api_reference"
|
||||
description: "Patch is provided to give a concrete name and type to the Kubernetes PATCH request body."
|
||||
title: "Patch"
|
||||
weight: 15
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/apimachinery/pkg/apis/meta/v1"`
|
||||
|
||||
|
||||
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/api/core/v1"
|
||||
kind: "PodAffinity"
|
||||
content_type: "api_reference"
|
||||
description: "Pod affinity is a group of inter pod affinity scheduling rules."
|
||||
title: "PodAffinity"
|
||||
weight: 16
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/api/core/v1"`
|
||||
|
||||
|
||||
Pod affinity is a group of inter pod affinity scheduling rules.
|
||||
|
||||
<hr>
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution** ([]WeightedPodAffinityTerm)
|
||||
|
||||
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.
|
||||
|
||||
<a name="WeightedPodAffinityTerm"></a>
|
||||
*The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)*
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm** (PodAffinityTerm), required
|
||||
|
||||
Required. A pod affinity term, associated with the corresponding weight.
|
||||
|
||||
<a name="PodAffinityTerm"></a>
|
||||
*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 <topologyKey> matches that of any node on which a pod of the set of pods is running*
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.topologyKey** (string), required
|
||||
|
||||
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.
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
|
||||
|
||||
A label query over a set of resources, in this case pods.
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaces** ([]string)
|
||||
|
||||
namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution.weight** (int32), required
|
||||
|
||||
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
|
||||
|
||||
- **requiredDuringSchedulingIgnoredDuringExecution** ([]PodAffinityTerm)
|
||||
|
||||
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.
|
||||
|
||||
<a name="PodAffinityTerm"></a>
|
||||
*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 <topologyKey> matches that of any node on which a pod of the set of pods is running*
|
||||
|
||||
- **requiredDuringSchedulingIgnoredDuringExecution.topologyKey** (string), required
|
||||
|
||||
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.
|
||||
|
||||
- **requiredDuringSchedulingIgnoredDuringExecution.labelSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
|
||||
|
||||
A label query over a set of resources, in this case pods.
|
||||
|
||||
- **requiredDuringSchedulingIgnoredDuringExecution.namespaces** ([]string)
|
||||
|
||||
namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/api/core/v1"
|
||||
kind: "PodAntiAffinity"
|
||||
content_type: "api_reference"
|
||||
description: "Pod anti affinity is a group of inter pod anti affinity scheduling rules."
|
||||
title: "PodAntiAffinity"
|
||||
weight: 17
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/api/core/v1"`
|
||||
|
||||
|
||||
Pod anti affinity is a group of inter pod anti affinity scheduling rules.
|
||||
|
||||
<hr>
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution** ([]WeightedPodAffinityTerm)
|
||||
|
||||
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.
|
||||
|
||||
<a name="WeightedPodAffinityTerm"></a>
|
||||
*The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)*
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm** (PodAffinityTerm), required
|
||||
|
||||
Required. A pod affinity term, associated with the corresponding weight.
|
||||
|
||||
<a name="PodAffinityTerm"></a>
|
||||
*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 <topologyKey> matches that of any node on which a pod of the set of pods is running*
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.topologyKey** (string), required
|
||||
|
||||
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.
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
|
||||
|
||||
A label query over a set of resources, in this case pods.
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaces** ([]string)
|
||||
|
||||
namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution.weight** (int32), required
|
||||
|
||||
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
|
||||
|
||||
- **requiredDuringSchedulingIgnoredDuringExecution** ([]PodAffinityTerm)
|
||||
|
||||
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.
|
||||
|
||||
<a name="PodAffinityTerm"></a>
|
||||
*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 <topologyKey> matches that of any node on which a pod of the set of pods is running*
|
||||
|
||||
- **requiredDuringSchedulingIgnoredDuringExecution.topologyKey** (string), required
|
||||
|
||||
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.
|
||||
|
||||
- **requiredDuringSchedulingIgnoredDuringExecution.labelSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
|
||||
|
||||
A label query over a set of resources, in this case pods.
|
||||
|
||||
- **requiredDuringSchedulingIgnoredDuringExecution.namespaces** ([]string)
|
||||
|
||||
namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,54 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/apimachinery/pkg/api/resource"
|
||||
kind: "Quantity"
|
||||
content_type: "api_reference"
|
||||
description: "Quantity is a fixed-point representation of a number."
|
||||
title: "Quantity"
|
||||
weight: 18
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/apimachinery/pkg/api/resource"`
|
||||
|
||||
|
||||
Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.
|
||||
|
||||
The serialization format is:
|
||||
|
||||
\<quantity> ::= \<signedNumber>\<suffix>
|
||||
(Note that \<suffix> may be empty, from the "" case in \<decimalSI>.)
|
||||
\<digit> ::= 0 | 1 | ... | 9 \<digits> ::= \<digit> | \<digit>\<digits> \<number> ::= \<digits> | \<digits>.\<digits> | \<digits>. | .\<digits> \<sign> ::= "+" | "-" \<signedNumber> ::= \<number> | \<sign>\<number> \<suffix> ::= \<binarySI> | \<decimalExponent> | \<decimalSI> \<binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei
|
||||
(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)
|
||||
\<decimalSI> ::= m | "" | k | M | G | T | P | E
|
||||
(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)
|
||||
\<decimalExponent> ::= "e" \<signedNumber> | "E" \<signedNumber>
|
||||
|
||||
No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.
|
||||
|
||||
When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.
|
||||
|
||||
Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:
|
||||
a. No precision is lost
|
||||
b. No fractional digits will be emitted
|
||||
c. The exponent (or suffix) is as large as possible.
|
||||
The sign will be omitted unless the number is negative.
|
||||
|
||||
Examples:
|
||||
1.5 will be serialized as "1500m"
|
||||
1.5Gi will be serialized as "1536Mi"
|
||||
|
||||
Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.
|
||||
|
||||
Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)
|
||||
|
||||
This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
+36
@@ -0,0 +1,36 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/api/core/v1"
|
||||
kind: "ResourceFieldSelector"
|
||||
content_type: "api_reference"
|
||||
description: "ResourceFieldSelector represents container resources (cpu, memory) and their output format."
|
||||
title: "ResourceFieldSelector"
|
||||
weight: 19
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/api/core/v1"`
|
||||
|
||||
|
||||
ResourceFieldSelector represents container resources (cpu, memory) and their output format
|
||||
|
||||
<hr>
|
||||
|
||||
- **resource** (string), required
|
||||
|
||||
Required: resource to select
|
||||
|
||||
- **containerName** (string)
|
||||
|
||||
Container name: required for volumes, optional for env vars
|
||||
|
||||
- **divisor** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
|
||||
|
||||
Specifies the output format of the exposed resources, defaults to "1"
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,102 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
kind: "Status"
|
||||
content_type: "api_reference"
|
||||
description: "Status is a return value for calls that don't return other objects."
|
||||
title: "Status"
|
||||
weight: 20
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/apimachinery/pkg/apis/meta/v1"`
|
||||
|
||||
|
||||
Status is a return value for calls that don't return other objects.
|
||||
|
||||
<hr>
|
||||
|
||||
- **apiVersion** (string)
|
||||
|
||||
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
|
||||
|
||||
- **code** (int32)
|
||||
|
||||
Suggested HTTP return code for this status, 0 if not set.
|
||||
|
||||
- **details** (StatusDetails)
|
||||
|
||||
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 name="StatusDetails"></a>
|
||||
*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.*
|
||||
|
||||
- **details.causes** ([]StatusCause)
|
||||
|
||||
The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
|
||||
|
||||
<a name="StatusCause"></a>
|
||||
*StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.*
|
||||
|
||||
- **details.causes.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"
|
||||
|
||||
- **details.causes.message** (string)
|
||||
|
||||
A human-readable description of the cause of the error. This field may be presented as-is to a reader.
|
||||
|
||||
- **details.causes.reason** (string)
|
||||
|
||||
A machine-readable description of the cause of the error. If this value is empty there is no information available.
|
||||
|
||||
- **details.group** (string)
|
||||
|
||||
The group attribute of the resource associated with the status StatusReason.
|
||||
|
||||
- **details.kind** (string)
|
||||
|
||||
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/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
- **details.name** (string)
|
||||
|
||||
The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
|
||||
|
||||
- **details.retryAfterSeconds** (int32)
|
||||
|
||||
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.
|
||||
|
||||
- **details.uid** (string)
|
||||
|
||||
UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids
|
||||
|
||||
- **kind** (string)
|
||||
|
||||
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
- **message** (string)
|
||||
|
||||
A human-readable description of the status of this operation.
|
||||
|
||||
- **metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
|
||||
|
||||
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
- **reason** (string)
|
||||
|
||||
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.
|
||||
|
||||
- **status** (string)
|
||||
|
||||
Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/api/core/v1"
|
||||
kind: "TCPSocketAction"
|
||||
content_type: "api_reference"
|
||||
description: "TCPSocketAction describes an action based on opening a socket."
|
||||
title: "TCPSocketAction"
|
||||
weight: 21
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/api/core/v1"`
|
||||
|
||||
|
||||
TCPSocketAction describes an action based on opening a socket
|
||||
|
||||
<hr>
|
||||
|
||||
- **port** (IntOrString), required
|
||||
|
||||
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.
|
||||
|
||||
<a name="IntOrString"></a>
|
||||
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
|
||||
|
||||
- **host** (string)
|
||||
|
||||
Optional: Host name to connect to, defaults to the pod IP.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
+36
@@ -0,0 +1,36 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: ""
|
||||
import: "k8s.io/api/core/v1"
|
||||
kind: "TypedLocalObjectReference"
|
||||
content_type: "api_reference"
|
||||
description: "TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace."
|
||||
title: "TypedLocalObjectReference"
|
||||
weight: 22
|
||||
---
|
||||
|
||||
|
||||
|
||||
`import "k8s.io/api/core/v1"`
|
||||
|
||||
|
||||
TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.
|
||||
|
||||
<hr>
|
||||
|
||||
- **kind** (string), required
|
||||
|
||||
Kind is the type of resource being referenced
|
||||
|
||||
- **name** (string), required
|
||||
|
||||
Name is the name of resource being referenced
|
||||
|
||||
- **apiGroup** (string)
|
||||
|
||||
APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user