Config is the configuration object for a registry instance managed by the registry operator
Config is the configuration object for a registry instance managed by the registry operator
object
metadata
spec
Property | Type | Description |
---|---|---|
|
|
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 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 |
|
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
|
ImageRegistrySpec defines the specs for the running registry. |
|
|
ImageRegistryStatus reports image registry operational status. |
ImageRegistrySpec defines the specs for the running registry.
object
managementState
replicas
Property | Type | Description |
---|---|---|
|
|
affinity is a group of node affinity scheduling rules for the image registry pod(s). |
|
|
defaultRoute indicates whether an external facing route for the registry should be created using the default generated hostname. |
|
|
disableRedirect controls whether to route all data through the Registry, rather than redirecting to the backend. |
|
|
httpSecret is the value needed by the registry to secure uploads, generated by default. |
|
|
logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands. Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal". |
|
|
logging is deprecated, use logLevel instead. |
|
|
managementState indicates whether and how the operator should manage the component |
|
|
nodeSelector defines the node selection constraints for the registry pod. |
|
`` |
observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator |
|
|
operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves. Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal". |
|
|
proxy defines the proxy to be used when calling master api, upstream registries, etc. |
|
|
readOnly indicates whether the registry instance should reject attempts to push new images or delete existing ones. |
|
|
replicas determines the number of registry instances to run. |
|
|
requests controls how many parallel requests a given registry instance will handle before queuing additional requests. |
|
|
resources defines the resource requests+limits for the registry pod. |
|
|
rolloutStrategy defines rollout strategy for the image registry deployment. |
|
|
routes defines additional external facing routes which should be created for the registry. |
|
|
ImageRegistryConfigRoute holds information on external route access to image registry. |
|
|
storage details for configuring registry storage, e.g. S3 bucket coordinates. |
|
|
tolerations defines the tolerations for the registry pod. |
|
|
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>. |
|
`` |
unsupportedConfigOverrides holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides |
affinity is a group of node affinity scheduling rules for the image registry pod(s).
object
Property | Type | Description |
---|---|---|
|
|
Describes node affinity scheduling rules for the pod. |
|
|
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). |
|
|
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). |
Describes node affinity scheduling rules for the pod.
object
Property | Type | 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. |
|
|
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). |
|
|
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. |
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.
array
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).
object
preference
weight
Property | Type | Description |
---|---|---|
|
|
A node selector term, associated with the corresponding weight. |
|
|
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. |
A node selector term, associated with the corresponding weight.
object
Property | Type | Description |
---|---|---|
|
|
A list of node selector requirements by node’s labels. |
|
|
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
A list of node selector requirements by node’s fields. |
|
|
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
A list of node selector requirements by node’s labels.
array
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
key
operator
Property | Type | Description |
---|---|---|
|
|
The label key that the selector applies to. |
|
|
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
|
|
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. |
A list of node selector requirements by node’s fields.
array
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
key
operator
Property | Type | Description |
---|---|---|
|
|
The label key that the selector applies to. |
|
|
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
|
|
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. |
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.
object
nodeSelectorTerms
Property | Type | Description |
---|---|---|
|
|
Required. A list of node selector terms. The terms are ORed. |
|
|
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. |
Required. A list of node selector terms. The terms are ORed.
array
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.
object
Property | Type | Description |
---|---|---|
|
|
A list of node selector requirements by node’s labels. |
|
|
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
A list of node selector requirements by node’s fields. |
|
|
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
A list of node selector requirements by node’s labels.
array
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
key
operator
Property | Type | Description |
---|---|---|
|
|
The label key that the selector applies to. |
|
|
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
|
|
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. |
A list of node selector requirements by node’s fields.
array
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
key
operator
Property | Type | Description |
---|---|---|
|
|
The label key that the selector applies to. |
|
|
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
|
|
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. |
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
object
Property | Type | 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. |
|
|
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) |
|
|
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. |
|
|
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 |
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.
array
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
object
podAffinityTerm
weight
Property | Type | Description |
---|---|---|
|
|
Required. A pod affinity term, associated with the corresponding weight. |
|
|
weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |
Required. A pod affinity term, associated with the corresponding weight.
object
topologyKey
Property | Type | Description |
---|---|---|
|
|
A label query over a set of resources, in this case pods. |
|
|
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. This field is alpha-level and is only honored when PodAffinityNamespaceSelector feature is enabled. |
|
|
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" |
|
|
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. |
A label query over a set of resources, in this case pods.
object
Property | Type | Description |
---|---|---|
|
|
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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 is a list of label selector requirements. The requirements are ANDed.
array
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
key
operator
Property | Type | Description |
---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
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. |
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. This field is alpha-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
object
Property | Type | Description |
---|---|---|
|
|
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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 is a list of label selector requirements. The requirements are ANDed.
array
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
key
operator
Property | Type | Description |
---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
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. |
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.
array
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
object
topologyKey
Property | Type | Description |
---|---|---|
|
|
A label query over a set of resources, in this case pods. |
|
|
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. This field is alpha-level and is only honored when PodAffinityNamespaceSelector feature is enabled. |
|
|
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" |
|
|
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. |
A label query over a set of resources, in this case pods.
object
Property | Type | Description |
---|---|---|
|
|
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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 is a list of label selector requirements. The requirements are ANDed.
array
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
key
operator
Property | Type | Description |
---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
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. |
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. This field is alpha-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
object
Property | Type | Description |
---|---|---|
|
|
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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 is a list of label selector requirements. The requirements are ANDed.
array
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
key
operator
Property | Type | Description |
---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
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. |
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
object
Property | Type | 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. |
|
|
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) |
|
|
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. |
|
|
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 |
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.
array
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
object
podAffinityTerm
weight
Property | Type | Description |
---|---|---|
|
|
Required. A pod affinity term, associated with the corresponding weight. |
|
|
weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |
Required. A pod affinity term, associated with the corresponding weight.
object
topologyKey
Property | Type | Description |
---|---|---|
|
|
A label query over a set of resources, in this case pods. |
|
|
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. This field is alpha-level and is only honored when PodAffinityNamespaceSelector feature is enabled. |
|
|
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" |
|
|
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. |
A label query over a set of resources, in this case pods.
object
Property | Type | Description |
---|---|---|
|
|
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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 is a list of label selector requirements. The requirements are ANDed.
array
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
key
operator
Property | Type | Description |
---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
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. |
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. This field is alpha-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
object
Property | Type | Description |
---|---|---|
|
|
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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 is a list of label selector requirements. The requirements are ANDed.
array
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
key
operator
Property | Type | Description |
---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
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. |
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.
array
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
object
topologyKey
Property | Type | Description |
---|---|---|
|
|
A label query over a set of resources, in this case pods. |
|
|
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. This field is alpha-level and is only honored when PodAffinityNamespaceSelector feature is enabled. |
|
|
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" |
|
|
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. |
A label query over a set of resources, in this case pods.
object
Property | Type | Description |
---|---|---|
|
|
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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 is a list of label selector requirements. The requirements are ANDed.
array
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
key
operator
Property | Type | Description |
---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
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. |
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. This field is alpha-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
object
Property | Type | Description |
---|---|---|
|
|
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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 is a list of label selector requirements. The requirements are ANDed.
array
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
key
operator
Property | Type | Description |
---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
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. |
proxy defines the proxy to be used when calling master api, upstream registries, etc.
object
Property | Type | Description |
---|---|---|
|
|
http defines the proxy to be used by the image registry when accessing HTTP endpoints. |
|
|
https defines the proxy to be used by the image registry when accessing HTTPS endpoints. |
|
|
noProxy defines a comma-separated list of host names that shouldn’t go through any proxy. |
requests controls how many parallel requests a given registry instance will handle before queuing additional requests.
object
Property | Type | Description |
---|---|---|
|
|
read defines limits for image registry’s reads. |
|
|
write defines limits for image registry’s writes. |
read defines limits for image registry’s reads.
object
Property | Type | Description |
---|---|---|
|
|
maxInQueue sets the maximum queued api requests to the registry. |
|
|
maxRunning sets the maximum in flight api requests to the registry. |
|
|
maxWaitInQueue sets the maximum time a request can wait in the queue before being rejected. |
write defines limits for image registry’s writes.
object
Property | Type | Description |
---|---|---|
|
|
maxInQueue sets the maximum queued api requests to the registry. |
|
|
maxRunning sets the maximum in flight api requests to the registry. |
|
|
maxWaitInQueue sets the maximum time a request can wait in the queue before being rejected. |
resources defines the resource requests+limits for the registry pod.
object
Property | Type | Description |
---|---|---|
|
|
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
routes defines additional external facing routes which should be created for the registry.
array
ImageRegistryConfigRoute holds information on external route access to image registry.
object
name
Property | Type | Description |
---|---|---|
|
|
hostname for the route. |
|
|
name of the route to be created. |
|
|
secretName points to secret containing the certificates to be used by the route. |
storage details for configuring registry storage, e.g. S3 bucket coordinates.
object
Property | Type | Description |
---|---|---|
|
|
azure represents configuration that uses Azure Blob Storage. |
|
|
emptyDir represents ephemeral storage on the pod’s host node. WARNING: this storage cannot be used with more than 1 replica and is not suitable for production use. When the pod is removed from a node for any reason, the data in the emptyDir is deleted forever. |
|
|
gcs represents configuration that uses Google Cloud Storage. |
|
|
ibmcos represents configuration that uses IBM Cloud Object Storage. |
|
|
managementState indicates if the operator manages the underlying storage unit. If Managed the operator will remove the storage when this operator gets Removed. |
|
|
pvc represents configuration that uses a PersistentVolumeClaim. |
|
|
s3 represents configuration that uses Amazon Simple Storage Service. |
|
|
swift represents configuration that uses OpenStack Object Storage. |
azure represents configuration that uses Azure Blob Storage.
object
Property | Type | Description |
---|---|---|
|
|
accountName defines the account to be used by the registry. |
|
|
cloudName is the name of the Azure cloud environment to be used by the registry. If empty, the operator will set it based on the infrastructure object. |
|
|
container defines Azure’s container to be used by registry. |
emptyDir represents ephemeral storage on the pod’s host node. WARNING: this storage cannot be used with more than 1 replica and is not suitable for production use. When the pod is removed from a node for any reason, the data in the emptyDir is deleted forever.
object
gcs represents configuration that uses Google Cloud Storage.
object
Property | Type | Description |
---|---|---|
|
|
bucket is the bucket name in which you want to store the registry’s data. Optional, will be generated if not provided. |
|
|
keyID is the KMS key ID to use for encryption. Optional, buckets are encrypted by default on GCP. This allows for the use of a custom encryption key. |
|
|
projectID is the Project ID of the GCP project that this bucket should be associated with. |
|
|
region is the GCS location in which your bucket exists. Optional, will be set based on the installed GCS Region. |
ibmcos represents configuration that uses IBM Cloud Object Storage.
object
Property | Type | Description |
---|---|---|
|
|
bucket is the bucket name in which you want to store the registry’s data. Optional, will be generated if not provided. |
|
|
location is the IBM Cloud location in which your bucket exists. Optional, will be set based on the installed IBM Cloud location. |
|
|
resourceGroupName is the name of the IBM Cloud resource group that this bucket and its service instance is associated with. Optional, will be set based on the installed IBM Cloud resource group. |
|
|
resourceKeyCRN is the CRN of the IBM Cloud resource key that is created for the service instance. Commonly referred as a service credential and must contain HMAC type credentials. Optional, will be computed if not provided. |
|
|
serviceInstanceCRN is the CRN of the IBM Cloud Object Storage service instance that this bucket is associated with. Optional, will be computed if not provided. |
pvc represents configuration that uses a PersistentVolumeClaim.
object
Property | Type | Description |
---|---|---|
|
|
claim defines the Persisent Volume Claim’s name to be used. |
s3 represents configuration that uses Amazon Simple Storage Service.
object
Property | Type | Description |
---|---|---|
|
|
bucket is the bucket name in which you want to store the registry’s data. Optional, will be generated if not provided. |
|
|
cloudFront configures Amazon Cloudfront as the storage middleware in a registry. |
|
|
encrypt specifies whether the registry stores the image in encrypted format or not. Optional, defaults to false. |
|
|
keyID is the KMS key ID to use for encryption. Optional, Encrypt must be true, or this parameter is ignored. |
|
|
region is the AWS region in which your bucket exists. Optional, will be set based on the installed AWS Region. |
|
|
regionEndpoint is the endpoint for S3 compatible storage services. Optional, defaults based on the Region that is provided. |
|
|
virtualHostedStyle enables using S3 virtual hosted style bucket paths with a custom RegionEndpoint Optional, defaults to false. |
cloudFront configures Amazon Cloudfront as the storage middleware in a registry.
object
baseURL
keypairID
privateKey
Property | Type | Description |
---|---|---|
|
|
baseURL contains the SCHEME://HOST[/PATH] at which Cloudfront is served. |
|
|
duration is the duration of the Cloudfront session. |
|
|
keypairID is key pair ID provided by AWS. |
|
|
privateKey points to secret containing the private key, provided by AWS. |
privateKey points to secret containing the private key, provided by AWS.
object
key
Property | Type | Description |
---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
swift represents configuration that uses OpenStack Object Storage.
object
Property | Type | Description |
---|---|---|
|
|
authURL defines the URL for obtaining an authentication token. |
|
|
authVersion specifies the OpenStack Auth’s version. |
|
|
container defines the name of Swift container where to store the registry’s data. |
|
|
domain specifies Openstack’s domain name for Identity v3 API. |
|
|
domainID specifies Openstack’s domain id for Identity v3 API. |
|
|
regionName defines Openstack’s region in which container exists. |
|
|
tenant defines Openstack tenant name to be used by registry. |
|
|
tenant defines Openstack tenant id to be used by registry. |
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
object
Property | Type | Description |
---|---|---|
|
|
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. |
|
|
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 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 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 is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |
ImageRegistryStatus reports image registry operational status.
object
storage
storageManaged
Property | Type | Description |
---|---|---|
|
|
conditions is a list of conditions and their status |
|
|
OperatorCondition is just the standard condition fields. |
|
|
generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction. |
|
|
GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made. |
|
|
observedGeneration is the last generation change you’ve dealt with |
|
|
readyReplicas indicates how many replicas are ready and at the desired state |
|
|
storage indicates the current applied storage configuration of the registry. |
|
|
storageManaged is deprecated, please refer to Storage.managementState |
|
|
version is the level this availability applies to |
OperatorCondition is just the standard condition fields.
object
Property | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.
array
GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made.
object
Property | Type | Description |
---|---|---|
|
|
group is the group of the thing you’re tracking |
|
|
hash is an optional field set for resources without generation that are content sensitive like secrets and configmaps |
|
|
lastGeneration is the last generation of the workload controller involved |
|
|
name is the name of the thing you’re tracking |
|
|
namespace is where the thing you’re tracking is |
|
|
resource is the resource type of the thing you’re tracking |
storage indicates the current applied storage configuration of the registry.
object
Property | Type | Description |
---|---|---|
|
|
azure represents configuration that uses Azure Blob Storage. |
|
|
emptyDir represents ephemeral storage on the pod’s host node. WARNING: this storage cannot be used with more than 1 replica and is not suitable for production use. When the pod is removed from a node for any reason, the data in the emptyDir is deleted forever. |
|
|
gcs represents configuration that uses Google Cloud Storage. |
|
|
ibmcos represents configuration that uses IBM Cloud Object Storage. |
|
|
managementState indicates if the operator manages the underlying storage unit. If Managed the operator will remove the storage when this operator gets Removed. |
|
|
pvc represents configuration that uses a PersistentVolumeClaim. |
|
|
s3 represents configuration that uses Amazon Simple Storage Service. |
|
|
swift represents configuration that uses OpenStack Object Storage. |
azure represents configuration that uses Azure Blob Storage.
object
Property | Type | Description |
---|---|---|
|
|
accountName defines the account to be used by the registry. |
|
|
cloudName is the name of the Azure cloud environment to be used by the registry. If empty, the operator will set it based on the infrastructure object. |
|
|
container defines Azure’s container to be used by registry. |
emptyDir represents ephemeral storage on the pod’s host node. WARNING: this storage cannot be used with more than 1 replica and is not suitable for production use. When the pod is removed from a node for any reason, the data in the emptyDir is deleted forever.
object
gcs represents configuration that uses Google Cloud Storage.
object
Property | Type | Description |
---|---|---|
|
|
bucket is the bucket name in which you want to store the registry’s data. Optional, will be generated if not provided. |
|
|
keyID is the KMS key ID to use for encryption. Optional, buckets are encrypted by default on GCP. This allows for the use of a custom encryption key. |
|
|
projectID is the Project ID of the GCP project that this bucket should be associated with. |
|
|
region is the GCS location in which your bucket exists. Optional, will be set based on the installed GCS Region. |
ibmcos represents configuration that uses IBM Cloud Object Storage.
object
Property | Type | Description |
---|---|---|
|
|
bucket is the bucket name in which you want to store the registry’s data. Optional, will be generated if not provided. |
|
|
location is the IBM Cloud location in which your bucket exists. Optional, will be set based on the installed IBM Cloud location. |
|
|
resourceGroupName is the name of the IBM Cloud resource group that this bucket and its service instance is associated with. Optional, will be set based on the installed IBM Cloud resource group. |
|
|
resourceKeyCRN is the CRN of the IBM Cloud resource key that is created for the service instance. Commonly referred as a service credential and must contain HMAC type credentials. Optional, will be computed if not provided. |
|
|
serviceInstanceCRN is the CRN of the IBM Cloud Object Storage service instance that this bucket is associated with. Optional, will be computed if not provided. |
pvc represents configuration that uses a PersistentVolumeClaim.
object
Property | Type | Description |
---|---|---|
|
|
claim defines the Persisent Volume Claim’s name to be used. |
s3 represents configuration that uses Amazon Simple Storage Service.
object
Property | Type | Description |
---|---|---|
|
|
bucket is the bucket name in which you want to store the registry’s data. Optional, will be generated if not provided. |
|
|
cloudFront configures Amazon Cloudfront as the storage middleware in a registry. |
|
|
encrypt specifies whether the registry stores the image in encrypted format or not. Optional, defaults to false. |
|
|
keyID is the KMS key ID to use for encryption. Optional, Encrypt must be true, or this parameter is ignored. |
|
|
region is the AWS region in which your bucket exists. Optional, will be set based on the installed AWS Region. |
|
|
regionEndpoint is the endpoint for S3 compatible storage services. Optional, defaults based on the Region that is provided. |
|
|
virtualHostedStyle enables using S3 virtual hosted style bucket paths with a custom RegionEndpoint Optional, defaults to false. |
cloudFront configures Amazon Cloudfront as the storage middleware in a registry.
object
baseURL
keypairID
privateKey
Property | Type | Description |
---|---|---|
|
|
baseURL contains the SCHEME://HOST[/PATH] at which Cloudfront is served. |
|
|
duration is the duration of the Cloudfront session. |
|
|
keypairID is key pair ID provided by AWS. |
|
|
privateKey points to secret containing the private key, provided by AWS. |