Omit API reference updates for v1.21
Omitting this merge to make it easier to merge in from primary branch and back in to the same primary branch.
This commit is contained in:
Tim Bannister
+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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ api_metadata:
|
||||
content_type: "api_reference"
|
||||
description: "A label selector is a label query over a set of resources."
|
||||
title: "LabelSelector"
|
||||
weight: 2
|
||||
weight: 7
|
||||
---
|
||||
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ api_metadata:
|
||||
content_type: "api_reference"
|
||||
description: "ListMeta describes metadata that synthetic resources must have, including lists and various status objects."
|
||||
title: "ListMeta"
|
||||
weight: 3
|
||||
weight: 8
|
||||
---
|
||||
|
||||
|
||||
|
||||
+1
-1
@@ -6,7 +6,7 @@ api_metadata:
|
||||
content_type: "api_reference"
|
||||
description: "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace."
|
||||
title: "LocalObjectReference"
|
||||
weight: 4
|
||||
weight: 9
|
||||
---
|
||||
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
+1
-1
@@ -6,7 +6,7 @@ api_metadata:
|
||||
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: 5
|
||||
weight: 11
|
||||
---
|
||||
|
||||
|
||||
|
||||
+1
-1
@@ -6,7 +6,7 @@ api_metadata:
|
||||
content_type: "api_reference"
|
||||
description: "ObjectFieldSelector selects an APIVersioned field of an object."
|
||||
title: "ObjectFieldSelector"
|
||||
weight: 6
|
||||
weight: 12
|
||||
---
|
||||
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ api_metadata:
|
||||
content_type: "api_reference"
|
||||
description: "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."
|
||||
title: "ObjectMeta"
|
||||
weight: 7
|
||||
weight: 13
|
||||
---
|
||||
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ api_metadata:
|
||||
content_type: "api_reference"
|
||||
description: "ObjectReference contains enough information to let you inspect or modify the referred object."
|
||||
title: "ObjectReference"
|
||||
weight: 8
|
||||
weight: 14
|
||||
---
|
||||
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ api_metadata:
|
||||
content_type: "api_reference"
|
||||
description: "Patch is provided to give a concrete name and type to the Kubernetes PATCH request body."
|
||||
title: "Patch"
|
||||
weight: 9
|
||||
weight: 15
|
||||
---
|
||||
|
||||
|
||||
|
||||
@@ -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"
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ api_metadata:
|
||||
content_type: "api_reference"
|
||||
description: "Quantity is a fixed-point representation of a number."
|
||||
title: "Quantity"
|
||||
weight: 10
|
||||
weight: 18
|
||||
---
|
||||
|
||||
|
||||
|
||||
+1
-1
@@ -6,7 +6,7 @@ api_metadata:
|
||||
content_type: "api_reference"
|
||||
description: "ResourceFieldSelector represents container resources (cpu, memory) and their output format."
|
||||
title: "ResourceFieldSelector"
|
||||
weight: 11
|
||||
weight: 19
|
||||
---
|
||||
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ api_metadata:
|
||||
content_type: "api_reference"
|
||||
description: "Status is a return value for calls that don't return other objects."
|
||||
title: "Status"
|
||||
weight: 12
|
||||
weight: 20
|
||||
---
|
||||
|
||||
|
||||
@@ -40,21 +40,21 @@ Status is a return value for calls that don't return other objects.
|
||||
<a name="StatusCause"></a>
|
||||
*StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.*
|
||||
|
||||
- **details.causes.field** (string)
|
||||
- **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"
|
||||
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)
|
||||
- **details.causes.message** (string)
|
||||
|
||||
A human-readable description of the cause of the error. This field may be presented as-is to a reader.
|
||||
A human-readable description of the cause of the error. This field may be presented as-is to a reader.
|
||||
|
||||
- **details.causes.reason** (string)
|
||||
- **details.causes.reason** (string)
|
||||
|
||||
A machine-readable description of the cause of the error. If this value is empty there is no information available.
|
||||
A machine-readable description of the cause of the error. If this value is empty there is no information available.
|
||||
|
||||
- **details.group** (string)
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
+1
-1
@@ -6,7 +6,7 @@ api_metadata:
|
||||
content_type: "api_reference"
|
||||
description: "TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace."
|
||||
title: "TypedLocalObjectReference"
|
||||
weight: 13
|
||||
weight: 22
|
||||
---
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user