PGAdmin

PGAdmin

PGAdmin is the Schema for the pgadmins API

nametyperequireddescription
apiVersionstring✅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
kindstring✅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
metadataobject✅Kubernetes resource namespace, name, labels, and annotations
specobject❌PGAdminSpec defines the desired state of PGAdmin
statusobject❌PGAdminStatus defines the observed state of PGAdmin

↩ ParentPGAdmin.spec

PGAdminSpec defines the desired state of PGAdmin

nametyperequireddescription
affinityobject❌Scheduling constraints of the PGAdmin pod. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node
configobject❌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.
dataVolumeClaimSpecobject✅Defines a PersistentVolumeClaim for pgAdmin data. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
imagestring❌The image name to use for pgAdmin instance.
imagePullPolicyAlways, 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/
metadataobject❌Metadata contains metadata for custom resources
priorityClassNamestring❌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/
resourcesobject❌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.
tolerations[]object❌Tolerations of the PGAdmin pod. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration

↩ ParentPGAdmin.spec.affinity

Scheduling constraints of the PGAdmin pod. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node

nametyperequireddescription
nodeAffinityobject❌Describes node affinity scheduling rules for the pod.
podAffinityobject❌Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
podAntiAffinityobject❌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.

nametyperequireddescription
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.
requiredDuringSchedulingIgnoredDuringExecutionobject❌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.

nametyperequireddescription
preferenceobject✅A node selector term, associated with the corresponding weight.
weightinteger✅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.

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

nametyperequireddescription
keystring✅The label key that the selector applies to.
operatorstring✅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.

nametyperequireddescription
keystring✅The label key that the selector applies to.
operatorstring✅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.

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

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

nametyperequireddescription
keystring✅The label key that the selector applies to.
operatorstring✅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.

nametyperequireddescription
keystring✅The label key that the selector applies to.
operatorstring✅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)).

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

nametyperequireddescription
podAffinityTermobject✅Required. A pod affinity term, associated with the corresponding weight.
weightinteger✅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.

nametyperequireddescription
labelSelectorobject❌A label query over a set of resources, in this case pods.
namespaceSelectorobject❌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".
topologyKeystring✅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.

