Kind: SGDistributedLogs
listKind: SGDistributedLogsList
plural: sgdistributedlogs
singular: sgdistributedlogs
shortNames sgdil
The SGDistributedLogs custom resource represents a distributed logs cluster.
When a Postgres cluster is configured to use distributed logs, all logs from different sources will be forwarded to the distributed logs cluster.
Under the hood, distributed log cluster use an SGCluster.
Therefore, the distributed log cluster can be queried using SQL as well, for example using postgres-util.
Example:
apiVersion: stackgres.io/v1
kind: SGDistributedLogs
metadata:
name: distributedlogs
spec:
persistentVolume:
size: 10Gi
See also Distribtued Logs section.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| apiVersion | ✓ | string | stackgres.io/v1 | ||
| kind | ✓ | string | SGDistributedLogs | ||
| metadata | ✓ | ✓ | object | Refer to the Kubernetes API documentation for the fields of the metadata field. |
|
| spec | ✓ | ✓ | object |
|
|
| status | ✓ | object |
|
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| persistentVolume | ✓ | ✓ | object |
Pod’s persistent volume configuration |
|
| configurations | ✓ | object |
Cluster custom configurations.
|
||
| metadata | ✓ | object |
Metadata information from cluster created resources. |
||
| nonProductionOptions | ✓ | object |
|
||
| postgresServices | ✓ | object |
Kubernetes services created or managed by StackGres.
|
||
| profile | ✓ | ✓ | string |
The profile allow to change in a convenient place a set of configuration defaults that affect how the cluster is generated.
All those defaults can be overwritten by setting the correspoinding fields. Available profiles are:
Changing this field may require a restart.
|
|
| resources | ✓ | object |
Pod custom resources configuration. |
||
| scheduling | ✓ | ✓ | object |
Pod custom scheduling and affinity configuration.
Changing this field may require a restart.
|
|
| sgInstanceProfile | ✓ | ✓ | string |
Name of the SGInstanceProfile. A SGInstanceProfile defines CPU and memory limits. Must exist before creating a distributed logs. When no profile is set, a default (currently: 1 core, 2 GiB RAM) one is used.
Changing this field may require a restart.
|
|
| toInstallPostgresExtensions | ✓ | []object |
The list of Postgres extensions to install.
This section is filled by the operator.
|
Pod’s persistent volume configuration
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| size | ✓ | string |
Size of the PersistentVolume set for the pod of the cluster for distributed logs. This size is specified either in Mebibytes, Gibibytes or Tebibytes (multiples of 2^20, 2^30 or 2^40, respectively).
|
||
| storageClass | ✓ | string |
Name of an existing StorageClass in the Kubernetes cluster, used to create the PersistentVolumes for the instances of the cluster.
|
Cluster custom configurations.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| sgPostgresConfig | ✓ | ✓ | string |
Name of the SGPostgresConfig used for the distributed logs. It must exist. When not set, a default Postgres config, for the major version selected, is used.
Changing this field may require a restart.
|
Metadata information from cluster created resources.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| annotations | ✓ | object |
Custom Kubernetes annotations to be passed to resources created and managed by StackGres. |
Custom Kubernetes annotations to be passed to resources created and managed by StackGres.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| allResources | ✓ | map[string]string |
Annotations to attach to any resource created or managed by StackGres. |
||
| pods | ✓ | map[string]string |
Annotations to attach to pods created or managed by StackGres. |
||
| services | ✓ | map[string]string |
Annotations to attach to services created or managed by StackGres. |
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| disableClusterPodAntiAffinity | ✓ | ✓ | boolean |
It is a best practice, on non-containerized environments, when running production workloads, to run each database server on a different server (virtual or physical), i.e., not to co-locate more than one database server per host.
The same best practice applies to databases on containers. By default, StackGres will not allow to run more than one StackGres or Distributed Logs pod on a given Kubernetes node. If set to Changing this field may require a restart.
|
|
| disableClusterResourceRequirements | ✓ | ✓ | boolean |
It is a best practice, on containerized environments, when running production workloads, to enforce container’s resources requirements.
By default, StackGres will configure resource requirements for all the containers. Set this property to true to prevent StackGres from setting container’s resources requirements (except for patroni container, see Changing this field may require a restart.
|
|
| disablePatroniResourceRequirements | ✓ | ✓ | boolean |
It is a best practice, on containerized environments, when running production workloads, to enforce container’s resources requirements.
The same best practice applies to databases on containers. By default, StackGres will configure resource requirements for patroni container. Set this property to true to prevent StackGres from setting patroni container’s resources requirement. Changing this field may require a restart.
|
|
| enableSetClusterCpuRequests | ✓ | ✓ | boolean |
Deprecated this value is ignored and you can consider it as always true.
On containerized environments, when running production workloads, enforcing container’s cpu requirements request to be equals to the limit allow to achieve the highest level of performance. Doing so, reduces the chances of leaving the workload with less cpu than it requires. It also allow to set static CPU management policy that allows to guarantee a pod the usage exclusive CPUs on the node. By default, StackGres will configure cpu requirements to have the same limit and request for all the containers. Set this property to true to prevent StackGres from setting container’s cpu requirements request equals to the limit (except for patroni container, see Changing this field may require a restart.
|
|
| enableSetClusterMemoryRequests | ✓ | ✓ | boolean |
Deprecated this value is ignored and you can consider it as always true.
On containerized environments, when running production workloads, enforcing container’s memory requirements request to be equals to the limit allow to achieve the highest level of performance. Doing so, reduces the chances of leaving the workload with less memory than it requires. By default, StackGres will configure memory requirements to have the same limit and request for all the containers. Set this property to true to prevent StackGres from setting container’s memory requirements request equals to the limit (except for patroni container, see Changing this field may require a restart.
|
|
| enableSetPatroniCpuRequests | ✓ | ✓ | boolean |
Deprecated this value is ignored and you can consider it as always true.
On containerized environments, when running production workloads, enforcing container’s cpu requirements request to be equals to the limit allow to achieve the highest level of performance. Doing so, reduces the chances of leaving the workload with less cpu than it requires. It also allow to set static CPU management policy that allows to guarantee a pod the usage exclusive CPUs on the node. By default, StackGres will configure cpu requirements to have the same limit and request for the patroni container. Set this property to true to prevent StackGres from setting patroni container’s cpu requirements request equals to the limit
when Changing this field may require a restart.
|
|
| enableSetPatroniMemoryRequests | ✓ | ✓ | boolean |
Deprecated this value is ignored and you can consider it as always true.
On containerized environments, when running production workloads, enforcing container’s memory requirements request to be equals to the limit allow to achieve the highest level of performance. Doing so, reduces the chances of leaving the workload with less memory than it requires. By default, StackGres will configure memory requirements to have the same limit and request for the patroni container. Set this property to true to prevent StackGres from setting patroni container’s memory requirements request equals to the limit
when Changing this field may require a restart.
|
Kubernetes services created or managed by StackGres.
Example:
apiVersion: stackgres.io/v1
kind: SGDistributedLogs
metadata:
name: stackgres
spec:
postgresServices:
primary:
type: ClusterIP
replicas:
enabled: true
type: ClusterIP
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| primary | ✓ | object |
Configuration for the -primary service. It provides a stable connection (regardless of primary failures or switchovers) to the read-write Postgres server of the cluster. |
||
| replicas | ✓ | object |
Configuration for the -replicas service. It provides a stable connection (regardless of replica node failures) to any read-only Postgres server of the cluster. Read-only servers are load-balanced via this service. |
Configuration for the -primary service. It provides a stable connection (regardless of primary failures or switchovers) to the read-write Postgres server of the cluster.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| annotations | ✓ | map[string]string |
Custom Kubernetes annotations passed to the -primary service.
|
||
| loadBalancerIP | ✓ | string |
Specify loadBalancer IP of Postgres primary service for Distributed Log |
||
| type | ✓ | enum |
Specifies the type of Kubernetes service(`ClusterIP`, `LoadBalancer`, `NodePort`) Enum: ClusterIP, LoadBalancer, NodePort |
Configuration for the -replicas service. It provides a stable connection (regardless of replica node failures) to any read-only Postgres server of the cluster. Read-only servers are load-balanced via this service.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| annotations | ✓ | map[string]string |
Custom Kubernetes annotations passed to the -replicas service. |
||
| enabled | ✓ | boolean |
Specify if the -replicas service should be created or not. |
||
| loadBalancerIP | ✓ | string |
Specify loadBalancer IP of Postgres replica service for Distributed Log |
||
| type | ✓ | enum |
Specifies the type of Kubernetes service(ClusterIP, LoadBalancer, NodePort).Enum: ClusterIP, LoadBalancer, NodePort |
Pod custom resources configuration.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| disableResourcesRequestsSplitFromTotal | ✓ | ✓ | boolean |
When set to true the resources requests values in fields SGInstanceProfile.spec.requests.cpu and SGInstanceProfile.spec.requests.memory will represent the resources
requests of the patroni container and the total resources requests calculated by adding the resources requests of all the containers (including the patroni container).
Changing this field may require a restart.
|
|
| enableClusterLimitsRequirements | ✓ | ✓ | boolean |
When set to true resources limits for containers other than the patroni container wil be set just like for patroni contianer as specified in the SGInstanceProfile.
Changing this field may require a restart.
|
Pod custom scheduling and affinity configuration.
Changing this field may require a restart.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| nodeAffinity | ✓ | ✓ | object |
Node affinity is a group of node affinity scheduling rules.
See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#nodeaffinity-v1-core |
|
| nodeSelector | ✓ | ✓ | map[string]string |
NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
|
|
| podAffinity | ✓ | ✓ | object |
Pod affinity is a group of inter pod affinity scheduling rules.
See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#podaffinity-v1-core |
|
| podAntiAffinity | ✓ | ✓ | object |
Pod anti affinity is a group of inter pod anti affinity scheduling rules.
See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#podantiaffinity-v1-core |
|
| priorityClassName | ✓ | ✓ | string |
If specified, indicates the pod’s priority. “system-node-critical” and “system-cluster-critical” are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. |
|
| tolerations | ✓ | ✓ | []object |
If specified, the pod’s tolerations.
See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#toleration-v1-core |
Node affinity is a group of node affinity scheduling rules.
See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#nodeaffinity-v1-core
Property |
Required |
Updatable |
May Require Restart |
Type |
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 |
A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. |
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| preference | ✓ | ✓ | ✓ | object |
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. |
| weight | ✓ | ✓ | ✓ | integer |
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32 |
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
Property |
Required |
Updatable |
May Require Restart |
Type |
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. |
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| key | ✓ | ✓ | ✓ | string |
The label key that the selector applies to. |
| operator | ✓ | ✓ | ✓ | string |
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
| values | ✓ | ✓ | []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. |
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| key | ✓ | ✓ | ✓ | string |
The label key that the selector applies to. |
| operator | ✓ | ✓ | ✓ | string |
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
| values | ✓ | ✓ | []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. |
A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| nodeSelectorTerms | ✓ | ✓ | ✓ | []object |
Required. A list of node selector terms. The terms are ORed. |
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
Property |
Required |
Updatable |
May Require Restart |
Type |
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. |
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| key | ✓ | ✓ | ✓ | string |
The label key that the selector applies to. |
| operator | ✓ | ✓ | ✓ | string |
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
| values | ✓ | ✓ | []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. |
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| key | ✓ | ✓ | ✓ | string |
The label key that the selector applies to. |
| operator | ✓ | ✓ | ✓ | string |
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
| values | ✓ | ✓ | []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. |
Pod affinity is a group of inter pod affinity scheduling rules.
See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#podaffinity-v1-core
Property |
Required |
Updatable |
May Require Restart |
Type |
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. |
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| podAffinityTerm | ✓ | ✓ | ✓ | object |
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key |
| weight | ✓ | ✓ | ✓ | integer |
weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32 |
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| topologyKey | ✓ | ✓ | ✓ | string |
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
| labelSelector | ✓ | ✓ | object |
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. |
|
| 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 selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. |
|
| 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”. |
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
Property |
Required |
Updatable |
May Require Restart |
Type |
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. |
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| key | ✓ | ✓ | ✓ | string |
key is the label key that the selector applies to. |
| operator | ✓ | ✓ | ✓ | string |
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
| values | ✓ | ✓ | []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. |
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
Property |
Required |
Updatable |
May Require Restart |
Type |
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. |
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| key | ✓ | ✓ | ✓ | string |
key is the label key that the selector applies to. |
| operator | ✓ | ✓ | ✓ | string |
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
| values | ✓ | ✓ | []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. |
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| topologyKey | ✓ | ✓ | ✓ | string |
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
| labelSelector | ✓ | ✓ | object |
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. |
|
| 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 selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. |
|
| 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”. |
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
Property |
Required |
Updatable |
May Require Restart |
Type |
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. |
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| key | ✓ | ✓ | ✓ | string |
key is the label key that the selector applies to. |
| operator | ✓ | ✓ | ✓ | string |
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
| values | ✓ | ✓ | []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. |
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
Property |
Required |
Updatable |
May Require Restart |
Type |
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. |
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| key | ✓ | ✓ | ✓ | string |
key is the label key that the selector applies to. |
| operator | ✓ | ✓ | ✓ | string |
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
| values | ✓ | ✓ | []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. |
Pod anti affinity is a group of inter pod anti affinity scheduling rules.
See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#podantiaffinity-v1-core
Property |
Required |
Updatable |
May Require Restart |
Type |
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. |
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| podAffinityTerm | ✓ | ✓ | ✓ | object |
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key |
| weight | ✓ | ✓ | ✓ | integer |
weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32 |
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| topologyKey | ✓ | ✓ | ✓ | string |
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
| labelSelector | ✓ | ✓ | object |
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. |
|
| 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 selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. |
|
| 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”. |
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
Property |
Required |
Updatable |
May Require Restart |
Type |
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. |
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| key | ✓ | ✓ | ✓ | string |
key is the label key that the selector applies to. |
| operator | ✓ | ✓ | ✓ | string |
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
| values | ✓ | ✓ | []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. |
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
Property |
Required |
Updatable |
May Require Restart |
Type |
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. |
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| key | ✓ | ✓ | ✓ | string |
key is the label key that the selector applies to. |
| operator | ✓ | ✓ | ✓ | string |
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
| values | ✓ | ✓ | []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. |
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| topologyKey | ✓ | ✓ | ✓ | string |
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
| labelSelector | ✓ | ✓ | object |
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. |
|
| 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 selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. |
|
| 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”. |
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
Property |
Required |
Updatable |
May Require Restart |
Type |
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. |
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| key | ✓ | ✓ | ✓ | string |
key is the label key that the selector applies to. |
| operator | ✓ | ✓ | ✓ | string |
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
| values | ✓ | ✓ | []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. |
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
Property |
Required |
Updatable |
May Require Restart |
Type |
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. |
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| key | ✓ | ✓ | ✓ | string |
key is the label key that the selector applies to. |
| operator | ✓ | ✓ | ✓ | string |
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
| values | ✓ | ✓ | []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. |
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| effect | ✓ | ✓ | string |
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. |
|
| key | ✓ | ✓ | string |
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. |
|
| operator | ✓ | ✓ | string |
Operator represents a key’s relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. |
|
| tolerationSeconds | ✓ | ✓ | integer |
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64 |
|
| 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. |
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| name | ✓ | ✓ | string |
The name of the extension to install. |
|
| postgresVersion | ✓ | ✓ | string |
The postgres major version of the extension to install. |
|
| publisher | ✓ | ✓ | string |
The id of the publisher of the extension to install. |
|
| repository | ✓ | ✓ | string |
The repository base URL from where the extension will be installed from. |
|
| version | ✓ | ✓ | string |
The version of the extension to install. |
|
| build | ✓ | string |
The build version of the extension to install. |
||
| extraMounts | ✓ | []string |
The extra mounts of the extension to install. |
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| arch | ✓ | string |
The architecture on which the cluster has been initialized. |
||
| conditions | ✓ | []object |
|
||
| connectedClusters | ✓ | []object |
The list of connected sgclusters |
||
| databases | ✓ | []object |
The list of database status |
||
| fluentdConfigHash | ✓ | string |
The hash of the configuration file that is used by fluentd |
||
| labelPrefix | ✓ | string |
The custom prefix that is prepended to all labels. |
||
| os | ✓ | string |
The operative system on which the cluster has been initialized. |
||
| podStatuses | ✓ | []object |
The list of pod statuses. |
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| lastTransitionTime | ✓ | string |
Last time the condition transitioned from one status to another. |
||
| message | ✓ | string |
A human readable message indicating details about the transition. |
||
| reason | ✓ | string |
The reason for the condition’s last transition. |
||
| status | ✓ | string |
Status of the condition, one of True, False, Unknown. |
||
| type | ✓ | string |
Type of deployment condition. |
A connected sgcluster
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| config | ✓ | object |
The configuration for sgdistributedlgos of this sgcluster |
||
| name | ✓ | string |
The sgcluster name |
||
| namespace | ✓ | string |
The sgcluster namespace |
The configuration for sgdistributedlgos of this sgcluster
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| retention | ✓ | string |
The retention window that has been applied to tables |
||
| sgDistributedLogs | ✓ | string |
The sgdistributedlogs to which this sgcluster is connected to |
A database status
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| name | ✓ | string |
The database name that has been created |
||
| retention | ✓ | string |
The retention window that has been applied to tables |
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| name | ✓ | ✓ | string |
The name of the pod. |
|
| installedPostgresExtensions | ✓ | []object |
The list of extensions currently installed. |
||
| pendingRestart | ✓ | boolean |
Indicates if the pod requires restart |
||
| primary | ✓ | boolean |
Indicates if the pod is the elected primary |
Property |
Required |
Updatable |
May Require Restart |
Type |
Description |
|---|---|---|---|---|---|
| name | ✓ | ✓ | string |
The name of the installed extension. |
|
| postgresVersion | ✓ | ✓ | string |
The postgres major version of the installed extension. |
|
| publisher | ✓ | ✓ | string |
The id of the publisher of the installed extension. |
|
| repository | ✓ | ✓ | string |
The repository base URL from where the extension was installed. |
|
| version | ✓ | ✓ | string |
The version of the installed extension. |
|
| build | ✓ | string |
The build version of the installed extension. |