ImagePruner [imageregistry.operator.openshift.io/v1] - Operator APIs | API reference

Specification
API endpoints

Description

ImagePruner is the configuration object for an image registry pruner managed by the registry operator. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type

object

Required

metadata
spec

Specification

Property Type Description

Property	Type	Description
`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
`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
`metadata`	`ObjectMeta`	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`object`	ImagePrunerSpec defines the specs for the running image pruner.
`status`	`object`	ImagePrunerStatus reports image pruner operational status.

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

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

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

ImagePrunerSpec defines the specs for the running image pruner.

status

object

ImagePrunerStatus reports image pruner operational status.

.spec

Description: ImagePrunerSpec defines the specs for the running image pruner.
Type: object

Property Type Description

Property	Type	Description
`affinity`	`object`	affinity is a group of node affinity scheduling rules for the image pruner pod.
`failedJobsHistoryLimit`	`integer`	failedJobsHistoryLimit specifies how many failed image pruner jobs to retain. Defaults to 3 if not set.
`ignoreInvalidImageReferences`	`boolean`	ignoreInvalidImageReferences indicates whether the pruner can ignore errors while parsing image references.
`keepTagRevisions`	`integer`	keepTagRevisions specifies the number of image revisions for a tag in an image stream that will be preserved. Defaults to 3.
`keepYoungerThan`	`integer`	keepYoungerThan specifies the minimum age in nanoseconds of an image and its referrers for it to be considered a candidate for pruning. DePReCATeD: This field is deprecated in favor of keepYoungerThanDuration. If both are set, this field is ignored and keepYoungerThanDuration takes precedence.
`keepYoungerThanDuration`	`string`	keepYoungerThanDuration specifies the minimum age of an image and its referrers for it to be considered a candidate for pruning. Defaults to 60m (60 minutes).
`logLevel`	`string`	logLevel sets the level of log output for the pruner job. Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal".
`nodeSelector`	`object (string)`	nodeSelector defines the node selection constraints for the image pruner pod.
`resources`	`object`	resources defines the resource requests and limits for the image pruner pod.
`schedule`	`string`	schedule specifies when to execute the job using standard cronjob syntax: https://wikipedia.org/wiki/Cron. Defaults to `0 0 * * *`.
`successfulJobsHistoryLimit`	`integer`	successfulJobsHistoryLimit specifies how many successful image pruner jobs to retain. Defaults to 3 if not set.
`suspend`	`boolean`	suspend specifies whether or not to suspend subsequent executions of this cronjob. Defaults to false.
`tolerations`	`array`	tolerations defines the node tolerations for the image pruner pod.
`tolerations[]`	`object`	The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.

affinity

object

affinity is a group of node affinity scheduling rules for the image pruner pod.

failedJobsHistoryLimit

integer

failedJobsHistoryLimit specifies how many failed image pruner jobs to retain. Defaults to 3 if not set.

ignoreInvalidImageReferences

boolean

ignoreInvalidImageReferences indicates whether the pruner can ignore errors while parsing image references.

keepTagRevisions

integer

keepTagRevisions specifies the number of image revisions for a tag in an image stream that will be preserved. Defaults to 3.

keepYoungerThan

integer

keepYoungerThan specifies the minimum age in nanoseconds of an image and its referrers for it to be considered a candidate for pruning. DePReCATeD: This field is deprecated in favor of keepYoungerThanDuration. If both are set, this field is ignored and keepYoungerThanDuration takes precedence.

keepYoungerThanDuration

string

keepYoungerThanDuration specifies the minimum age of an image and its referrers for it to be considered a candidate for pruning. Defaults to 60m (60 minutes).

logLevel

string

logLevel sets the level of log output for the pruner job. Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal".

nodeSelector

object (string)

nodeSelector defines the node selection constraints for the image pruner pod.

resources

object

resources defines the resource requests and limits for the image pruner pod.

schedule

string