nametyperequireddescription
matchExpressions[]object❌matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabelsmap[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.

nametyperequireddescription
keystring✅key is the label key that the selector applies to.
operatorstring✅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.

nametyperequireddescription
matchExpressions[]object❌matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabelsmap[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.

nametyperequireddescription
keystring✅key is the label key that the selector applies to.
operatorstring✅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.

nametyperequireddescription
labelSelectorobject❌A label query over a set of resources, in this case pods.
namespaceSelectorobject❌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".
topologyKeystring✅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.

nametyperequireddescription
matchExpressions[]object❌matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabelsmap[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.

nametyperequireddescription
keystring✅key is the label key that the selector applies to.
operatorstring✅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.

nametyperequireddescription
matchExpressions[]object❌matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabelsmap[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.

nametyperequireddescription
keystring✅key is the label key that the selector applies to.
operatorstring✅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)).

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

nametyperequireddescription
podAffinityTermobject✅Required. A pod affinity term, associated with the corresponding weight.
weightinteger✅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.

nametyperequireddescription
labelSelectorobject❌A label query over a set of resources, in this case pods.
namespaceSelectorobject❌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".
topologyKeystring✅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.

nametyperequireddescription
matchExpressions[]object❌matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabelsmap[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.

nametyperequireddescription
keystring✅key is the label key that the selector applies to.
operatorstring✅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.

nametyperequireddescription
matchExpressions[]object❌matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabelsmap[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.

nametyperequireddescription
keystring✅key is the label key that the selector applies to.
operatorstring✅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.

nametyperequireddescription
labelSelectorobject❌A label query over a set of resources, in this case pods.
namespaceSelectorobject❌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".
topologyKeystring✅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.

nametyperequireddescription
matchExpressions[]object❌matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabelsmap[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.

nametyperequireddescription
keystring✅key is the label key that the selector applies to.
operatorstring✅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.

nametyperequireddescription
matchExpressions[]object❌matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabelsmap[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.

nametyperequireddescription
keystring✅key is the label key that the selector applies to.
operatorstring✅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.

nametyperequireddescription
files[]object❌Files allows the user to mount projected volumes into the pgAdmin container so that files can be referenced by pgAdmin as needed.
ldapBindPasswordobject❌A Secret containing the value for the LDAP_BIND_PASSWORD setting. More info: https://www.pgadmin.org/docs/pgadmin4/latest/ldap.html
settingsobject❌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.files[index]

Files allows the user to mount projected volumes into the pgAdmin container so that files can be referenced by pgAdmin as needed.

nametyperequireddescription
configMapobject❌configMap information about the configMap data to project
downwardAPIobject❌downwardAPI information about the downwardAPI data to project
secretobject❌secret information about the secret data to project
serviceAccountTokenobject❌serviceAccountToken is information about the serviceAccountToken data to project

↩ ParentPGAdmin.spec.config.files[index].configMap

configMap information about the configMap data to project

nametyperequireddescription
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 '..'.
namestring❌Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalboolean❌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 '..'.

nametyperequireddescription
keystring✅key is the key to project.
modeinteger❌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.
pathstring✅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

nametyperequireddescription
items[]object❌Items is a list of DownwardAPIVolume file

↩ ParentPGAdmin.spec.config.files[index].downwardAPI.items[index]

Items is a list of DownwardAPIVolume file

nametyperequireddescription
fieldRefobject❌Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
modeinteger❌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.
pathstring✅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 '..'
resourceFieldRefobject❌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 and namespace are supported.

nametyperequireddescription
apiVersionstring❌Version of the schema the FieldPath is written in terms of, defaults to "v1".
fieldPathstring✅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.

nametyperequireddescription
containerNamestring❌Container name: required for volumes, optional for env vars
divisorint or string❌Specifies the output format of the exposed resources, defaults to "1"
resourcestring✅Required: resource to select

↩ ParentPGAdmin.spec.config.files[index].secret

secret information about the secret data to project

nametyperequireddescription
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 '..'.
namestring❌Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalboolean❌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 '..'.

nametyperequireddescription
keystring✅key is the key to project.
modeinteger❌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.
pathstring✅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

nametyperequireddescription
audiencestring❌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.
expirationSecondsinteger❌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.
pathstring✅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

nametyperequireddescription
keystring✅The key of the secret to select from. Must be a valid secret key.
namestring❌Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalboolean❌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

nametyperequireddescription
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
dataSourceobject❌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. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.
dataSourceRefobject❌dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local 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, 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. There are two 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. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
resourcesobject❌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
selectorobject❌selector is a label query over volumes to consider for binding.
storageClassNamestring❌storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
volumeModestring❌volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
volumeNamestring❌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. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

nametyperequireddescription
apiGroupstring❌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.
kindstring✅Kind is the type of resource being referenced
namestring✅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 local 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, 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. There are two 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. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

nametyperequireddescription
apiGroupstring❌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.
kindstring✅Kind is the type of resource being referenced
namestring✅Name is the name of resource being referenced

↩ 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

nametyperequireddescription
limitsmap[string]: int or string❌Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
requestsmap[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. 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.

nametyperequireddescription
matchExpressions[]object❌matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabelsmap[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.

nametyperequireddescription
keystring✅key is the label key that the selector applies to.
operatorstring✅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/

nametyperequireddescription
namestring❌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

nametyperequireddescription
annotationsmap[string]: string❌undefined
labelsmap[string]: string❌undefined

↩ ParentPGAdmin.spec.resources

Resource requirements for the PGAdmin container.

nametyperequireddescription
limitsmap[string]: int or string❌Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
requestsmap[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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

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

nametyperequireddescription
namestring✅The name for the ServerGroup in pgAdmin. Must be unique in the pgAdmin's ServerGroups since it becomes the ServerGroup name in pgAdmin.
postgresClusterSelectorobject✅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.

nametyperequireddescription
matchExpressions[]object❌matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabelsmap[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.

nametyperequireddescription
keystring✅key is the label key that the selector applies to.
operatorstring✅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

nametyperequireddescription
effectstring❌Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
keystring❌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.
operatorstring❌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.
tolerationSecondsinteger❌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.
valuestring❌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.status

PGAdminStatus defines the observed state of PGAdmin

nametyperequireddescription
conditions[]object❌conditions represent the observations of pgadmin's current state. Known .status.conditions.type are: "PersistentVolumeResizing", "Progressing", "ProxyAvailable"
observedGenerationinteger❌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 are: "PersistentVolumeResizing", "Progressing", "ProxyAvailable"

nametyperequireddescription
lastTransitionTimestring✅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.
messagestring✅message is a human readable message indicating details about the transition. This may be an empty string.
observedGenerationinteger❌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.
reasonstring✅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.
statusTrue, False, Unknown✅status of the condition, one of True, False, Unknown.
typestring✅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)