PGAdmin
PGAdmin
PGAdmin is the Schema for the PGAdmin 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 | ❌ | PGAdminSpec defines the desired state of PGAdmin |
status | object | ❌ | PGAdminStatus defines the observed state of PGAdmin |
↩ ParentPGAdmin.spec
PGAdminSpec defines the desired state of PGAdmin
name | type | required | description |
---|---|---|---|
affinity | object | ❌ | Scheduling constraints of the PGAdmin pod. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node |
config | object | ❌ | Configuration settings for the pgAdmin process. Changes to any of these values will be loaded without validation. Be careful, as you may put pgAdmin into an unusable state. |
dataVolumeClaimSpec | object | ✅ | Defines a PersistentVolumeClaim for pgAdmin data. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes |
image | string | ❌ | The image name to use for pgAdmin instance. |
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 PGAdmin pods to restart. https://k8s.io/docs/tasks/configure-pod-container/pull-image-private-registry/ |
metadata | object | ❌ | Metadata contains metadata for custom resources |
priorityClassName | string | ❌ | Priority class name for the PGAdmin pod. Changing this value causes PGAdmin pod to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/ |
resources | object | ❌ | Resource requirements for the PGAdmin container. |
serverGroups | []object | ❌ | ServerGroups for importing PostgresClusters to pgAdmin. To create a pgAdmin with no selectors, leave this field empty. A pgAdmin created with no ServerGroups will not automatically add any servers through discovery. PostgresClusters can still be added manually. |
serviceName | string | ❌ | ServiceName will be used as the name of a ClusterIP service pointing to the pgAdmin pod and port. If the service already exists, PGO will update the service. For more information about services reference the Kubernetes and CrunchyData documentation. https://kubernetes.io/docs/concepts/services-networking/service/ |
tolerations | []object | ❌ | Tolerations of the PGAdmin pod. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration |
users | []object | ❌ | pgAdmin users that are managed via the PGAdmin spec. Users can still be added via the pgAdmin GUI, but those users will not show up here. |
↩ ParentPGAdmin.spec.affinity
Scheduling constraints of the PGAdmin 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)). |
↩ ParentPGAdmin.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. |
↩ ParentPGAdmin.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. |
↩ ParentPGAdmin.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. |
↩ ParentPGAdmin.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. |
↩ ParentPGAdmin.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. |
↩ ParentPGAdmin.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. |
↩ ParentPGAdmin.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. |
↩ ParentPGAdmin.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. |
↩ ParentPGAdmin.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. |
↩ ParentPGAdmin.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. |
↩ ParentPGAdmin.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. |
↩ ParentPGAdmin.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. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. |
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. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. |
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. |
↩ ParentPGAdmin.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. |
↩ ParentPGAdmin.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. |
↩ ParentPGAdmin.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. |
↩ ParentPGAdmin.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. |
↩ ParentPGAdmin.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]
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.
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. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. |
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. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. |
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. |
↩ ParentPGAdmin.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].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. |
↩ ParentPGAdmin.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].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. |
↩ ParentPGAdmin.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].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. |
↩ ParentPGAdmin.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].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. |
↩ ParentPGAdmin.spec.affinity.podAntiAffinity
Describes pod anti-affinity scheduling rules (e.g. avoid putting 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 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. |
requiredDuringSchedulingIgnoredDuringExecution | []object | ❌ | 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. |
↩ ParentPGAdmin.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
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.
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. |
↩ ParentPGAdmin.spec.affinity.podAntiAffinity.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. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. |
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. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. |
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. |
↩ ParentPGAdmin.spec.affinity.podAntiAffinity.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. |
↩ ParentPGAdmin.spec.affinity.podAntiAffinity.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. |
↩ ParentPGAdmin.spec.affinity.podAntiAffinity.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. |
↩ ParentPGAdmin.spec.affinity.podAntiAffinity.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. |
↩ ParentPGAdmin.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]
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.
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. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. |
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. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. |
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. |
↩ ParentPGAdmin.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].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. |
↩ ParentPGAdmin.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].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. |
↩ ParentPGAdmin.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].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. |
↩ ParentPGAdmin.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].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. |
↩ ParentPGAdmin.spec.config
Configuration settings for the pgAdmin process. Changes to any of these values will be loaded without validation. Be careful, as you may put pgAdmin into an unusable state.
name | type | required | description |
---|---|---|---|
configDatabaseURI | object | ❌ | A Secret containing the value for the CONFIG_DATABASE_URI setting. More info: https://www.pgadmin.org/docs/pgadmin4/latest/external_database.html |
files | []object | ❌ | Files allows the user to mount projected volumes into the pgAdmin container so that files can be referenced by pgAdmin as needed. |
gunicorn | object | ❌ | Settings for the gunicorn server. More info: https://docs.gunicorn.org/en/latest/settings.html |
ldapBindPassword | object | ❌ | A Secret containing the value for the LDAP_BIND_PASSWORD setting. More info: https://www.pgadmin.org/docs/pgadmin4/latest/ldap.html |
settings | object | ❌ | Settings for the pgAdmin server process. Keys should be uppercase and values must be constants. More info: https://www.pgadmin.org/docs/pgadmin4/latest/config_py.html |
↩ ParentPGAdmin.spec.config.configDatabaseURI
A Secret containing the value for the CONFIG_DATABASE_URI setting. More info: https://www.pgadmin.org/docs/pgadmin4/latest/external_database.html
name | type | required | description |
---|---|---|---|
key | string | ✅ | The key of the secret to select from. Must be a valid secret key. |
name | string | ❌ | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | ❌ | Specify whether the Secret or its key must be defined |
↩ ParentPGAdmin.spec.config.files[index]
Files allows the user to mount projected volumes into the pgAdmin container so that files can be referenced by pgAdmin as needed.
name | type | required | description |
---|---|---|---|
clusterTrustBundle | object | ❌ | ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time. |
configMap | object | ❌ | configMap information about the configMap data to project |
downwardAPI | object | ❌ | downwardAPI information about the downwardAPI data to project |
secret | object | ❌ | secret information about the secret data to project |
serviceAccountToken | object | ❌ | serviceAccountToken is information about the serviceAccountToken data to project |
↩ ParentPGAdmin.spec.config.files[index].clusterTrustBundle
ClusterTrustBundle allows a pod to access the .spec.trustBundle
field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.
name | type | required | description |
---|---|---|---|
labelSelector | object | ❌ | Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything". |
name | string | ❌ | Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector. |
optional | boolean | ❌ | If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles. |
path | string | ✅ | Relative path from the volume root to write the bundle. |
signerName | string | ❌ | Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated. |
↩ ParentPGAdmin.spec.config.files[index].clusterTrustBundle.labelSelector
Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".
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. |
↩ ParentPGAdmin.spec.config.files[index].clusterTrustBundle.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. |
↩ ParentPGAdmin.spec.config.files[index].configMap
configMap information about the configMap data to project
name | type | required | description |
---|---|---|---|
items | []object | ❌ | items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. |
name | string | ❌ | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | ❌ | optional specify whether the ConfigMap or its keys must be defined |
↩ ParentPGAdmin.spec.config.files[index].configMap.items[index]
items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name | type | required | description |
---|---|---|---|
key | string | ✅ | key is the key to project. |
mode | integer | ❌ | mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
path | string | ✅ | path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |
↩ ParentPGAdmin.spec.config.files[index].downwardAPI
downwardAPI information about the downwardAPI data to project
name | type | required | description |
---|---|---|---|
items | []object | ❌ | Items is a list of DownwardAPIVolume file |
↩ ParentPGAdmin.spec.config.files[index].downwardAPI.items[index]
Items is a list of DownwardAPIVolume file
name | type | required | description |
---|---|---|---|
fieldRef | object | ❌ | Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. |
mode | integer | ❌ | Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
path | string | ✅ | Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' |
resourceFieldRef | object | ❌ | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |
↩ ParentPGAdmin.spec.config.files[index].downwardAPI.items[index].fieldRef
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
name | type | required | description |
---|---|---|---|
apiVersion | string | ❌ | Version of the schema the FieldPath is written in terms of, defaults to "v1". |
fieldPath | string | ✅ | Path of the field to select in the specified API version. |
↩ ParentPGAdmin.spec.config.files[index].downwardAPI.items[index].resourceFieldRef
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
name | type | required | description |
---|---|---|---|
containerName | string | ❌ | Container name: required for volumes, optional for env vars |
divisor | int or string | ❌ | Specifies the output format of the exposed resources, defaults to "1" |
resource | string | ✅ | Required: resource to select |
↩ ParentPGAdmin.spec.config.files[index].secret
secret information about the secret data to project
name | type | required | description |
---|---|---|---|
items | []object | ❌ | items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. |
name | string | ❌ | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | ❌ | optional field specify whether the Secret or its key must be defined |
↩ ParentPGAdmin.spec.config.files[index].secret.items[index]
items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name | type | required | description |
---|---|---|---|
key | string | ✅ | key is the key to project. |
mode | integer | ❌ | mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
path | string | ✅ | path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |
↩ ParentPGAdmin.spec.config.files[index].serviceAccountToken
serviceAccountToken is information about the serviceAccountToken data to project
name | type | required | description |
---|---|---|---|
audience | string | ❌ | audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. |
expirationSeconds | integer | ❌ | expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. |
path | string | ✅ | path is the path relative to the mount point of the file to project the token into. |
↩ ParentPGAdmin.spec.config.ldapBindPassword
A Secret containing the value for the LDAP_BIND_PASSWORD setting. More info: https://www.pgadmin.org/docs/pgadmin4/latest/ldap.html
name | type | required | description |
---|---|---|---|
key | string | ✅ | The key of the secret to select from. Must be a valid secret key. |
name | string | ❌ | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | ❌ | Specify whether the Secret or its key must be defined |
↩ ParentPGAdmin.spec.dataVolumeClaimSpec
Defines a PersistentVolumeClaim for pgAdmin data. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
name | type | required | description |
---|---|---|---|
accessModes | []string | ❌ | accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
dataSource | object | ❌ | dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource. |
dataSourceRef | object | ❌ | dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled. |
resources | object | ❌ | resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
selector | object | ❌ | selector is a label query over volumes to consider for binding. |
storageClassName | string | ❌ | storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
volumeAttributesClassName | string | ❌ | volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled. |
volumeMode | string | ❌ | volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. |
volumeName | string | ❌ | volumeName is the binding reference to the PersistentVolume backing this claim. |
↩ ParentPGAdmin.spec.dataVolumeClaimSpec.dataSource
dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.
name | type | required | description |
---|---|---|---|
apiGroup | string | ❌ | APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
kind | string | ✅ | Kind is the type of resource being referenced |
name | string | ✅ | Name is the name of resource being referenced |
↩ ParentPGAdmin.spec.dataVolumeClaimSpec.dataSourceRef
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
name | type | required | description |
---|---|---|---|
apiGroup | string | ❌ | APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
kind | string | ✅ | Kind is the type of resource being referenced |
name | string | ✅ | Name is the name of resource being referenced |
namespace | string | ❌ | Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled. |
↩ ParentPGAdmin.spec.dataVolumeClaimSpec.resources
resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
name | type | required | description |
---|---|---|---|
limits | map[string]: int or string | ❌ | Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
requests | map[string]: int 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/ |
↩ ParentPGAdmin.spec.dataVolumeClaimSpec.selector
selector is a label query over volumes to consider for binding.
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. |
↩ ParentPGAdmin.spec.dataVolumeClaimSpec.selector.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. |
↩ ParentPGAdmin.spec.imagePullSecrets[index]
The image pull secrets used to pull from a private registry. Changing this value causes all running PGAdmin pods to restart. https://k8s.io/docs/tasks/configure-pod-container/pull-image-private-registry/
name | type | required | description |
---|---|---|---|
name | string | ❌ | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
↩ ParentPGAdmin.spec.metadata
Metadata contains metadata for custom resources
name | type | required | description |
---|---|---|---|
annotations | map[string]: string | ❌ | undefined |
labels | map[string]: string | ❌ | undefined |
↩ ParentPGAdmin.spec.resources
Resource requirements for the PGAdmin container.
name | type | required | description |
---|---|---|---|
claims | []object | ❌ | 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. |
limits | map[string]: int or string | ❌ | Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
requests | map[string]: int 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/ |
↩ ParentPGAdmin.spec.resources.claims[index]
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.
name | type | required | 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. |
↩ ParentPGAdmin.spec.serverGroups[index]
ServerGroups for importing PostgresClusters to pgAdmin. To create a pgAdmin with no selectors, leave this field empty. A pgAdmin created with no ServerGroups
will not automatically add any servers through discovery. PostgresClusters can still be added manually.
name | type | required | description |
---|---|---|---|
name | string | ✅ | The name for the ServerGroup in pgAdmin. Must be unique in the pgAdmin's ServerGroups since it becomes the ServerGroup name in pgAdmin. |
postgresClusterName | string | ❌ | PostgresClusterName selects one cluster to add to pgAdmin by name. |
postgresClusterSelector | object | ❌ | PostgresClusterSelector selects clusters to dynamically add to pgAdmin by matching labels. An empty selector like {} will select ALL clusters in the namespace. |
↩ ParentPGAdmin.spec.serverGroups[index].postgresClusterSelector
PostgresClusterSelector selects clusters to dynamically add to pgAdmin by matching labels. An empty selector like {}
will select ALL clusters in the namespace.
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. |
↩ ParentPGAdmin.spec.serverGroups[index].postgresClusterSelector.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. |
↩ ParentPGAdmin.spec.tolerations[index]
Tolerations of the PGAdmin pod. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration
name | type | required | 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. |
↩ ParentPGAdmin.spec.users[index]
pgAdmin users that are managed via the PGAdmin spec. Users can still be added via the pgAdmin GUI, but those users will not show up here.
name | type | required | description |
---|---|---|---|
passwordRef | object | ✅ | A reference to the secret that holds the user's password. |
role | Administrator , User | ❌ | Role determines whether the user has admin privileges or not. Defaults to User. Valid options are Administrator and User. |
username | string | ✅ | The username for User in pgAdmin. Must be unique in the pgAdmin's users list. |
↩ ParentPGAdmin.spec.users[index].passwordRef
A reference to the secret that holds the user's password.
name | type | required | description |
---|---|---|---|
key | string | ✅ | The key of the secret to select from. Must be a valid secret key. |
name | string | ❌ | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | ❌ | Specify whether the Secret or its key must be defined |
↩ ParentPGAdmin.status
PGAdminStatus defines the observed state of PGAdmin
name | type | required | description |
---|---|---|---|
conditions | []object | ❌ | conditions represent the observations of pgAdmin's current state. Known .status.conditions.type is: "PersistentVolumeResizing" |
imageSHA | string | ❌ | ImageSHA represents the image SHA for the container running pgAdmin. |
majorVersion | integer | ❌ | MajorVersion represents the major version of the running pgAdmin. |
observedGeneration | integer | ❌ | observedGeneration represents the .metadata.generation on which the status was based. |
↩ ParentPGAdmin.status.conditions[index]
conditions represent the observations of pgAdmin's current state. Known .status.conditions.type is: "PersistentVolumeResizing"
name | type | required | description |
---|---|---|---|
lastTransitionTime | string | ✅ | lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. |
message | string | ✅ | message is a human readable message indicating details about the transition. This may be an empty string. |
observedGeneration | integer | ❌ | observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. |
reason | string | ✅ | reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. |
status | True , False , Unknown | ✅ | status of the condition, one of True, False, Unknown. |
type | string | ✅ | type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) |