schedule specifies when to execute the job using standard cronjob syntax: https://wikipedia.org/wiki/Cron. Defaults to 0 0 * * *.

successfulJobsHistoryLimit

integer

successfulJobsHistoryLimit specifies how many successful image pruner jobs to retain. Defaults to 3 if not set.

suspend

boolean

suspend specifies whether or not to suspend subsequent executions of this cronjob. Defaults to false.

tolerations

array

tolerations defines the node tolerations for the image pruner pod.

tolerations[]

object

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.

.spec.affinity

Description: affinity is a group of node affinity scheduling rules for the image pruner pod.
Type: object

Property Type Description

Property	Type	Description
`nodeAffinity`	`object`	Describes node affinity scheduling rules for the pod.
`podAffinity`	`object`	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
`podAntiAffinity`	`object`	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

nodeAffinity

object

Describes node affinity scheduling rules for the pod.

podAffinity

object

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

podAntiAffinity

object

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

.spec.affinity.nodeAffinity

Description: Describes node affinity scheduling rules for the pod.
Type: object

Property Type Description

Property	Type	Description
`preferredDuringSchedulingIgnoredDuringexecution`	`array`	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.
`preferredDuringSchedulingIgnoredDuringexecution[]`	`object`	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).
`requiredDuringSchedulingIgnoredDuringexecution`	`object`	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.

preferredDuringSchedulingIgnoredDuringexecution

array

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.

preferredDuringSchedulingIgnoredDuringexecution[]

object

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).

requiredDuringSchedulingIgnoredDuringexecution

object

.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringexecution

Description: 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.
Type: array

.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringexecution[]

Description

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).

Type

object

Required

preference
weight

Property Type Description

Property	Type	Description
`preference`	`object`	A node selector term, associated with the corresponding weight.
`weight`	`integer`	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

preference

object

A node selector term, associated with the corresponding weight.

weight

integer

Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringexecution[].preference

Description: A node selector term, associated with the corresponding weight.
Type: object

Property Type Description

Property	Type	Description
`matchexpressions`	`array`	A list of node selector requirements by node’s labels.
`matchexpressions[]`	`object`	A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
`matchFields`	`array`	A list of node selector requirements by node’s fields.
`matchFields[]`	`object`	A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchexpressions

array

A list of node selector requirements by node’s labels.

matchexpressions[]

object

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchFields

array

A list of node selector requirements by node’s fields.

matchFields[]

object

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringexecution[].preference.matchexpressions

Description: A list of node selector requirements by node’s labels.
Type: array

.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringexecution[].preference.matchexpressions[]

Description

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Required

key
operator

Property Type Description

