PGUpgrade - v1beta1
PGUpgrade
PGUpgrade is the Schema for the pgupgrades API
| name | type | required | 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 | object | ✅ | Kubernetes resource namespace, name, labels, and annotations |
| spec | object | ❌ | PGUpgradeSpec defines the desired state of PGUpgrade |
| status | object | ❌ | PGUpgradeStatus defines the observed state of PGUpgrade |
↩ ParentPGUpgrade.spec
PGUpgradeSpec defines the desired state of PGUpgrade
| name | type | required | description |
|---|---|---|---|
| affinity | object | ❌ | Scheduling constraints of the PGUpgrade pod. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node |
| fromPostgresVersion | integer | ✅ | The major version of PostgreSQL before the upgrade. |
| image | string | ❌ | The image name to use for major PostgreSQL upgrades. |
| imagePullPolicy | Always, Never, IfNotPresent | ❌ | ImagePullPolicy is used to determine when Kubernetes will attempt to pull (download) container images. More info: https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy |
| imagePullSecrets | []object | ❌ | The image pull secrets used to pull from a private registry. Changing this value causes all running PGUpgrade pods to restart. https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry |
| jobs | integer | ❌ | The number of simultaneous processes pg_upgrade should use. More info: https://www.postgresql.org/docs/current/pgupgrade.html |
| metadata | object | ❌ | Metadata contains metadata for custom resources |
| postgresClusterName | string | ✅ | The name of the Postgres cluster to upgrade. |
| priorityClassName | string | ❌ | Priority class name for the PGUpgrade pod. Changing this value causes PGUpgrade pod to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption |
| resources | object | ❌ | Resource requirements for the PGUpgrade container. |
| toPostgresVersion | integer | ✅ | The major version of PostgreSQL to be upgraded to. |
| tolerations | []object | ❌ | Tolerations of the PGUpgrade pod. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration |
| transferMethod | Clone, Copy, CopyFileRange, Link | ❌ | The method pg_upgrade should use to transfer files to the new cluster. More info: https://www.postgresql.org/docs/current/pgupgrade.html |
↩ ParentPGUpgrade.spec.affinity
Scheduling constraints of the PGUpgrade pod. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node
| name | type | required | 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)). |
↩ ParentPGUpgrade.spec.affinity.nodeAffinity
Describes node affinity scheduling rules for the pod.
| name | type | required | description |
|---|---|---|---|
| preferredDuringSchedulingIgnoredDuringExecution | []object | ❌ | 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. |
| 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. |
↩ ParentPGUpgrade.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
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.
| name | type | required | 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. |
↩ ParentPGUpgrade.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference
A node selector term, associated with the corresponding weight.
| name | type | required | description |
|---|---|---|---|
| matchExpressions | []object | ❌ | A list of node selector requirements by node's labels. |
| matchFields | []object | ❌ | A list of node selector requirements by node's fields. |
↩ ParentPGUpgrade.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]
A list of node selector requirements by node's labels.
| name | type | required | 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 | []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. |
↩ ParentPGUpgrade.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]
A list of node selector requirements by node's fields.
| name | type | required | 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 | []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. |
↩ ParentPGUpgrade.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
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.
| name | type | required | description |
|---|---|---|---|
| nodeSelectorTerms | []object | ✅ | Required. A list of node selector terms. The terms are ORed. |
↩ ParentPGUpgrade.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]
Required. A list of node selector terms. The terms are ORed.
| name | type | required | description |
|---|---|---|---|
| matchExpressions | []object | ❌ | A list of node selector requirements by node's labels. |
| matchFields | []object | ❌ | A list of node selector requirements by node's fields. |
↩ ParentPGUpgrade.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]
A list of node selector requirements by node's labels.
| name | type | required | 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 | []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. |
↩ ParentPGUpgrade.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]
A list of node selector requirements by node's fields.
| name | type | required | 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 | []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. |
↩ ParentPGUpgrade.spec.affinity.podAffinity
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
| name | type | required | description |
|---|---|---|---|
| preferredDuringSchedulingIgnoredDuringExecution | []object | ❌ | 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. |
| 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 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. |
↩ ParentPGUpgrade.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
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.
| name | type | required | 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. |
↩ ParentPGUpgrade.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm
Required. A pod affinity term, associated with the corresponding weight.
| name | type | required | description |
|---|---|---|---|
| labelSelector | object | ❌ | A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods. |
| matchLabelKeys | []string | ❌ | MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. |
| mismatchLabelKeys | []string | ❌ | MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. |
| 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 | []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. |
↩ ParentPGUpgrade.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector
A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
| name | type | required | description |
|---|---|---|---|
| matchExpressions | []object | ❌ | matchExpressions is a list of label selector requirements. The requirements are ANDed. |
| matchLabels | map[string]: string | ❌ | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
↩ ParentPGUpgrade.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]
matchExpressions is a list of label selector requirements. The requirements are ANDed.
| name | type | required | 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 | []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. |
↩ ParentPGUpgrade.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector
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.
| name | type | required | description |
|---|---|---|---|
| matchExpressions | []object | ❌ | matchExpressions is a list of label selector requirements. The requirements are ANDed. |
| matchLabels | map[string]: string | ❌ | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
↩ ParentPGUpgrade.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]
matchExpressions is a list of label selector requirements. The requirements are ANDed.
| name | type | required | 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 | []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. |