diff --git a/1.18.5/_gen/postgresql/v1/cluster.libsonnet b/1.18.5/_gen/postgresql/v1/cluster.libsonnet index 40186b4..2619ec6 100644 --- a/1.18.5/_gen/postgresql/v1/cluster.libsonnet +++ b/1.18.5/_gen/postgresql/v1/cluster.libsonnet @@ -555,6 +555,10 @@ withOnline(online): { spec+: { backup+: { volumeSnapshot+: { online: online } } } }, '#withSnapshotOwnerReference':: d.fn(help='"SnapshotOwnerReference indicates the type of owner reference the snapshot should have"', args=[d.arg(name='snapshotOwnerReference', type=d.T.string)]), withSnapshotOwnerReference(snapshotOwnerReference): { spec+: { backup+: { volumeSnapshot+: { snapshotOwnerReference: snapshotOwnerReference } } } }, + '#withTablespaceClassName':: d.fn(help='"TablespaceClassName specifies the Snapshot Class to be used for the tablespaces. defaults to the PGDATA Snapshot Class, if set"', args=[d.arg(name='tablespaceClassName', type=d.T.object)]), + withTablespaceClassName(tablespaceClassName): { spec+: { backup+: { volumeSnapshot+: { tablespaceClassName: tablespaceClassName } } } }, + '#withTablespaceClassNameMixin':: d.fn(help='"TablespaceClassName specifies the Snapshot Class to be used for the tablespaces. defaults to the PGDATA Snapshot Class, if set"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='tablespaceClassName', type=d.T.object)]), + withTablespaceClassNameMixin(tablespaceClassName): { spec+: { backup+: { volumeSnapshot+: { tablespaceClassName+: tablespaceClassName } } } }, '#withWalClassName':: d.fn(help='"WalClassName specifies the Snapshot Class to be used for the PG_WAL PersistentVolumeClaim."', args=[d.arg(name='walClassName', type=d.T.string)]), withWalClassName(walClassName): { spec+: { backup+: { volumeSnapshot+: { walClassName: walClassName } } } }, }, @@ -724,6 +728,10 @@ '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), withName(name): { spec+: { bootstrap+: { recovery+: { volumeSnapshots+: { walStorage+: { name: name } } } } } }, }, + '#withTablespaceStorage':: d.fn(help='"Configuration of the storage for PostgreSQL tablespaces"', args=[d.arg(name='tablespaceStorage', type=d.T.object)]), + withTablespaceStorage(tablespaceStorage): { spec+: { bootstrap+: { recovery+: { volumeSnapshots+: { tablespaceStorage: tablespaceStorage } } } } }, + '#withTablespaceStorageMixin':: d.fn(help='"Configuration of the storage for PostgreSQL tablespaces"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='tablespaceStorage', type=d.T.object)]), + withTablespaceStorageMixin(tablespaceStorage): { spec+: { bootstrap+: { recovery+: { volumeSnapshots+: { tablespaceStorage+: tablespaceStorage } } } } }, }, '#withDatabase':: d.fn(help='"Name of the database used by the application. Default: `app`."', args=[d.arg(name='database', type=d.T.string)]), withDatabase(database): { spec+: { bootstrap+: { recovery+: { database: database } } } }, @@ -942,7 +950,7 @@ '#withTagsMixin':: d.fn(help='"Tags is a list of key value pairs that will be passed to the Barman --tags option."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='tags', type=d.T.object)]), withTagsMixin(tags): { barmanObjectStore+: { tags+: tags } }, }, - '#password':: d.obj(help='"The reference to the password to be used to connect to the server"'), + '#password':: d.obj(help="\"The reference to the password to be used to connect to the server. If a password is provided, CloudNativePG creates a PostgreSQL passfile at `/controller/external/NAME/pass` (where \\\"NAME\\\" is the cluster's name). This passfile is automatically referenced in the connection string when establishing a connection to the remote PostgreSQL server from the current PostgreSQL `Cluster`. This ensures secure and efficient password management for external clusters.\""), password: { '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), withKey(key): { password+: { key: key } }, @@ -1062,6 +1070,44 @@ '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), withName(name): { name: name }, }, + '#podMonitorMetricRelabelings':: d.obj(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."'), + podMonitorMetricRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching. \\n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \\n Default: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values. \\n Only applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the regular expression matches. \\n Regex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement. \\n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \\n Regex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#podMonitorRelabelings':: d.obj(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."'), + podMonitorRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching. \\n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \\n Default: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values. \\n Only applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the regular expression matches. \\n Regex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement. \\n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \\n Regex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, '#withCustomQueriesConfigMap':: d.fn(help='"The list of config maps containing the custom queries"', args=[d.arg(name='customQueriesConfigMap', type=d.T.array)]), withCustomQueriesConfigMap(customQueriesConfigMap): { spec+: { monitoring+: { customQueriesConfigMap: if std.isArray(v=customQueriesConfigMap) then customQueriesConfigMap else [customQueriesConfigMap] } } }, '#withCustomQueriesConfigMapMixin':: d.fn(help='"The list of config maps containing the custom queries"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='customQueriesConfigMap', type=d.T.array)]), @@ -1074,6 +1120,14 @@ withDisableDefaultQueries(disableDefaultQueries): { spec+: { monitoring+: { disableDefaultQueries: disableDefaultQueries } } }, '#withEnablePodMonitor':: d.fn(help='"Enable or disable the `PodMonitor`"', args=[d.arg(name='enablePodMonitor', type=d.T.boolean)]), withEnablePodMonitor(enablePodMonitor): { spec+: { monitoring+: { enablePodMonitor: enablePodMonitor } } }, + '#withPodMonitorMetricRelabelings':: d.fn(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."', args=[d.arg(name='podMonitorMetricRelabelings', type=d.T.array)]), + withPodMonitorMetricRelabelings(podMonitorMetricRelabelings): { spec+: { monitoring+: { podMonitorMetricRelabelings: if std.isArray(v=podMonitorMetricRelabelings) then podMonitorMetricRelabelings else [podMonitorMetricRelabelings] } } }, + '#withPodMonitorMetricRelabelingsMixin':: d.fn(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podMonitorMetricRelabelings', type=d.T.array)]), + withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings): { spec+: { monitoring+: { podMonitorMetricRelabelings+: if std.isArray(v=podMonitorMetricRelabelings) then podMonitorMetricRelabelings else [podMonitorMetricRelabelings] } } }, + '#withPodMonitorRelabelings':: d.fn(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."', args=[d.arg(name='podMonitorRelabelings', type=d.T.array)]), + withPodMonitorRelabelings(podMonitorRelabelings): { spec+: { monitoring+: { podMonitorRelabelings: if std.isArray(v=podMonitorRelabelings) then podMonitorRelabelings else [podMonitorRelabelings] } } }, + '#withPodMonitorRelabelingsMixin':: d.fn(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podMonitorRelabelings', type=d.T.array)]), + withPodMonitorRelabelingsMixin(podMonitorRelabelings): { spec+: { monitoring+: { podMonitorRelabelings+: if std.isArray(v=podMonitorRelabelings) then podMonitorRelabelings else [podMonitorRelabelings] } } }, }, '#nodeMaintenanceWindow':: d.obj(help='"Define a maintenance window for the Kubernetes nodes"'), nodeMaintenanceWindow: { @@ -1131,6 +1185,8 @@ '#withNodeLabelsAntiAffinityMixin':: d.fn(help='"A list of node labels values to extract and compare to evaluate if the pods reside in the same topology or not"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='nodeLabelsAntiAffinity', type=d.T.array)]), withNodeLabelsAntiAffinityMixin(nodeLabelsAntiAffinity): { spec+: { postgresql+: { syncReplicaElectionConstraint+: { nodeLabelsAntiAffinity+: if std.isArray(v=nodeLabelsAntiAffinity) then nodeLabelsAntiAffinity else [nodeLabelsAntiAffinity] } } } }, }, + '#withEnableAlterSystem':: d.fn(help='"If this parameter is true, the user will be able to invoke `ALTER SYSTEM` on this CloudNativePG Cluster. This should only be used for debugging and troubleshooting. Defaults to false."', args=[d.arg(name='enableAlterSystem', type=d.T.boolean)]), + withEnableAlterSystem(enableAlterSystem): { spec+: { postgresql+: { enableAlterSystem: enableAlterSystem } } }, '#withParameters':: d.fn(help='"PostgreSQL configuration options (postgresql.conf)"', args=[d.arg(name='parameters', type=d.T.object)]), withParameters(parameters): { spec+: { postgresql+: { parameters: parameters } } }, '#withParametersMixin':: d.fn(help='"PostgreSQL configuration options (postgresql.conf)"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='parameters', type=d.T.object)]), @@ -1378,7 +1434,7 @@ withResizeInUseVolumes(resizeInUseVolumes): { spec+: { storage+: { resizeInUseVolumes: resizeInUseVolumes } } }, '#withSize':: d.fn(help='"Size of the storage. Required if not already specified in the PVC template. Changes to this field are automatically reapplied to the created PVCs. Size cannot be decreased."', args=[d.arg(name='size', type=d.T.string)]), withSize(size): { spec+: { storage+: { size: size } } }, - '#withStorageClass':: d.fn(help='"StorageClass to use for database data (`PGDATA`). Applied after evaluating the PVC template, if available. If not specified, generated PVCs will be satisfied by the default storage class"', args=[d.arg(name='storageClass', type=d.T.string)]), + '#withStorageClass':: d.fn(help='"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class"', args=[d.arg(name='storageClass', type=d.T.string)]), withStorageClass(storageClass): { spec+: { storage+: { storageClass: storageClass } } }, }, '#superuserSecret':: d.obj(help='"The secret containing the superuser password. If not defined a new secret will be created with a randomly generated password"'), @@ -1386,6 +1442,102 @@ '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), withName(name): { spec+: { superuserSecret+: { name: name } } }, }, + '#tablespaces':: d.obj(help='"The tablespaces configuration"'), + tablespaces: { + '#owner':: d.obj(help='"Owner is the PostgreSQL user owning the tablespace"'), + owner: { + '#withName':: d.fn(help='', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { owner+: { name: name } }, + }, + '#storage':: d.obj(help='"The storage configuration for the tablespace"'), + storage: { + '#pvcTemplate':: d.obj(help='"Template to be used to generate the Persistent Volume Claim"'), + pvcTemplate: { + '#dataSource':: d.obj(help='"dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource."'), + dataSource: { + '#withApiGroup':: d.fn(help='"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."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { storage+: { pvcTemplate+: { dataSource+: { apiGroup: apiGroup } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { storage+: { pvcTemplate+: { dataSource+: { kind: kind } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { storage+: { pvcTemplate+: { dataSource+: { name: name } } } }, + }, + '#dataSourceRef':: d.obj(help="\"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\""), + dataSourceRef: { + '#withApiGroup':: d.fn(help='"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."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { storage+: { pvcTemplate+: { dataSourceRef+: { apiGroup: apiGroup } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { storage+: { pvcTemplate+: { dataSourceRef+: { kind: kind } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { storage+: { pvcTemplate+: { dataSourceRef+: { name: name } } } }, + '#withNamespace':: d.fn(help="\"Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\"", args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { storage+: { pvcTemplate+: { dataSourceRef+: { namespace: namespace } } } }, + }, + '#resources':: d.obj(help='"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"'), + resources: { + '#claims':: d.obj(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."'), + claims: { + '#withName':: d.fn(help='"Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withClaims':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."', args=[d.arg(name='claims', type=d.T.array)]), + withClaims(claims): { storage+: { pvcTemplate+: { resources+: { claims: if std.isArray(v=claims) then claims else [claims] } } } }, + '#withClaimsMixin':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claims', type=d.T.array)]), + withClaimsMixin(claims): { storage+: { pvcTemplate+: { resources+: { claims+: if std.isArray(v=claims) then claims else [claims] } } } }, + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { storage+: { pvcTemplate+: { resources+: { limits: limits } } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { storage+: { pvcTemplate+: { resources+: { limits+: limits } } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { storage+: { pvcTemplate+: { resources+: { requests: requests } } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { storage+: { pvcTemplate+: { resources+: { requests+: requests } } } }, + }, + '#selector':: d.obj(help='"selector is a label query over volumes to consider for binding."'), + selector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"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."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { storage+: { pvcTemplate+: { selector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { storage+: { pvcTemplate+: { selector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } }, + '#withMatchLabels':: d.fn(help='"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."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { storage+: { pvcTemplate+: { selector+: { matchLabels: matchLabels } } } }, + '#withMatchLabelsMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { storage+: { pvcTemplate+: { selector+: { matchLabels+: matchLabels } } } }, + }, + '#withAccessModes':: d.fn(help='"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModes(accessModes): { storage+: { pvcTemplate+: { accessModes: if std.isArray(v=accessModes) then accessModes else [accessModes] } } }, + '#withAccessModesMixin':: d.fn(help='"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModesMixin(accessModes): { storage+: { pvcTemplate+: { accessModes+: if std.isArray(v=accessModes) then accessModes else [accessModes] } } }, + '#withStorageClassName':: d.fn(help='"storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"', args=[d.arg(name='storageClassName', type=d.T.string)]), + withStorageClassName(storageClassName): { storage+: { pvcTemplate+: { storageClassName: storageClassName } } }, + '#withVolumeMode':: d.fn(help='"volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec."', args=[d.arg(name='volumeMode', type=d.T.string)]), + withVolumeMode(volumeMode): { storage+: { pvcTemplate+: { volumeMode: volumeMode } } }, + '#withVolumeName':: d.fn(help='"volumeName is the binding reference to the PersistentVolume backing this claim."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { storage+: { pvcTemplate+: { volumeName: volumeName } } }, + }, + '#withResizeInUseVolumes':: d.fn(help='"Resize existent PVCs, defaults to true"', args=[d.arg(name='resizeInUseVolumes', type=d.T.boolean)]), + withResizeInUseVolumes(resizeInUseVolumes): { storage+: { resizeInUseVolumes: resizeInUseVolumes } }, + '#withSize':: d.fn(help='"Size of the storage. Required if not already specified in the PVC template. Changes to this field are automatically reapplied to the created PVCs. Size cannot be decreased."', args=[d.arg(name='size', type=d.T.string)]), + withSize(size): { storage+: { size: size } }, + '#withStorageClass':: d.fn(help='"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class"', args=[d.arg(name='storageClass', type=d.T.string)]), + withStorageClass(storageClass): { storage+: { storageClass: storageClass } }, + }, + '#withName':: d.fn(help='"The name of the tablespace"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withTemporary':: d.fn(help='"When set to true, the tablespace will be added as a `temp_tablespaces` entry in PostgreSQL, and will be available to automatically house temp database objects, or other temporary files. Please refer to PostgreSQL documentation for more information on the `temp_tablespaces` GUC."', args=[d.arg(name='temporary', type=d.T.boolean)]), + withTemporary(temporary): { temporary: temporary }, + }, '#topologySpreadConstraints':: d.obj(help='"TopologySpreadConstraints specifies how to spread matching pods among the given topology. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/"'), topologySpreadConstraints: { '#labelSelector':: d.obj(help='"LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain."'), @@ -1508,7 +1660,7 @@ withResizeInUseVolumes(resizeInUseVolumes): { spec+: { walStorage+: { resizeInUseVolumes: resizeInUseVolumes } } }, '#withSize':: d.fn(help='"Size of the storage. Required if not already specified in the PVC template. Changes to this field are automatically reapplied to the created PVCs. Size cannot be decreased."', args=[d.arg(name='size', type=d.T.string)]), withSize(size): { spec+: { walStorage+: { size: size } } }, - '#withStorageClass':: d.fn(help='"StorageClass to use for database data (`PGDATA`). Applied after evaluating the PVC template, if available. If not specified, generated PVCs will be satisfied by the default storage class"', args=[d.arg(name='storageClass', type=d.T.string)]), + '#withStorageClass':: d.fn(help='"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class"', args=[d.arg(name='storageClass', type=d.T.string)]), withStorageClass(storageClass): { spec+: { walStorage+: { storageClass: storageClass } } }, }, '#withDescription':: d.fn(help='"Description of this PostgreSQL cluster"', args=[d.arg(name='description', type=d.T.string)]), @@ -1565,6 +1717,10 @@ withStopDelay(stopDelay): { spec+: { stopDelay: stopDelay } }, '#withSwitchoverDelay':: d.fn(help='"The time in seconds that is allowed for a primary PostgreSQL instance to gracefully shutdown during a switchover. Default value is 3600 seconds (1 hour)."', args=[d.arg(name='switchoverDelay', type=d.T.integer)]), withSwitchoverDelay(switchoverDelay): { spec+: { switchoverDelay: switchoverDelay } }, + '#withTablespaces':: d.fn(help='"The tablespaces configuration"', args=[d.arg(name='tablespaces', type=d.T.array)]), + withTablespaces(tablespaces): { spec+: { tablespaces: if std.isArray(v=tablespaces) then tablespaces else [tablespaces] } }, + '#withTablespacesMixin':: d.fn(help='"The tablespaces configuration"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='tablespaces', type=d.T.array)]), + withTablespacesMixin(tablespaces): { spec+: { tablespaces+: if std.isArray(v=tablespaces) then tablespaces else [tablespaces] } }, '#withTopologySpreadConstraints':: d.fn(help='"TopologySpreadConstraints specifies how to spread matching pods among the given topology. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/"', args=[d.arg(name='topologySpreadConstraints', type=d.T.array)]), withTopologySpreadConstraints(topologySpreadConstraints): { spec+: { topologySpreadConstraints: if std.isArray(v=topologySpreadConstraints) then topologySpreadConstraints else [topologySpreadConstraints] } }, '#withTopologySpreadConstraintsMixin':: d.fn(help='"TopologySpreadConstraints specifies how to spread matching pods among the given topology. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='topologySpreadConstraints', type=d.T.array)]), diff --git a/1.18.5/_gen/postgresql/v1/pooler.libsonnet b/1.18.5/_gen/postgresql/v1/pooler.libsonnet index 95018cc..c60376a 100644 --- a/1.18.5/_gen/postgresql/v1/pooler.libsonnet +++ b/1.18.5/_gen/postgresql/v1/pooler.libsonnet @@ -68,8 +68,54 @@ }, '#monitoring':: d.obj(help='"The configuration of the monitoring infrastructure of this pooler."'), monitoring: { + '#podMonitorMetricRelabelings':: d.obj(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."'), + podMonitorMetricRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching. \\n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \\n Default: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values. \\n Only applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the regular expression matches. \\n Regex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement. \\n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \\n Regex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#podMonitorRelabelings':: d.obj(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."'), + podMonitorRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching. \\n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \\n Default: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values. \\n Only applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the regular expression matches. \\n Regex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement. \\n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \\n Regex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, '#withEnablePodMonitor':: d.fn(help='"Enable or disable the `PodMonitor`"', args=[d.arg(name='enablePodMonitor', type=d.T.boolean)]), withEnablePodMonitor(enablePodMonitor): { spec+: { monitoring+: { enablePodMonitor: enablePodMonitor } } }, + '#withPodMonitorMetricRelabelings':: d.fn(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."', args=[d.arg(name='podMonitorMetricRelabelings', type=d.T.array)]), + withPodMonitorMetricRelabelings(podMonitorMetricRelabelings): { spec+: { monitoring+: { podMonitorMetricRelabelings: if std.isArray(v=podMonitorMetricRelabelings) then podMonitorMetricRelabelings else [podMonitorMetricRelabelings] } } }, + '#withPodMonitorMetricRelabelingsMixin':: d.fn(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podMonitorMetricRelabelings', type=d.T.array)]), + withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings): { spec+: { monitoring+: { podMonitorMetricRelabelings+: if std.isArray(v=podMonitorMetricRelabelings) then podMonitorMetricRelabelings else [podMonitorMetricRelabelings] } } }, + '#withPodMonitorRelabelings':: d.fn(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."', args=[d.arg(name='podMonitorRelabelings', type=d.T.array)]), + withPodMonitorRelabelings(podMonitorRelabelings): { spec+: { monitoring+: { podMonitorRelabelings: if std.isArray(v=podMonitorRelabelings) then podMonitorRelabelings else [podMonitorRelabelings] } } }, + '#withPodMonitorRelabelingsMixin':: d.fn(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podMonitorRelabelings', type=d.T.array)]), + withPodMonitorRelabelingsMixin(podMonitorRelabelings): { spec+: { monitoring+: { podMonitorRelabelings+: if std.isArray(v=podMonitorRelabelings) then podMonitorRelabelings else [podMonitorRelabelings] } } }, }, '#pgbouncer':: d.obj(help='"The PgBouncer configuration"'), pgbouncer: { diff --git a/1.19.6/_gen/postgresql/v1/cluster.libsonnet b/1.19.6/_gen/postgresql/v1/cluster.libsonnet index 40186b4..2619ec6 100644 --- a/1.19.6/_gen/postgresql/v1/cluster.libsonnet +++ b/1.19.6/_gen/postgresql/v1/cluster.libsonnet @@ -555,6 +555,10 @@ withOnline(online): { spec+: { backup+: { volumeSnapshot+: { online: online } } } }, '#withSnapshotOwnerReference':: d.fn(help='"SnapshotOwnerReference indicates the type of owner reference the snapshot should have"', args=[d.arg(name='snapshotOwnerReference', type=d.T.string)]), withSnapshotOwnerReference(snapshotOwnerReference): { spec+: { backup+: { volumeSnapshot+: { snapshotOwnerReference: snapshotOwnerReference } } } }, + '#withTablespaceClassName':: d.fn(help='"TablespaceClassName specifies the Snapshot Class to be used for the tablespaces. defaults to the PGDATA Snapshot Class, if set"', args=[d.arg(name='tablespaceClassName', type=d.T.object)]), + withTablespaceClassName(tablespaceClassName): { spec+: { backup+: { volumeSnapshot+: { tablespaceClassName: tablespaceClassName } } } }, + '#withTablespaceClassNameMixin':: d.fn(help='"TablespaceClassName specifies the Snapshot Class to be used for the tablespaces. defaults to the PGDATA Snapshot Class, if set"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='tablespaceClassName', type=d.T.object)]), + withTablespaceClassNameMixin(tablespaceClassName): { spec+: { backup+: { volumeSnapshot+: { tablespaceClassName+: tablespaceClassName } } } }, '#withWalClassName':: d.fn(help='"WalClassName specifies the Snapshot Class to be used for the PG_WAL PersistentVolumeClaim."', args=[d.arg(name='walClassName', type=d.T.string)]), withWalClassName(walClassName): { spec+: { backup+: { volumeSnapshot+: { walClassName: walClassName } } } }, }, @@ -724,6 +728,10 @@ '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), withName(name): { spec+: { bootstrap+: { recovery+: { volumeSnapshots+: { walStorage+: { name: name } } } } } }, }, + '#withTablespaceStorage':: d.fn(help='"Configuration of the storage for PostgreSQL tablespaces"', args=[d.arg(name='tablespaceStorage', type=d.T.object)]), + withTablespaceStorage(tablespaceStorage): { spec+: { bootstrap+: { recovery+: { volumeSnapshots+: { tablespaceStorage: tablespaceStorage } } } } }, + '#withTablespaceStorageMixin':: d.fn(help='"Configuration of the storage for PostgreSQL tablespaces"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='tablespaceStorage', type=d.T.object)]), + withTablespaceStorageMixin(tablespaceStorage): { spec+: { bootstrap+: { recovery+: { volumeSnapshots+: { tablespaceStorage+: tablespaceStorage } } } } }, }, '#withDatabase':: d.fn(help='"Name of the database used by the application. Default: `app`."', args=[d.arg(name='database', type=d.T.string)]), withDatabase(database): { spec+: { bootstrap+: { recovery+: { database: database } } } }, @@ -942,7 +950,7 @@ '#withTagsMixin':: d.fn(help='"Tags is a list of key value pairs that will be passed to the Barman --tags option."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='tags', type=d.T.object)]), withTagsMixin(tags): { barmanObjectStore+: { tags+: tags } }, }, - '#password':: d.obj(help='"The reference to the password to be used to connect to the server"'), + '#password':: d.obj(help="\"The reference to the password to be used to connect to the server. If a password is provided, CloudNativePG creates a PostgreSQL passfile at `/controller/external/NAME/pass` (where \\\"NAME\\\" is the cluster's name). This passfile is automatically referenced in the connection string when establishing a connection to the remote PostgreSQL server from the current PostgreSQL `Cluster`. This ensures secure and efficient password management for external clusters.\""), password: { '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), withKey(key): { password+: { key: key } }, @@ -1062,6 +1070,44 @@ '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), withName(name): { name: name }, }, + '#podMonitorMetricRelabelings':: d.obj(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."'), + podMonitorMetricRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching. \\n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \\n Default: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values. \\n Only applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the regular expression matches. \\n Regex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement. \\n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \\n Regex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#podMonitorRelabelings':: d.obj(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."'), + podMonitorRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching. \\n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \\n Default: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values. \\n Only applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the regular expression matches. \\n Regex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement. \\n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \\n Regex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, '#withCustomQueriesConfigMap':: d.fn(help='"The list of config maps containing the custom queries"', args=[d.arg(name='customQueriesConfigMap', type=d.T.array)]), withCustomQueriesConfigMap(customQueriesConfigMap): { spec+: { monitoring+: { customQueriesConfigMap: if std.isArray(v=customQueriesConfigMap) then customQueriesConfigMap else [customQueriesConfigMap] } } }, '#withCustomQueriesConfigMapMixin':: d.fn(help='"The list of config maps containing the custom queries"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='customQueriesConfigMap', type=d.T.array)]), @@ -1074,6 +1120,14 @@ withDisableDefaultQueries(disableDefaultQueries): { spec+: { monitoring+: { disableDefaultQueries: disableDefaultQueries } } }, '#withEnablePodMonitor':: d.fn(help='"Enable or disable the `PodMonitor`"', args=[d.arg(name='enablePodMonitor', type=d.T.boolean)]), withEnablePodMonitor(enablePodMonitor): { spec+: { monitoring+: { enablePodMonitor: enablePodMonitor } } }, + '#withPodMonitorMetricRelabelings':: d.fn(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."', args=[d.arg(name='podMonitorMetricRelabelings', type=d.T.array)]), + withPodMonitorMetricRelabelings(podMonitorMetricRelabelings): { spec+: { monitoring+: { podMonitorMetricRelabelings: if std.isArray(v=podMonitorMetricRelabelings) then podMonitorMetricRelabelings else [podMonitorMetricRelabelings] } } }, + '#withPodMonitorMetricRelabelingsMixin':: d.fn(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podMonitorMetricRelabelings', type=d.T.array)]), + withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings): { spec+: { monitoring+: { podMonitorMetricRelabelings+: if std.isArray(v=podMonitorMetricRelabelings) then podMonitorMetricRelabelings else [podMonitorMetricRelabelings] } } }, + '#withPodMonitorRelabelings':: d.fn(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."', args=[d.arg(name='podMonitorRelabelings', type=d.T.array)]), + withPodMonitorRelabelings(podMonitorRelabelings): { spec+: { monitoring+: { podMonitorRelabelings: if std.isArray(v=podMonitorRelabelings) then podMonitorRelabelings else [podMonitorRelabelings] } } }, + '#withPodMonitorRelabelingsMixin':: d.fn(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podMonitorRelabelings', type=d.T.array)]), + withPodMonitorRelabelingsMixin(podMonitorRelabelings): { spec+: { monitoring+: { podMonitorRelabelings+: if std.isArray(v=podMonitorRelabelings) then podMonitorRelabelings else [podMonitorRelabelings] } } }, }, '#nodeMaintenanceWindow':: d.obj(help='"Define a maintenance window for the Kubernetes nodes"'), nodeMaintenanceWindow: { @@ -1131,6 +1185,8 @@ '#withNodeLabelsAntiAffinityMixin':: d.fn(help='"A list of node labels values to extract and compare to evaluate if the pods reside in the same topology or not"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='nodeLabelsAntiAffinity', type=d.T.array)]), withNodeLabelsAntiAffinityMixin(nodeLabelsAntiAffinity): { spec+: { postgresql+: { syncReplicaElectionConstraint+: { nodeLabelsAntiAffinity+: if std.isArray(v=nodeLabelsAntiAffinity) then nodeLabelsAntiAffinity else [nodeLabelsAntiAffinity] } } } }, }, + '#withEnableAlterSystem':: d.fn(help='"If this parameter is true, the user will be able to invoke `ALTER SYSTEM` on this CloudNativePG Cluster. This should only be used for debugging and troubleshooting. Defaults to false."', args=[d.arg(name='enableAlterSystem', type=d.T.boolean)]), + withEnableAlterSystem(enableAlterSystem): { spec+: { postgresql+: { enableAlterSystem: enableAlterSystem } } }, '#withParameters':: d.fn(help='"PostgreSQL configuration options (postgresql.conf)"', args=[d.arg(name='parameters', type=d.T.object)]), withParameters(parameters): { spec+: { postgresql+: { parameters: parameters } } }, '#withParametersMixin':: d.fn(help='"PostgreSQL configuration options (postgresql.conf)"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='parameters', type=d.T.object)]), @@ -1378,7 +1434,7 @@ withResizeInUseVolumes(resizeInUseVolumes): { spec+: { storage+: { resizeInUseVolumes: resizeInUseVolumes } } }, '#withSize':: d.fn(help='"Size of the storage. Required if not already specified in the PVC template. Changes to this field are automatically reapplied to the created PVCs. Size cannot be decreased."', args=[d.arg(name='size', type=d.T.string)]), withSize(size): { spec+: { storage+: { size: size } } }, - '#withStorageClass':: d.fn(help='"StorageClass to use for database data (`PGDATA`). Applied after evaluating the PVC template, if available. If not specified, generated PVCs will be satisfied by the default storage class"', args=[d.arg(name='storageClass', type=d.T.string)]), + '#withStorageClass':: d.fn(help='"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class"', args=[d.arg(name='storageClass', type=d.T.string)]), withStorageClass(storageClass): { spec+: { storage+: { storageClass: storageClass } } }, }, '#superuserSecret':: d.obj(help='"The secret containing the superuser password. If not defined a new secret will be created with a randomly generated password"'), @@ -1386,6 +1442,102 @@ '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), withName(name): { spec+: { superuserSecret+: { name: name } } }, }, + '#tablespaces':: d.obj(help='"The tablespaces configuration"'), + tablespaces: { + '#owner':: d.obj(help='"Owner is the PostgreSQL user owning the tablespace"'), + owner: { + '#withName':: d.fn(help='', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { owner+: { name: name } }, + }, + '#storage':: d.obj(help='"The storage configuration for the tablespace"'), + storage: { + '#pvcTemplate':: d.obj(help='"Template to be used to generate the Persistent Volume Claim"'), + pvcTemplate: { + '#dataSource':: d.obj(help='"dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource."'), + dataSource: { + '#withApiGroup':: d.fn(help='"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."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { storage+: { pvcTemplate+: { dataSource+: { apiGroup: apiGroup } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { storage+: { pvcTemplate+: { dataSource+: { kind: kind } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { storage+: { pvcTemplate+: { dataSource+: { name: name } } } }, + }, + '#dataSourceRef':: d.obj(help="\"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\""), + dataSourceRef: { + '#withApiGroup':: d.fn(help='"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."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { storage+: { pvcTemplate+: { dataSourceRef+: { apiGroup: apiGroup } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { storage+: { pvcTemplate+: { dataSourceRef+: { kind: kind } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { storage+: { pvcTemplate+: { dataSourceRef+: { name: name } } } }, + '#withNamespace':: d.fn(help="\"Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\"", args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { storage+: { pvcTemplate+: { dataSourceRef+: { namespace: namespace } } } }, + }, + '#resources':: d.obj(help='"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"'), + resources: { + '#claims':: d.obj(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."'), + claims: { + '#withName':: d.fn(help='"Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withClaims':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."', args=[d.arg(name='claims', type=d.T.array)]), + withClaims(claims): { storage+: { pvcTemplate+: { resources+: { claims: if std.isArray(v=claims) then claims else [claims] } } } }, + '#withClaimsMixin':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claims', type=d.T.array)]), + withClaimsMixin(claims): { storage+: { pvcTemplate+: { resources+: { claims+: if std.isArray(v=claims) then claims else [claims] } } } }, + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { storage+: { pvcTemplate+: { resources+: { limits: limits } } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { storage+: { pvcTemplate+: { resources+: { limits+: limits } } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { storage+: { pvcTemplate+: { resources+: { requests: requests } } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { storage+: { pvcTemplate+: { resources+: { requests+: requests } } } }, + }, + '#selector':: d.obj(help='"selector is a label query over volumes to consider for binding."'), + selector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"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."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { storage+: { pvcTemplate+: { selector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { storage+: { pvcTemplate+: { selector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } }, + '#withMatchLabels':: d.fn(help='"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."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { storage+: { pvcTemplate+: { selector+: { matchLabels: matchLabels } } } }, + '#withMatchLabelsMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { storage+: { pvcTemplate+: { selector+: { matchLabels+: matchLabels } } } }, + }, + '#withAccessModes':: d.fn(help='"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModes(accessModes): { storage+: { pvcTemplate+: { accessModes: if std.isArray(v=accessModes) then accessModes else [accessModes] } } }, + '#withAccessModesMixin':: d.fn(help='"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModesMixin(accessModes): { storage+: { pvcTemplate+: { accessModes+: if std.isArray(v=accessModes) then accessModes else [accessModes] } } }, + '#withStorageClassName':: d.fn(help='"storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"', args=[d.arg(name='storageClassName', type=d.T.string)]), + withStorageClassName(storageClassName): { storage+: { pvcTemplate+: { storageClassName: storageClassName } } }, + '#withVolumeMode':: d.fn(help='"volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec."', args=[d.arg(name='volumeMode', type=d.T.string)]), + withVolumeMode(volumeMode): { storage+: { pvcTemplate+: { volumeMode: volumeMode } } }, + '#withVolumeName':: d.fn(help='"volumeName is the binding reference to the PersistentVolume backing this claim."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { storage+: { pvcTemplate+: { volumeName: volumeName } } }, + }, + '#withResizeInUseVolumes':: d.fn(help='"Resize existent PVCs, defaults to true"', args=[d.arg(name='resizeInUseVolumes', type=d.T.boolean)]), + withResizeInUseVolumes(resizeInUseVolumes): { storage+: { resizeInUseVolumes: resizeInUseVolumes } }, + '#withSize':: d.fn(help='"Size of the storage. Required if not already specified in the PVC template. Changes to this field are automatically reapplied to the created PVCs. Size cannot be decreased."', args=[d.arg(name='size', type=d.T.string)]), + withSize(size): { storage+: { size: size } }, + '#withStorageClass':: d.fn(help='"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class"', args=[d.arg(name='storageClass', type=d.T.string)]), + withStorageClass(storageClass): { storage+: { storageClass: storageClass } }, + }, + '#withName':: d.fn(help='"The name of the tablespace"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withTemporary':: d.fn(help='"When set to true, the tablespace will be added as a `temp_tablespaces` entry in PostgreSQL, and will be available to automatically house temp database objects, or other temporary files. Please refer to PostgreSQL documentation for more information on the `temp_tablespaces` GUC."', args=[d.arg(name='temporary', type=d.T.boolean)]), + withTemporary(temporary): { temporary: temporary }, + }, '#topologySpreadConstraints':: d.obj(help='"TopologySpreadConstraints specifies how to spread matching pods among the given topology. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/"'), topologySpreadConstraints: { '#labelSelector':: d.obj(help='"LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain."'), @@ -1508,7 +1660,7 @@ withResizeInUseVolumes(resizeInUseVolumes): { spec+: { walStorage+: { resizeInUseVolumes: resizeInUseVolumes } } }, '#withSize':: d.fn(help='"Size of the storage. Required if not already specified in the PVC template. Changes to this field are automatically reapplied to the created PVCs. Size cannot be decreased."', args=[d.arg(name='size', type=d.T.string)]), withSize(size): { spec+: { walStorage+: { size: size } } }, - '#withStorageClass':: d.fn(help='"StorageClass to use for database data (`PGDATA`). Applied after evaluating the PVC template, if available. If not specified, generated PVCs will be satisfied by the default storage class"', args=[d.arg(name='storageClass', type=d.T.string)]), + '#withStorageClass':: d.fn(help='"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class"', args=[d.arg(name='storageClass', type=d.T.string)]), withStorageClass(storageClass): { spec+: { walStorage+: { storageClass: storageClass } } }, }, '#withDescription':: d.fn(help='"Description of this PostgreSQL cluster"', args=[d.arg(name='description', type=d.T.string)]), @@ -1565,6 +1717,10 @@ withStopDelay(stopDelay): { spec+: { stopDelay: stopDelay } }, '#withSwitchoverDelay':: d.fn(help='"The time in seconds that is allowed for a primary PostgreSQL instance to gracefully shutdown during a switchover. Default value is 3600 seconds (1 hour)."', args=[d.arg(name='switchoverDelay', type=d.T.integer)]), withSwitchoverDelay(switchoverDelay): { spec+: { switchoverDelay: switchoverDelay } }, + '#withTablespaces':: d.fn(help='"The tablespaces configuration"', args=[d.arg(name='tablespaces', type=d.T.array)]), + withTablespaces(tablespaces): { spec+: { tablespaces: if std.isArray(v=tablespaces) then tablespaces else [tablespaces] } }, + '#withTablespacesMixin':: d.fn(help='"The tablespaces configuration"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='tablespaces', type=d.T.array)]), + withTablespacesMixin(tablespaces): { spec+: { tablespaces+: if std.isArray(v=tablespaces) then tablespaces else [tablespaces] } }, '#withTopologySpreadConstraints':: d.fn(help='"TopologySpreadConstraints specifies how to spread matching pods among the given topology. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/"', args=[d.arg(name='topologySpreadConstraints', type=d.T.array)]), withTopologySpreadConstraints(topologySpreadConstraints): { spec+: { topologySpreadConstraints: if std.isArray(v=topologySpreadConstraints) then topologySpreadConstraints else [topologySpreadConstraints] } }, '#withTopologySpreadConstraintsMixin':: d.fn(help='"TopologySpreadConstraints specifies how to spread matching pods among the given topology. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='topologySpreadConstraints', type=d.T.array)]), diff --git a/1.19.6/_gen/postgresql/v1/pooler.libsonnet b/1.19.6/_gen/postgresql/v1/pooler.libsonnet index 95018cc..c60376a 100644 --- a/1.19.6/_gen/postgresql/v1/pooler.libsonnet +++ b/1.19.6/_gen/postgresql/v1/pooler.libsonnet @@ -68,8 +68,54 @@ }, '#monitoring':: d.obj(help='"The configuration of the monitoring infrastructure of this pooler."'), monitoring: { + '#podMonitorMetricRelabelings':: d.obj(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."'), + podMonitorMetricRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching. \\n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \\n Default: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values. \\n Only applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the regular expression matches. \\n Regex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement. \\n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \\n Regex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#podMonitorRelabelings':: d.obj(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."'), + podMonitorRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching. \\n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \\n Default: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values. \\n Only applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the regular expression matches. \\n Regex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement. \\n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \\n Regex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, '#withEnablePodMonitor':: d.fn(help='"Enable or disable the `PodMonitor`"', args=[d.arg(name='enablePodMonitor', type=d.T.boolean)]), withEnablePodMonitor(enablePodMonitor): { spec+: { monitoring+: { enablePodMonitor: enablePodMonitor } } }, + '#withPodMonitorMetricRelabelings':: d.fn(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."', args=[d.arg(name='podMonitorMetricRelabelings', type=d.T.array)]), + withPodMonitorMetricRelabelings(podMonitorMetricRelabelings): { spec+: { monitoring+: { podMonitorMetricRelabelings: if std.isArray(v=podMonitorMetricRelabelings) then podMonitorMetricRelabelings else [podMonitorMetricRelabelings] } } }, + '#withPodMonitorMetricRelabelingsMixin':: d.fn(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podMonitorMetricRelabelings', type=d.T.array)]), + withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings): { spec+: { monitoring+: { podMonitorMetricRelabelings+: if std.isArray(v=podMonitorMetricRelabelings) then podMonitorMetricRelabelings else [podMonitorMetricRelabelings] } } }, + '#withPodMonitorRelabelings':: d.fn(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."', args=[d.arg(name='podMonitorRelabelings', type=d.T.array)]), + withPodMonitorRelabelings(podMonitorRelabelings): { spec+: { monitoring+: { podMonitorRelabelings: if std.isArray(v=podMonitorRelabelings) then podMonitorRelabelings else [podMonitorRelabelings] } } }, + '#withPodMonitorRelabelingsMixin':: d.fn(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podMonitorRelabelings', type=d.T.array)]), + withPodMonitorRelabelingsMixin(podMonitorRelabelings): { spec+: { monitoring+: { podMonitorRelabelings+: if std.isArray(v=podMonitorRelabelings) then podMonitorRelabelings else [podMonitorRelabelings] } } }, }, '#pgbouncer':: d.obj(help='"The PgBouncer configuration"'), pgbouncer: { diff --git a/1.20.4/_gen/postgresql/v1/cluster.libsonnet b/1.20.4/_gen/postgresql/v1/cluster.libsonnet index 40186b4..2619ec6 100644 --- a/1.20.4/_gen/postgresql/v1/cluster.libsonnet +++ b/1.20.4/_gen/postgresql/v1/cluster.libsonnet @@ -555,6 +555,10 @@ withOnline(online): { spec+: { backup+: { volumeSnapshot+: { online: online } } } }, '#withSnapshotOwnerReference':: d.fn(help='"SnapshotOwnerReference indicates the type of owner reference the snapshot should have"', args=[d.arg(name='snapshotOwnerReference', type=d.T.string)]), withSnapshotOwnerReference(snapshotOwnerReference): { spec+: { backup+: { volumeSnapshot+: { snapshotOwnerReference: snapshotOwnerReference } } } }, + '#withTablespaceClassName':: d.fn(help='"TablespaceClassName specifies the Snapshot Class to be used for the tablespaces. defaults to the PGDATA Snapshot Class, if set"', args=[d.arg(name='tablespaceClassName', type=d.T.object)]), + withTablespaceClassName(tablespaceClassName): { spec+: { backup+: { volumeSnapshot+: { tablespaceClassName: tablespaceClassName } } } }, + '#withTablespaceClassNameMixin':: d.fn(help='"TablespaceClassName specifies the Snapshot Class to be used for the tablespaces. defaults to the PGDATA Snapshot Class, if set"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='tablespaceClassName', type=d.T.object)]), + withTablespaceClassNameMixin(tablespaceClassName): { spec+: { backup+: { volumeSnapshot+: { tablespaceClassName+: tablespaceClassName } } } }, '#withWalClassName':: d.fn(help='"WalClassName specifies the Snapshot Class to be used for the PG_WAL PersistentVolumeClaim."', args=[d.arg(name='walClassName', type=d.T.string)]), withWalClassName(walClassName): { spec+: { backup+: { volumeSnapshot+: { walClassName: walClassName } } } }, }, @@ -724,6 +728,10 @@ '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), withName(name): { spec+: { bootstrap+: { recovery+: { volumeSnapshots+: { walStorage+: { name: name } } } } } }, }, + '#withTablespaceStorage':: d.fn(help='"Configuration of the storage for PostgreSQL tablespaces"', args=[d.arg(name='tablespaceStorage', type=d.T.object)]), + withTablespaceStorage(tablespaceStorage): { spec+: { bootstrap+: { recovery+: { volumeSnapshots+: { tablespaceStorage: tablespaceStorage } } } } }, + '#withTablespaceStorageMixin':: d.fn(help='"Configuration of the storage for PostgreSQL tablespaces"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='tablespaceStorage', type=d.T.object)]), + withTablespaceStorageMixin(tablespaceStorage): { spec+: { bootstrap+: { recovery+: { volumeSnapshots+: { tablespaceStorage+: tablespaceStorage } } } } }, }, '#withDatabase':: d.fn(help='"Name of the database used by the application. Default: `app`."', args=[d.arg(name='database', type=d.T.string)]), withDatabase(database): { spec+: { bootstrap+: { recovery+: { database: database } } } }, @@ -942,7 +950,7 @@ '#withTagsMixin':: d.fn(help='"Tags is a list of key value pairs that will be passed to the Barman --tags option."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='tags', type=d.T.object)]), withTagsMixin(tags): { barmanObjectStore+: { tags+: tags } }, }, - '#password':: d.obj(help='"The reference to the password to be used to connect to the server"'), + '#password':: d.obj(help="\"The reference to the password to be used to connect to the server. If a password is provided, CloudNativePG creates a PostgreSQL passfile at `/controller/external/NAME/pass` (where \\\"NAME\\\" is the cluster's name). This passfile is automatically referenced in the connection string when establishing a connection to the remote PostgreSQL server from the current PostgreSQL `Cluster`. This ensures secure and efficient password management for external clusters.\""), password: { '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), withKey(key): { password+: { key: key } }, @@ -1062,6 +1070,44 @@ '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), withName(name): { name: name }, }, + '#podMonitorMetricRelabelings':: d.obj(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."'), + podMonitorMetricRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching. \\n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \\n Default: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values. \\n Only applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the regular expression matches. \\n Regex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement. \\n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \\n Regex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#podMonitorRelabelings':: d.obj(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."'), + podMonitorRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching. \\n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \\n Default: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values. \\n Only applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the regular expression matches. \\n Regex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement. \\n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \\n Regex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, '#withCustomQueriesConfigMap':: d.fn(help='"The list of config maps containing the custom queries"', args=[d.arg(name='customQueriesConfigMap', type=d.T.array)]), withCustomQueriesConfigMap(customQueriesConfigMap): { spec+: { monitoring+: { customQueriesConfigMap: if std.isArray(v=customQueriesConfigMap) then customQueriesConfigMap else [customQueriesConfigMap] } } }, '#withCustomQueriesConfigMapMixin':: d.fn(help='"The list of config maps containing the custom queries"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='customQueriesConfigMap', type=d.T.array)]), @@ -1074,6 +1120,14 @@ withDisableDefaultQueries(disableDefaultQueries): { spec+: { monitoring+: { disableDefaultQueries: disableDefaultQueries } } }, '#withEnablePodMonitor':: d.fn(help='"Enable or disable the `PodMonitor`"', args=[d.arg(name='enablePodMonitor', type=d.T.boolean)]), withEnablePodMonitor(enablePodMonitor): { spec+: { monitoring+: { enablePodMonitor: enablePodMonitor } } }, + '#withPodMonitorMetricRelabelings':: d.fn(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."', args=[d.arg(name='podMonitorMetricRelabelings', type=d.T.array)]), + withPodMonitorMetricRelabelings(podMonitorMetricRelabelings): { spec+: { monitoring+: { podMonitorMetricRelabelings: if std.isArray(v=podMonitorMetricRelabelings) then podMonitorMetricRelabelings else [podMonitorMetricRelabelings] } } }, + '#withPodMonitorMetricRelabelingsMixin':: d.fn(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podMonitorMetricRelabelings', type=d.T.array)]), + withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings): { spec+: { monitoring+: { podMonitorMetricRelabelings+: if std.isArray(v=podMonitorMetricRelabelings) then podMonitorMetricRelabelings else [podMonitorMetricRelabelings] } } }, + '#withPodMonitorRelabelings':: d.fn(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."', args=[d.arg(name='podMonitorRelabelings', type=d.T.array)]), + withPodMonitorRelabelings(podMonitorRelabelings): { spec+: { monitoring+: { podMonitorRelabelings: if std.isArray(v=podMonitorRelabelings) then podMonitorRelabelings else [podMonitorRelabelings] } } }, + '#withPodMonitorRelabelingsMixin':: d.fn(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podMonitorRelabelings', type=d.T.array)]), + withPodMonitorRelabelingsMixin(podMonitorRelabelings): { spec+: { monitoring+: { podMonitorRelabelings+: if std.isArray(v=podMonitorRelabelings) then podMonitorRelabelings else [podMonitorRelabelings] } } }, }, '#nodeMaintenanceWindow':: d.obj(help='"Define a maintenance window for the Kubernetes nodes"'), nodeMaintenanceWindow: { @@ -1131,6 +1185,8 @@ '#withNodeLabelsAntiAffinityMixin':: d.fn(help='"A list of node labels values to extract and compare to evaluate if the pods reside in the same topology or not"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='nodeLabelsAntiAffinity', type=d.T.array)]), withNodeLabelsAntiAffinityMixin(nodeLabelsAntiAffinity): { spec+: { postgresql+: { syncReplicaElectionConstraint+: { nodeLabelsAntiAffinity+: if std.isArray(v=nodeLabelsAntiAffinity) then nodeLabelsAntiAffinity else [nodeLabelsAntiAffinity] } } } }, }, + '#withEnableAlterSystem':: d.fn(help='"If this parameter is true, the user will be able to invoke `ALTER SYSTEM` on this CloudNativePG Cluster. This should only be used for debugging and troubleshooting. Defaults to false."', args=[d.arg(name='enableAlterSystem', type=d.T.boolean)]), + withEnableAlterSystem(enableAlterSystem): { spec+: { postgresql+: { enableAlterSystem: enableAlterSystem } } }, '#withParameters':: d.fn(help='"PostgreSQL configuration options (postgresql.conf)"', args=[d.arg(name='parameters', type=d.T.object)]), withParameters(parameters): { spec+: { postgresql+: { parameters: parameters } } }, '#withParametersMixin':: d.fn(help='"PostgreSQL configuration options (postgresql.conf)"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='parameters', type=d.T.object)]), @@ -1378,7 +1434,7 @@ withResizeInUseVolumes(resizeInUseVolumes): { spec+: { storage+: { resizeInUseVolumes: resizeInUseVolumes } } }, '#withSize':: d.fn(help='"Size of the storage. Required if not already specified in the PVC template. Changes to this field are automatically reapplied to the created PVCs. Size cannot be decreased."', args=[d.arg(name='size', type=d.T.string)]), withSize(size): { spec+: { storage+: { size: size } } }, - '#withStorageClass':: d.fn(help='"StorageClass to use for database data (`PGDATA`). Applied after evaluating the PVC template, if available. If not specified, generated PVCs will be satisfied by the default storage class"', args=[d.arg(name='storageClass', type=d.T.string)]), + '#withStorageClass':: d.fn(help='"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class"', args=[d.arg(name='storageClass', type=d.T.string)]), withStorageClass(storageClass): { spec+: { storage+: { storageClass: storageClass } } }, }, '#superuserSecret':: d.obj(help='"The secret containing the superuser password. If not defined a new secret will be created with a randomly generated password"'), @@ -1386,6 +1442,102 @@ '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), withName(name): { spec+: { superuserSecret+: { name: name } } }, }, + '#tablespaces':: d.obj(help='"The tablespaces configuration"'), + tablespaces: { + '#owner':: d.obj(help='"Owner is the PostgreSQL user owning the tablespace"'), + owner: { + '#withName':: d.fn(help='', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { owner+: { name: name } }, + }, + '#storage':: d.obj(help='"The storage configuration for the tablespace"'), + storage: { + '#pvcTemplate':: d.obj(help='"Template to be used to generate the Persistent Volume Claim"'), + pvcTemplate: { + '#dataSource':: d.obj(help='"dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource."'), + dataSource: { + '#withApiGroup':: d.fn(help='"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."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { storage+: { pvcTemplate+: { dataSource+: { apiGroup: apiGroup } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { storage+: { pvcTemplate+: { dataSource+: { kind: kind } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { storage+: { pvcTemplate+: { dataSource+: { name: name } } } }, + }, + '#dataSourceRef':: d.obj(help="\"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\""), + dataSourceRef: { + '#withApiGroup':: d.fn(help='"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."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { storage+: { pvcTemplate+: { dataSourceRef+: { apiGroup: apiGroup } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { storage+: { pvcTemplate+: { dataSourceRef+: { kind: kind } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { storage+: { pvcTemplate+: { dataSourceRef+: { name: name } } } }, + '#withNamespace':: d.fn(help="\"Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\"", args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { storage+: { pvcTemplate+: { dataSourceRef+: { namespace: namespace } } } }, + }, + '#resources':: d.obj(help='"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"'), + resources: { + '#claims':: d.obj(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."'), + claims: { + '#withName':: d.fn(help='"Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withClaims':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."', args=[d.arg(name='claims', type=d.T.array)]), + withClaims(claims): { storage+: { pvcTemplate+: { resources+: { claims: if std.isArray(v=claims) then claims else [claims] } } } }, + '#withClaimsMixin':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claims', type=d.T.array)]), + withClaimsMixin(claims): { storage+: { pvcTemplate+: { resources+: { claims+: if std.isArray(v=claims) then claims else [claims] } } } }, + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { storage+: { pvcTemplate+: { resources+: { limits: limits } } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { storage+: { pvcTemplate+: { resources+: { limits+: limits } } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { storage+: { pvcTemplate+: { resources+: { requests: requests } } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { storage+: { pvcTemplate+: { resources+: { requests+: requests } } } }, + }, + '#selector':: d.obj(help='"selector is a label query over volumes to consider for binding."'), + selector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"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."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { storage+: { pvcTemplate+: { selector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { storage+: { pvcTemplate+: { selector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } }, + '#withMatchLabels':: d.fn(help='"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."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { storage+: { pvcTemplate+: { selector+: { matchLabels: matchLabels } } } }, + '#withMatchLabelsMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { storage+: { pvcTemplate+: { selector+: { matchLabels+: matchLabels } } } }, + }, + '#withAccessModes':: d.fn(help='"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModes(accessModes): { storage+: { pvcTemplate+: { accessModes: if std.isArray(v=accessModes) then accessModes else [accessModes] } } }, + '#withAccessModesMixin':: d.fn(help='"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModesMixin(accessModes): { storage+: { pvcTemplate+: { accessModes+: if std.isArray(v=accessModes) then accessModes else [accessModes] } } }, + '#withStorageClassName':: d.fn(help='"storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"', args=[d.arg(name='storageClassName', type=d.T.string)]), + withStorageClassName(storageClassName): { storage+: { pvcTemplate+: { storageClassName: storageClassName } } }, + '#withVolumeMode':: d.fn(help='"volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec."', args=[d.arg(name='volumeMode', type=d.T.string)]), + withVolumeMode(volumeMode): { storage+: { pvcTemplate+: { volumeMode: volumeMode } } }, + '#withVolumeName':: d.fn(help='"volumeName is the binding reference to the PersistentVolume backing this claim."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { storage+: { pvcTemplate+: { volumeName: volumeName } } }, + }, + '#withResizeInUseVolumes':: d.fn(help='"Resize existent PVCs, defaults to true"', args=[d.arg(name='resizeInUseVolumes', type=d.T.boolean)]), + withResizeInUseVolumes(resizeInUseVolumes): { storage+: { resizeInUseVolumes: resizeInUseVolumes } }, + '#withSize':: d.fn(help='"Size of the storage. Required if not already specified in the PVC template. Changes to this field are automatically reapplied to the created PVCs. Size cannot be decreased."', args=[d.arg(name='size', type=d.T.string)]), + withSize(size): { storage+: { size: size } }, + '#withStorageClass':: d.fn(help='"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class"', args=[d.arg(name='storageClass', type=d.T.string)]), + withStorageClass(storageClass): { storage+: { storageClass: storageClass } }, + }, + '#withName':: d.fn(help='"The name of the tablespace"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withTemporary':: d.fn(help='"When set to true, the tablespace will be added as a `temp_tablespaces` entry in PostgreSQL, and will be available to automatically house temp database objects, or other temporary files. Please refer to PostgreSQL documentation for more information on the `temp_tablespaces` GUC."', args=[d.arg(name='temporary', type=d.T.boolean)]), + withTemporary(temporary): { temporary: temporary }, + }, '#topologySpreadConstraints':: d.obj(help='"TopologySpreadConstraints specifies how to spread matching pods among the given topology. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/"'), topologySpreadConstraints: { '#labelSelector':: d.obj(help='"LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain."'), @@ -1508,7 +1660,7 @@ withResizeInUseVolumes(resizeInUseVolumes): { spec+: { walStorage+: { resizeInUseVolumes: resizeInUseVolumes } } }, '#withSize':: d.fn(help='"Size of the storage. Required if not already specified in the PVC template. Changes to this field are automatically reapplied to the created PVCs. Size cannot be decreased."', args=[d.arg(name='size', type=d.T.string)]), withSize(size): { spec+: { walStorage+: { size: size } } }, - '#withStorageClass':: d.fn(help='"StorageClass to use for database data (`PGDATA`). Applied after evaluating the PVC template, if available. If not specified, generated PVCs will be satisfied by the default storage class"', args=[d.arg(name='storageClass', type=d.T.string)]), + '#withStorageClass':: d.fn(help='"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class"', args=[d.arg(name='storageClass', type=d.T.string)]), withStorageClass(storageClass): { spec+: { walStorage+: { storageClass: storageClass } } }, }, '#withDescription':: d.fn(help='"Description of this PostgreSQL cluster"', args=[d.arg(name='description', type=d.T.string)]), @@ -1565,6 +1717,10 @@ withStopDelay(stopDelay): { spec+: { stopDelay: stopDelay } }, '#withSwitchoverDelay':: d.fn(help='"The time in seconds that is allowed for a primary PostgreSQL instance to gracefully shutdown during a switchover. Default value is 3600 seconds (1 hour)."', args=[d.arg(name='switchoverDelay', type=d.T.integer)]), withSwitchoverDelay(switchoverDelay): { spec+: { switchoverDelay: switchoverDelay } }, + '#withTablespaces':: d.fn(help='"The tablespaces configuration"', args=[d.arg(name='tablespaces', type=d.T.array)]), + withTablespaces(tablespaces): { spec+: { tablespaces: if std.isArray(v=tablespaces) then tablespaces else [tablespaces] } }, + '#withTablespacesMixin':: d.fn(help='"The tablespaces configuration"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='tablespaces', type=d.T.array)]), + withTablespacesMixin(tablespaces): { spec+: { tablespaces+: if std.isArray(v=tablespaces) then tablespaces else [tablespaces] } }, '#withTopologySpreadConstraints':: d.fn(help='"TopologySpreadConstraints specifies how to spread matching pods among the given topology. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/"', args=[d.arg(name='topologySpreadConstraints', type=d.T.array)]), withTopologySpreadConstraints(topologySpreadConstraints): { spec+: { topologySpreadConstraints: if std.isArray(v=topologySpreadConstraints) then topologySpreadConstraints else [topologySpreadConstraints] } }, '#withTopologySpreadConstraintsMixin':: d.fn(help='"TopologySpreadConstraints specifies how to spread matching pods among the given topology. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='topologySpreadConstraints', type=d.T.array)]), diff --git a/1.20.4/_gen/postgresql/v1/pooler.libsonnet b/1.20.4/_gen/postgresql/v1/pooler.libsonnet index 95018cc..c60376a 100644 --- a/1.20.4/_gen/postgresql/v1/pooler.libsonnet +++ b/1.20.4/_gen/postgresql/v1/pooler.libsonnet @@ -68,8 +68,54 @@ }, '#monitoring':: d.obj(help='"The configuration of the monitoring infrastructure of this pooler."'), monitoring: { + '#podMonitorMetricRelabelings':: d.obj(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."'), + podMonitorMetricRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching. \\n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \\n Default: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values. \\n Only applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the regular expression matches. \\n Regex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement. \\n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \\n Regex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#podMonitorRelabelings':: d.obj(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."'), + podMonitorRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching. \\n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \\n Default: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values. \\n Only applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the regular expression matches. \\n Regex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement. \\n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \\n Regex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, '#withEnablePodMonitor':: d.fn(help='"Enable or disable the `PodMonitor`"', args=[d.arg(name='enablePodMonitor', type=d.T.boolean)]), withEnablePodMonitor(enablePodMonitor): { spec+: { monitoring+: { enablePodMonitor: enablePodMonitor } } }, + '#withPodMonitorMetricRelabelings':: d.fn(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."', args=[d.arg(name='podMonitorMetricRelabelings', type=d.T.array)]), + withPodMonitorMetricRelabelings(podMonitorMetricRelabelings): { spec+: { monitoring+: { podMonitorMetricRelabelings: if std.isArray(v=podMonitorMetricRelabelings) then podMonitorMetricRelabelings else [podMonitorMetricRelabelings] } } }, + '#withPodMonitorMetricRelabelingsMixin':: d.fn(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podMonitorMetricRelabelings', type=d.T.array)]), + withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings): { spec+: { monitoring+: { podMonitorMetricRelabelings+: if std.isArray(v=podMonitorMetricRelabelings) then podMonitorMetricRelabelings else [podMonitorMetricRelabelings] } } }, + '#withPodMonitorRelabelings':: d.fn(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."', args=[d.arg(name='podMonitorRelabelings', type=d.T.array)]), + withPodMonitorRelabelings(podMonitorRelabelings): { spec+: { monitoring+: { podMonitorRelabelings: if std.isArray(v=podMonitorRelabelings) then podMonitorRelabelings else [podMonitorRelabelings] } } }, + '#withPodMonitorRelabelingsMixin':: d.fn(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podMonitorRelabelings', type=d.T.array)]), + withPodMonitorRelabelingsMixin(podMonitorRelabelings): { spec+: { monitoring+: { podMonitorRelabelings+: if std.isArray(v=podMonitorRelabelings) then podMonitorRelabelings else [podMonitorRelabelings] } } }, }, '#pgbouncer':: d.obj(help='"The PgBouncer configuration"'), pgbouncer: { diff --git a/1.21.1/_gen/postgresql/v1/cluster.libsonnet b/1.21.1/_gen/postgresql/v1/cluster.libsonnet index 40186b4..2619ec6 100644 --- a/1.21.1/_gen/postgresql/v1/cluster.libsonnet +++ b/1.21.1/_gen/postgresql/v1/cluster.libsonnet @@ -555,6 +555,10 @@ withOnline(online): { spec+: { backup+: { volumeSnapshot+: { online: online } } } }, '#withSnapshotOwnerReference':: d.fn(help='"SnapshotOwnerReference indicates the type of owner reference the snapshot should have"', args=[d.arg(name='snapshotOwnerReference', type=d.T.string)]), withSnapshotOwnerReference(snapshotOwnerReference): { spec+: { backup+: { volumeSnapshot+: { snapshotOwnerReference: snapshotOwnerReference } } } }, + '#withTablespaceClassName':: d.fn(help='"TablespaceClassName specifies the Snapshot Class to be used for the tablespaces. defaults to the PGDATA Snapshot Class, if set"', args=[d.arg(name='tablespaceClassName', type=d.T.object)]), + withTablespaceClassName(tablespaceClassName): { spec+: { backup+: { volumeSnapshot+: { tablespaceClassName: tablespaceClassName } } } }, + '#withTablespaceClassNameMixin':: d.fn(help='"TablespaceClassName specifies the Snapshot Class to be used for the tablespaces. defaults to the PGDATA Snapshot Class, if set"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='tablespaceClassName', type=d.T.object)]), + withTablespaceClassNameMixin(tablespaceClassName): { spec+: { backup+: { volumeSnapshot+: { tablespaceClassName+: tablespaceClassName } } } }, '#withWalClassName':: d.fn(help='"WalClassName specifies the Snapshot Class to be used for the PG_WAL PersistentVolumeClaim."', args=[d.arg(name='walClassName', type=d.T.string)]), withWalClassName(walClassName): { spec+: { backup+: { volumeSnapshot+: { walClassName: walClassName } } } }, }, @@ -724,6 +728,10 @@ '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), withName(name): { spec+: { bootstrap+: { recovery+: { volumeSnapshots+: { walStorage+: { name: name } } } } } }, }, + '#withTablespaceStorage':: d.fn(help='"Configuration of the storage for PostgreSQL tablespaces"', args=[d.arg(name='tablespaceStorage', type=d.T.object)]), + withTablespaceStorage(tablespaceStorage): { spec+: { bootstrap+: { recovery+: { volumeSnapshots+: { tablespaceStorage: tablespaceStorage } } } } }, + '#withTablespaceStorageMixin':: d.fn(help='"Configuration of the storage for PostgreSQL tablespaces"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='tablespaceStorage', type=d.T.object)]), + withTablespaceStorageMixin(tablespaceStorage): { spec+: { bootstrap+: { recovery+: { volumeSnapshots+: { tablespaceStorage+: tablespaceStorage } } } } }, }, '#withDatabase':: d.fn(help='"Name of the database used by the application. Default: `app`."', args=[d.arg(name='database', type=d.T.string)]), withDatabase(database): { spec+: { bootstrap+: { recovery+: { database: database } } } }, @@ -942,7 +950,7 @@ '#withTagsMixin':: d.fn(help='"Tags is a list of key value pairs that will be passed to the Barman --tags option."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='tags', type=d.T.object)]), withTagsMixin(tags): { barmanObjectStore+: { tags+: tags } }, }, - '#password':: d.obj(help='"The reference to the password to be used to connect to the server"'), + '#password':: d.obj(help="\"The reference to the password to be used to connect to the server. If a password is provided, CloudNativePG creates a PostgreSQL passfile at `/controller/external/NAME/pass` (where \\\"NAME\\\" is the cluster's name). This passfile is automatically referenced in the connection string when establishing a connection to the remote PostgreSQL server from the current PostgreSQL `Cluster`. This ensures secure and efficient password management for external clusters.\""), password: { '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), withKey(key): { password+: { key: key } }, @@ -1062,6 +1070,44 @@ '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), withName(name): { name: name }, }, + '#podMonitorMetricRelabelings':: d.obj(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."'), + podMonitorMetricRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching. \\n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \\n Default: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values. \\n Only applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the regular expression matches. \\n Regex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement. \\n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \\n Regex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#podMonitorRelabelings':: d.obj(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."'), + podMonitorRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching. \\n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \\n Default: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values. \\n Only applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the regular expression matches. \\n Regex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement. \\n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \\n Regex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, '#withCustomQueriesConfigMap':: d.fn(help='"The list of config maps containing the custom queries"', args=[d.arg(name='customQueriesConfigMap', type=d.T.array)]), withCustomQueriesConfigMap(customQueriesConfigMap): { spec+: { monitoring+: { customQueriesConfigMap: if std.isArray(v=customQueriesConfigMap) then customQueriesConfigMap else [customQueriesConfigMap] } } }, '#withCustomQueriesConfigMapMixin':: d.fn(help='"The list of config maps containing the custom queries"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='customQueriesConfigMap', type=d.T.array)]), @@ -1074,6 +1120,14 @@ withDisableDefaultQueries(disableDefaultQueries): { spec+: { monitoring+: { disableDefaultQueries: disableDefaultQueries } } }, '#withEnablePodMonitor':: d.fn(help='"Enable or disable the `PodMonitor`"', args=[d.arg(name='enablePodMonitor', type=d.T.boolean)]), withEnablePodMonitor(enablePodMonitor): { spec+: { monitoring+: { enablePodMonitor: enablePodMonitor } } }, + '#withPodMonitorMetricRelabelings':: d.fn(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."', args=[d.arg(name='podMonitorMetricRelabelings', type=d.T.array)]), + withPodMonitorMetricRelabelings(podMonitorMetricRelabelings): { spec+: { monitoring+: { podMonitorMetricRelabelings: if std.isArray(v=podMonitorMetricRelabelings) then podMonitorMetricRelabelings else [podMonitorMetricRelabelings] } } }, + '#withPodMonitorMetricRelabelingsMixin':: d.fn(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podMonitorMetricRelabelings', type=d.T.array)]), + withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings): { spec+: { monitoring+: { podMonitorMetricRelabelings+: if std.isArray(v=podMonitorMetricRelabelings) then podMonitorMetricRelabelings else [podMonitorMetricRelabelings] } } }, + '#withPodMonitorRelabelings':: d.fn(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."', args=[d.arg(name='podMonitorRelabelings', type=d.T.array)]), + withPodMonitorRelabelings(podMonitorRelabelings): { spec+: { monitoring+: { podMonitorRelabelings: if std.isArray(v=podMonitorRelabelings) then podMonitorRelabelings else [podMonitorRelabelings] } } }, + '#withPodMonitorRelabelingsMixin':: d.fn(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podMonitorRelabelings', type=d.T.array)]), + withPodMonitorRelabelingsMixin(podMonitorRelabelings): { spec+: { monitoring+: { podMonitorRelabelings+: if std.isArray(v=podMonitorRelabelings) then podMonitorRelabelings else [podMonitorRelabelings] } } }, }, '#nodeMaintenanceWindow':: d.obj(help='"Define a maintenance window for the Kubernetes nodes"'), nodeMaintenanceWindow: { @@ -1131,6 +1185,8 @@ '#withNodeLabelsAntiAffinityMixin':: d.fn(help='"A list of node labels values to extract and compare to evaluate if the pods reside in the same topology or not"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='nodeLabelsAntiAffinity', type=d.T.array)]), withNodeLabelsAntiAffinityMixin(nodeLabelsAntiAffinity): { spec+: { postgresql+: { syncReplicaElectionConstraint+: { nodeLabelsAntiAffinity+: if std.isArray(v=nodeLabelsAntiAffinity) then nodeLabelsAntiAffinity else [nodeLabelsAntiAffinity] } } } }, }, + '#withEnableAlterSystem':: d.fn(help='"If this parameter is true, the user will be able to invoke `ALTER SYSTEM` on this CloudNativePG Cluster. This should only be used for debugging and troubleshooting. Defaults to false."', args=[d.arg(name='enableAlterSystem', type=d.T.boolean)]), + withEnableAlterSystem(enableAlterSystem): { spec+: { postgresql+: { enableAlterSystem: enableAlterSystem } } }, '#withParameters':: d.fn(help='"PostgreSQL configuration options (postgresql.conf)"', args=[d.arg(name='parameters', type=d.T.object)]), withParameters(parameters): { spec+: { postgresql+: { parameters: parameters } } }, '#withParametersMixin':: d.fn(help='"PostgreSQL configuration options (postgresql.conf)"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='parameters', type=d.T.object)]), @@ -1378,7 +1434,7 @@ withResizeInUseVolumes(resizeInUseVolumes): { spec+: { storage+: { resizeInUseVolumes: resizeInUseVolumes } } }, '#withSize':: d.fn(help='"Size of the storage. Required if not already specified in the PVC template. Changes to this field are automatically reapplied to the created PVCs. Size cannot be decreased."', args=[d.arg(name='size', type=d.T.string)]), withSize(size): { spec+: { storage+: { size: size } } }, - '#withStorageClass':: d.fn(help='"StorageClass to use for database data (`PGDATA`). Applied after evaluating the PVC template, if available. If not specified, generated PVCs will be satisfied by the default storage class"', args=[d.arg(name='storageClass', type=d.T.string)]), + '#withStorageClass':: d.fn(help='"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class"', args=[d.arg(name='storageClass', type=d.T.string)]), withStorageClass(storageClass): { spec+: { storage+: { storageClass: storageClass } } }, }, '#superuserSecret':: d.obj(help='"The secret containing the superuser password. If not defined a new secret will be created with a randomly generated password"'), @@ -1386,6 +1442,102 @@ '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), withName(name): { spec+: { superuserSecret+: { name: name } } }, }, + '#tablespaces':: d.obj(help='"The tablespaces configuration"'), + tablespaces: { + '#owner':: d.obj(help='"Owner is the PostgreSQL user owning the tablespace"'), + owner: { + '#withName':: d.fn(help='', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { owner+: { name: name } }, + }, + '#storage':: d.obj(help='"The storage configuration for the tablespace"'), + storage: { + '#pvcTemplate':: d.obj(help='"Template to be used to generate the Persistent Volume Claim"'), + pvcTemplate: { + '#dataSource':: d.obj(help='"dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource."'), + dataSource: { + '#withApiGroup':: d.fn(help='"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."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { storage+: { pvcTemplate+: { dataSource+: { apiGroup: apiGroup } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { storage+: { pvcTemplate+: { dataSource+: { kind: kind } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { storage+: { pvcTemplate+: { dataSource+: { name: name } } } }, + }, + '#dataSourceRef':: d.obj(help="\"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\""), + dataSourceRef: { + '#withApiGroup':: d.fn(help='"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."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { storage+: { pvcTemplate+: { dataSourceRef+: { apiGroup: apiGroup } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { storage+: { pvcTemplate+: { dataSourceRef+: { kind: kind } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { storage+: { pvcTemplate+: { dataSourceRef+: { name: name } } } }, + '#withNamespace':: d.fn(help="\"Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\"", args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { storage+: { pvcTemplate+: { dataSourceRef+: { namespace: namespace } } } }, + }, + '#resources':: d.obj(help='"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"'), + resources: { + '#claims':: d.obj(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."'), + claims: { + '#withName':: d.fn(help='"Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withClaims':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."', args=[d.arg(name='claims', type=d.T.array)]), + withClaims(claims): { storage+: { pvcTemplate+: { resources+: { claims: if std.isArray(v=claims) then claims else [claims] } } } }, + '#withClaimsMixin':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claims', type=d.T.array)]), + withClaimsMixin(claims): { storage+: { pvcTemplate+: { resources+: { claims+: if std.isArray(v=claims) then claims else [claims] } } } }, + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { storage+: { pvcTemplate+: { resources+: { limits: limits } } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { storage+: { pvcTemplate+: { resources+: { limits+: limits } } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { storage+: { pvcTemplate+: { resources+: { requests: requests } } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { storage+: { pvcTemplate+: { resources+: { requests+: requests } } } }, + }, + '#selector':: d.obj(help='"selector is a label query over volumes to consider for binding."'), + selector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"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."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { storage+: { pvcTemplate+: { selector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { storage+: { pvcTemplate+: { selector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } }, + '#withMatchLabels':: d.fn(help='"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."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { storage+: { pvcTemplate+: { selector+: { matchLabels: matchLabels } } } }, + '#withMatchLabelsMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { storage+: { pvcTemplate+: { selector+: { matchLabels+: matchLabels } } } }, + }, + '#withAccessModes':: d.fn(help='"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModes(accessModes): { storage+: { pvcTemplate+: { accessModes: if std.isArray(v=accessModes) then accessModes else [accessModes] } } }, + '#withAccessModesMixin':: d.fn(help='"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModesMixin(accessModes): { storage+: { pvcTemplate+: { accessModes+: if std.isArray(v=accessModes) then accessModes else [accessModes] } } }, + '#withStorageClassName':: d.fn(help='"storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"', args=[d.arg(name='storageClassName', type=d.T.string)]), + withStorageClassName(storageClassName): { storage+: { pvcTemplate+: { storageClassName: storageClassName } } }, + '#withVolumeMode':: d.fn(help='"volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec."', args=[d.arg(name='volumeMode', type=d.T.string)]), + withVolumeMode(volumeMode): { storage+: { pvcTemplate+: { volumeMode: volumeMode } } }, + '#withVolumeName':: d.fn(help='"volumeName is the binding reference to the PersistentVolume backing this claim."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { storage+: { pvcTemplate+: { volumeName: volumeName } } }, + }, + '#withResizeInUseVolumes':: d.fn(help='"Resize existent PVCs, defaults to true"', args=[d.arg(name='resizeInUseVolumes', type=d.T.boolean)]), + withResizeInUseVolumes(resizeInUseVolumes): { storage+: { resizeInUseVolumes: resizeInUseVolumes } }, + '#withSize':: d.fn(help='"Size of the storage. Required if not already specified in the PVC template. Changes to this field are automatically reapplied to the created PVCs. Size cannot be decreased."', args=[d.arg(name='size', type=d.T.string)]), + withSize(size): { storage+: { size: size } }, + '#withStorageClass':: d.fn(help='"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class"', args=[d.arg(name='storageClass', type=d.T.string)]), + withStorageClass(storageClass): { storage+: { storageClass: storageClass } }, + }, + '#withName':: d.fn(help='"The name of the tablespace"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withTemporary':: d.fn(help='"When set to true, the tablespace will be added as a `temp_tablespaces` entry in PostgreSQL, and will be available to automatically house temp database objects, or other temporary files. Please refer to PostgreSQL documentation for more information on the `temp_tablespaces` GUC."', args=[d.arg(name='temporary', type=d.T.boolean)]), + withTemporary(temporary): { temporary: temporary }, + }, '#topologySpreadConstraints':: d.obj(help='"TopologySpreadConstraints specifies how to spread matching pods among the given topology. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/"'), topologySpreadConstraints: { '#labelSelector':: d.obj(help='"LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain."'), @@ -1508,7 +1660,7 @@ withResizeInUseVolumes(resizeInUseVolumes): { spec+: { walStorage+: { resizeInUseVolumes: resizeInUseVolumes } } }, '#withSize':: d.fn(help='"Size of the storage. Required if not already specified in the PVC template. Changes to this field are automatically reapplied to the created PVCs. Size cannot be decreased."', args=[d.arg(name='size', type=d.T.string)]), withSize(size): { spec+: { walStorage+: { size: size } } }, - '#withStorageClass':: d.fn(help='"StorageClass to use for database data (`PGDATA`). Applied after evaluating the PVC template, if available. If not specified, generated PVCs will be satisfied by the default storage class"', args=[d.arg(name='storageClass', type=d.T.string)]), + '#withStorageClass':: d.fn(help='"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class"', args=[d.arg(name='storageClass', type=d.T.string)]), withStorageClass(storageClass): { spec+: { walStorage+: { storageClass: storageClass } } }, }, '#withDescription':: d.fn(help='"Description of this PostgreSQL cluster"', args=[d.arg(name='description', type=d.T.string)]), @@ -1565,6 +1717,10 @@ withStopDelay(stopDelay): { spec+: { stopDelay: stopDelay } }, '#withSwitchoverDelay':: d.fn(help='"The time in seconds that is allowed for a primary PostgreSQL instance to gracefully shutdown during a switchover. Default value is 3600 seconds (1 hour)."', args=[d.arg(name='switchoverDelay', type=d.T.integer)]), withSwitchoverDelay(switchoverDelay): { spec+: { switchoverDelay: switchoverDelay } }, + '#withTablespaces':: d.fn(help='"The tablespaces configuration"', args=[d.arg(name='tablespaces', type=d.T.array)]), + withTablespaces(tablespaces): { spec+: { tablespaces: if std.isArray(v=tablespaces) then tablespaces else [tablespaces] } }, + '#withTablespacesMixin':: d.fn(help='"The tablespaces configuration"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='tablespaces', type=d.T.array)]), + withTablespacesMixin(tablespaces): { spec+: { tablespaces+: if std.isArray(v=tablespaces) then tablespaces else [tablespaces] } }, '#withTopologySpreadConstraints':: d.fn(help='"TopologySpreadConstraints specifies how to spread matching pods among the given topology. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/"', args=[d.arg(name='topologySpreadConstraints', type=d.T.array)]), withTopologySpreadConstraints(topologySpreadConstraints): { spec+: { topologySpreadConstraints: if std.isArray(v=topologySpreadConstraints) then topologySpreadConstraints else [topologySpreadConstraints] } }, '#withTopologySpreadConstraintsMixin':: d.fn(help='"TopologySpreadConstraints specifies how to spread matching pods among the given topology. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='topologySpreadConstraints', type=d.T.array)]), diff --git a/1.21.1/_gen/postgresql/v1/pooler.libsonnet b/1.21.1/_gen/postgresql/v1/pooler.libsonnet index 95018cc..c60376a 100644 --- a/1.21.1/_gen/postgresql/v1/pooler.libsonnet +++ b/1.21.1/_gen/postgresql/v1/pooler.libsonnet @@ -68,8 +68,54 @@ }, '#monitoring':: d.obj(help='"The configuration of the monitoring infrastructure of this pooler."'), monitoring: { + '#podMonitorMetricRelabelings':: d.obj(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."'), + podMonitorMetricRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching. \\n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \\n Default: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values. \\n Only applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the regular expression matches. \\n Regex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement. \\n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \\n Regex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#podMonitorRelabelings':: d.obj(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."'), + podMonitorRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching. \\n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \\n Default: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values. \\n Only applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the regular expression matches. \\n Regex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement. \\n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \\n Regex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, '#withEnablePodMonitor':: d.fn(help='"Enable or disable the `PodMonitor`"', args=[d.arg(name='enablePodMonitor', type=d.T.boolean)]), withEnablePodMonitor(enablePodMonitor): { spec+: { monitoring+: { enablePodMonitor: enablePodMonitor } } }, + '#withPodMonitorMetricRelabelings':: d.fn(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."', args=[d.arg(name='podMonitorMetricRelabelings', type=d.T.array)]), + withPodMonitorMetricRelabelings(podMonitorMetricRelabelings): { spec+: { monitoring+: { podMonitorMetricRelabelings: if std.isArray(v=podMonitorMetricRelabelings) then podMonitorMetricRelabelings else [podMonitorMetricRelabelings] } } }, + '#withPodMonitorMetricRelabelingsMixin':: d.fn(help='"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podMonitorMetricRelabelings', type=d.T.array)]), + withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings): { spec+: { monitoring+: { podMonitorMetricRelabelings+: if std.isArray(v=podMonitorMetricRelabelings) then podMonitorMetricRelabelings else [podMonitorMetricRelabelings] } } }, + '#withPodMonitorRelabelings':: d.fn(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."', args=[d.arg(name='podMonitorRelabelings', type=d.T.array)]), + withPodMonitorRelabelings(podMonitorRelabelings): { spec+: { monitoring+: { podMonitorRelabelings: if std.isArray(v=podMonitorRelabelings) then podMonitorRelabelings else [podMonitorRelabelings] } } }, + '#withPodMonitorRelabelingsMixin':: d.fn(help='"The list of relabelings for the `PodMonitor`. Applied to samples before scraping."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podMonitorRelabelings', type=d.T.array)]), + withPodMonitorRelabelingsMixin(podMonitorRelabelings): { spec+: { monitoring+: { podMonitorRelabelings+: if std.isArray(v=podMonitorRelabelings) then podMonitorRelabelings else [podMonitorRelabelings] } } }, }, '#pgbouncer':: d.obj(help='"The PgBouncer configuration"'), pgbouncer: { diff --git a/docs/1.18.5/postgresql/v1/cluster.md b/docs/1.18.5/postgresql/v1/cluster.md index 3b6a95e..1fb5c46 100644 --- a/docs/1.18.5/postgresql/v1/cluster.md +++ b/docs/1.18.5/postgresql/v1/cluster.md @@ -57,6 +57,8 @@ permalink: /1.18.5/postgresql/v1/cluster/ * [`fn withStartDelay(startDelay)`](#fn-specwithstartdelay) * [`fn withStopDelay(stopDelay)`](#fn-specwithstopdelay) * [`fn withSwitchoverDelay(switchoverDelay)`](#fn-specwithswitchoverdelay) + * [`fn withTablespaces(tablespaces)`](#fn-specwithtablespaces) + * [`fn withTablespacesMixin(tablespaces)`](#fn-specwithtablespacesmixin) * [`fn withTopologySpreadConstraints(topologySpreadConstraints)`](#fn-specwithtopologyspreadconstraints) * [`fn withTopologySpreadConstraintsMixin(topologySpreadConstraints)`](#fn-specwithtopologyspreadconstraintsmixin) * [`obj spec.affinity`](#obj-specaffinity) @@ -285,6 +287,8 @@ permalink: /1.18.5/postgresql/v1/cluster/ * [`fn withLabelsMixin(labels)`](#fn-specbackupvolumesnapshotwithlabelsmixin) * [`fn withOnline(online)`](#fn-specbackupvolumesnapshotwithonline) * [`fn withSnapshotOwnerReference(snapshotOwnerReference)`](#fn-specbackupvolumesnapshotwithsnapshotownerreference) + * [`fn withTablespaceClassName(tablespaceClassName)`](#fn-specbackupvolumesnapshotwithtablespaceclassname) + * [`fn withTablespaceClassNameMixin(tablespaceClassName)`](#fn-specbackupvolumesnapshotwithtablespaceclassnamemixin) * [`fn withWalClassName(walClassName)`](#fn-specbackupvolumesnapshotwithwalclassname) * [`obj spec.backup.volumeSnapshot.onlineConfiguration`](#obj-specbackupvolumesnapshotonlineconfiguration) * [`fn withImmediateCheckpoint(immediateCheckpoint)`](#fn-specbackupvolumesnapshotonlineconfigurationwithimmediatecheckpoint) @@ -357,6 +361,8 @@ permalink: /1.18.5/postgresql/v1/cluster/ * [`obj spec.bootstrap.recovery.secret`](#obj-specbootstraprecoverysecret) * [`fn withName(name)`](#fn-specbootstraprecoverysecretwithname) * [`obj spec.bootstrap.recovery.volumeSnapshots`](#obj-specbootstraprecoveryvolumesnapshots) + * [`fn withTablespaceStorage(tablespaceStorage)`](#fn-specbootstraprecoveryvolumesnapshotswithtablespacestorage) + * [`fn withTablespaceStorageMixin(tablespaceStorage)`](#fn-specbootstraprecoveryvolumesnapshotswithtablespacestoragemixin) * [`obj spec.bootstrap.recovery.volumeSnapshots.storage`](#obj-specbootstraprecoveryvolumesnapshotsstorage) * [`fn withApiGroup(apiGroup)`](#fn-specbootstraprecoveryvolumesnapshotsstoragewithapigroup) * [`fn withKind(kind)`](#fn-specbootstraprecoveryvolumesnapshotsstoragewithkind) @@ -510,16 +516,39 @@ permalink: /1.18.5/postgresql/v1/cluster/ * [`fn withCustomQueriesSecretMixin(customQueriesSecret)`](#fn-specmonitoringwithcustomqueriessecretmixin) * [`fn withDisableDefaultQueries(disableDefaultQueries)`](#fn-specmonitoringwithdisabledefaultqueries) * [`fn withEnablePodMonitor(enablePodMonitor)`](#fn-specmonitoringwithenablepodmonitor) + * [`fn withPodMonitorMetricRelabelings(podMonitorMetricRelabelings)`](#fn-specmonitoringwithpodmonitormetricrelabelings) + * [`fn withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings)`](#fn-specmonitoringwithpodmonitormetricrelabelingsmixin) + * [`fn withPodMonitorRelabelings(podMonitorRelabelings)`](#fn-specmonitoringwithpodmonitorrelabelings) + * [`fn withPodMonitorRelabelingsMixin(podMonitorRelabelings)`](#fn-specmonitoringwithpodmonitorrelabelingsmixin) * [`obj spec.monitoring.customQueriesConfigMap`](#obj-specmonitoringcustomqueriesconfigmap) * [`fn withKey(key)`](#fn-specmonitoringcustomqueriesconfigmapwithkey) * [`fn withName(name)`](#fn-specmonitoringcustomqueriesconfigmapwithname) * [`obj spec.monitoring.customQueriesSecret`](#obj-specmonitoringcustomqueriessecret) * [`fn withKey(key)`](#fn-specmonitoringcustomqueriessecretwithkey) * [`fn withName(name)`](#fn-specmonitoringcustomqueriessecretwithname) + * [`obj spec.monitoring.podMonitorMetricRelabelings`](#obj-specmonitoringpodmonitormetricrelabelings) + * [`fn withAction(action)`](#fn-specmonitoringpodmonitormetricrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specmonitoringpodmonitormetricrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specmonitoringpodmonitormetricrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specmonitoringpodmonitormetricrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specmonitoringpodmonitormetricrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specmonitoringpodmonitormetricrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specmonitoringpodmonitormetricrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specmonitoringpodmonitormetricrelabelingswithtargetlabel) + * [`obj spec.monitoring.podMonitorRelabelings`](#obj-specmonitoringpodmonitorrelabelings) + * [`fn withAction(action)`](#fn-specmonitoringpodmonitorrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specmonitoringpodmonitorrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specmonitoringpodmonitorrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specmonitoringpodmonitorrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specmonitoringpodmonitorrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specmonitoringpodmonitorrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specmonitoringpodmonitorrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specmonitoringpodmonitorrelabelingswithtargetlabel) * [`obj spec.nodeMaintenanceWindow`](#obj-specnodemaintenancewindow) * [`fn withInProgress(inProgress)`](#fn-specnodemaintenancewindowwithinprogress) * [`fn withReusePVC(reusePVC)`](#fn-specnodemaintenancewindowwithreusepvc) * [`obj spec.postgresql`](#obj-specpostgresql) + * [`fn withEnableAlterSystem(enableAlterSystem)`](#fn-specpostgresqlwithenablealtersystem) * [`fn withParameters(parameters)`](#fn-specpostgresqlwithparameters) * [`fn withParametersMixin(parameters)`](#fn-specpostgresqlwithparametersmixin) * [`fn withPg_hba(pg_hba)`](#fn-specpostgresqlwithpg_hba) @@ -654,6 +683,49 @@ permalink: /1.18.5/postgresql/v1/cluster/ * [`fn withValuesMixin(values)`](#fn-specstoragepvctemplateselectormatchexpressionswithvaluesmixin) * [`obj spec.superuserSecret`](#obj-specsuperusersecret) * [`fn withName(name)`](#fn-specsuperusersecretwithname) + * [`obj spec.tablespaces`](#obj-spectablespaces) + * [`fn withName(name)`](#fn-spectablespaceswithname) + * [`fn withTemporary(temporary)`](#fn-spectablespaceswithtemporary) + * [`obj spec.tablespaces.owner`](#obj-spectablespacesowner) + * [`fn withName(name)`](#fn-spectablespacesownerwithname) + * [`obj spec.tablespaces.storage`](#obj-spectablespacesstorage) + * [`fn withResizeInUseVolumes(resizeInUseVolumes)`](#fn-spectablespacesstoragewithresizeinusevolumes) + * [`fn withSize(size)`](#fn-spectablespacesstoragewithsize) + * [`fn withStorageClass(storageClass)`](#fn-spectablespacesstoragewithstorageclass) + * [`obj spec.tablespaces.storage.pvcTemplate`](#obj-spectablespacesstoragepvctemplate) + * [`fn withAccessModes(accessModes)`](#fn-spectablespacesstoragepvctemplatewithaccessmodes) + * [`fn withAccessModesMixin(accessModes)`](#fn-spectablespacesstoragepvctemplatewithaccessmodesmixin) + * [`fn withStorageClassName(storageClassName)`](#fn-spectablespacesstoragepvctemplatewithstorageclassname) + * [`fn withVolumeMode(volumeMode)`](#fn-spectablespacesstoragepvctemplatewithvolumemode) + * [`fn withVolumeName(volumeName)`](#fn-spectablespacesstoragepvctemplatewithvolumename) + * [`obj spec.tablespaces.storage.pvcTemplate.dataSource`](#obj-spectablespacesstoragepvctemplatedatasource) + * [`fn withApiGroup(apiGroup)`](#fn-spectablespacesstoragepvctemplatedatasourcewithapigroup) + * [`fn withKind(kind)`](#fn-spectablespacesstoragepvctemplatedatasourcewithkind) + * [`fn withName(name)`](#fn-spectablespacesstoragepvctemplatedatasourcewithname) + * [`obj spec.tablespaces.storage.pvcTemplate.dataSourceRef`](#obj-spectablespacesstoragepvctemplatedatasourceref) + * [`fn withApiGroup(apiGroup)`](#fn-spectablespacesstoragepvctemplatedatasourcerefwithapigroup) + * [`fn withKind(kind)`](#fn-spectablespacesstoragepvctemplatedatasourcerefwithkind) + * [`fn withName(name)`](#fn-spectablespacesstoragepvctemplatedatasourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-spectablespacesstoragepvctemplatedatasourcerefwithnamespace) + * [`obj spec.tablespaces.storage.pvcTemplate.resources`](#obj-spectablespacesstoragepvctemplateresources) + * [`fn withClaims(claims)`](#fn-spectablespacesstoragepvctemplateresourceswithclaims) + * [`fn withClaimsMixin(claims)`](#fn-spectablespacesstoragepvctemplateresourceswithclaimsmixin) + * [`fn withLimits(limits)`](#fn-spectablespacesstoragepvctemplateresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-spectablespacesstoragepvctemplateresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-spectablespacesstoragepvctemplateresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-spectablespacesstoragepvctemplateresourceswithrequestsmixin) + * [`obj spec.tablespaces.storage.pvcTemplate.resources.claims`](#obj-spectablespacesstoragepvctemplateresourcesclaims) + * [`fn withName(name)`](#fn-spectablespacesstoragepvctemplateresourcesclaimswithname) + * [`obj spec.tablespaces.storage.pvcTemplate.selector`](#obj-spectablespacesstoragepvctemplateselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-spectablespacesstoragepvctemplateselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-spectablespacesstoragepvctemplateselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-spectablespacesstoragepvctemplateselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-spectablespacesstoragepvctemplateselectorwithmatchlabelsmixin) + * [`obj spec.tablespaces.storage.pvcTemplate.selector.matchExpressions`](#obj-spectablespacesstoragepvctemplateselectormatchexpressions) + * [`fn withKey(key)`](#fn-spectablespacesstoragepvctemplateselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-spectablespacesstoragepvctemplateselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-spectablespacesstoragepvctemplateselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-spectablespacesstoragepvctemplateselectormatchexpressionswithvaluesmixin) * [`obj spec.topologySpreadConstraints`](#obj-spectopologyspreadconstraints) * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-spectopologyspreadconstraintswithmatchlabelkeys) * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-spectopologyspreadconstraintswithmatchlabelkeysmixin) @@ -1114,6 +1186,24 @@ withSwitchoverDelay(switchoverDelay) "The time in seconds that is allowed for a primary PostgreSQL instance to gracefully shutdown during a switchover. Default value is 3600 seconds (1 hour)." +### fn spec.withTablespaces + +```ts +withTablespaces(tablespaces) +``` + +"The tablespaces configuration" + +### fn spec.withTablespacesMixin + +```ts +withTablespacesMixin(tablespaces) +``` + +"The tablespaces configuration" + +**Note:** This function appends passed data to existing values + ### fn spec.withTopologySpreadConstraints ```ts @@ -2824,6 +2914,24 @@ withSnapshotOwnerReference(snapshotOwnerReference) "SnapshotOwnerReference indicates the type of owner reference the snapshot should have" +### fn spec.backup.volumeSnapshot.withTablespaceClassName + +```ts +withTablespaceClassName(tablespaceClassName) +``` + +"TablespaceClassName specifies the Snapshot Class to be used for the tablespaces. defaults to the PGDATA Snapshot Class, if set" + +### fn spec.backup.volumeSnapshot.withTablespaceClassNameMixin + +```ts +withTablespaceClassNameMixin(tablespaceClassName) +``` + +"TablespaceClassName specifies the Snapshot Class to be used for the tablespaces. defaults to the PGDATA Snapshot Class, if set" + +**Note:** This function appends passed data to existing values + ### fn spec.backup.volumeSnapshot.withWalClassName ```ts @@ -3350,6 +3458,24 @@ withName(name) "The static PVC data source(s) from which to initiate the recovery procedure. Currently supporting `VolumeSnapshot` and `PersistentVolumeClaim` resources that map an existing PVC group, compatible with CloudNativePG, and taken with a cold backup copy on a fenced Postgres instance (limitation which will be removed in the future when online backup will be implemented). Mutually exclusive with `backup`." +### fn spec.bootstrap.recovery.volumeSnapshots.withTablespaceStorage + +```ts +withTablespaceStorage(tablespaceStorage) +``` + +"Configuration of the storage for PostgreSQL tablespaces" + +### fn spec.bootstrap.recovery.volumeSnapshots.withTablespaceStorageMixin + +```ts +withTablespaceStorageMixin(tablespaceStorage) +``` + +"Configuration of the storage for PostgreSQL tablespaces" + +**Note:** This function appends passed data to existing values + ## obj spec.bootstrap.recovery.volumeSnapshots.storage "Configuration of the storage of the instances" @@ -4056,7 +4182,7 @@ withMaxParallel(maxParallel) ## obj spec.externalClusters.password -"The reference to the password to be used to connect to the server" +"The reference to the password to be used to connect to the server. If a password is provided, CloudNativePG creates a PostgreSQL passfile at `/controller/external/NAME/pass` (where \"NAME\" is the cluster's name). This passfile is automatically referenced in the connection string when establishing a connection to the remote PostgreSQL server from the current PostgreSQL `Cluster`. This ensures secure and efficient password management for external clusters." ### fn spec.externalClusters.password.withKey @@ -4434,6 +4560,42 @@ withEnablePodMonitor(enablePodMonitor) "Enable or disable the `PodMonitor`" +### fn spec.monitoring.withPodMonitorMetricRelabelings + +```ts +withPodMonitorMetricRelabelings(podMonitorMetricRelabelings) +``` + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +### fn spec.monitoring.withPodMonitorMetricRelabelingsMixin + +```ts +withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings) +``` + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.withPodMonitorRelabelings + +```ts +withPodMonitorRelabelings(podMonitorRelabelings) +``` + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +### fn spec.monitoring.withPodMonitorRelabelingsMixin + +```ts +withPodMonitorRelabelingsMixin(podMonitorRelabelings) +``` + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +**Note:** This function appends passed data to existing values + ## obj spec.monitoring.customQueriesConfigMap "The list of config maps containing the custom queries" @@ -4474,6 +4636,146 @@ withName(name) "Name of the referent." +## obj spec.monitoring.podMonitorMetricRelabelings + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +### fn spec.monitoring.podMonitorMetricRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching. \n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \n Default: \"Replace\ + +### fn spec.monitoring.podMonitorMetricRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values. \n Only applicable when the action is `HashMod`." + +### fn spec.monitoring.podMonitorMetricRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.monitoring.podMonitorMetricRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the regular expression matches. \n Regex capture groups are available." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.podMonitorMetricRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement. \n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \n Regex capture groups are available." + +## obj spec.monitoring.podMonitorRelabelings + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +### fn spec.monitoring.podMonitorRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching. \n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \n Default: \"Replace\ + +### fn spec.monitoring.podMonitorRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values. \n Only applicable when the action is `HashMod`." + +### fn spec.monitoring.podMonitorRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.monitoring.podMonitorRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the regular expression matches. \n Regex capture groups are available." + +### fn spec.monitoring.podMonitorRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.monitoring.podMonitorRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +### fn spec.monitoring.podMonitorRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.podMonitorRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement. \n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \n Regex capture groups are available." + ## obj spec.nodeMaintenanceWindow "Define a maintenance window for the Kubernetes nodes" @@ -4498,6 +4800,14 @@ withReusePVC(reusePVC) "Configuration of the PostgreSQL server" +### fn spec.postgresql.withEnableAlterSystem + +```ts +withEnableAlterSystem(enableAlterSystem) +``` + +"If this parameter is true, the user will be able to invoke `ALTER SYSTEM` on this CloudNativePG Cluster. This should only be used for debugging and troubleshooting. Defaults to false." + ### fn spec.postgresql.withParameters ```ts @@ -5206,7 +5516,7 @@ withSize(size) withStorageClass(storageClass) ``` -"StorageClass to use for database data (`PGDATA`). Applied after evaluating the PVC template, if available. If not specified, generated PVCs will be satisfied by the default storage class" +"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class" ## obj spec.storage.pvcTemplate @@ -5478,6 +5788,324 @@ withName(name) "Name of the referent." +## obj spec.tablespaces + +"The tablespaces configuration" + +### fn spec.tablespaces.withName + +```ts +withName(name) +``` + +"The name of the tablespace" + +### fn spec.tablespaces.withTemporary + +```ts +withTemporary(temporary) +``` + +"When set to true, the tablespace will be added as a `temp_tablespaces` entry in PostgreSQL, and will be available to automatically house temp database objects, or other temporary files. Please refer to PostgreSQL documentation for more information on the `temp_tablespaces` GUC." + +## obj spec.tablespaces.owner + +"Owner is the PostgreSQL user owning the tablespace" + +### fn spec.tablespaces.owner.withName + +```ts +withName(name) +``` + + + +## obj spec.tablespaces.storage + +"The storage configuration for the tablespace" + +### fn spec.tablespaces.storage.withResizeInUseVolumes + +```ts +withResizeInUseVolumes(resizeInUseVolumes) +``` + +"Resize existent PVCs, defaults to true" + +### fn spec.tablespaces.storage.withSize + +```ts +withSize(size) +``` + +"Size of the storage. Required if not already specified in the PVC template. Changes to this field are automatically reapplied to the created PVCs. Size cannot be decreased." + +### fn spec.tablespaces.storage.withStorageClass + +```ts +withStorageClass(storageClass) +``` + +"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class" + +## obj spec.tablespaces.storage.pvcTemplate + +"Template to be used to generate the Persistent Volume Claim" + +### fn spec.tablespaces.storage.pvcTemplate.withAccessModes + +```ts +withAccessModes(accessModes) +``` + +"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +### fn spec.tablespaces.storage.pvcTemplate.withAccessModesMixin + +```ts +withAccessModesMixin(accessModes) +``` + +"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +**Note:** This function appends passed data to existing values + +### fn spec.tablespaces.storage.pvcTemplate.withStorageClassName + +```ts +withStorageClassName(storageClassName) +``` + +"storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1" + +### fn spec.tablespaces.storage.pvcTemplate.withVolumeMode + +```ts +withVolumeMode(volumeMode) +``` + +"volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec." + +### fn spec.tablespaces.storage.pvcTemplate.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the binding reference to the PersistentVolume backing this claim." + +## obj spec.tablespaces.storage.pvcTemplate.dataSource + +"dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource." + +### fn spec.tablespaces.storage.pvcTemplate.dataSource.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"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." + +### fn spec.tablespaces.storage.pvcTemplate.dataSource.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.tablespaces.storage.pvcTemplate.dataSource.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +## obj spec.tablespaces.storage.pvcTemplate.dataSourceRef + +"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +### fn spec.tablespaces.storage.pvcTemplate.dataSourceRef.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"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." + +### fn spec.tablespaces.storage.pvcTemplate.dataSourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.tablespaces.storage.pvcTemplate.dataSourceRef.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +### fn spec.tablespaces.storage.pvcTemplate.dataSourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +## obj spec.tablespaces.storage.pvcTemplate.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" + +### fn spec.tablespaces.storage.pvcTemplate.resources.withClaims + +```ts +withClaims(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +### fn spec.tablespaces.storage.pvcTemplate.resources.withClaimsMixin + +```ts +withClaimsMixin(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +**Note:** This function appends passed data to existing values + +### fn spec.tablespaces.storage.pvcTemplate.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.tablespaces.storage.pvcTemplate.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.tablespaces.storage.pvcTemplate.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.tablespaces.storage.pvcTemplate.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.tablespaces.storage.pvcTemplate.resources.claims + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +### fn spec.tablespaces.storage.pvcTemplate.resources.claims.withName + +```ts +withName(name) +``` + +"Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container." + +## obj spec.tablespaces.storage.pvcTemplate.selector + +"selector is a label query over volumes to consider for binding." + +### fn spec.tablespaces.storage.pvcTemplate.selector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.tablespaces.storage.pvcTemplate.selector.withMatchExpressionsMixin + +```ts +withMatchExpressionsMixin(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +### fn spec.tablespaces.storage.pvcTemplate.selector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"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." + +### fn spec.tablespaces.storage.pvcTemplate.selector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"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." + +**Note:** This function appends passed data to existing values + +## obj spec.tablespaces.storage.pvcTemplate.selector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.tablespaces.storage.pvcTemplate.selector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.tablespaces.storage.pvcTemplate.selector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.tablespaces.storage.pvcTemplate.selector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"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." + +### fn spec.tablespaces.storage.pvcTemplate.selector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"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." + +**Note:** This function appends passed data to existing values + ## obj spec.topologySpreadConstraints "TopologySpreadConstraints specifies how to spread matching pods among the given topology. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/" @@ -5652,7 +6280,7 @@ withSize(size) withStorageClass(storageClass) ``` -"StorageClass to use for database data (`PGDATA`). Applied after evaluating the PVC template, if available. If not specified, generated PVCs will be satisfied by the default storage class" +"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class" ## obj spec.walStorage.pvcTemplate diff --git a/docs/1.18.5/postgresql/v1/pooler.md b/docs/1.18.5/postgresql/v1/pooler.md index 9d9295d..b9b20d2 100644 --- a/docs/1.18.5/postgresql/v1/pooler.md +++ b/docs/1.18.5/postgresql/v1/pooler.md @@ -41,6 +41,28 @@ permalink: /1.18.5/postgresql/v1/pooler/ * [`fn withMaxUnavailable(maxUnavailable)`](#fn-specdeploymentstrategyrollingupdatewithmaxunavailable) * [`obj spec.monitoring`](#obj-specmonitoring) * [`fn withEnablePodMonitor(enablePodMonitor)`](#fn-specmonitoringwithenablepodmonitor) + * [`fn withPodMonitorMetricRelabelings(podMonitorMetricRelabelings)`](#fn-specmonitoringwithpodmonitormetricrelabelings) + * [`fn withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings)`](#fn-specmonitoringwithpodmonitormetricrelabelingsmixin) + * [`fn withPodMonitorRelabelings(podMonitorRelabelings)`](#fn-specmonitoringwithpodmonitorrelabelings) + * [`fn withPodMonitorRelabelingsMixin(podMonitorRelabelings)`](#fn-specmonitoringwithpodmonitorrelabelingsmixin) + * [`obj spec.monitoring.podMonitorMetricRelabelings`](#obj-specmonitoringpodmonitormetricrelabelings) + * [`fn withAction(action)`](#fn-specmonitoringpodmonitormetricrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specmonitoringpodmonitormetricrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specmonitoringpodmonitormetricrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specmonitoringpodmonitormetricrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specmonitoringpodmonitormetricrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specmonitoringpodmonitormetricrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specmonitoringpodmonitormetricrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specmonitoringpodmonitormetricrelabelingswithtargetlabel) + * [`obj spec.monitoring.podMonitorRelabelings`](#obj-specmonitoringpodmonitorrelabelings) + * [`fn withAction(action)`](#fn-specmonitoringpodmonitorrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specmonitoringpodmonitorrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specmonitoringpodmonitorrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specmonitoringpodmonitorrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specmonitoringpodmonitorrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specmonitoringpodmonitorrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specmonitoringpodmonitorrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specmonitoringpodmonitorrelabelingswithtargetlabel) * [`obj spec.pgbouncer`](#obj-specpgbouncer) * [`fn withAuthQuery(authQuery)`](#fn-specpgbouncerwithauthquery) * [`fn withParameters(parameters)`](#fn-specpgbouncerwithparameters) @@ -1509,6 +1531,182 @@ withEnablePodMonitor(enablePodMonitor) "Enable or disable the `PodMonitor`" +### fn spec.monitoring.withPodMonitorMetricRelabelings + +```ts +withPodMonitorMetricRelabelings(podMonitorMetricRelabelings) +``` + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +### fn spec.monitoring.withPodMonitorMetricRelabelingsMixin + +```ts +withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings) +``` + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.withPodMonitorRelabelings + +```ts +withPodMonitorRelabelings(podMonitorRelabelings) +``` + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +### fn spec.monitoring.withPodMonitorRelabelingsMixin + +```ts +withPodMonitorRelabelingsMixin(podMonitorRelabelings) +``` + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +**Note:** This function appends passed data to existing values + +## obj spec.monitoring.podMonitorMetricRelabelings + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +### fn spec.monitoring.podMonitorMetricRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching. \n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \n Default: \"Replace\ + +### fn spec.monitoring.podMonitorMetricRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values. \n Only applicable when the action is `HashMod`." + +### fn spec.monitoring.podMonitorMetricRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.monitoring.podMonitorMetricRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the regular expression matches. \n Regex capture groups are available." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.podMonitorMetricRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement. \n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \n Regex capture groups are available." + +## obj spec.monitoring.podMonitorRelabelings + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +### fn spec.monitoring.podMonitorRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching. \n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \n Default: \"Replace\ + +### fn spec.monitoring.podMonitorRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values. \n Only applicable when the action is `HashMod`." + +### fn spec.monitoring.podMonitorRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.monitoring.podMonitorRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the regular expression matches. \n Regex capture groups are available." + +### fn spec.monitoring.podMonitorRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.monitoring.podMonitorRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +### fn spec.monitoring.podMonitorRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.podMonitorRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement. \n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \n Regex capture groups are available." + ## obj spec.pgbouncer "The PgBouncer configuration" diff --git a/docs/1.19.6/postgresql/v1/cluster.md b/docs/1.19.6/postgresql/v1/cluster.md index c5f530b..9d100c7 100644 --- a/docs/1.19.6/postgresql/v1/cluster.md +++ b/docs/1.19.6/postgresql/v1/cluster.md @@ -57,6 +57,8 @@ permalink: /1.19.6/postgresql/v1/cluster/ * [`fn withStartDelay(startDelay)`](#fn-specwithstartdelay) * [`fn withStopDelay(stopDelay)`](#fn-specwithstopdelay) * [`fn withSwitchoverDelay(switchoverDelay)`](#fn-specwithswitchoverdelay) + * [`fn withTablespaces(tablespaces)`](#fn-specwithtablespaces) + * [`fn withTablespacesMixin(tablespaces)`](#fn-specwithtablespacesmixin) * [`fn withTopologySpreadConstraints(topologySpreadConstraints)`](#fn-specwithtopologyspreadconstraints) * [`fn withTopologySpreadConstraintsMixin(topologySpreadConstraints)`](#fn-specwithtopologyspreadconstraintsmixin) * [`obj spec.affinity`](#obj-specaffinity) @@ -285,6 +287,8 @@ permalink: /1.19.6/postgresql/v1/cluster/ * [`fn withLabelsMixin(labels)`](#fn-specbackupvolumesnapshotwithlabelsmixin) * [`fn withOnline(online)`](#fn-specbackupvolumesnapshotwithonline) * [`fn withSnapshotOwnerReference(snapshotOwnerReference)`](#fn-specbackupvolumesnapshotwithsnapshotownerreference) + * [`fn withTablespaceClassName(tablespaceClassName)`](#fn-specbackupvolumesnapshotwithtablespaceclassname) + * [`fn withTablespaceClassNameMixin(tablespaceClassName)`](#fn-specbackupvolumesnapshotwithtablespaceclassnamemixin) * [`fn withWalClassName(walClassName)`](#fn-specbackupvolumesnapshotwithwalclassname) * [`obj spec.backup.volumeSnapshot.onlineConfiguration`](#obj-specbackupvolumesnapshotonlineconfiguration) * [`fn withImmediateCheckpoint(immediateCheckpoint)`](#fn-specbackupvolumesnapshotonlineconfigurationwithimmediatecheckpoint) @@ -357,6 +361,8 @@ permalink: /1.19.6/postgresql/v1/cluster/ * [`obj spec.bootstrap.recovery.secret`](#obj-specbootstraprecoverysecret) * [`fn withName(name)`](#fn-specbootstraprecoverysecretwithname) * [`obj spec.bootstrap.recovery.volumeSnapshots`](#obj-specbootstraprecoveryvolumesnapshots) + * [`fn withTablespaceStorage(tablespaceStorage)`](#fn-specbootstraprecoveryvolumesnapshotswithtablespacestorage) + * [`fn withTablespaceStorageMixin(tablespaceStorage)`](#fn-specbootstraprecoveryvolumesnapshotswithtablespacestoragemixin) * [`obj spec.bootstrap.recovery.volumeSnapshots.storage`](#obj-specbootstraprecoveryvolumesnapshotsstorage) * [`fn withApiGroup(apiGroup)`](#fn-specbootstraprecoveryvolumesnapshotsstoragewithapigroup) * [`fn withKind(kind)`](#fn-specbootstraprecoveryvolumesnapshotsstoragewithkind) @@ -510,16 +516,39 @@ permalink: /1.19.6/postgresql/v1/cluster/ * [`fn withCustomQueriesSecretMixin(customQueriesSecret)`](#fn-specmonitoringwithcustomqueriessecretmixin) * [`fn withDisableDefaultQueries(disableDefaultQueries)`](#fn-specmonitoringwithdisabledefaultqueries) * [`fn withEnablePodMonitor(enablePodMonitor)`](#fn-specmonitoringwithenablepodmonitor) + * [`fn withPodMonitorMetricRelabelings(podMonitorMetricRelabelings)`](#fn-specmonitoringwithpodmonitormetricrelabelings) + * [`fn withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings)`](#fn-specmonitoringwithpodmonitormetricrelabelingsmixin) + * [`fn withPodMonitorRelabelings(podMonitorRelabelings)`](#fn-specmonitoringwithpodmonitorrelabelings) + * [`fn withPodMonitorRelabelingsMixin(podMonitorRelabelings)`](#fn-specmonitoringwithpodmonitorrelabelingsmixin) * [`obj spec.monitoring.customQueriesConfigMap`](#obj-specmonitoringcustomqueriesconfigmap) * [`fn withKey(key)`](#fn-specmonitoringcustomqueriesconfigmapwithkey) * [`fn withName(name)`](#fn-specmonitoringcustomqueriesconfigmapwithname) * [`obj spec.monitoring.customQueriesSecret`](#obj-specmonitoringcustomqueriessecret) * [`fn withKey(key)`](#fn-specmonitoringcustomqueriessecretwithkey) * [`fn withName(name)`](#fn-specmonitoringcustomqueriessecretwithname) + * [`obj spec.monitoring.podMonitorMetricRelabelings`](#obj-specmonitoringpodmonitormetricrelabelings) + * [`fn withAction(action)`](#fn-specmonitoringpodmonitormetricrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specmonitoringpodmonitormetricrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specmonitoringpodmonitormetricrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specmonitoringpodmonitormetricrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specmonitoringpodmonitormetricrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specmonitoringpodmonitormetricrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specmonitoringpodmonitormetricrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specmonitoringpodmonitormetricrelabelingswithtargetlabel) + * [`obj spec.monitoring.podMonitorRelabelings`](#obj-specmonitoringpodmonitorrelabelings) + * [`fn withAction(action)`](#fn-specmonitoringpodmonitorrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specmonitoringpodmonitorrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specmonitoringpodmonitorrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specmonitoringpodmonitorrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specmonitoringpodmonitorrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specmonitoringpodmonitorrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specmonitoringpodmonitorrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specmonitoringpodmonitorrelabelingswithtargetlabel) * [`obj spec.nodeMaintenanceWindow`](#obj-specnodemaintenancewindow) * [`fn withInProgress(inProgress)`](#fn-specnodemaintenancewindowwithinprogress) * [`fn withReusePVC(reusePVC)`](#fn-specnodemaintenancewindowwithreusepvc) * [`obj spec.postgresql`](#obj-specpostgresql) + * [`fn withEnableAlterSystem(enableAlterSystem)`](#fn-specpostgresqlwithenablealtersystem) * [`fn withParameters(parameters)`](#fn-specpostgresqlwithparameters) * [`fn withParametersMixin(parameters)`](#fn-specpostgresqlwithparametersmixin) * [`fn withPg_hba(pg_hba)`](#fn-specpostgresqlwithpg_hba) @@ -654,6 +683,49 @@ permalink: /1.19.6/postgresql/v1/cluster/ * [`fn withValuesMixin(values)`](#fn-specstoragepvctemplateselectormatchexpressionswithvaluesmixin) * [`obj spec.superuserSecret`](#obj-specsuperusersecret) * [`fn withName(name)`](#fn-specsuperusersecretwithname) + * [`obj spec.tablespaces`](#obj-spectablespaces) + * [`fn withName(name)`](#fn-spectablespaceswithname) + * [`fn withTemporary(temporary)`](#fn-spectablespaceswithtemporary) + * [`obj spec.tablespaces.owner`](#obj-spectablespacesowner) + * [`fn withName(name)`](#fn-spectablespacesownerwithname) + * [`obj spec.tablespaces.storage`](#obj-spectablespacesstorage) + * [`fn withResizeInUseVolumes(resizeInUseVolumes)`](#fn-spectablespacesstoragewithresizeinusevolumes) + * [`fn withSize(size)`](#fn-spectablespacesstoragewithsize) + * [`fn withStorageClass(storageClass)`](#fn-spectablespacesstoragewithstorageclass) + * [`obj spec.tablespaces.storage.pvcTemplate`](#obj-spectablespacesstoragepvctemplate) + * [`fn withAccessModes(accessModes)`](#fn-spectablespacesstoragepvctemplatewithaccessmodes) + * [`fn withAccessModesMixin(accessModes)`](#fn-spectablespacesstoragepvctemplatewithaccessmodesmixin) + * [`fn withStorageClassName(storageClassName)`](#fn-spectablespacesstoragepvctemplatewithstorageclassname) + * [`fn withVolumeMode(volumeMode)`](#fn-spectablespacesstoragepvctemplatewithvolumemode) + * [`fn withVolumeName(volumeName)`](#fn-spectablespacesstoragepvctemplatewithvolumename) + * [`obj spec.tablespaces.storage.pvcTemplate.dataSource`](#obj-spectablespacesstoragepvctemplatedatasource) + * [`fn withApiGroup(apiGroup)`](#fn-spectablespacesstoragepvctemplatedatasourcewithapigroup) + * [`fn withKind(kind)`](#fn-spectablespacesstoragepvctemplatedatasourcewithkind) + * [`fn withName(name)`](#fn-spectablespacesstoragepvctemplatedatasourcewithname) + * [`obj spec.tablespaces.storage.pvcTemplate.dataSourceRef`](#obj-spectablespacesstoragepvctemplatedatasourceref) + * [`fn withApiGroup(apiGroup)`](#fn-spectablespacesstoragepvctemplatedatasourcerefwithapigroup) + * [`fn withKind(kind)`](#fn-spectablespacesstoragepvctemplatedatasourcerefwithkind) + * [`fn withName(name)`](#fn-spectablespacesstoragepvctemplatedatasourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-spectablespacesstoragepvctemplatedatasourcerefwithnamespace) + * [`obj spec.tablespaces.storage.pvcTemplate.resources`](#obj-spectablespacesstoragepvctemplateresources) + * [`fn withClaims(claims)`](#fn-spectablespacesstoragepvctemplateresourceswithclaims) + * [`fn withClaimsMixin(claims)`](#fn-spectablespacesstoragepvctemplateresourceswithclaimsmixin) + * [`fn withLimits(limits)`](#fn-spectablespacesstoragepvctemplateresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-spectablespacesstoragepvctemplateresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-spectablespacesstoragepvctemplateresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-spectablespacesstoragepvctemplateresourceswithrequestsmixin) + * [`obj spec.tablespaces.storage.pvcTemplate.resources.claims`](#obj-spectablespacesstoragepvctemplateresourcesclaims) + * [`fn withName(name)`](#fn-spectablespacesstoragepvctemplateresourcesclaimswithname) + * [`obj spec.tablespaces.storage.pvcTemplate.selector`](#obj-spectablespacesstoragepvctemplateselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-spectablespacesstoragepvctemplateselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-spectablespacesstoragepvctemplateselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-spectablespacesstoragepvctemplateselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-spectablespacesstoragepvctemplateselectorwithmatchlabelsmixin) + * [`obj spec.tablespaces.storage.pvcTemplate.selector.matchExpressions`](#obj-spectablespacesstoragepvctemplateselectormatchexpressions) + * [`fn withKey(key)`](#fn-spectablespacesstoragepvctemplateselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-spectablespacesstoragepvctemplateselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-spectablespacesstoragepvctemplateselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-spectablespacesstoragepvctemplateselectormatchexpressionswithvaluesmixin) * [`obj spec.topologySpreadConstraints`](#obj-spectopologyspreadconstraints) * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-spectopologyspreadconstraintswithmatchlabelkeys) * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-spectopologyspreadconstraintswithmatchlabelkeysmixin) @@ -1114,6 +1186,24 @@ withSwitchoverDelay(switchoverDelay) "The time in seconds that is allowed for a primary PostgreSQL instance to gracefully shutdown during a switchover. Default value is 3600 seconds (1 hour)." +### fn spec.withTablespaces + +```ts +withTablespaces(tablespaces) +``` + +"The tablespaces configuration" + +### fn spec.withTablespacesMixin + +```ts +withTablespacesMixin(tablespaces) +``` + +"The tablespaces configuration" + +**Note:** This function appends passed data to existing values + ### fn spec.withTopologySpreadConstraints ```ts @@ -2824,6 +2914,24 @@ withSnapshotOwnerReference(snapshotOwnerReference) "SnapshotOwnerReference indicates the type of owner reference the snapshot should have" +### fn spec.backup.volumeSnapshot.withTablespaceClassName + +```ts +withTablespaceClassName(tablespaceClassName) +``` + +"TablespaceClassName specifies the Snapshot Class to be used for the tablespaces. defaults to the PGDATA Snapshot Class, if set" + +### fn spec.backup.volumeSnapshot.withTablespaceClassNameMixin + +```ts +withTablespaceClassNameMixin(tablespaceClassName) +``` + +"TablespaceClassName specifies the Snapshot Class to be used for the tablespaces. defaults to the PGDATA Snapshot Class, if set" + +**Note:** This function appends passed data to existing values + ### fn spec.backup.volumeSnapshot.withWalClassName ```ts @@ -3350,6 +3458,24 @@ withName(name) "The static PVC data source(s) from which to initiate the recovery procedure. Currently supporting `VolumeSnapshot` and `PersistentVolumeClaim` resources that map an existing PVC group, compatible with CloudNativePG, and taken with a cold backup copy on a fenced Postgres instance (limitation which will be removed in the future when online backup will be implemented). Mutually exclusive with `backup`." +### fn spec.bootstrap.recovery.volumeSnapshots.withTablespaceStorage + +```ts +withTablespaceStorage(tablespaceStorage) +``` + +"Configuration of the storage for PostgreSQL tablespaces" + +### fn spec.bootstrap.recovery.volumeSnapshots.withTablespaceStorageMixin + +```ts +withTablespaceStorageMixin(tablespaceStorage) +``` + +"Configuration of the storage for PostgreSQL tablespaces" + +**Note:** This function appends passed data to existing values + ## obj spec.bootstrap.recovery.volumeSnapshots.storage "Configuration of the storage of the instances" @@ -4056,7 +4182,7 @@ withMaxParallel(maxParallel) ## obj spec.externalClusters.password -"The reference to the password to be used to connect to the server" +"The reference to the password to be used to connect to the server. If a password is provided, CloudNativePG creates a PostgreSQL passfile at `/controller/external/NAME/pass` (where \"NAME\" is the cluster's name). This passfile is automatically referenced in the connection string when establishing a connection to the remote PostgreSQL server from the current PostgreSQL `Cluster`. This ensures secure and efficient password management for external clusters." ### fn spec.externalClusters.password.withKey @@ -4434,6 +4560,42 @@ withEnablePodMonitor(enablePodMonitor) "Enable or disable the `PodMonitor`" +### fn spec.monitoring.withPodMonitorMetricRelabelings + +```ts +withPodMonitorMetricRelabelings(podMonitorMetricRelabelings) +``` + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +### fn spec.monitoring.withPodMonitorMetricRelabelingsMixin + +```ts +withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings) +``` + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.withPodMonitorRelabelings + +```ts +withPodMonitorRelabelings(podMonitorRelabelings) +``` + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +### fn spec.monitoring.withPodMonitorRelabelingsMixin + +```ts +withPodMonitorRelabelingsMixin(podMonitorRelabelings) +``` + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +**Note:** This function appends passed data to existing values + ## obj spec.monitoring.customQueriesConfigMap "The list of config maps containing the custom queries" @@ -4474,6 +4636,146 @@ withName(name) "Name of the referent." +## obj spec.monitoring.podMonitorMetricRelabelings + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +### fn spec.monitoring.podMonitorMetricRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching. \n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \n Default: \"Replace\ + +### fn spec.monitoring.podMonitorMetricRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values. \n Only applicable when the action is `HashMod`." + +### fn spec.monitoring.podMonitorMetricRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.monitoring.podMonitorMetricRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the regular expression matches. \n Regex capture groups are available." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.podMonitorMetricRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement. \n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \n Regex capture groups are available." + +## obj spec.monitoring.podMonitorRelabelings + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +### fn spec.monitoring.podMonitorRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching. \n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \n Default: \"Replace\ + +### fn spec.monitoring.podMonitorRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values. \n Only applicable when the action is `HashMod`." + +### fn spec.monitoring.podMonitorRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.monitoring.podMonitorRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the regular expression matches. \n Regex capture groups are available." + +### fn spec.monitoring.podMonitorRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.monitoring.podMonitorRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +### fn spec.monitoring.podMonitorRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.podMonitorRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement. \n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \n Regex capture groups are available." + ## obj spec.nodeMaintenanceWindow "Define a maintenance window for the Kubernetes nodes" @@ -4498,6 +4800,14 @@ withReusePVC(reusePVC) "Configuration of the PostgreSQL server" +### fn spec.postgresql.withEnableAlterSystem + +```ts +withEnableAlterSystem(enableAlterSystem) +``` + +"If this parameter is true, the user will be able to invoke `ALTER SYSTEM` on this CloudNativePG Cluster. This should only be used for debugging and troubleshooting. Defaults to false." + ### fn spec.postgresql.withParameters ```ts @@ -5206,7 +5516,7 @@ withSize(size) withStorageClass(storageClass) ``` -"StorageClass to use for database data (`PGDATA`). Applied after evaluating the PVC template, if available. If not specified, generated PVCs will be satisfied by the default storage class" +"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class" ## obj spec.storage.pvcTemplate @@ -5478,6 +5788,324 @@ withName(name) "Name of the referent." +## obj spec.tablespaces + +"The tablespaces configuration" + +### fn spec.tablespaces.withName + +```ts +withName(name) +``` + +"The name of the tablespace" + +### fn spec.tablespaces.withTemporary + +```ts +withTemporary(temporary) +``` + +"When set to true, the tablespace will be added as a `temp_tablespaces` entry in PostgreSQL, and will be available to automatically house temp database objects, or other temporary files. Please refer to PostgreSQL documentation for more information on the `temp_tablespaces` GUC." + +## obj spec.tablespaces.owner + +"Owner is the PostgreSQL user owning the tablespace" + +### fn spec.tablespaces.owner.withName + +```ts +withName(name) +``` + + + +## obj spec.tablespaces.storage + +"The storage configuration for the tablespace" + +### fn spec.tablespaces.storage.withResizeInUseVolumes + +```ts +withResizeInUseVolumes(resizeInUseVolumes) +``` + +"Resize existent PVCs, defaults to true" + +### fn spec.tablespaces.storage.withSize + +```ts +withSize(size) +``` + +"Size of the storage. Required if not already specified in the PVC template. Changes to this field are automatically reapplied to the created PVCs. Size cannot be decreased." + +### fn spec.tablespaces.storage.withStorageClass + +```ts +withStorageClass(storageClass) +``` + +"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class" + +## obj spec.tablespaces.storage.pvcTemplate + +"Template to be used to generate the Persistent Volume Claim" + +### fn spec.tablespaces.storage.pvcTemplate.withAccessModes + +```ts +withAccessModes(accessModes) +``` + +"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +### fn spec.tablespaces.storage.pvcTemplate.withAccessModesMixin + +```ts +withAccessModesMixin(accessModes) +``` + +"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +**Note:** This function appends passed data to existing values + +### fn spec.tablespaces.storage.pvcTemplate.withStorageClassName + +```ts +withStorageClassName(storageClassName) +``` + +"storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1" + +### fn spec.tablespaces.storage.pvcTemplate.withVolumeMode + +```ts +withVolumeMode(volumeMode) +``` + +"volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec." + +### fn spec.tablespaces.storage.pvcTemplate.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the binding reference to the PersistentVolume backing this claim." + +## obj spec.tablespaces.storage.pvcTemplate.dataSource + +"dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource." + +### fn spec.tablespaces.storage.pvcTemplate.dataSource.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"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." + +### fn spec.tablespaces.storage.pvcTemplate.dataSource.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.tablespaces.storage.pvcTemplate.dataSource.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +## obj spec.tablespaces.storage.pvcTemplate.dataSourceRef + +"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +### fn spec.tablespaces.storage.pvcTemplate.dataSourceRef.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"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." + +### fn spec.tablespaces.storage.pvcTemplate.dataSourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.tablespaces.storage.pvcTemplate.dataSourceRef.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +### fn spec.tablespaces.storage.pvcTemplate.dataSourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +## obj spec.tablespaces.storage.pvcTemplate.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" + +### fn spec.tablespaces.storage.pvcTemplate.resources.withClaims + +```ts +withClaims(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +### fn spec.tablespaces.storage.pvcTemplate.resources.withClaimsMixin + +```ts +withClaimsMixin(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +**Note:** This function appends passed data to existing values + +### fn spec.tablespaces.storage.pvcTemplate.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.tablespaces.storage.pvcTemplate.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.tablespaces.storage.pvcTemplate.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.tablespaces.storage.pvcTemplate.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.tablespaces.storage.pvcTemplate.resources.claims + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +### fn spec.tablespaces.storage.pvcTemplate.resources.claims.withName + +```ts +withName(name) +``` + +"Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container." + +## obj spec.tablespaces.storage.pvcTemplate.selector + +"selector is a label query over volumes to consider for binding." + +### fn spec.tablespaces.storage.pvcTemplate.selector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.tablespaces.storage.pvcTemplate.selector.withMatchExpressionsMixin + +```ts +withMatchExpressionsMixin(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +### fn spec.tablespaces.storage.pvcTemplate.selector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"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." + +### fn spec.tablespaces.storage.pvcTemplate.selector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"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." + +**Note:** This function appends passed data to existing values + +## obj spec.tablespaces.storage.pvcTemplate.selector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.tablespaces.storage.pvcTemplate.selector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.tablespaces.storage.pvcTemplate.selector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.tablespaces.storage.pvcTemplate.selector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"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." + +### fn spec.tablespaces.storage.pvcTemplate.selector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"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." + +**Note:** This function appends passed data to existing values + ## obj spec.topologySpreadConstraints "TopologySpreadConstraints specifies how to spread matching pods among the given topology. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/" @@ -5652,7 +6280,7 @@ withSize(size) withStorageClass(storageClass) ``` -"StorageClass to use for database data (`PGDATA`). Applied after evaluating the PVC template, if available. If not specified, generated PVCs will be satisfied by the default storage class" +"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class" ## obj spec.walStorage.pvcTemplate diff --git a/docs/1.19.6/postgresql/v1/pooler.md b/docs/1.19.6/postgresql/v1/pooler.md index 3a13c68..006d821 100644 --- a/docs/1.19.6/postgresql/v1/pooler.md +++ b/docs/1.19.6/postgresql/v1/pooler.md @@ -41,6 +41,28 @@ permalink: /1.19.6/postgresql/v1/pooler/ * [`fn withMaxUnavailable(maxUnavailable)`](#fn-specdeploymentstrategyrollingupdatewithmaxunavailable) * [`obj spec.monitoring`](#obj-specmonitoring) * [`fn withEnablePodMonitor(enablePodMonitor)`](#fn-specmonitoringwithenablepodmonitor) + * [`fn withPodMonitorMetricRelabelings(podMonitorMetricRelabelings)`](#fn-specmonitoringwithpodmonitormetricrelabelings) + * [`fn withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings)`](#fn-specmonitoringwithpodmonitormetricrelabelingsmixin) + * [`fn withPodMonitorRelabelings(podMonitorRelabelings)`](#fn-specmonitoringwithpodmonitorrelabelings) + * [`fn withPodMonitorRelabelingsMixin(podMonitorRelabelings)`](#fn-specmonitoringwithpodmonitorrelabelingsmixin) + * [`obj spec.monitoring.podMonitorMetricRelabelings`](#obj-specmonitoringpodmonitormetricrelabelings) + * [`fn withAction(action)`](#fn-specmonitoringpodmonitormetricrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specmonitoringpodmonitormetricrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specmonitoringpodmonitormetricrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specmonitoringpodmonitormetricrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specmonitoringpodmonitormetricrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specmonitoringpodmonitormetricrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specmonitoringpodmonitormetricrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specmonitoringpodmonitormetricrelabelingswithtargetlabel) + * [`obj spec.monitoring.podMonitorRelabelings`](#obj-specmonitoringpodmonitorrelabelings) + * [`fn withAction(action)`](#fn-specmonitoringpodmonitorrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specmonitoringpodmonitorrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specmonitoringpodmonitorrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specmonitoringpodmonitorrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specmonitoringpodmonitorrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specmonitoringpodmonitorrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specmonitoringpodmonitorrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specmonitoringpodmonitorrelabelingswithtargetlabel) * [`obj spec.pgbouncer`](#obj-specpgbouncer) * [`fn withAuthQuery(authQuery)`](#fn-specpgbouncerwithauthquery) * [`fn withParameters(parameters)`](#fn-specpgbouncerwithparameters) @@ -1509,6 +1531,182 @@ withEnablePodMonitor(enablePodMonitor) "Enable or disable the `PodMonitor`" +### fn spec.monitoring.withPodMonitorMetricRelabelings + +```ts +withPodMonitorMetricRelabelings(podMonitorMetricRelabelings) +``` + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +### fn spec.monitoring.withPodMonitorMetricRelabelingsMixin + +```ts +withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings) +``` + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.withPodMonitorRelabelings + +```ts +withPodMonitorRelabelings(podMonitorRelabelings) +``` + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +### fn spec.monitoring.withPodMonitorRelabelingsMixin + +```ts +withPodMonitorRelabelingsMixin(podMonitorRelabelings) +``` + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +**Note:** This function appends passed data to existing values + +## obj spec.monitoring.podMonitorMetricRelabelings + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +### fn spec.monitoring.podMonitorMetricRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching. \n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \n Default: \"Replace\ + +### fn spec.monitoring.podMonitorMetricRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values. \n Only applicable when the action is `HashMod`." + +### fn spec.monitoring.podMonitorMetricRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.monitoring.podMonitorMetricRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the regular expression matches. \n Regex capture groups are available." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.podMonitorMetricRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement. \n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \n Regex capture groups are available." + +## obj spec.monitoring.podMonitorRelabelings + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +### fn spec.monitoring.podMonitorRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching. \n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \n Default: \"Replace\ + +### fn spec.monitoring.podMonitorRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values. \n Only applicable when the action is `HashMod`." + +### fn spec.monitoring.podMonitorRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.monitoring.podMonitorRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the regular expression matches. \n Regex capture groups are available." + +### fn spec.monitoring.podMonitorRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.monitoring.podMonitorRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +### fn spec.monitoring.podMonitorRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.podMonitorRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement. \n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \n Regex capture groups are available." + ## obj spec.pgbouncer "The PgBouncer configuration" diff --git a/docs/1.20.4/postgresql/v1/cluster.md b/docs/1.20.4/postgresql/v1/cluster.md index c3d0d1f..d9892b2 100644 --- a/docs/1.20.4/postgresql/v1/cluster.md +++ b/docs/1.20.4/postgresql/v1/cluster.md @@ -57,6 +57,8 @@ permalink: /1.20.4/postgresql/v1/cluster/ * [`fn withStartDelay(startDelay)`](#fn-specwithstartdelay) * [`fn withStopDelay(stopDelay)`](#fn-specwithstopdelay) * [`fn withSwitchoverDelay(switchoverDelay)`](#fn-specwithswitchoverdelay) + * [`fn withTablespaces(tablespaces)`](#fn-specwithtablespaces) + * [`fn withTablespacesMixin(tablespaces)`](#fn-specwithtablespacesmixin) * [`fn withTopologySpreadConstraints(topologySpreadConstraints)`](#fn-specwithtopologyspreadconstraints) * [`fn withTopologySpreadConstraintsMixin(topologySpreadConstraints)`](#fn-specwithtopologyspreadconstraintsmixin) * [`obj spec.affinity`](#obj-specaffinity) @@ -285,6 +287,8 @@ permalink: /1.20.4/postgresql/v1/cluster/ * [`fn withLabelsMixin(labels)`](#fn-specbackupvolumesnapshotwithlabelsmixin) * [`fn withOnline(online)`](#fn-specbackupvolumesnapshotwithonline) * [`fn withSnapshotOwnerReference(snapshotOwnerReference)`](#fn-specbackupvolumesnapshotwithsnapshotownerreference) + * [`fn withTablespaceClassName(tablespaceClassName)`](#fn-specbackupvolumesnapshotwithtablespaceclassname) + * [`fn withTablespaceClassNameMixin(tablespaceClassName)`](#fn-specbackupvolumesnapshotwithtablespaceclassnamemixin) * [`fn withWalClassName(walClassName)`](#fn-specbackupvolumesnapshotwithwalclassname) * [`obj spec.backup.volumeSnapshot.onlineConfiguration`](#obj-specbackupvolumesnapshotonlineconfiguration) * [`fn withImmediateCheckpoint(immediateCheckpoint)`](#fn-specbackupvolumesnapshotonlineconfigurationwithimmediatecheckpoint) @@ -357,6 +361,8 @@ permalink: /1.20.4/postgresql/v1/cluster/ * [`obj spec.bootstrap.recovery.secret`](#obj-specbootstraprecoverysecret) * [`fn withName(name)`](#fn-specbootstraprecoverysecretwithname) * [`obj spec.bootstrap.recovery.volumeSnapshots`](#obj-specbootstraprecoveryvolumesnapshots) + * [`fn withTablespaceStorage(tablespaceStorage)`](#fn-specbootstraprecoveryvolumesnapshotswithtablespacestorage) + * [`fn withTablespaceStorageMixin(tablespaceStorage)`](#fn-specbootstraprecoveryvolumesnapshotswithtablespacestoragemixin) * [`obj spec.bootstrap.recovery.volumeSnapshots.storage`](#obj-specbootstraprecoveryvolumesnapshotsstorage) * [`fn withApiGroup(apiGroup)`](#fn-specbootstraprecoveryvolumesnapshotsstoragewithapigroup) * [`fn withKind(kind)`](#fn-specbootstraprecoveryvolumesnapshotsstoragewithkind) @@ -510,16 +516,39 @@ permalink: /1.20.4/postgresql/v1/cluster/ * [`fn withCustomQueriesSecretMixin(customQueriesSecret)`](#fn-specmonitoringwithcustomqueriessecretmixin) * [`fn withDisableDefaultQueries(disableDefaultQueries)`](#fn-specmonitoringwithdisabledefaultqueries) * [`fn withEnablePodMonitor(enablePodMonitor)`](#fn-specmonitoringwithenablepodmonitor) + * [`fn withPodMonitorMetricRelabelings(podMonitorMetricRelabelings)`](#fn-specmonitoringwithpodmonitormetricrelabelings) + * [`fn withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings)`](#fn-specmonitoringwithpodmonitormetricrelabelingsmixin) + * [`fn withPodMonitorRelabelings(podMonitorRelabelings)`](#fn-specmonitoringwithpodmonitorrelabelings) + * [`fn withPodMonitorRelabelingsMixin(podMonitorRelabelings)`](#fn-specmonitoringwithpodmonitorrelabelingsmixin) * [`obj spec.monitoring.customQueriesConfigMap`](#obj-specmonitoringcustomqueriesconfigmap) * [`fn withKey(key)`](#fn-specmonitoringcustomqueriesconfigmapwithkey) * [`fn withName(name)`](#fn-specmonitoringcustomqueriesconfigmapwithname) * [`obj spec.monitoring.customQueriesSecret`](#obj-specmonitoringcustomqueriessecret) * [`fn withKey(key)`](#fn-specmonitoringcustomqueriessecretwithkey) * [`fn withName(name)`](#fn-specmonitoringcustomqueriessecretwithname) + * [`obj spec.monitoring.podMonitorMetricRelabelings`](#obj-specmonitoringpodmonitormetricrelabelings) + * [`fn withAction(action)`](#fn-specmonitoringpodmonitormetricrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specmonitoringpodmonitormetricrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specmonitoringpodmonitormetricrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specmonitoringpodmonitormetricrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specmonitoringpodmonitormetricrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specmonitoringpodmonitormetricrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specmonitoringpodmonitormetricrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specmonitoringpodmonitormetricrelabelingswithtargetlabel) + * [`obj spec.monitoring.podMonitorRelabelings`](#obj-specmonitoringpodmonitorrelabelings) + * [`fn withAction(action)`](#fn-specmonitoringpodmonitorrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specmonitoringpodmonitorrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specmonitoringpodmonitorrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specmonitoringpodmonitorrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specmonitoringpodmonitorrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specmonitoringpodmonitorrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specmonitoringpodmonitorrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specmonitoringpodmonitorrelabelingswithtargetlabel) * [`obj spec.nodeMaintenanceWindow`](#obj-specnodemaintenancewindow) * [`fn withInProgress(inProgress)`](#fn-specnodemaintenancewindowwithinprogress) * [`fn withReusePVC(reusePVC)`](#fn-specnodemaintenancewindowwithreusepvc) * [`obj spec.postgresql`](#obj-specpostgresql) + * [`fn withEnableAlterSystem(enableAlterSystem)`](#fn-specpostgresqlwithenablealtersystem) * [`fn withParameters(parameters)`](#fn-specpostgresqlwithparameters) * [`fn withParametersMixin(parameters)`](#fn-specpostgresqlwithparametersmixin) * [`fn withPg_hba(pg_hba)`](#fn-specpostgresqlwithpg_hba) @@ -654,6 +683,49 @@ permalink: /1.20.4/postgresql/v1/cluster/ * [`fn withValuesMixin(values)`](#fn-specstoragepvctemplateselectormatchexpressionswithvaluesmixin) * [`obj spec.superuserSecret`](#obj-specsuperusersecret) * [`fn withName(name)`](#fn-specsuperusersecretwithname) + * [`obj spec.tablespaces`](#obj-spectablespaces) + * [`fn withName(name)`](#fn-spectablespaceswithname) + * [`fn withTemporary(temporary)`](#fn-spectablespaceswithtemporary) + * [`obj spec.tablespaces.owner`](#obj-spectablespacesowner) + * [`fn withName(name)`](#fn-spectablespacesownerwithname) + * [`obj spec.tablespaces.storage`](#obj-spectablespacesstorage) + * [`fn withResizeInUseVolumes(resizeInUseVolumes)`](#fn-spectablespacesstoragewithresizeinusevolumes) + * [`fn withSize(size)`](#fn-spectablespacesstoragewithsize) + * [`fn withStorageClass(storageClass)`](#fn-spectablespacesstoragewithstorageclass) + * [`obj spec.tablespaces.storage.pvcTemplate`](#obj-spectablespacesstoragepvctemplate) + * [`fn withAccessModes(accessModes)`](#fn-spectablespacesstoragepvctemplatewithaccessmodes) + * [`fn withAccessModesMixin(accessModes)`](#fn-spectablespacesstoragepvctemplatewithaccessmodesmixin) + * [`fn withStorageClassName(storageClassName)`](#fn-spectablespacesstoragepvctemplatewithstorageclassname) + * [`fn withVolumeMode(volumeMode)`](#fn-spectablespacesstoragepvctemplatewithvolumemode) + * [`fn withVolumeName(volumeName)`](#fn-spectablespacesstoragepvctemplatewithvolumename) + * [`obj spec.tablespaces.storage.pvcTemplate.dataSource`](#obj-spectablespacesstoragepvctemplatedatasource) + * [`fn withApiGroup(apiGroup)`](#fn-spectablespacesstoragepvctemplatedatasourcewithapigroup) + * [`fn withKind(kind)`](#fn-spectablespacesstoragepvctemplatedatasourcewithkind) + * [`fn withName(name)`](#fn-spectablespacesstoragepvctemplatedatasourcewithname) + * [`obj spec.tablespaces.storage.pvcTemplate.dataSourceRef`](#obj-spectablespacesstoragepvctemplatedatasourceref) + * [`fn withApiGroup(apiGroup)`](#fn-spectablespacesstoragepvctemplatedatasourcerefwithapigroup) + * [`fn withKind(kind)`](#fn-spectablespacesstoragepvctemplatedatasourcerefwithkind) + * [`fn withName(name)`](#fn-spectablespacesstoragepvctemplatedatasourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-spectablespacesstoragepvctemplatedatasourcerefwithnamespace) + * [`obj spec.tablespaces.storage.pvcTemplate.resources`](#obj-spectablespacesstoragepvctemplateresources) + * [`fn withClaims(claims)`](#fn-spectablespacesstoragepvctemplateresourceswithclaims) + * [`fn withClaimsMixin(claims)`](#fn-spectablespacesstoragepvctemplateresourceswithclaimsmixin) + * [`fn withLimits(limits)`](#fn-spectablespacesstoragepvctemplateresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-spectablespacesstoragepvctemplateresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-spectablespacesstoragepvctemplateresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-spectablespacesstoragepvctemplateresourceswithrequestsmixin) + * [`obj spec.tablespaces.storage.pvcTemplate.resources.claims`](#obj-spectablespacesstoragepvctemplateresourcesclaims) + * [`fn withName(name)`](#fn-spectablespacesstoragepvctemplateresourcesclaimswithname) + * [`obj spec.tablespaces.storage.pvcTemplate.selector`](#obj-spectablespacesstoragepvctemplateselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-spectablespacesstoragepvctemplateselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-spectablespacesstoragepvctemplateselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-spectablespacesstoragepvctemplateselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-spectablespacesstoragepvctemplateselectorwithmatchlabelsmixin) + * [`obj spec.tablespaces.storage.pvcTemplate.selector.matchExpressions`](#obj-spectablespacesstoragepvctemplateselectormatchexpressions) + * [`fn withKey(key)`](#fn-spectablespacesstoragepvctemplateselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-spectablespacesstoragepvctemplateselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-spectablespacesstoragepvctemplateselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-spectablespacesstoragepvctemplateselectormatchexpressionswithvaluesmixin) * [`obj spec.topologySpreadConstraints`](#obj-spectopologyspreadconstraints) * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-spectopologyspreadconstraintswithmatchlabelkeys) * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-spectopologyspreadconstraintswithmatchlabelkeysmixin) @@ -1114,6 +1186,24 @@ withSwitchoverDelay(switchoverDelay) "The time in seconds that is allowed for a primary PostgreSQL instance to gracefully shutdown during a switchover. Default value is 3600 seconds (1 hour)." +### fn spec.withTablespaces + +```ts +withTablespaces(tablespaces) +``` + +"The tablespaces configuration" + +### fn spec.withTablespacesMixin + +```ts +withTablespacesMixin(tablespaces) +``` + +"The tablespaces configuration" + +**Note:** This function appends passed data to existing values + ### fn spec.withTopologySpreadConstraints ```ts @@ -2824,6 +2914,24 @@ withSnapshotOwnerReference(snapshotOwnerReference) "SnapshotOwnerReference indicates the type of owner reference the snapshot should have" +### fn spec.backup.volumeSnapshot.withTablespaceClassName + +```ts +withTablespaceClassName(tablespaceClassName) +``` + +"TablespaceClassName specifies the Snapshot Class to be used for the tablespaces. defaults to the PGDATA Snapshot Class, if set" + +### fn spec.backup.volumeSnapshot.withTablespaceClassNameMixin + +```ts +withTablespaceClassNameMixin(tablespaceClassName) +``` + +"TablespaceClassName specifies the Snapshot Class to be used for the tablespaces. defaults to the PGDATA Snapshot Class, if set" + +**Note:** This function appends passed data to existing values + ### fn spec.backup.volumeSnapshot.withWalClassName ```ts @@ -3350,6 +3458,24 @@ withName(name) "The static PVC data source(s) from which to initiate the recovery procedure. Currently supporting `VolumeSnapshot` and `PersistentVolumeClaim` resources that map an existing PVC group, compatible with CloudNativePG, and taken with a cold backup copy on a fenced Postgres instance (limitation which will be removed in the future when online backup will be implemented). Mutually exclusive with `backup`." +### fn spec.bootstrap.recovery.volumeSnapshots.withTablespaceStorage + +```ts +withTablespaceStorage(tablespaceStorage) +``` + +"Configuration of the storage for PostgreSQL tablespaces" + +### fn spec.bootstrap.recovery.volumeSnapshots.withTablespaceStorageMixin + +```ts +withTablespaceStorageMixin(tablespaceStorage) +``` + +"Configuration of the storage for PostgreSQL tablespaces" + +**Note:** This function appends passed data to existing values + ## obj spec.bootstrap.recovery.volumeSnapshots.storage "Configuration of the storage of the instances" @@ -4056,7 +4182,7 @@ withMaxParallel(maxParallel) ## obj spec.externalClusters.password -"The reference to the password to be used to connect to the server" +"The reference to the password to be used to connect to the server. If a password is provided, CloudNativePG creates a PostgreSQL passfile at `/controller/external/NAME/pass` (where \"NAME\" is the cluster's name). This passfile is automatically referenced in the connection string when establishing a connection to the remote PostgreSQL server from the current PostgreSQL `Cluster`. This ensures secure and efficient password management for external clusters." ### fn spec.externalClusters.password.withKey @@ -4434,6 +4560,42 @@ withEnablePodMonitor(enablePodMonitor) "Enable or disable the `PodMonitor`" +### fn spec.monitoring.withPodMonitorMetricRelabelings + +```ts +withPodMonitorMetricRelabelings(podMonitorMetricRelabelings) +``` + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +### fn spec.monitoring.withPodMonitorMetricRelabelingsMixin + +```ts +withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings) +``` + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.withPodMonitorRelabelings + +```ts +withPodMonitorRelabelings(podMonitorRelabelings) +``` + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +### fn spec.monitoring.withPodMonitorRelabelingsMixin + +```ts +withPodMonitorRelabelingsMixin(podMonitorRelabelings) +``` + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +**Note:** This function appends passed data to existing values + ## obj spec.monitoring.customQueriesConfigMap "The list of config maps containing the custom queries" @@ -4474,6 +4636,146 @@ withName(name) "Name of the referent." +## obj spec.monitoring.podMonitorMetricRelabelings + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +### fn spec.monitoring.podMonitorMetricRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching. \n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \n Default: \"Replace\ + +### fn spec.monitoring.podMonitorMetricRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values. \n Only applicable when the action is `HashMod`." + +### fn spec.monitoring.podMonitorMetricRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.monitoring.podMonitorMetricRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the regular expression matches. \n Regex capture groups are available." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.podMonitorMetricRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement. \n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \n Regex capture groups are available." + +## obj spec.monitoring.podMonitorRelabelings + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +### fn spec.monitoring.podMonitorRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching. \n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \n Default: \"Replace\ + +### fn spec.monitoring.podMonitorRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values. \n Only applicable when the action is `HashMod`." + +### fn spec.monitoring.podMonitorRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.monitoring.podMonitorRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the regular expression matches. \n Regex capture groups are available." + +### fn spec.monitoring.podMonitorRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.monitoring.podMonitorRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +### fn spec.monitoring.podMonitorRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.podMonitorRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement. \n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \n Regex capture groups are available." + ## obj spec.nodeMaintenanceWindow "Define a maintenance window for the Kubernetes nodes" @@ -4498,6 +4800,14 @@ withReusePVC(reusePVC) "Configuration of the PostgreSQL server" +### fn spec.postgresql.withEnableAlterSystem + +```ts +withEnableAlterSystem(enableAlterSystem) +``` + +"If this parameter is true, the user will be able to invoke `ALTER SYSTEM` on this CloudNativePG Cluster. This should only be used for debugging and troubleshooting. Defaults to false." + ### fn spec.postgresql.withParameters ```ts @@ -5206,7 +5516,7 @@ withSize(size) withStorageClass(storageClass) ``` -"StorageClass to use for database data (`PGDATA`). Applied after evaluating the PVC template, if available. If not specified, generated PVCs will be satisfied by the default storage class" +"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class" ## obj spec.storage.pvcTemplate @@ -5478,6 +5788,324 @@ withName(name) "Name of the referent." +## obj spec.tablespaces + +"The tablespaces configuration" + +### fn spec.tablespaces.withName + +```ts +withName(name) +``` + +"The name of the tablespace" + +### fn spec.tablespaces.withTemporary + +```ts +withTemporary(temporary) +``` + +"When set to true, the tablespace will be added as a `temp_tablespaces` entry in PostgreSQL, and will be available to automatically house temp database objects, or other temporary files. Please refer to PostgreSQL documentation for more information on the `temp_tablespaces` GUC." + +## obj spec.tablespaces.owner + +"Owner is the PostgreSQL user owning the tablespace" + +### fn spec.tablespaces.owner.withName + +```ts +withName(name) +``` + + + +## obj spec.tablespaces.storage + +"The storage configuration for the tablespace" + +### fn spec.tablespaces.storage.withResizeInUseVolumes + +```ts +withResizeInUseVolumes(resizeInUseVolumes) +``` + +"Resize existent PVCs, defaults to true" + +### fn spec.tablespaces.storage.withSize + +```ts +withSize(size) +``` + +"Size of the storage. Required if not already specified in the PVC template. Changes to this field are automatically reapplied to the created PVCs. Size cannot be decreased." + +### fn spec.tablespaces.storage.withStorageClass + +```ts +withStorageClass(storageClass) +``` + +"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class" + +## obj spec.tablespaces.storage.pvcTemplate + +"Template to be used to generate the Persistent Volume Claim" + +### fn spec.tablespaces.storage.pvcTemplate.withAccessModes + +```ts +withAccessModes(accessModes) +``` + +"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +### fn spec.tablespaces.storage.pvcTemplate.withAccessModesMixin + +```ts +withAccessModesMixin(accessModes) +``` + +"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +**Note:** This function appends passed data to existing values + +### fn spec.tablespaces.storage.pvcTemplate.withStorageClassName + +```ts +withStorageClassName(storageClassName) +``` + +"storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1" + +### fn spec.tablespaces.storage.pvcTemplate.withVolumeMode + +```ts +withVolumeMode(volumeMode) +``` + +"volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec." + +### fn spec.tablespaces.storage.pvcTemplate.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the binding reference to the PersistentVolume backing this claim." + +## obj spec.tablespaces.storage.pvcTemplate.dataSource + +"dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource." + +### fn spec.tablespaces.storage.pvcTemplate.dataSource.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"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." + +### fn spec.tablespaces.storage.pvcTemplate.dataSource.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.tablespaces.storage.pvcTemplate.dataSource.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +## obj spec.tablespaces.storage.pvcTemplate.dataSourceRef + +"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +### fn spec.tablespaces.storage.pvcTemplate.dataSourceRef.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"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." + +### fn spec.tablespaces.storage.pvcTemplate.dataSourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.tablespaces.storage.pvcTemplate.dataSourceRef.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +### fn spec.tablespaces.storage.pvcTemplate.dataSourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +## obj spec.tablespaces.storage.pvcTemplate.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" + +### fn spec.tablespaces.storage.pvcTemplate.resources.withClaims + +```ts +withClaims(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +### fn spec.tablespaces.storage.pvcTemplate.resources.withClaimsMixin + +```ts +withClaimsMixin(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +**Note:** This function appends passed data to existing values + +### fn spec.tablespaces.storage.pvcTemplate.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.tablespaces.storage.pvcTemplate.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.tablespaces.storage.pvcTemplate.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.tablespaces.storage.pvcTemplate.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.tablespaces.storage.pvcTemplate.resources.claims + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +### fn spec.tablespaces.storage.pvcTemplate.resources.claims.withName + +```ts +withName(name) +``` + +"Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container." + +## obj spec.tablespaces.storage.pvcTemplate.selector + +"selector is a label query over volumes to consider for binding." + +### fn spec.tablespaces.storage.pvcTemplate.selector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.tablespaces.storage.pvcTemplate.selector.withMatchExpressionsMixin + +```ts +withMatchExpressionsMixin(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +### fn spec.tablespaces.storage.pvcTemplate.selector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"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." + +### fn spec.tablespaces.storage.pvcTemplate.selector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"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." + +**Note:** This function appends passed data to existing values + +## obj spec.tablespaces.storage.pvcTemplate.selector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.tablespaces.storage.pvcTemplate.selector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.tablespaces.storage.pvcTemplate.selector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.tablespaces.storage.pvcTemplate.selector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"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." + +### fn spec.tablespaces.storage.pvcTemplate.selector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"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." + +**Note:** This function appends passed data to existing values + ## obj spec.topologySpreadConstraints "TopologySpreadConstraints specifies how to spread matching pods among the given topology. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/" @@ -5652,7 +6280,7 @@ withSize(size) withStorageClass(storageClass) ``` -"StorageClass to use for database data (`PGDATA`). Applied after evaluating the PVC template, if available. If not specified, generated PVCs will be satisfied by the default storage class" +"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class" ## obj spec.walStorage.pvcTemplate diff --git a/docs/1.20.4/postgresql/v1/pooler.md b/docs/1.20.4/postgresql/v1/pooler.md index 581720f..9029b5d 100644 --- a/docs/1.20.4/postgresql/v1/pooler.md +++ b/docs/1.20.4/postgresql/v1/pooler.md @@ -41,6 +41,28 @@ permalink: /1.20.4/postgresql/v1/pooler/ * [`fn withMaxUnavailable(maxUnavailable)`](#fn-specdeploymentstrategyrollingupdatewithmaxunavailable) * [`obj spec.monitoring`](#obj-specmonitoring) * [`fn withEnablePodMonitor(enablePodMonitor)`](#fn-specmonitoringwithenablepodmonitor) + * [`fn withPodMonitorMetricRelabelings(podMonitorMetricRelabelings)`](#fn-specmonitoringwithpodmonitormetricrelabelings) + * [`fn withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings)`](#fn-specmonitoringwithpodmonitormetricrelabelingsmixin) + * [`fn withPodMonitorRelabelings(podMonitorRelabelings)`](#fn-specmonitoringwithpodmonitorrelabelings) + * [`fn withPodMonitorRelabelingsMixin(podMonitorRelabelings)`](#fn-specmonitoringwithpodmonitorrelabelingsmixin) + * [`obj spec.monitoring.podMonitorMetricRelabelings`](#obj-specmonitoringpodmonitormetricrelabelings) + * [`fn withAction(action)`](#fn-specmonitoringpodmonitormetricrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specmonitoringpodmonitormetricrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specmonitoringpodmonitormetricrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specmonitoringpodmonitormetricrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specmonitoringpodmonitormetricrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specmonitoringpodmonitormetricrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specmonitoringpodmonitormetricrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specmonitoringpodmonitormetricrelabelingswithtargetlabel) + * [`obj spec.monitoring.podMonitorRelabelings`](#obj-specmonitoringpodmonitorrelabelings) + * [`fn withAction(action)`](#fn-specmonitoringpodmonitorrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specmonitoringpodmonitorrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specmonitoringpodmonitorrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specmonitoringpodmonitorrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specmonitoringpodmonitorrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specmonitoringpodmonitorrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specmonitoringpodmonitorrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specmonitoringpodmonitorrelabelingswithtargetlabel) * [`obj spec.pgbouncer`](#obj-specpgbouncer) * [`fn withAuthQuery(authQuery)`](#fn-specpgbouncerwithauthquery) * [`fn withParameters(parameters)`](#fn-specpgbouncerwithparameters) @@ -1509,6 +1531,182 @@ withEnablePodMonitor(enablePodMonitor) "Enable or disable the `PodMonitor`" +### fn spec.monitoring.withPodMonitorMetricRelabelings + +```ts +withPodMonitorMetricRelabelings(podMonitorMetricRelabelings) +``` + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +### fn spec.monitoring.withPodMonitorMetricRelabelingsMixin + +```ts +withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings) +``` + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.withPodMonitorRelabelings + +```ts +withPodMonitorRelabelings(podMonitorRelabelings) +``` + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +### fn spec.monitoring.withPodMonitorRelabelingsMixin + +```ts +withPodMonitorRelabelingsMixin(podMonitorRelabelings) +``` + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +**Note:** This function appends passed data to existing values + +## obj spec.monitoring.podMonitorMetricRelabelings + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +### fn spec.monitoring.podMonitorMetricRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching. \n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \n Default: \"Replace\ + +### fn spec.monitoring.podMonitorMetricRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values. \n Only applicable when the action is `HashMod`." + +### fn spec.monitoring.podMonitorMetricRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.monitoring.podMonitorMetricRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the regular expression matches. \n Regex capture groups are available." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.podMonitorMetricRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement. \n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \n Regex capture groups are available." + +## obj spec.monitoring.podMonitorRelabelings + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +### fn spec.monitoring.podMonitorRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching. \n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \n Default: \"Replace\ + +### fn spec.monitoring.podMonitorRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values. \n Only applicable when the action is `HashMod`." + +### fn spec.monitoring.podMonitorRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.monitoring.podMonitorRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the regular expression matches. \n Regex capture groups are available." + +### fn spec.monitoring.podMonitorRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.monitoring.podMonitorRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +### fn spec.monitoring.podMonitorRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.podMonitorRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement. \n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \n Regex capture groups are available." + ## obj spec.pgbouncer "The PgBouncer configuration" diff --git a/docs/1.21.1/postgresql/v1/cluster.md b/docs/1.21.1/postgresql/v1/cluster.md index a6d7222..6ef60f6 100644 --- a/docs/1.21.1/postgresql/v1/cluster.md +++ b/docs/1.21.1/postgresql/v1/cluster.md @@ -57,6 +57,8 @@ permalink: /1.21.1/postgresql/v1/cluster/ * [`fn withStartDelay(startDelay)`](#fn-specwithstartdelay) * [`fn withStopDelay(stopDelay)`](#fn-specwithstopdelay) * [`fn withSwitchoverDelay(switchoverDelay)`](#fn-specwithswitchoverdelay) + * [`fn withTablespaces(tablespaces)`](#fn-specwithtablespaces) + * [`fn withTablespacesMixin(tablespaces)`](#fn-specwithtablespacesmixin) * [`fn withTopologySpreadConstraints(topologySpreadConstraints)`](#fn-specwithtopologyspreadconstraints) * [`fn withTopologySpreadConstraintsMixin(topologySpreadConstraints)`](#fn-specwithtopologyspreadconstraintsmixin) * [`obj spec.affinity`](#obj-specaffinity) @@ -285,6 +287,8 @@ permalink: /1.21.1/postgresql/v1/cluster/ * [`fn withLabelsMixin(labels)`](#fn-specbackupvolumesnapshotwithlabelsmixin) * [`fn withOnline(online)`](#fn-specbackupvolumesnapshotwithonline) * [`fn withSnapshotOwnerReference(snapshotOwnerReference)`](#fn-specbackupvolumesnapshotwithsnapshotownerreference) + * [`fn withTablespaceClassName(tablespaceClassName)`](#fn-specbackupvolumesnapshotwithtablespaceclassname) + * [`fn withTablespaceClassNameMixin(tablespaceClassName)`](#fn-specbackupvolumesnapshotwithtablespaceclassnamemixin) * [`fn withWalClassName(walClassName)`](#fn-specbackupvolumesnapshotwithwalclassname) * [`obj spec.backup.volumeSnapshot.onlineConfiguration`](#obj-specbackupvolumesnapshotonlineconfiguration) * [`fn withImmediateCheckpoint(immediateCheckpoint)`](#fn-specbackupvolumesnapshotonlineconfigurationwithimmediatecheckpoint) @@ -357,6 +361,8 @@ permalink: /1.21.1/postgresql/v1/cluster/ * [`obj spec.bootstrap.recovery.secret`](#obj-specbootstraprecoverysecret) * [`fn withName(name)`](#fn-specbootstraprecoverysecretwithname) * [`obj spec.bootstrap.recovery.volumeSnapshots`](#obj-specbootstraprecoveryvolumesnapshots) + * [`fn withTablespaceStorage(tablespaceStorage)`](#fn-specbootstraprecoveryvolumesnapshotswithtablespacestorage) + * [`fn withTablespaceStorageMixin(tablespaceStorage)`](#fn-specbootstraprecoveryvolumesnapshotswithtablespacestoragemixin) * [`obj spec.bootstrap.recovery.volumeSnapshots.storage`](#obj-specbootstraprecoveryvolumesnapshotsstorage) * [`fn withApiGroup(apiGroup)`](#fn-specbootstraprecoveryvolumesnapshotsstoragewithapigroup) * [`fn withKind(kind)`](#fn-specbootstraprecoveryvolumesnapshotsstoragewithkind) @@ -510,16 +516,39 @@ permalink: /1.21.1/postgresql/v1/cluster/ * [`fn withCustomQueriesSecretMixin(customQueriesSecret)`](#fn-specmonitoringwithcustomqueriessecretmixin) * [`fn withDisableDefaultQueries(disableDefaultQueries)`](#fn-specmonitoringwithdisabledefaultqueries) * [`fn withEnablePodMonitor(enablePodMonitor)`](#fn-specmonitoringwithenablepodmonitor) + * [`fn withPodMonitorMetricRelabelings(podMonitorMetricRelabelings)`](#fn-specmonitoringwithpodmonitormetricrelabelings) + * [`fn withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings)`](#fn-specmonitoringwithpodmonitormetricrelabelingsmixin) + * [`fn withPodMonitorRelabelings(podMonitorRelabelings)`](#fn-specmonitoringwithpodmonitorrelabelings) + * [`fn withPodMonitorRelabelingsMixin(podMonitorRelabelings)`](#fn-specmonitoringwithpodmonitorrelabelingsmixin) * [`obj spec.monitoring.customQueriesConfigMap`](#obj-specmonitoringcustomqueriesconfigmap) * [`fn withKey(key)`](#fn-specmonitoringcustomqueriesconfigmapwithkey) * [`fn withName(name)`](#fn-specmonitoringcustomqueriesconfigmapwithname) * [`obj spec.monitoring.customQueriesSecret`](#obj-specmonitoringcustomqueriessecret) * [`fn withKey(key)`](#fn-specmonitoringcustomqueriessecretwithkey) * [`fn withName(name)`](#fn-specmonitoringcustomqueriessecretwithname) + * [`obj spec.monitoring.podMonitorMetricRelabelings`](#obj-specmonitoringpodmonitormetricrelabelings) + * [`fn withAction(action)`](#fn-specmonitoringpodmonitormetricrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specmonitoringpodmonitormetricrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specmonitoringpodmonitormetricrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specmonitoringpodmonitormetricrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specmonitoringpodmonitormetricrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specmonitoringpodmonitormetricrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specmonitoringpodmonitormetricrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specmonitoringpodmonitormetricrelabelingswithtargetlabel) + * [`obj spec.monitoring.podMonitorRelabelings`](#obj-specmonitoringpodmonitorrelabelings) + * [`fn withAction(action)`](#fn-specmonitoringpodmonitorrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specmonitoringpodmonitorrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specmonitoringpodmonitorrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specmonitoringpodmonitorrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specmonitoringpodmonitorrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specmonitoringpodmonitorrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specmonitoringpodmonitorrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specmonitoringpodmonitorrelabelingswithtargetlabel) * [`obj spec.nodeMaintenanceWindow`](#obj-specnodemaintenancewindow) * [`fn withInProgress(inProgress)`](#fn-specnodemaintenancewindowwithinprogress) * [`fn withReusePVC(reusePVC)`](#fn-specnodemaintenancewindowwithreusepvc) * [`obj spec.postgresql`](#obj-specpostgresql) + * [`fn withEnableAlterSystem(enableAlterSystem)`](#fn-specpostgresqlwithenablealtersystem) * [`fn withParameters(parameters)`](#fn-specpostgresqlwithparameters) * [`fn withParametersMixin(parameters)`](#fn-specpostgresqlwithparametersmixin) * [`fn withPg_hba(pg_hba)`](#fn-specpostgresqlwithpg_hba) @@ -654,6 +683,49 @@ permalink: /1.21.1/postgresql/v1/cluster/ * [`fn withValuesMixin(values)`](#fn-specstoragepvctemplateselectormatchexpressionswithvaluesmixin) * [`obj spec.superuserSecret`](#obj-specsuperusersecret) * [`fn withName(name)`](#fn-specsuperusersecretwithname) + * [`obj spec.tablespaces`](#obj-spectablespaces) + * [`fn withName(name)`](#fn-spectablespaceswithname) + * [`fn withTemporary(temporary)`](#fn-spectablespaceswithtemporary) + * [`obj spec.tablespaces.owner`](#obj-spectablespacesowner) + * [`fn withName(name)`](#fn-spectablespacesownerwithname) + * [`obj spec.tablespaces.storage`](#obj-spectablespacesstorage) + * [`fn withResizeInUseVolumes(resizeInUseVolumes)`](#fn-spectablespacesstoragewithresizeinusevolumes) + * [`fn withSize(size)`](#fn-spectablespacesstoragewithsize) + * [`fn withStorageClass(storageClass)`](#fn-spectablespacesstoragewithstorageclass) + * [`obj spec.tablespaces.storage.pvcTemplate`](#obj-spectablespacesstoragepvctemplate) + * [`fn withAccessModes(accessModes)`](#fn-spectablespacesstoragepvctemplatewithaccessmodes) + * [`fn withAccessModesMixin(accessModes)`](#fn-spectablespacesstoragepvctemplatewithaccessmodesmixin) + * [`fn withStorageClassName(storageClassName)`](#fn-spectablespacesstoragepvctemplatewithstorageclassname) + * [`fn withVolumeMode(volumeMode)`](#fn-spectablespacesstoragepvctemplatewithvolumemode) + * [`fn withVolumeName(volumeName)`](#fn-spectablespacesstoragepvctemplatewithvolumename) + * [`obj spec.tablespaces.storage.pvcTemplate.dataSource`](#obj-spectablespacesstoragepvctemplatedatasource) + * [`fn withApiGroup(apiGroup)`](#fn-spectablespacesstoragepvctemplatedatasourcewithapigroup) + * [`fn withKind(kind)`](#fn-spectablespacesstoragepvctemplatedatasourcewithkind) + * [`fn withName(name)`](#fn-spectablespacesstoragepvctemplatedatasourcewithname) + * [`obj spec.tablespaces.storage.pvcTemplate.dataSourceRef`](#obj-spectablespacesstoragepvctemplatedatasourceref) + * [`fn withApiGroup(apiGroup)`](#fn-spectablespacesstoragepvctemplatedatasourcerefwithapigroup) + * [`fn withKind(kind)`](#fn-spectablespacesstoragepvctemplatedatasourcerefwithkind) + * [`fn withName(name)`](#fn-spectablespacesstoragepvctemplatedatasourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-spectablespacesstoragepvctemplatedatasourcerefwithnamespace) + * [`obj spec.tablespaces.storage.pvcTemplate.resources`](#obj-spectablespacesstoragepvctemplateresources) + * [`fn withClaims(claims)`](#fn-spectablespacesstoragepvctemplateresourceswithclaims) + * [`fn withClaimsMixin(claims)`](#fn-spectablespacesstoragepvctemplateresourceswithclaimsmixin) + * [`fn withLimits(limits)`](#fn-spectablespacesstoragepvctemplateresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-spectablespacesstoragepvctemplateresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-spectablespacesstoragepvctemplateresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-spectablespacesstoragepvctemplateresourceswithrequestsmixin) + * [`obj spec.tablespaces.storage.pvcTemplate.resources.claims`](#obj-spectablespacesstoragepvctemplateresourcesclaims) + * [`fn withName(name)`](#fn-spectablespacesstoragepvctemplateresourcesclaimswithname) + * [`obj spec.tablespaces.storage.pvcTemplate.selector`](#obj-spectablespacesstoragepvctemplateselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-spectablespacesstoragepvctemplateselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-spectablespacesstoragepvctemplateselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-spectablespacesstoragepvctemplateselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-spectablespacesstoragepvctemplateselectorwithmatchlabelsmixin) + * [`obj spec.tablespaces.storage.pvcTemplate.selector.matchExpressions`](#obj-spectablespacesstoragepvctemplateselectormatchexpressions) + * [`fn withKey(key)`](#fn-spectablespacesstoragepvctemplateselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-spectablespacesstoragepvctemplateselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-spectablespacesstoragepvctemplateselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-spectablespacesstoragepvctemplateselectormatchexpressionswithvaluesmixin) * [`obj spec.topologySpreadConstraints`](#obj-spectopologyspreadconstraints) * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-spectopologyspreadconstraintswithmatchlabelkeys) * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-spectopologyspreadconstraintswithmatchlabelkeysmixin) @@ -1114,6 +1186,24 @@ withSwitchoverDelay(switchoverDelay) "The time in seconds that is allowed for a primary PostgreSQL instance to gracefully shutdown during a switchover. Default value is 3600 seconds (1 hour)." +### fn spec.withTablespaces + +```ts +withTablespaces(tablespaces) +``` + +"The tablespaces configuration" + +### fn spec.withTablespacesMixin + +```ts +withTablespacesMixin(tablespaces) +``` + +"The tablespaces configuration" + +**Note:** This function appends passed data to existing values + ### fn spec.withTopologySpreadConstraints ```ts @@ -2824,6 +2914,24 @@ withSnapshotOwnerReference(snapshotOwnerReference) "SnapshotOwnerReference indicates the type of owner reference the snapshot should have" +### fn spec.backup.volumeSnapshot.withTablespaceClassName + +```ts +withTablespaceClassName(tablespaceClassName) +``` + +"TablespaceClassName specifies the Snapshot Class to be used for the tablespaces. defaults to the PGDATA Snapshot Class, if set" + +### fn spec.backup.volumeSnapshot.withTablespaceClassNameMixin + +```ts +withTablespaceClassNameMixin(tablespaceClassName) +``` + +"TablespaceClassName specifies the Snapshot Class to be used for the tablespaces. defaults to the PGDATA Snapshot Class, if set" + +**Note:** This function appends passed data to existing values + ### fn spec.backup.volumeSnapshot.withWalClassName ```ts @@ -3350,6 +3458,24 @@ withName(name) "The static PVC data source(s) from which to initiate the recovery procedure. Currently supporting `VolumeSnapshot` and `PersistentVolumeClaim` resources that map an existing PVC group, compatible with CloudNativePG, and taken with a cold backup copy on a fenced Postgres instance (limitation which will be removed in the future when online backup will be implemented). Mutually exclusive with `backup`." +### fn spec.bootstrap.recovery.volumeSnapshots.withTablespaceStorage + +```ts +withTablespaceStorage(tablespaceStorage) +``` + +"Configuration of the storage for PostgreSQL tablespaces" + +### fn spec.bootstrap.recovery.volumeSnapshots.withTablespaceStorageMixin + +```ts +withTablespaceStorageMixin(tablespaceStorage) +``` + +"Configuration of the storage for PostgreSQL tablespaces" + +**Note:** This function appends passed data to existing values + ## obj spec.bootstrap.recovery.volumeSnapshots.storage "Configuration of the storage of the instances" @@ -4056,7 +4182,7 @@ withMaxParallel(maxParallel) ## obj spec.externalClusters.password -"The reference to the password to be used to connect to the server" +"The reference to the password to be used to connect to the server. If a password is provided, CloudNativePG creates a PostgreSQL passfile at `/controller/external/NAME/pass` (where \"NAME\" is the cluster's name). This passfile is automatically referenced in the connection string when establishing a connection to the remote PostgreSQL server from the current PostgreSQL `Cluster`. This ensures secure and efficient password management for external clusters." ### fn spec.externalClusters.password.withKey @@ -4434,6 +4560,42 @@ withEnablePodMonitor(enablePodMonitor) "Enable or disable the `PodMonitor`" +### fn spec.monitoring.withPodMonitorMetricRelabelings + +```ts +withPodMonitorMetricRelabelings(podMonitorMetricRelabelings) +``` + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +### fn spec.monitoring.withPodMonitorMetricRelabelingsMixin + +```ts +withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings) +``` + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.withPodMonitorRelabelings + +```ts +withPodMonitorRelabelings(podMonitorRelabelings) +``` + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +### fn spec.monitoring.withPodMonitorRelabelingsMixin + +```ts +withPodMonitorRelabelingsMixin(podMonitorRelabelings) +``` + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +**Note:** This function appends passed data to existing values + ## obj spec.monitoring.customQueriesConfigMap "The list of config maps containing the custom queries" @@ -4474,6 +4636,146 @@ withName(name) "Name of the referent." +## obj spec.monitoring.podMonitorMetricRelabelings + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +### fn spec.monitoring.podMonitorMetricRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching. \n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \n Default: \"Replace\ + +### fn spec.monitoring.podMonitorMetricRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values. \n Only applicable when the action is `HashMod`." + +### fn spec.monitoring.podMonitorMetricRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.monitoring.podMonitorMetricRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the regular expression matches. \n Regex capture groups are available." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.podMonitorMetricRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement. \n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \n Regex capture groups are available." + +## obj spec.monitoring.podMonitorRelabelings + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +### fn spec.monitoring.podMonitorRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching. \n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \n Default: \"Replace\ + +### fn spec.monitoring.podMonitorRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values. \n Only applicable when the action is `HashMod`." + +### fn spec.monitoring.podMonitorRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.monitoring.podMonitorRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the regular expression matches. \n Regex capture groups are available." + +### fn spec.monitoring.podMonitorRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.monitoring.podMonitorRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +### fn spec.monitoring.podMonitorRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.podMonitorRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement. \n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \n Regex capture groups are available." + ## obj spec.nodeMaintenanceWindow "Define a maintenance window for the Kubernetes nodes" @@ -4498,6 +4800,14 @@ withReusePVC(reusePVC) "Configuration of the PostgreSQL server" +### fn spec.postgresql.withEnableAlterSystem + +```ts +withEnableAlterSystem(enableAlterSystem) +``` + +"If this parameter is true, the user will be able to invoke `ALTER SYSTEM` on this CloudNativePG Cluster. This should only be used for debugging and troubleshooting. Defaults to false." + ### fn spec.postgresql.withParameters ```ts @@ -5206,7 +5516,7 @@ withSize(size) withStorageClass(storageClass) ``` -"StorageClass to use for database data (`PGDATA`). Applied after evaluating the PVC template, if available. If not specified, generated PVCs will be satisfied by the default storage class" +"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class" ## obj spec.storage.pvcTemplate @@ -5478,6 +5788,324 @@ withName(name) "Name of the referent." +## obj spec.tablespaces + +"The tablespaces configuration" + +### fn spec.tablespaces.withName + +```ts +withName(name) +``` + +"The name of the tablespace" + +### fn spec.tablespaces.withTemporary + +```ts +withTemporary(temporary) +``` + +"When set to true, the tablespace will be added as a `temp_tablespaces` entry in PostgreSQL, and will be available to automatically house temp database objects, or other temporary files. Please refer to PostgreSQL documentation for more information on the `temp_tablespaces` GUC." + +## obj spec.tablespaces.owner + +"Owner is the PostgreSQL user owning the tablespace" + +### fn spec.tablespaces.owner.withName + +```ts +withName(name) +``` + + + +## obj spec.tablespaces.storage + +"The storage configuration for the tablespace" + +### fn spec.tablespaces.storage.withResizeInUseVolumes + +```ts +withResizeInUseVolumes(resizeInUseVolumes) +``` + +"Resize existent PVCs, defaults to true" + +### fn spec.tablespaces.storage.withSize + +```ts +withSize(size) +``` + +"Size of the storage. Required if not already specified in the PVC template. Changes to this field are automatically reapplied to the created PVCs. Size cannot be decreased." + +### fn spec.tablespaces.storage.withStorageClass + +```ts +withStorageClass(storageClass) +``` + +"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class" + +## obj spec.tablespaces.storage.pvcTemplate + +"Template to be used to generate the Persistent Volume Claim" + +### fn spec.tablespaces.storage.pvcTemplate.withAccessModes + +```ts +withAccessModes(accessModes) +``` + +"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +### fn spec.tablespaces.storage.pvcTemplate.withAccessModesMixin + +```ts +withAccessModesMixin(accessModes) +``` + +"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +**Note:** This function appends passed data to existing values + +### fn spec.tablespaces.storage.pvcTemplate.withStorageClassName + +```ts +withStorageClassName(storageClassName) +``` + +"storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1" + +### fn spec.tablespaces.storage.pvcTemplate.withVolumeMode + +```ts +withVolumeMode(volumeMode) +``` + +"volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec." + +### fn spec.tablespaces.storage.pvcTemplate.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the binding reference to the PersistentVolume backing this claim." + +## obj spec.tablespaces.storage.pvcTemplate.dataSource + +"dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource." + +### fn spec.tablespaces.storage.pvcTemplate.dataSource.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"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." + +### fn spec.tablespaces.storage.pvcTemplate.dataSource.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.tablespaces.storage.pvcTemplate.dataSource.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +## obj spec.tablespaces.storage.pvcTemplate.dataSourceRef + +"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +### fn spec.tablespaces.storage.pvcTemplate.dataSourceRef.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"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." + +### fn spec.tablespaces.storage.pvcTemplate.dataSourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.tablespaces.storage.pvcTemplate.dataSourceRef.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +### fn spec.tablespaces.storage.pvcTemplate.dataSourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +## obj spec.tablespaces.storage.pvcTemplate.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" + +### fn spec.tablespaces.storage.pvcTemplate.resources.withClaims + +```ts +withClaims(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +### fn spec.tablespaces.storage.pvcTemplate.resources.withClaimsMixin + +```ts +withClaimsMixin(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +**Note:** This function appends passed data to existing values + +### fn spec.tablespaces.storage.pvcTemplate.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.tablespaces.storage.pvcTemplate.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.tablespaces.storage.pvcTemplate.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.tablespaces.storage.pvcTemplate.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.tablespaces.storage.pvcTemplate.resources.claims + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +### fn spec.tablespaces.storage.pvcTemplate.resources.claims.withName + +```ts +withName(name) +``` + +"Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container." + +## obj spec.tablespaces.storage.pvcTemplate.selector + +"selector is a label query over volumes to consider for binding." + +### fn spec.tablespaces.storage.pvcTemplate.selector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.tablespaces.storage.pvcTemplate.selector.withMatchExpressionsMixin + +```ts +withMatchExpressionsMixin(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +### fn spec.tablespaces.storage.pvcTemplate.selector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"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." + +### fn spec.tablespaces.storage.pvcTemplate.selector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"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." + +**Note:** This function appends passed data to existing values + +## obj spec.tablespaces.storage.pvcTemplate.selector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.tablespaces.storage.pvcTemplate.selector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.tablespaces.storage.pvcTemplate.selector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.tablespaces.storage.pvcTemplate.selector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"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." + +### fn spec.tablespaces.storage.pvcTemplate.selector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"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." + +**Note:** This function appends passed data to existing values + ## obj spec.topologySpreadConstraints "TopologySpreadConstraints specifies how to spread matching pods among the given topology. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/" @@ -5652,7 +6280,7 @@ withSize(size) withStorageClass(storageClass) ``` -"StorageClass to use for database data (`PGDATA`). Applied after evaluating the PVC template, if available. If not specified, generated PVCs will be satisfied by the default storage class" +"StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class" ## obj spec.walStorage.pvcTemplate diff --git a/docs/1.21.1/postgresql/v1/pooler.md b/docs/1.21.1/postgresql/v1/pooler.md index daaf5d7..dc9a60d 100644 --- a/docs/1.21.1/postgresql/v1/pooler.md +++ b/docs/1.21.1/postgresql/v1/pooler.md @@ -41,6 +41,28 @@ permalink: /1.21.1/postgresql/v1/pooler/ * [`fn withMaxUnavailable(maxUnavailable)`](#fn-specdeploymentstrategyrollingupdatewithmaxunavailable) * [`obj spec.monitoring`](#obj-specmonitoring) * [`fn withEnablePodMonitor(enablePodMonitor)`](#fn-specmonitoringwithenablepodmonitor) + * [`fn withPodMonitorMetricRelabelings(podMonitorMetricRelabelings)`](#fn-specmonitoringwithpodmonitormetricrelabelings) + * [`fn withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings)`](#fn-specmonitoringwithpodmonitormetricrelabelingsmixin) + * [`fn withPodMonitorRelabelings(podMonitorRelabelings)`](#fn-specmonitoringwithpodmonitorrelabelings) + * [`fn withPodMonitorRelabelingsMixin(podMonitorRelabelings)`](#fn-specmonitoringwithpodmonitorrelabelingsmixin) + * [`obj spec.monitoring.podMonitorMetricRelabelings`](#obj-specmonitoringpodmonitormetricrelabelings) + * [`fn withAction(action)`](#fn-specmonitoringpodmonitormetricrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specmonitoringpodmonitormetricrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specmonitoringpodmonitormetricrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specmonitoringpodmonitormetricrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specmonitoringpodmonitormetricrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specmonitoringpodmonitormetricrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specmonitoringpodmonitormetricrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specmonitoringpodmonitormetricrelabelingswithtargetlabel) + * [`obj spec.monitoring.podMonitorRelabelings`](#obj-specmonitoringpodmonitorrelabelings) + * [`fn withAction(action)`](#fn-specmonitoringpodmonitorrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specmonitoringpodmonitorrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specmonitoringpodmonitorrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specmonitoringpodmonitorrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specmonitoringpodmonitorrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specmonitoringpodmonitorrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specmonitoringpodmonitorrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specmonitoringpodmonitorrelabelingswithtargetlabel) * [`obj spec.pgbouncer`](#obj-specpgbouncer) * [`fn withAuthQuery(authQuery)`](#fn-specpgbouncerwithauthquery) * [`fn withParameters(parameters)`](#fn-specpgbouncerwithparameters) @@ -1509,6 +1531,182 @@ withEnablePodMonitor(enablePodMonitor) "Enable or disable the `PodMonitor`" +### fn spec.monitoring.withPodMonitorMetricRelabelings + +```ts +withPodMonitorMetricRelabelings(podMonitorMetricRelabelings) +``` + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +### fn spec.monitoring.withPodMonitorMetricRelabelingsMixin + +```ts +withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings) +``` + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.withPodMonitorRelabelings + +```ts +withPodMonitorRelabelings(podMonitorRelabelings) +``` + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +### fn spec.monitoring.withPodMonitorRelabelingsMixin + +```ts +withPodMonitorRelabelingsMixin(podMonitorRelabelings) +``` + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +**Note:** This function appends passed data to existing values + +## obj spec.monitoring.podMonitorMetricRelabelings + +"The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion." + +### fn spec.monitoring.podMonitorMetricRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching. \n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \n Default: \"Replace\ + +### fn spec.monitoring.podMonitorMetricRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values. \n Only applicable when the action is `HashMod`." + +### fn spec.monitoring.podMonitorMetricRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.monitoring.podMonitorMetricRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the regular expression matches. \n Regex capture groups are available." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +### fn spec.monitoring.podMonitorMetricRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.podMonitorMetricRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement. \n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \n Regex capture groups are available." + +## obj spec.monitoring.podMonitorRelabelings + +"The list of relabelings for the `PodMonitor`. Applied to samples before scraping." + +### fn spec.monitoring.podMonitorRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching. \n `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. \n Default: \"Replace\ + +### fn spec.monitoring.podMonitorRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values. \n Only applicable when the action is `HashMod`." + +### fn spec.monitoring.podMonitorRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.monitoring.podMonitorRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the regular expression matches. \n Regex capture groups are available." + +### fn spec.monitoring.podMonitorRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.monitoring.podMonitorRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +### fn spec.monitoring.podMonitorRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.monitoring.podMonitorRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement. \n It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. \n Regex capture groups are available." + ## obj spec.pgbouncer "The PgBouncer configuration"