Property	Type	Description
`key`	`string`	The label key that the selector applies to.
`operator`	`string`	Represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists, DoesNotexist. Gt, and Lt.
`values`	`array (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.

key

string

The label key that the selector applies to.

operator

string

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists, DoesNotexist. Gt, and Lt.

values

array (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.

.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringexecution[].preference.matchFields

Description: A list of node selector requirements by node’s fields.
Type: array

.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringexecution[].preference.matchFields[]

Description

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Required

key
operator

Property Type Description

Property	Type	Description
`key`	`string`	The label key that the selector applies to.
`operator`	`string`	Represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists, DoesNotexist. Gt, and Lt.
`values`	`array (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.

key

string

The label key that the selector applies to.

operator

string

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists, DoesNotexist. Gt, and Lt.

values

array (string)

.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringexecution

Description

Type

object

Required

nodeSelectorTerms

Property Type Description

Property	Type	Description
`nodeSelectorTerms`	`array`	Required. A list of node selector terms. The terms are ORed.
`nodeSelectorTerms[]`	`object`	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.

nodeSelectorTerms

array

Required. A list of node selector terms. The terms are ORed.

nodeSelectorTerms[]

object

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.

.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringexecution.nodeSelectorTerms

Description: Required. A list of node selector terms. The terms are ORed.
Type: array

.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringexecution.nodeSelectorTerms[]

Description: 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.
Type: object

Property Type Description

Property	Type	Description
`matchexpressions`	`array`	A list of node selector requirements by node’s labels.
`matchexpressions[]`	`object`	A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
`matchFields`	`array`	A list of node selector requirements by node’s fields.
`matchFields[]`	`object`	A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchexpressions

array

A list of node selector requirements by node’s labels.

matchexpressions[]

object

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchFields

array

A list of node selector requirements by node’s fields.

matchFields[]

object

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringexecution.nodeSelectorTerms[].matchexpressions

Description: A list of node selector requirements by node’s labels.
Type: array

.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringexecution.nodeSelectorTerms[].matchexpressions[]

Description

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Required

key
operator

Property Type Description

Property	Type	Description
`key`	`string`	The label key that the selector applies to.
`operator`	`string`	Represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists, DoesNotexist. Gt, and Lt.
`values`	`array (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.

key

string

The label key that the selector applies to.

operator

string

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists, DoesNotexist. Gt, and Lt.

values

array (string)

.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringexecution.nodeSelectorTerms[].matchFields

Description: A list of node selector requirements by node’s fields.
Type: array

.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringexecution.nodeSelectorTerms[].matchFields[]

Description

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Required

key
operator

Property Type Description

Property	Type	Description
`key`	`string`	The label key that the selector applies to.
`operator`	`string`	Represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists, DoesNotexist. Gt, and Lt.
`values`	`array (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.

key

string

The label key that the selector applies to.

operator

string

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists, DoesNotexist. Gt, and Lt.

values

array (string)

.spec.affinity.podAffinity

Description: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
Type: object

Property Type Description

Property	Type	Description
`preferredDuringSchedulingIgnoredDuringexecution`	`array`	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.
`preferredDuringSchedulingIgnoredDuringexecution[]`	`object`	The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
`requiredDuringSchedulingIgnoredDuringexecution`	`array`	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.
`requiredDuringSchedulingIgnoredDuringexecution[]`	`object`	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

array

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.

preferredDuringSchedulingIgnoredDuringexecution[]

object

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

requiredDuringSchedulingIgnoredDuringexecution

array

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.

requiredDuringSchedulingIgnoredDuringexecution[]

object

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

.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringexecution

Description: 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.
Type: array

.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringexecution[]

Description

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Type

object

Required

podAffinityTerm
weight

Property Type Description

Property	Type	Description
`podAffinityTerm`	`object`	Required. A pod affinity term, associated with the corresponding weight.
`weight`	`integer`	weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

podAffinityTerm

object

Required. A pod affinity term, associated with the corresponding weight.

weight

integer

weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringexecution[].podAffinityTerm

Description

Required. A pod affinity term, associated with the corresponding weight.

Type

object

Required

topologyKey

Property Type Description

Property	Type	Description
`labelSelector`	`object`	A label query over a set of resources, in this case pods.
`namespaceSelector`	`object`	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.
`namespaces`	`array (string)`	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod’s namespace".
`topologyKey`	`string`	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. empty topologyKey is not allowed.

labelSelector

object

A label query over a set of resources, in this case pods.

namespaceSelector

object

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.

namespaces

array (string)

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod’s namespace".

topologyKey

string

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. empty topologyKey is not allowed.

.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringexecution[].podAffinityTerm.labelSelector

Description: A label query over a set of resources, in this case pods.
Type: object

Property Type Description

Property	Type	Description
`matchexpressions`	`array`	matchexpressions is a list of label selector requirements. The requirements are ANDed.
`matchexpressions[]`	`object`	A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
`matchLabels`	`object (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.

matchexpressions

array

matchexpressions is a list of label selector requirements. The requirements are ANDed.

matchexpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (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.

.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringexecution[].podAffinityTerm.labelSelector.matchexpressions

Description: matchexpressions is a list of label selector requirements. The requirements are ANDed.
Type: array

.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringexecution[].podAffinityTerm.labelSelector.matchexpressions[]

Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Required

key
operator

Property Type Description

Property	Type	Description
`key`	`string`	key is the label key that the selector applies to.
`operator`	`string`	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist.
`values`	`array (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.

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist.

values

array (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.

.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringexecution[].podAffinityTerm.namespaceSelector

Description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.
Type: object

Property Type Description

Property	Type	Description
`matchexpressions`	`array`	matchexpressions is a list of label selector requirements. The requirements are ANDed.
`matchexpressions[]`	`object`	A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
`matchLabels`	`object (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.

matchexpressions

array

matchexpressions is a list of label selector requirements. The requirements are ANDed.

matchexpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringexecution[].podAffinityTerm.namespaceSelector.matchexpressions

Description: matchexpressions is a list of label selector requirements. The requirements are ANDed.
Type: array

.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringexecution[].podAffinityTerm.namespaceSelector.matchexpressions[]

Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Required

key
operator

Property Type Description

Property	Type	Description
`key`	`string`	key is the label key that the selector applies to.
`operator`	`string`	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist.
`values`	`array (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.

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist.

values

array (string)

.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringexecution

Description: 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.
Type: array

.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringexecution[]

Description

Type

object

Required

topologyKey

Property Type Description

Property	Type	Description
`labelSelector`	`object`	A label query over a set of resources, in this case pods.
`namespaceSelector`	`object`	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.
`namespaces`	`array (string)`	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod’s namespace".
`topologyKey`	`string`	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. empty topologyKey is not allowed.

labelSelector

object

A label query over a set of resources, in this case pods.

namespaceSelector

object

namespaces

array (string)

topologyKey

string

.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringexecution[].labelSelector

Description: A label query over a set of resources, in this case pods.
Type: object

Property Type Description

Property	Type	Description
`matchexpressions`	`array`	matchexpressions is a list of label selector requirements. The requirements are ANDed.
`matchexpressions[]`	`object`	A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
`matchLabels`	`object (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.

matchexpressions

array

matchexpressions is a list of label selector requirements. The requirements are ANDed.

matchexpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringexecution[].labelSelector.matchexpressions

Description: matchexpressions is a list of label selector requirements. The requirements are ANDed.
Type: array

.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringexecution[].labelSelector.matchexpressions[]

Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Required

key
operator

Property Type Description

Property	Type	Description
`key`	`string`	key is the label key that the selector applies to.
`operator`	`string`	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist.
`values`	`array (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.

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist.

values

array (string)

.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringexecution[].namespaceSelector

Description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.
Type: object

Property Type Description

Property	Type	Description
`matchexpressions`	`array`	matchexpressions is a list of label selector requirements. The requirements are ANDed.
`matchexpressions[]`	`object`	A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
`matchLabels`	`object (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.

matchexpressions

array

matchexpressions is a list of label selector requirements. The requirements are ANDed.

matchexpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringexecution[].namespaceSelector.matchexpressions

Description: matchexpressions is a list of label selector requirements. The requirements are ANDed.
Type: array

.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringexecution[].namespaceSelector.matchexpressions[]

Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Required

key
operator

Property Type Description

Property	Type	Description
`key`	`string`	key is the label key that the selector applies to.
`operator`	`string`	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist.
`values`	`array (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.

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist.

values

array (string)

.spec.affinity.podAntiAffinity

Description: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
Type: object

Property Type Description

Property	Type	Description
`preferredDuringSchedulingIgnoredDuringexecution`	`array`	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.
`preferredDuringSchedulingIgnoredDuringexecution[]`	`object`	The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
`requiredDuringSchedulingIgnoredDuringexecution`	`array`	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.
`requiredDuringSchedulingIgnoredDuringexecution[]`	`object`	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

array

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.

preferredDuringSchedulingIgnoredDuringexecution[]

object

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

requiredDuringSchedulingIgnoredDuringexecution

array

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.

requiredDuringSchedulingIgnoredDuringexecution[]

object

.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringexecution

Description: 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.
Type: array

.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringexecution[]

Description

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Type

object

Required

podAffinityTerm
weight

Property Type Description

Property	Type	Description
`podAffinityTerm`	`object`	Required. A pod affinity term, associated with the corresponding weight.
`weight`	`integer`	weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

podAffinityTerm

object

Required. A pod affinity term, associated with the corresponding weight.

weight

integer

weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringexecution[].podAffinityTerm

Description

Required. A pod affinity term, associated with the corresponding weight.

Type

object

Required

topologyKey

Property Type Description

Property	Type	Description
`labelSelector`	`object`	A label query over a set of resources, in this case pods.
`namespaceSelector`	`object`	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.
`namespaces`	`array (string)`	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod’s namespace".
`topologyKey`	`string`	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. empty topologyKey is not allowed.

labelSelector

object

A label query over a set of resources, in this case pods.

namespaceSelector

object

namespaces

array (string)

topologyKey

string

.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringexecution[].podAffinityTerm.labelSelector

Description: A label query over a set of resources, in this case pods.
Type: object

Property Type Description

Property	Type	Description
`matchexpressions`	`array`	matchexpressions is a list of label selector requirements. The requirements are ANDed.
`matchexpressions[]`	`object`	A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
`matchLabels`	`object (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.

matchexpressions

array

matchexpressions is a list of label selector requirements. The requirements are ANDed.

matchexpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringexecution[].podAffinityTerm.labelSelector.matchexpressions

Description: matchexpressions is a list of label selector requirements. The requirements are ANDed.
Type: array

.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringexecution[].podAffinityTerm.labelSelector.matchexpressions[]

Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Required

key
operator

Property Type Description

Property	Type	Description
`key`	`string`	key is the label key that the selector applies to.
`operator`	`string`	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist.
`values`	`array (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.

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist.

values

array (string)

.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringexecution[].podAffinityTerm.namespaceSelector

Description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.
Type: object

Property Type Description

Property	Type	Description
`matchexpressions`	`array`	matchexpressions is a list of label selector requirements. The requirements are ANDed.
`matchexpressions[]`	`object`	A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
`matchLabels`	`object (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.

matchexpressions

array

matchexpressions is a list of label selector requirements. The requirements are ANDed.

matchexpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringexecution[].podAffinityTerm.namespaceSelector.matchexpressions

Description: matchexpressions is a list of label selector requirements. The requirements are ANDed.
Type: array

.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringexecution[].podAffinityTerm.namespaceSelector.matchexpressions[]

Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Required

key
operator

Property Type Description

Property	Type	Description
`key`	`string`	key is the label key that the selector applies to.
`operator`	`string`	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist.
`values`	`array (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.

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist.

values

array (string)

.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringexecution

Description: 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.
Type: array

.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringexecution[]

Description

Type

object

Required

topologyKey

Property Type Description

Property	Type	Description
`labelSelector`	`object`	A label query over a set of resources, in this case pods.
`namespaceSelector`	`object`	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.
`namespaces`	`array (string)`	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod’s namespace".
`topologyKey`	`string`	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. empty topologyKey is not allowed.

labelSelector

object

A label query over a set of resources, in this case pods.

namespaceSelector

object

namespaces

array (string)

topologyKey

string

.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringexecution[].labelSelector

Description: A label query over a set of resources, in this case pods.
Type: object

Property Type Description

Property	Type	Description
`matchexpressions`	`array`	matchexpressions is a list of label selector requirements. The requirements are ANDed.
`matchexpressions[]`	`object`	A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
`matchLabels`	`object (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.

matchexpressions

array

matchexpressions is a list of label selector requirements. The requirements are ANDed.

matchexpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringexecution[].labelSelector.matchexpressions

Description: matchexpressions is a list of label selector requirements. The requirements are ANDed.
Type: array

.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringexecution[].labelSelector.matchexpressions[]

Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Required

key
operator

Property Type Description

Property	Type	Description
`key`	`string`	key is the label key that the selector applies to.
`operator`	`string`	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist.
`values`	`array (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.

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist.

values

array (string)

.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringexecution[].namespaceSelector

Description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.
Type: object

Property Type Description

Property	Type	Description
`matchexpressions`	`array`	matchexpressions is a list of label selector requirements. The requirements are ANDed.
`matchexpressions[]`	`object`	A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
`matchLabels`	`object (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.

matchexpressions

array

matchexpressions is a list of label selector requirements. The requirements are ANDed.

matchexpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringexecution[].namespaceSelector.matchexpressions

Description: matchexpressions is a list of label selector requirements. The requirements are ANDed.
Type: array

.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringexecution[].namespaceSelector.matchexpressions[]

Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Required

key
operator

Property Type Description

Property	Type	Description
`key`	`string`	key is the label key that the selector applies to.
`operator`	`string`	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist.
`values`	`array (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.

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist.

values

array (string)

.spec.resources

Description: resources defines the resource requests and limits for the image pruner pod.
Type: object

Property Type Description

Property	Type	Description
`claims`	`array`	Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
`claims[]`	`object`	ResourceClaim references one entry in PodSpec.ResourceClaims.
`limits`	`integer-or-string`	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
`requests`	`integer-or-string`	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

claims

array

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.

claims[]

object

ResourceClaim references one entry in PodSpec.ResourceClaims.

limits

integer-or-string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

.spec.resources.claims

Description: Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
Type: array

.spec.resources.claims[]

Description

ResourceClaim references one entry in PodSpec.ResourceClaims.

Type

object

Required

name

Property Type Description

Property	Type	Description
`name`	`string`	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.

name

string

Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.

.spec.tolerations

Description: tolerations defines the node tolerations for the image pruner pod.
Type: array

.spec.tolerations[]

Description: The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
Type: object

Property Type Description

Property	Type	Description
`effect`	`string`	effect indicates the taint effect to match. empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and Noexecute.
`key`	`string`	Key is the taint key that the toleration applies to. empty means match all taint keys. If the key is empty, operator must be exists; this combination means to match all values and all keys.
`operator`	`string`	Operator represents a key’s relationship to the value. Valid operators are exists and equal. Defaults to equal. exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
`tolerationSeconds`	`integer`	TolerationSeconds represents the period of time the toleration (which must be of effect Noexecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
`value`	`string`	Value is the taint value the toleration matches to. If the operator is exists, the value should be empty, otherwise just a regular string.

effect

string

effect indicates the taint effect to match. empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and Noexecute.

key

string

Key is the taint key that the toleration applies to. empty means match all taint keys. If the key is empty, operator must be exists; this combination means to match all values and all keys.

operator

string

Operator represents a key’s relationship to the value. Valid operators are exists and equal. Defaults to equal. exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.

tolerationSeconds

integer

TolerationSeconds represents the period of time the toleration (which must be of effect Noexecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

value

string

Value is the taint value the toleration matches to. If the operator is exists, the value should be empty, otherwise just a regular string.

.status

Description: ImagePrunerStatus reports image pruner operational status.
Type: object

Property Type Description

Property	Type	Description
`conditions`	`array`	conditions is a list of conditions and their status.
`conditions[]`	`object`	OperatorCondition is just the standard condition fields.
`observedGeneration`	`integer`	observedGeneration is the last generation change that has been applied.

conditions

array

conditions is a list of conditions and their status.

conditions[]

object

OperatorCondition is just the standard condition fields.

observedGeneration

integer

observedGeneration is the last generation change that has been applied.

.status.conditions

Description: conditions is a list of conditions and their status.
Type: array

.status.conditions[]

Description: OperatorCondition is just the standard condition fields.
Type: object

Property Type Description

Property	Type	Description
`lastTransitionTime`	`string`
`message`	`string`
`reason`	`string`
`status`	`string`
`type`	`string`

lastTransitionTime

string

message

string

reason

string

status

string

type

string

API endpoints

The following API endpoints are available:

/apis/imageregistry.operator.openshift.io/v1/imagepruners
- DeLeTe: delete collection of ImagePruner
- GeT: list objects of kind ImagePruner
- POST: create an ImagePruner
/apis/imageregistry.operator.openshift.io/v1/imagepruners/{name}
- DeLeTe: delete an ImagePruner
- GeT: read the specified ImagePruner
- PATCH: partially update the specified ImagePruner
- PUT: replace the specified ImagePruner
/apis/imageregistry.operator.openshift.io/v1/imagepruners/{name}/status
- GeT: read status of the specified ImagePruner
- PATCH: partially update status of the specified ImagePruner
- PUT: replace status of the specified ImagePruner

/apis/imageregistry.operator.openshift.io/v1/imagepruners

HTTP method: DeLeTe
Description: delete collection of ImagePruner

Table 1. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
401 - Unauthorized	empty

HTTP method: GeT
Description: list objects of kind ImagePruner

Table 2. HTTP responses
HTTP code	Reponse body
200 - OK	`ImagePrunerList` schema
401 - Unauthorized	empty

HTTP method: POST
Description: create an ImagePruner

Table 3. Query parameters
Parameter	Type	Description
`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
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 4. Body parameters
Parameter	Type	Description
`body`	`ImagePruner` schema

Table 5. HTTP responses
HTTP code	Reponse body
200 - OK	`ImagePruner` schema
201 - Created	`ImagePruner` schema
202 - Accepted	`ImagePruner` schema
401 - Unauthorized	empty

/apis/imageregistry.operator.openshift.io/v1/imagepruners/{name}

Table 6. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ImagePruner

HTTP method: DeLeTe
Description: delete an ImagePruner

Table 7. Query parameters
Parameter	Type	Description
`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

Table 8. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	empty

HTTP method: GeT
Description: read the specified ImagePruner

Table 9. HTTP responses
HTTP code	Reponse body
200 - OK	`ImagePruner` schema
401 - Unauthorized	empty

HTTP method: PATCH
Description: partially update the specified ImagePruner

Table 10. Query parameters
Parameter	Type	Description
`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
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 11. HTTP responses
HTTP code	Reponse body
200 - OK	`ImagePruner` schema
401 - Unauthorized	empty

HTTP method: PUT
Description: replace the specified ImagePruner

Table 12. Query parameters
Parameter	Type	Description
`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
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 13. Body parameters
Parameter	Type	Description
`body`	`ImagePruner` schema

Table 14. HTTP responses
HTTP code	Reponse body
200 - OK	`ImagePruner` schema
201 - Created	`ImagePruner` schema
401 - Unauthorized	empty

/apis/imageregistry.operator.openshift.io/v1/imagepruners/{name}/status

Table 15. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ImagePruner

HTTP method: GeT
Description: read status of the specified ImagePruner

Table 16. HTTP responses
HTTP code	Reponse body
200 - OK	`ImagePruner` schema
401 - Unauthorized	empty

HTTP method: PATCH
Description: partially update status of the specified ImagePruner

Table 17. Query parameters
Parameter	Type	Description
`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
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`ImagePruner` schema
401 - Unauthorized	empty

HTTP method: PUT
Description: replace status of the specified ImagePruner

Table 19. Query parameters
Parameter	Type	Description
`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
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 20. Body parameters
Parameter	Type	Description
`body`	`ImagePruner` schema

Table 21. HTTP responses
HTTP code	Reponse body
200 - OK	`ImagePruner` schema
201 - Created	`ImagePruner` schema
401 - Unauthorized	empty