postgresql.v1.cluster

"Cluster is the Schema for the PostgreSQL API"

Index

• fn new(name)
• obj metadata
  • fn withAnnotations(annotations)
  • fn withAnnotationsMixin(annotations)
  • fn withClusterName(clusterName)
  • fn withCreationTimestamp(creationTimestamp)
  • fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
  • fn withDeletionTimestamp(deletionTimestamp)
  • fn withFinalizers(finalizers)
  • fn withFinalizersMixin(finalizers)
  • fn withGenerateName(generateName)
  • fn withGeneration(generation)
  • fn withLabels(labels)
  • fn withLabelsMixin(labels)
  • fn withName(name)
  • fn withNamespace(namespace)
  • fn withOwnerReferences(ownerReferences)
  • fn withOwnerReferencesMixin(ownerReferences)
  • fn withResourceVersion(resourceVersion)
  • fn withSelfLink(selfLink)
  • fn withUid(uid)
• obj spec
  • fn withDescription(description)
  • fn withEnablePDB(enablePDB)
  • fn withEnableSuperuserAccess(enableSuperuserAccess)
  • fn withEnv(env)
  • fn withEnvFrom(envFrom)
  • fn withEnvFromMixin(envFrom)
  • fn withEnvMixin(env)
  • fn withExternalClusters(externalClusters)
  • fn withExternalClustersMixin(externalClusters)
  • fn withFailoverDelay(failoverDelay)
  • fn withImageName(imageName)
  • fn withImagePullPolicy(imagePullPolicy)
  • fn withImagePullSecrets(imagePullSecrets)
  • fn withImagePullSecretsMixin(imagePullSecrets)
  • fn withInstances(instances)
  • fn withLivenessProbeTimeout(livenessProbeTimeout)
  • fn withLogLevel(logLevel)
  • fn withMaxSyncReplicas(maxSyncReplicas)
  • fn withMinSyncReplicas(minSyncReplicas)
  • fn withPlugins(plugins)
  • fn withPluginsMixin(plugins)
  • fn withPostgresGID(postgresGID)
  • fn withPostgresUID(postgresUID)
  • fn withPrimaryUpdateMethod(primaryUpdateMethod)
  • fn withPrimaryUpdateStrategy(primaryUpdateStrategy)
  • fn withPriorityClassName(priorityClassName)
  • fn withSchedulerName(schedulerName)
  • fn withSmartShutdownTimeout(smartShutdownTimeout)
  • fn withStartDelay(startDelay)
  • fn withStopDelay(stopDelay)
  • fn withSwitchoverDelay(switchoverDelay)
  • fn withTablespaces(tablespaces)
  • fn withTablespacesMixin(tablespaces)
  • fn withTopologySpreadConstraints(topologySpreadConstraints)
  • fn withTopologySpreadConstraintsMixin(topologySpreadConstraints)
  • obj spec.affinity
    • fn withEnablePodAntiAffinity(enablePodAntiAffinity)
    • fn withNodeSelector(nodeSelector)
    • fn withNodeSelectorMixin(nodeSelector)
    • fn withPodAntiAffinityType(podAntiAffinityType)
    • fn withTolerations(tolerations)
    • fn withTolerationsMixin(tolerations)
    • fn withTopologyKey(topologyKey)
    • obj spec.affinity.additionalPodAffinity
      • fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)
      • fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)
      • fn withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)
      • fn withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)
      • obj spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution
        • fn withWeight(weight)
        • obj spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm
          • fn withMatchLabelKeys(matchLabelKeys)
          • fn withMatchLabelKeysMixin(matchLabelKeys)
          • fn withMismatchLabelKeys(mismatchLabelKeys)
          • fn withMismatchLabelKeysMixin(mismatchLabelKeys)
          • fn withNamespaces(namespaces)
          • fn withNamespacesMixin(namespaces)
          • fn withTopologyKey(topologyKey)
          • obj spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector
            • fn withMatchExpressions(matchExpressions)
            • fn withMatchExpressionsMixin(matchExpressions)
            • fn withMatchLabels(matchLabels)
            • fn withMatchLabelsMixin(matchLabels)
            • obj spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions
              • fn withKey(key)
              • fn withOperator(operator)
              • fn withValues(values)
              • fn withValuesMixin(values)
          • obj spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector
            • fn withMatchExpressions(matchExpressions)
            • fn withMatchExpressionsMixin(matchExpressions)
            • fn withMatchLabels(matchLabels)
            • fn withMatchLabelsMixin(matchLabels)
            • obj spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions
              • fn withKey(key)
              • fn withOperator(operator)
              • fn withValues(values)
              • fn withValuesMixin(values)
      • obj spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution
        • fn withMatchLabelKeys(matchLabelKeys)
        • fn withMatchLabelKeysMixin(matchLabelKeys)
        • fn withMismatchLabelKeys(mismatchLabelKeys)
        • fn withMismatchLabelKeysMixin(mismatchLabelKeys)
        • fn withNamespaces(namespaces)
        • fn withNamespacesMixin(namespaces)
        • fn withTopologyKey(topologyKey)
        • obj spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector
          • fn withMatchExpressions(matchExpressions)
          • fn withMatchExpressionsMixin(matchExpressions)
          • fn withMatchLabels(matchLabels)
          • fn withMatchLabelsMixin(matchLabels)
          • obj spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions
            • fn withKey(key)
            • fn withOperator(operator)
            • fn withValues(values)
            • fn withValuesMixin(values)
        • obj spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector
          • fn withMatchExpressions(matchExpressions)
          • fn withMatchExpressionsMixin(matchExpressions)
          • fn withMatchLabels(matchLabels)
          • fn withMatchLabelsMixin(matchLabels)
          • obj spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions
            • fn withKey(key)
            • fn withOperator(operator)
            • fn withValues(values)
            • fn withValuesMixin(values)
    • obj spec.affinity.additionalPodAntiAffinity
      • fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)
      • fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)
      • fn withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)
      • fn withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)
      • obj spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution
        • fn withWeight(weight)
        • obj spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm
          • fn withMatchLabelKeys(matchLabelKeys)
          • fn withMatchLabelKeysMixin(matchLabelKeys)
          • fn withMismatchLabelKeys(mismatchLabelKeys)
          • fn withMismatchLabelKeysMixin(mismatchLabelKeys)
          • fn withNamespaces(namespaces)
          • fn withNamespacesMixin(namespaces)
          • fn withTopologyKey(topologyKey)
          • obj spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector
            • fn withMatchExpressions(matchExpressions)
            • fn withMatchExpressionsMixin(matchExpressions)
            • fn withMatchLabels(matchLabels)
            • fn withMatchLabelsMixin(matchLabels)
            • obj spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions
              • fn withKey(key)
              • fn withOperator(operator)
              • fn withValues(values)
              • fn withValuesMixin(values)
          • obj spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector
            • fn withMatchExpressions(matchExpressions)
            • fn withMatchExpressionsMixin(matchExpressions)
            • fn withMatchLabels(matchLabels)
            • fn withMatchLabelsMixin(matchLabels)
            • obj spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions
              • fn withKey(key)
              • fn withOperator(operator)
              • fn withValues(values)
              • fn withValuesMixin(values)
      • obj spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution
        • fn withMatchLabelKeys(matchLabelKeys)
        • fn withMatchLabelKeysMixin(matchLabelKeys)
        • fn withMismatchLabelKeys(mismatchLabelKeys)
        • fn withMismatchLabelKeysMixin(mismatchLabelKeys)
        • fn withNamespaces(namespaces)
        • fn withNamespacesMixin(namespaces)
        • fn withTopologyKey(topologyKey)
        • obj spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector
          • fn withMatchExpressions(matchExpressions)
          • fn withMatchExpressionsMixin(matchExpressions)
          • fn withMatchLabels(matchLabels)
          • fn withMatchLabelsMixin(matchLabels)
          • obj spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions
            • fn withKey(key)
            • fn withOperator(operator)
            • fn withValues(values)
            • fn withValuesMixin(values)
        • obj spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector
          • fn withMatchExpressions(matchExpressions)
          • fn withMatchExpressionsMixin(matchExpressions)
          • fn withMatchLabels(matchLabels)
          • fn withMatchLabelsMixin(matchLabels)
          • obj spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions
            • fn withKey(key)
            • fn withOperator(operator)
            • fn withValues(values)
            • fn withValuesMixin(values)
    • obj spec.affinity.nodeAffinity
      • fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)
      • fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)
      • obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution
        • fn withWeight(weight)
        • obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference
          • fn withMatchExpressions(matchExpressions)
          • fn withMatchExpressionsMixin(matchExpressions)
          • fn withMatchFields(matchFields)
          • fn withMatchFieldsMixin(matchFields)
          • obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions
            • fn withKey(key)
            • fn withOperator(operator)
            • fn withValues(values)
            • fn withValuesMixin(values)
          • obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields
            • fn withKey(key)
            • fn withOperator(operator)
            • fn withValues(values)
            • fn withValuesMixin(values)
      • obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
        • fn withNodeSelectorTerms(nodeSelectorTerms)
        • fn withNodeSelectorTermsMixin(nodeSelectorTerms)
        • obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms
          • fn withMatchExpressions(matchExpressions)
          • fn withMatchExpressionsMixin(matchExpressions)
          • fn withMatchFields(matchFields)
          • fn withMatchFieldsMixin(matchFields)
          • obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions
            • fn withKey(key)
            • fn withOperator(operator)
            • fn withValues(values)
            • fn withValuesMixin(values)
          • obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields
            • fn withKey(key)
            • fn withOperator(operator)
            • fn withValues(values)
            • fn withValuesMixin(values)
    • obj spec.affinity.tolerations
      • fn withEffect(effect)
      • fn withKey(key)
      • fn withOperator(operator)
      • fn withTolerationSeconds(tolerationSeconds)
      • fn withValue(value)
  • obj spec.backup
    • fn withRetentionPolicy(retentionPolicy)
    • fn withTarget(target)
    • obj spec.backup.barmanObjectStore
      • fn withDestinationPath(destinationPath)
      • fn withEndpointURL(endpointURL)
      • fn withHistoryTags(historyTags)
      • fn withHistoryTagsMixin(historyTags)
      • fn withServerName(serverName)
      • fn withTags(tags)
      • fn withTagsMixin(tags)
      • obj spec.backup.barmanObjectStore.azureCredentials
        • fn withInheritFromAzureAD(inheritFromAzureAD)
        • obj spec.backup.barmanObjectStore.azureCredentials.connectionString
          • fn withKey(key)
          • fn withName(name)
        • obj spec.backup.barmanObjectStore.azureCredentials.storageAccount
          • fn withKey(key)
          • fn withName(name)
        • obj spec.backup.barmanObjectStore.azureCredentials.storageKey
          • fn withKey(key)
          • fn withName(name)
        • obj spec.backup.barmanObjectStore.azureCredentials.storageSasToken
          • fn withKey(key)
          • fn withName(name)
      • obj spec.backup.barmanObjectStore.data
        • fn withAdditionalCommandArgs(additionalCommandArgs)
        • fn withAdditionalCommandArgsMixin(additionalCommandArgs)
        • fn withCompression(compression)
        • fn withEncryption(encryption)
        • fn withImmediateCheckpoint(immediateCheckpoint)
        • fn withJobs(jobs)
      • obj spec.backup.barmanObjectStore.endpointCA
        • fn withKey(key)
        • fn withName(name)
      • obj spec.backup.barmanObjectStore.googleCredentials
        • fn withGkeEnvironment(gkeEnvironment)
        • obj spec.backup.barmanObjectStore.googleCredentials.applicationCredentials
          • fn withKey(key)
          • fn withName(name)
      • obj spec.backup.barmanObjectStore.s3Credentials
        • fn withInheritFromIAMRole(inheritFromIAMRole)
        • obj spec.backup.barmanObjectStore.s3Credentials.accessKeyId
          • fn withKey(key)
          • fn withName(name)
        • obj spec.backup.barmanObjectStore.s3Credentials.region
          • fn withKey(key)
          • fn withName(name)
        • obj spec.backup.barmanObjectStore.s3Credentials.secretAccessKey
          • fn withKey(key)
          • fn withName(name)
        • obj spec.backup.barmanObjectStore.s3Credentials.sessionToken
          • fn withKey(key)
          • fn withName(name)
      • obj spec.backup.barmanObjectStore.wal
        • fn withArchiveAdditionalCommandArgs(archiveAdditionalCommandArgs)
        • fn withArchiveAdditionalCommandArgsMixin(archiveAdditionalCommandArgs)
        • fn withCompression(compression)
        • fn withEncryption(encryption)
        • fn withMaxParallel(maxParallel)
        • fn withRestoreAdditionalCommandArgs(restoreAdditionalCommandArgs)
        • fn withRestoreAdditionalCommandArgsMixin(restoreAdditionalCommandArgs)
    • obj spec.backup.volumeSnapshot
      • fn withAnnotations(annotations)
      • fn withAnnotationsMixin(annotations)
      • fn withClassName(className)
      • fn withLabels(labels)
      • fn withLabelsMixin(labels)
      • fn withOnline(online)
      • fn withSnapshotOwnerReference(snapshotOwnerReference)
      • fn withTablespaceClassName(tablespaceClassName)
      • fn withTablespaceClassNameMixin(tablespaceClassName)
      • fn withWalClassName(walClassName)
      • obj spec.backup.volumeSnapshot.onlineConfiguration
        • fn withImmediateCheckpoint(immediateCheckpoint)
        • fn withWaitForArchive(waitForArchive)
  • obj spec.bootstrap
    • obj spec.bootstrap.initdb
      • fn withDataChecksums(dataChecksums)
      • fn withDatabase(database)
      • fn withEncoding(encoding)
      • fn withLocaleCType(localeCType)
      • fn withLocaleCollate(localeCollate)
      • fn withOptions(options)
      • fn withOptionsMixin(options)
      • fn withOwner(owner)
      • fn withPostInitApplicationSQL(postInitApplicationSQL)
      • fn withPostInitApplicationSQLMixin(postInitApplicationSQL)
      • fn withPostInitSQL(postInitSQL)
      • fn withPostInitSQLMixin(postInitSQL)
      • fn withPostInitTemplateSQL(postInitTemplateSQL)
      • fn withPostInitTemplateSQLMixin(postInitTemplateSQL)
      • fn withWalSegmentSize(walSegmentSize)
      • obj spec.bootstrap.initdb.import
        • fn withDatabases(databases)
        • fn withDatabasesMixin(databases)
        • fn withPostImportApplicationSQL(postImportApplicationSQL)
        • fn withPostImportApplicationSQLMixin(postImportApplicationSQL)
        • fn withRoles(roles)
        • fn withRolesMixin(roles)
        • fn withSchemaOnly(schemaOnly)
        • fn withType(type)
        • obj spec.bootstrap.initdb.import.source
          • fn withExternalCluster(externalCluster)
      • obj spec.bootstrap.initdb.postInitApplicationSQLRefs
        • fn withConfigMapRefs(configMapRefs)
        • fn withConfigMapRefsMixin(configMapRefs)
        • fn withSecretRefs(secretRefs)
        • fn withSecretRefsMixin(secretRefs)
        • obj spec.bootstrap.initdb.postInitApplicationSQLRefs.configMapRefs
          • fn withKey(key)
          • fn withName(name)
        • obj spec.bootstrap.initdb.postInitApplicationSQLRefs.secretRefs
          • fn withKey(key)
          • fn withName(name)
      • obj spec.bootstrap.initdb.postInitSQLRefs
        • fn withConfigMapRefs(configMapRefs)
        • fn withConfigMapRefsMixin(configMapRefs)
        • fn withSecretRefs(secretRefs)
        • fn withSecretRefsMixin(secretRefs)
        • obj spec.bootstrap.initdb.postInitSQLRefs.configMapRefs
          • fn withKey(key)
          • fn withName(name)
        • obj spec.bootstrap.initdb.postInitSQLRefs.secretRefs
          • fn withKey(key)
          • fn withName(name)
      • obj spec.bootstrap.initdb.postInitTemplateSQLRefs
        • fn withConfigMapRefs(configMapRefs)
        • fn withConfigMapRefsMixin(configMapRefs)
        • fn withSecretRefs(secretRefs)
        • fn withSecretRefsMixin(secretRefs)
        • obj spec.bootstrap.initdb.postInitTemplateSQLRefs.configMapRefs
          • fn withKey(key)
          • fn withName(name)
        • obj spec.bootstrap.initdb.postInitTemplateSQLRefs.secretRefs
          • fn withKey(key)
          • fn withName(name)
      • obj spec.bootstrap.initdb.secret
        • fn withName(name)
    • obj spec.bootstrap.pg_basebackup
      • fn withDatabase(database)
      • fn withOwner(owner)
      • fn withSource(source)
      • obj spec.bootstrap.pg_basebackup.secret
        • fn withName(name)
    • obj spec.bootstrap.recovery
      • fn withDatabase(database)
      • fn withOwner(owner)
      • fn withSource(source)
      • obj spec.bootstrap.recovery.backup
        • fn withName(name)
        • obj spec.bootstrap.recovery.backup.endpointCA
          • fn withKey(key)
          • fn withName(name)
      • obj spec.bootstrap.recovery.recoveryTarget
        • fn withBackupID(backupID)
        • fn withExclusive(exclusive)
        • fn withTargetImmediate(targetImmediate)
        • fn withTargetLSN(targetLSN)
        • fn withTargetName(targetName)
        • fn withTargetTLI(targetTLI)
        • fn withTargetTime(targetTime)
        • fn withTargetXID(targetXID)
      • obj spec.bootstrap.recovery.secret
        • fn withName(name)
      • obj spec.bootstrap.recovery.volumeSnapshots
        • fn withTablespaceStorage(tablespaceStorage)
        • fn withTablespaceStorageMixin(tablespaceStorage)
        • obj spec.bootstrap.recovery.volumeSnapshots.storage
          • fn withApiGroup(apiGroup)
          • fn withKind(kind)
          • fn withName(name)
        • obj spec.bootstrap.recovery.volumeSnapshots.walStorage
          • fn withApiGroup(apiGroup)
          • fn withKind(kind)
          • fn withName(name)
  • obj spec.certificates
    • fn withClientCASecret(clientCASecret)
    • fn withReplicationTLSSecret(replicationTLSSecret)
    • fn withServerAltDNSNames(serverAltDNSNames)
    • fn withServerAltDNSNamesMixin(serverAltDNSNames)
    • fn withServerCASecret(serverCASecret)
    • fn withServerTLSSecret(serverTLSSecret)
  • obj spec.env
    • fn withName(name)
    • fn withValue(value)
    • obj spec.env.valueFrom
      • obj spec.env.valueFrom.configMapKeyRef
        • fn withKey(key)
        • fn withName(name)
        • fn withOptional(optional)
      • obj spec.env.valueFrom.fieldRef
        • fn withApiVersion(apiVersion)
        • fn withFieldPath(fieldPath)
      • obj spec.env.valueFrom.resourceFieldRef
        • fn withContainerName(containerName)
        • fn withDivisor(divisor)
        • fn withResource(resource)
      • obj spec.env.valueFrom.secretKeyRef
        • fn withKey(key)
        • fn withName(name)
        • fn withOptional(optional)
  • obj spec.envFrom
    • fn withPrefix(prefix)
    • obj spec.envFrom.configMapRef
      • fn withName(name)
      • fn withOptional(optional)
    • obj spec.envFrom.secretRef
      • fn withName(name)
      • fn withOptional(optional)
  • obj spec.ephemeralVolumeSource
    • obj spec.ephemeralVolumeSource.volumeClaimTemplate
      • fn withMetadata(metadata)
      • fn withMetadataMixin(metadata)
      • obj spec.ephemeralVolumeSource.volumeClaimTemplate.spec
        • fn withAccessModes(accessModes)
        • fn withAccessModesMixin(accessModes)
        • fn withStorageClassName(storageClassName)
        • fn withVolumeAttributesClassName(volumeAttributesClassName)
        • fn withVolumeMode(volumeMode)
        • fn withVolumeName(volumeName)
        • obj spec.ephemeralVolumeSource.volumeClaimTemplate.spec.dataSource
          • fn withApiGroup(apiGroup)
          • fn withKind(kind)
          • fn withName(name)
        • obj spec.ephemeralVolumeSource.volumeClaimTemplate.spec.dataSourceRef
          • fn withApiGroup(apiGroup)
          • fn withKind(kind)
          • fn withName(name)
          • fn withNamespace(namespace)
        • obj spec.ephemeralVolumeSource.volumeClaimTemplate.spec.resources
          • fn withLimits(limits)
          • fn withLimitsMixin(limits)
          • fn withRequests(requests)
          • fn withRequestsMixin(requests)
        • obj spec.ephemeralVolumeSource.volumeClaimTemplate.spec.selector
          • fn withMatchExpressions(matchExpressions)
          • fn withMatchExpressionsMixin(matchExpressions)
          • fn withMatchLabels(matchLabels)
          • fn withMatchLabelsMixin(matchLabels)
          • obj spec.ephemeralVolumeSource.volumeClaimTemplate.spec.selector.matchExpressions
            • fn withKey(key)
            • fn withOperator(operator)
            • fn withValues(values)
            • fn withValuesMixin(values)
  • obj spec.ephemeralVolumesSizeLimit
    • fn withShm(shm)
    • fn withTemporaryData(temporaryData)
  • obj spec.externalClusters
    • fn withConnectionParameters(connectionParameters)
    • fn withConnectionParametersMixin(connectionParameters)
    • fn withName(name)
    • obj spec.externalClusters.barmanObjectStore
      • fn withDestinationPath(destinationPath)
      • fn withEndpointURL(endpointURL)
      • fn withHistoryTags(historyTags)
      • fn withHistoryTagsMixin(historyTags)
      • fn withServerName(serverName)
      • fn withTags(tags)
      • fn withTagsMixin(tags)
      • obj spec.externalClusters.barmanObjectStore.azureCredentials
        • fn withInheritFromAzureAD(inheritFromAzureAD)
        • obj spec.externalClusters.barmanObjectStore.azureCredentials.connectionString
          • fn withKey(key)
          • fn withName(name)
        • obj spec.externalClusters.barmanObjectStore.azureCredentials.storageAccount
          • fn withKey(key)
          • fn withName(name)
        • obj spec.externalClusters.barmanObjectStore.azureCredentials.storageKey
          • fn withKey(key)
          • fn withName(name)
        • obj spec.externalClusters.barmanObjectStore.azureCredentials.storageSasToken
          • fn withKey(key)
          • fn withName(name)
      • obj spec.externalClusters.barmanObjectStore.data
        • fn withAdditionalCommandArgs(additionalCommandArgs)
        • fn withAdditionalCommandArgsMixin(additionalCommandArgs)
        • fn withCompression(compression)
        • fn withEncryption(encryption)
        • fn withImmediateCheckpoint(immediateCheckpoint)
        • fn withJobs(jobs)
      • obj spec.externalClusters.barmanObjectStore.endpointCA
        • fn withKey(key)
        • fn withName(name)
      • obj spec.externalClusters.barmanObjectStore.googleCredentials
        • fn withGkeEnvironment(gkeEnvironment)
        • obj spec.externalClusters.barmanObjectStore.googleCredentials.applicationCredentials
          • fn withKey(key)
          • fn withName(name)
      • obj spec.externalClusters.barmanObjectStore.s3Credentials
        • fn withInheritFromIAMRole(inheritFromIAMRole)
        • obj spec.externalClusters.barmanObjectStore.s3Credentials.accessKeyId
          • fn withKey(key)
          • fn withName(name)
        • obj spec.externalClusters.barmanObjectStore.s3Credentials.region
          • fn withKey(key)
          • fn withName(name)
        • obj spec.externalClusters.barmanObjectStore.s3Credentials.secretAccessKey
          • fn withKey(key)
          • fn withName(name)
        • obj spec.externalClusters.barmanObjectStore.s3Credentials.sessionToken
          • fn withKey(key)
          • fn withName(name)
      • obj spec.externalClusters.barmanObjectStore.wal
        • fn withArchiveAdditionalCommandArgs(archiveAdditionalCommandArgs)
        • fn withArchiveAdditionalCommandArgsMixin(archiveAdditionalCommandArgs)
        • fn withCompression(compression)
        • fn withEncryption(encryption)
        • fn withMaxParallel(maxParallel)
        • fn withRestoreAdditionalCommandArgs(restoreAdditionalCommandArgs)
        • fn withRestoreAdditionalCommandArgsMixin(restoreAdditionalCommandArgs)
    • obj spec.externalClusters.password
      • fn withKey(key)
      • fn withName(name)
      • fn withOptional(optional)
    • obj spec.externalClusters.sslCert
      • fn withKey(key)
      • fn withName(name)
      • fn withOptional(optional)
    • obj spec.externalClusters.sslKey
      • fn withKey(key)
      • fn withName(name)
      • fn withOptional(optional)
    • obj spec.externalClusters.sslRootCert
      • fn withKey(key)
      • fn withName(name)
      • fn withOptional(optional)
  • obj spec.imageCatalogRef
    • fn withApiGroup(apiGroup)
    • fn withKind(kind)
    • fn withMajor(major)
    • fn withName(name)
  • obj spec.imagePullSecrets
    • fn withName(name)
  • obj spec.inheritedMetadata
    • fn withAnnotations(annotations)
    • fn withAnnotationsMixin(annotations)
    • fn withLabels(labels)
    • fn withLabelsMixin(labels)
  • obj spec.managed
    • fn withRoles(roles)
    • fn withRolesMixin(roles)
    • obj spec.managed.roles
      • fn withBypassrls(bypassrls)
      • fn withComment(comment)
      • fn withConnectionLimit(connectionLimit)
      • fn withCreatedb(createdb)
      • fn withCreaterole(createrole)
      • fn withDisablePassword(disablePassword)
      • fn withEnsure(ensure)
      • fn withInRoles(inRoles)
      • fn withInRolesMixin(inRoles)
      • fn withInherit(inherit)
      • fn withLogin(login)
      • fn withName(name)
      • fn withReplication(replication)
      • fn withSuperuser(superuser)
      • fn withValidUntil(validUntil)
      • obj spec.managed.roles.passwordSecret
        • fn withName(name)
    • obj spec.managed.services
      • fn withAdditional(additional)
      • fn withAdditionalMixin(additional)
      • fn withDisabledDefaultServices(disabledDefaultServices)
      • fn withDisabledDefaultServicesMixin(disabledDefaultServices)
      • obj spec.managed.services.additional
        • fn withSelectorType(selectorType)
        • fn withUpdateStrategy(updateStrategy)
        • obj spec.managed.services.additional.serviceTemplate
          • obj spec.managed.services.additional.serviceTemplate.metadata
            • fn withAnnotations(annotations)
            • fn withAnnotationsMixin(annotations)
            • fn withLabels(labels)
            • fn withLabelsMixin(labels)
            • fn withName(name)
          • obj spec.managed.services.additional.serviceTemplate.spec
            • fn withAllocateLoadBalancerNodePorts(allocateLoadBalancerNodePorts)
            • fn withClusterIP(clusterIP)
            • fn withClusterIPs(clusterIPs)
            • fn withClusterIPsMixin(clusterIPs)
            • fn withExternalIPs(externalIPs)
            • fn withExternalIPsMixin(externalIPs)
            • fn withExternalName(externalName)
            • fn withExternalTrafficPolicy(externalTrafficPolicy)
            • fn withHealthCheckNodePort(healthCheckNodePort)
            • fn withInternalTrafficPolicy(internalTrafficPolicy)
            • fn withIpFamilies(ipFamilies)
            • fn withIpFamiliesMixin(ipFamilies)
            • fn withIpFamilyPolicy(ipFamilyPolicy)
            • fn withLoadBalancerClass(loadBalancerClass)
            • fn withLoadBalancerIP(loadBalancerIP)
            • fn withLoadBalancerSourceRanges(loadBalancerSourceRanges)
            • fn withLoadBalancerSourceRangesMixin(loadBalancerSourceRanges)
            • fn withPorts(ports)
            • fn withPortsMixin(ports)
            • fn withPublishNotReadyAddresses(publishNotReadyAddresses)
            • fn withSelector(selector)
            • fn withSelectorMixin(selector)
            • fn withSessionAffinity(sessionAffinity)
            • fn withTrafficDistribution(trafficDistribution)
            • fn withType(type)
            • obj spec.managed.services.additional.serviceTemplate.spec.ports
              • fn withAppProtocol(appProtocol)
              • fn withName(name)
              • fn withNodePort(nodePort)
              • fn withPort(port)
              • fn withProtocol(protocol)
              • fn withTargetPort(targetPort)
            • obj spec.managed.services.additional.serviceTemplate.spec.sessionAffinityConfig
              • obj spec.managed.services.additional.serviceTemplate.spec.sessionAffinityConfig.clientIP
                • fn withTimeoutSeconds(timeoutSeconds)
  • obj spec.monitoring
    • fn withCustomQueriesConfigMap(customQueriesConfigMap)
    • fn withCustomQueriesConfigMapMixin(customQueriesConfigMap)
    • fn withCustomQueriesSecret(customQueriesSecret)
    • fn withCustomQueriesSecretMixin(customQueriesSecret)
    • fn withDisableDefaultQueries(disableDefaultQueries)
    • fn withEnablePodMonitor(enablePodMonitor)
    • fn withPodMonitorMetricRelabelings(podMonitorMetricRelabelings)
    • fn withPodMonitorMetricRelabelingsMixin(podMonitorMetricRelabelings)
    • fn withPodMonitorRelabelings(podMonitorRelabelings)
    • fn withPodMonitorRelabelingsMixin(podMonitorRelabelings)
    • obj spec.monitoring.customQueriesConfigMap
      • fn withKey(key)
      • fn withName(name)
    • obj spec.monitoring.customQueriesSecret
      • fn withKey(key)
      • fn withName(name)
    • obj spec.monitoring.podMonitorMetricRelabelings
      • fn withAction(action)
      • fn withModulus(modulus)
      • fn withRegex(regex)
      • fn withReplacement(replacement)
      • fn withSeparator(separator)
      • fn withSourceLabels(sourceLabels)
      • fn withSourceLabelsMixin(sourceLabels)
      • fn withTargetLabel(targetLabel)
    • obj spec.monitoring.podMonitorRelabelings
      • fn withAction(action)
      • fn withModulus(modulus)
      • fn withRegex(regex)
      • fn withReplacement(replacement)
      • fn withSeparator(separator)
      • fn withSourceLabels(sourceLabels)
      • fn withSourceLabelsMixin(sourceLabels)
      • fn withTargetLabel(targetLabel)
    • obj spec.monitoring.tls
      • fn withEnabled(enabled)
  • obj spec.nodeMaintenanceWindow
    • fn withInProgress(inProgress)
    • fn withReusePVC(reusePVC)
  • obj spec.plugins
    • fn withEnabled(enabled)
    • fn withName(name)
    • fn withParameters(parameters)
    • fn withParametersMixin(parameters)
  • obj spec.postgresql
    • fn withEnableAlterSystem(enableAlterSystem)
    • fn withParameters(parameters)
    • fn withParametersMixin(parameters)
    • fn withPg_hba(pg_hba)
    • fn withPg_hbaMixin(pg_hba)
    • fn withPg_ident(pg_ident)
    • fn withPg_identMixin(pg_ident)
    • fn withPromotionTimeout(promotionTimeout)
    • fn withShared_preload_libraries(shared_preload_libraries)
    • fn withShared_preload_librariesMixin(shared_preload_libraries)
    • obj spec.postgresql.ldap
      • fn withPort(port)
      • fn withScheme(scheme)
      • fn withServer(server)
      • fn withTls(tls)
      • obj spec.postgresql.ldap.bindAsAuth
        • fn withPrefix(prefix)
        • fn withSuffix(suffix)
      • obj spec.postgresql.ldap.bindSearchAuth
        • fn withBaseDN(baseDN)
        • fn withBindDN(bindDN)
        • fn withSearchAttribute(searchAttribute)
        • fn withSearchFilter(searchFilter)
        • obj spec.postgresql.ldap.bindSearchAuth.bindPassword
          • fn withKey(key)
          • fn withName(name)
          • fn withOptional(optional)
    • obj spec.postgresql.syncReplicaElectionConstraint
      • fn withEnabled(enabled)
      • fn withNodeLabelsAntiAffinity(nodeLabelsAntiAffinity)
      • fn withNodeLabelsAntiAffinityMixin(nodeLabelsAntiAffinity)
    • obj spec.postgresql.synchronous
      • fn withMaxStandbyNamesFromCluster(maxStandbyNamesFromCluster)
      • fn withMethod(method)
      • fn withNumber(number)
      • fn withStandbyNamesPost(standbyNamesPost)
      • fn withStandbyNamesPostMixin(standbyNamesPost)
      • fn withStandbyNamesPre(standbyNamesPre)
      • fn withStandbyNamesPreMixin(standbyNamesPre)
  • obj spec.projectedVolumeTemplate
    • fn withDefaultMode(defaultMode)
    • fn withSources(sources)
    • fn withSourcesMixin(sources)
    • obj spec.projectedVolumeTemplate.sources
      • obj spec.projectedVolumeTemplate.sources.clusterTrustBundle
        • fn withName(name)
        • fn withOptional(optional)
        • fn withPath(path)
        • fn withSignerName(signerName)
        • obj spec.projectedVolumeTemplate.sources.clusterTrustBundle.labelSelector
          • fn withMatchExpressions(matchExpressions)
          • fn withMatchExpressionsMixin(matchExpressions)
          • fn withMatchLabels(matchLabels)
          • fn withMatchLabelsMixin(matchLabels)
          • obj spec.projectedVolumeTemplate.sources.clusterTrustBundle.labelSelector.matchExpressions
            • fn withKey(key)
            • fn withOperator(operator)
            • fn withValues(values)
            • fn withValuesMixin(values)
      • obj spec.projectedVolumeTemplate.sources.configMap
        • fn withItems(items)
        • fn withItemsMixin(items)
        • fn withName(name)
        • fn withOptional(optional)
        • obj spec.projectedVolumeTemplate.sources.configMap.items
          • fn withKey(key)
          • fn withMode(mode)
          • fn withPath(path)
      • obj spec.projectedVolumeTemplate.sources.downwardAPI
        • fn withItems(items)
        • fn withItemsMixin(items)
        • obj spec.projectedVolumeTemplate.sources.downwardAPI.items
          • fn withMode(mode)
          • fn withPath(path)
          • obj spec.projectedVolumeTemplate.sources.downwardAPI.items.fieldRef
            • fn withApiVersion(apiVersion)
            • fn withFieldPath(fieldPath)
          • obj spec.projectedVolumeTemplate.sources.downwardAPI.items.resourceFieldRef
            • fn withContainerName(containerName)
            • fn withDivisor(divisor)
            • fn withResource(resource)
      • obj spec.projectedVolumeTemplate.sources.secret
        • fn withItems(items)
        • fn withItemsMixin(items)
        • fn withName(name)
        • fn withOptional(optional)
        • obj spec.projectedVolumeTemplate.sources.secret.items
          • fn withKey(key)
          • fn withMode(mode)
          • fn withPath(path)
      • obj spec.projectedVolumeTemplate.sources.serviceAccountToken
        • fn withAudience(audience)
        • fn withExpirationSeconds(expirationSeconds)
        • fn withPath(path)
  • obj spec.replica
    • fn withEnabled(enabled)
    • fn withMinApplyDelay(minApplyDelay)
    • fn withPrimary(primary)
    • fn withPromotionToken(promotionToken)
    • fn withSelf(Self)
    • fn withSource(source)
  • obj spec.replicationSlots
    • fn withUpdateInterval(updateInterval)
    • obj spec.replicationSlots.highAvailability
      • fn withEnabled(enabled)
      • fn withSlotPrefix(slotPrefix)
    • obj spec.replicationSlots.synchronizeReplicas
      • fn withEnabled(enabled)
      • fn withExcludePatterns(excludePatterns)
      • fn withExcludePatternsMixin(excludePatterns)
  • obj spec.resources
    • fn withClaims(claims)
    • fn withClaimsMixin(claims)
    • fn withLimits(limits)
    • fn withLimitsMixin(limits)
    • fn withRequests(requests)
    • fn withRequestsMixin(requests)
    • obj spec.resources.claims
      • fn withName(name)
      • fn withRequest(request)
  • obj spec.seccompProfile
    • fn withLocalhostProfile(localhostProfile)
    • fn withType(type)
  • obj spec.serviceAccountTemplate
    • obj spec.serviceAccountTemplate.metadata
      • fn withAnnotations(annotations)
      • fn withAnnotationsMixin(annotations)
      • fn withLabels(labels)
      • fn withLabelsMixin(labels)
      • fn withName(name)
  • obj spec.storage
    • fn withResizeInUseVolumes(resizeInUseVolumes)
    • fn withSize(size)
    • fn withStorageClass(storageClass)
    • obj spec.storage.pvcTemplate
      • fn withAccessModes(accessModes)
      • fn withAccessModesMixin(accessModes)
      • fn withStorageClassName(storageClassName)
      • fn withVolumeAttributesClassName(volumeAttributesClassName)
      • fn withVolumeMode(volumeMode)
      • fn withVolumeName(volumeName)
      • obj spec.storage.pvcTemplate.dataSource
        • fn withApiGroup(apiGroup)
        • fn withKind(kind)
        • fn withName(name)
      • obj spec.storage.pvcTemplate.dataSourceRef
        • fn withApiGroup(apiGroup)
        • fn withKind(kind)
        • fn withName(name)
        • fn withNamespace(namespace)
      • obj spec.storage.pvcTemplate.resources
        • fn withLimits(limits)
        • fn withLimitsMixin(limits)
        • fn withRequests(requests)
        • fn withRequestsMixin(requests)
      • obj spec.storage.pvcTemplate.selector
        • fn withMatchExpressions(matchExpressions)
        • fn withMatchExpressionsMixin(matchExpressions)
        • fn withMatchLabels(matchLabels)
        • fn withMatchLabelsMixin(matchLabels)
        • obj spec.storage.pvcTemplate.selector.matchExpressions
          • fn withKey(key)
          • fn withOperator(operator)
          • fn withValues(values)
          • fn withValuesMixin(values)
  • obj spec.superuserSecret
    • fn withName(name)
  • obj spec.tablespaces
    • fn withName(name)
    • fn withTemporary(temporary)
    • obj spec.tablespaces.owner
      • fn withName(name)
    • obj spec.tablespaces.storage
      • fn withResizeInUseVolumes(resizeInUseVolumes)
      • fn withSize(size)
      • fn withStorageClass(storageClass)
      • obj spec.tablespaces.storage.pvcTemplate
        • fn withAccessModes(accessModes)
        • fn withAccessModesMixin(accessModes)
        • fn withStorageClassName(storageClassName)
        • fn withVolumeAttributesClassName(volumeAttributesClassName)
        • fn withVolumeMode(volumeMode)
        • fn withVolumeName(volumeName)
        • obj spec.tablespaces.storage.pvcTemplate.dataSource
          • fn withApiGroup(apiGroup)
          • fn withKind(kind)
          • fn withName(name)
        • obj spec.tablespaces.storage.pvcTemplate.dataSourceRef
          • fn withApiGroup(apiGroup)
          • fn withKind(kind)
          • fn withName(name)
          • fn withNamespace(namespace)
        • obj spec.tablespaces.storage.pvcTemplate.resources
          • fn withLimits(limits)
          • fn withLimitsMixin(limits)
          • fn withRequests(requests)
          • fn withRequestsMixin(requests)
        • obj spec.tablespaces.storage.pvcTemplate.selector
          • fn withMatchExpressions(matchExpressions)
          • fn withMatchExpressionsMixin(matchExpressions)
          • fn withMatchLabels(matchLabels)
          • fn withMatchLabelsMixin(matchLabels)
          • obj spec.tablespaces.storage.pvcTemplate.selector.matchExpressions
            • fn withKey(key)
            • fn withOperator(operator)
            • fn withValues(values)
            • fn withValuesMixin(values)
  • obj spec.topologySpreadConstraints
    • fn withMatchLabelKeys(matchLabelKeys)
    • fn withMatchLabelKeysMixin(matchLabelKeys)
    • fn withMaxSkew(maxSkew)
    • fn withMinDomains(minDomains)
    • fn withNodeAffinityPolicy(nodeAffinityPolicy)
    • fn withNodeTaintsPolicy(nodeTaintsPolicy)
    • fn withTopologyKey(topologyKey)
    • fn withWhenUnsatisfiable(whenUnsatisfiable)
    • obj spec.topologySpreadConstraints.labelSelector
      • fn withMatchExpressions(matchExpressions)
      • fn withMatchExpressionsMixin(matchExpressions)
      • fn withMatchLabels(matchLabels)
      • fn withMatchLabelsMixin(matchLabels)
      • obj spec.topologySpreadConstraints.labelSelector.matchExpressions
        • fn withKey(key)
        • fn withOperator(operator)
        • fn withValues(values)
        • fn withValuesMixin(values)
  • obj spec.walStorage
    • fn withResizeInUseVolumes(resizeInUseVolumes)
    • fn withSize(size)
    • fn withStorageClass(storageClass)
    • obj spec.walStorage.pvcTemplate
      • fn withAccessModes(accessModes)
      • fn withAccessModesMixin(accessModes)
      • fn withStorageClassName(storageClassName)
      • fn withVolumeAttributesClassName(volumeAttributesClassName)
      • fn withVolumeMode(volumeMode)
      • fn withVolumeName(volumeName)
      • obj spec.walStorage.pvcTemplate.dataSource
        • fn withApiGroup(apiGroup)
        • fn withKind(kind)
        • fn withName(name)
      • obj spec.walStorage.pvcTemplate.dataSourceRef
        • fn withApiGroup(apiGroup)
        • fn withKind(kind)
        • fn withName(name)
        • fn withNamespace(namespace)
      • obj spec.walStorage.pvcTemplate.resources
        • fn withLimits(limits)
        • fn withLimitsMixin(limits)
        • fn withRequests(requests)
        • fn withRequestsMixin(requests)
      • obj spec.walStorage.pvcTemplate.selector
        • fn withMatchExpressions(matchExpressions)
        • fn withMatchExpressionsMixin(matchExpressions)
        • fn withMatchLabels(matchLabels)
        • fn withMatchLabelsMixin(matchLabels)
        • obj spec.walStorage.pvcTemplate.selector.matchExpressions
          • fn withKey(key)
          • fn withOperator(operator)
          • fn withValues(values)
          • fn withValuesMixin(values)

Fields

fn new

new(name)

new returns an instance of Cluster

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn metadata.withSelfLink

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"Specification of the desired behavior of the cluster.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"

fn spec.withDescription

withDescription(description)

"Description of this PostgreSQL cluster"

fn spec.withEnablePDB

withEnablePDB(enablePDB)

"Manage the PodDisruptionBudget resources within the cluster. When\nconfigured as true (default setting), the pod disruption budgets\nwill safeguard the primary node from being terminated. Conversely,\nsetting it to false will result in the absence of any\nPodDisruptionBudget resource, permitting the shutdown of all nodes\nhosting the PostgreSQL cluster. This latter configuration is\nadvisable for any PostgreSQL cluster employed for\ndevelopment/staging purposes."

fn spec.withEnableSuperuserAccess

withEnableSuperuserAccess(enableSuperuserAccess)

"When this option is enabled, the operator will use the SuperuserSecret\nto update the postgres user password (if the secret is\nnot present, the operator will automatically create one). When this\noption is disabled, the operator will ignore the SuperuserSecret content, delete\nit when automatically created, and then blank the password of the postgres\nuser by setting it to NULL. Disabled by default."

fn spec.withEnv

withEnv(env)

"Env follows the Env format to pass environment variables\nto the pods created in the cluster"

fn spec.withEnvFrom

withEnvFrom(envFrom)

"EnvFrom follows the EnvFrom format to pass environment variables\nsources to the pods to be used by Env"

fn spec.withEnvFromMixin

withEnvFromMixin(envFrom)

"EnvFrom follows the EnvFrom format to pass environment variables\nsources to the pods to be used by Env"

Note: This function appends passed data to existing values

fn spec.withEnvMixin

withEnvMixin(env)

"Env follows the Env format to pass environment variables\nto the pods created in the cluster"

Note: This function appends passed data to existing values

fn spec.withExternalClusters

withExternalClusters(externalClusters)

"The list of external clusters which are used in the configuration"

fn spec.withExternalClustersMixin

withExternalClustersMixin(externalClusters)

"The list of external clusters which are used in the configuration"

Note: This function appends passed data to existing values

fn spec.withFailoverDelay

withFailoverDelay(failoverDelay)

"The amount of time (in seconds) to wait before triggering a failover\nafter the primary PostgreSQL instance in the cluster was detected\nto be unhealthy"

fn spec.withImageName

withImageName(imageName)

"Name of the container image, supporting both tags (<image>:<tag>)\nand digests for deterministic and repeatable deployments\n(<image>:<tag>@sha256:<digestValue>)"

fn spec.withImagePullPolicy

withImagePullPolicy(imagePullPolicy)

"Image pull policy.\nOne of Always, Never or IfNotPresent.\nIf not defined, it defaults to IfNotPresent.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images"

fn spec.withImagePullSecrets

withImagePullSecrets(imagePullSecrets)

"The list of pull secrets to be used to pull the images"

fn spec.withImagePullSecretsMixin

withImagePullSecretsMixin(imagePullSecrets)

"The list of pull secrets to be used to pull the images"

Note: This function appends passed data to existing values

fn spec.withInstances

withInstances(instances)

"Number of instances required in the cluster"

fn spec.withLivenessProbeTimeout

withLivenessProbeTimeout(livenessProbeTimeout)

"LivenessProbeTimeout is the time (in seconds) that is allowed for a PostgreSQL instance\nto successfully respond to the liveness probe (default 30).\nThe Liveness probe failure threshold is derived from this value using the formula:\nceiling(livenessProbe / 10)."

fn spec.withLogLevel

withLogLevel(logLevel)

"The instances' log level, one of the following values: error, warning, info (default), debug, trace"

fn spec.withMaxSyncReplicas

withMaxSyncReplicas(maxSyncReplicas)

"The target value for the synchronous replication quorum, that can be\ndecreased if the number of ready standbys is lower than this.\nUndefined or 0 disable synchronous replication."

fn spec.withMinSyncReplicas

withMinSyncReplicas(minSyncReplicas)

"Minimum number of instances required in synchronous replication with the\nprimary. Undefined or 0 allow writes to complete when no standby is\navailable."

fn spec.withPlugins

withPlugins(plugins)

"The plugins configuration, containing\nany plugin to be loaded with the corresponding configuration"

fn spec.withPluginsMixin

withPluginsMixin(plugins)

"The plugins configuration, containing\nany plugin to be loaded with the corresponding configuration"

Note: This function appends passed data to existing values

fn spec.withPostgresGID

withPostgresGID(postgresGID)

"The GID of the postgres user inside the image, defaults to 26"

fn spec.withPostgresUID

withPostgresUID(postgresUID)

"The UID of the postgres user inside the image, defaults to 26"

fn spec.withPrimaryUpdateMethod

withPrimaryUpdateMethod(primaryUpdateMethod)

"Method to follow to upgrade the primary server during a rolling\nupdate procedure, after all replicas have been successfully updated:\nit can be with a switchover (switchover) or in-place (restart - default)"

fn spec.withPrimaryUpdateStrategy

withPrimaryUpdateStrategy(primaryUpdateStrategy)

"Deployment strategy to follow to upgrade the primary server during a rolling\nupdate procedure, after all replicas have been successfully updated:\nit can be automated (unsupervised - default) or manual (supervised)"

fn spec.withPriorityClassName

withPriorityClassName(priorityClassName)

"Name of the priority class which will be used in every generated Pod, if the PriorityClass\nspecified does not exist, the pod will not be able to schedule. Please refer to\nhttps://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/#priorityclass\nfor more information"

fn spec.withSchedulerName

withSchedulerName(schedulerName)

"If specified, the pod will be dispatched by specified Kubernetes\nscheduler. If not specified, the pod will be dispatched by the default\nscheduler. More info:\nhttps://kubernetes.io/docs/concepts/scheduling-eviction/kube-scheduler/"

fn spec.withSmartShutdownTimeout

withSmartShutdownTimeout(smartShutdownTimeout)

"The time in seconds that controls the window of time reserved for the smart shutdown of Postgres to complete.\nMake sure you reserve enough time for the operator to request a fast shutdown of Postgres\n(that is: stopDelay - smartShutdownTimeout)."

fn spec.withStartDelay

withStartDelay(startDelay)

"The time in seconds that is allowed for a PostgreSQL instance to\nsuccessfully start up (default 3600).\nThe startup probe failure threshold is derived from this value using the formula:\nceiling(startDelay / 10)."

fn spec.withStopDelay

withStopDelay(stopDelay)

"The time in seconds that is allowed for a PostgreSQL instance to\ngracefully shutdown (default 1800)"

fn spec.withSwitchoverDelay

withSwitchoverDelay(switchoverDelay)

"The time in seconds that is allowed for a primary PostgreSQL instance\nto gracefully shutdown during a switchover.\nDefault value is 3600 seconds (1 hour)."

fn spec.withTablespaces

withTablespaces(tablespaces)

"The tablespaces configuration"

fn spec.withTablespacesMixin

withTablespacesMixin(tablespaces)

"The tablespaces configuration"

Note: This function appends passed data to existing values

fn spec.withTopologySpreadConstraints

withTopologySpreadConstraints(topologySpreadConstraints)

"TopologySpreadConstraints specifies how to spread matching pods among the given topology.\nMore info:\nhttps://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/"

fn spec.withTopologySpreadConstraintsMixin

withTopologySpreadConstraintsMixin(topologySpreadConstraints)

"TopologySpreadConstraints specifies how to spread matching pods among the given topology.\nMore info:\nhttps://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/"

Note: This function appends passed data to existing values

obj spec.affinity

"Affinity/Anti-affinity rules for Pods"

fn spec.affinity.withEnablePodAntiAffinity

withEnablePodAntiAffinity(enablePodAntiAffinity)

"Activates anti-affinity for the pods. The operator will define pods\nanti-affinity unless this field is explicitly set to false"

fn spec.affinity.withNodeSelector

withNodeSelector(nodeSelector)

"NodeSelector is map of key-value pairs used to define the nodes on which\nthe pods can run.\nMore info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/"

fn spec.affinity.withNodeSelectorMixin

withNodeSelectorMixin(nodeSelector)

"NodeSelector is map of key-value pairs used to define the nodes on which\nthe pods can run.\nMore info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/"

Note: This function appends passed data to existing values

fn spec.affinity.withPodAntiAffinityType

withPodAntiAffinityType(podAntiAffinityType)

"PodAntiAffinityType allows the user to decide whether pod anti-affinity between cluster instance has to be\nconsidered a strong requirement during scheduling or not. Allowed values are: \"preferred\" (default if empty) or\n\"required\". Setting it to \"required\", could lead to instances remaining pending until new kubernetes nodes are\nadded if all the existing nodes don't match the required pod anti-affinity rule.\nMore info:\nhttps://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity"

fn spec.affinity.withTolerations

withTolerations(tolerations)

"Tolerations is a list of Tolerations that should be set for all the pods, in order to allow them to run\non tainted nodes.\nMore info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/"

fn spec.affinity.withTolerationsMixin

withTolerationsMixin(tolerations)

"Tolerations is a list of Tolerations that should be set for all the pods, in order to allow them to run\non tainted nodes.\nMore info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/"

Note: This function appends passed data to existing values

fn spec.affinity.withTopologyKey

withTopologyKey(topologyKey)

"TopologyKey to use for anti-affinity configuration. See k8s documentation\nfor more info on that"

obj spec.affinity.additionalPodAffinity

"AdditionalPodAffinity allows to specify pod affinity terms to be passed to all the cluster's pods."

fn spec.affinity.additionalPodAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred."

fn spec.affinity.additionalPodAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred."

Note: This function appends passed data to existing values

fn spec.affinity.additionalPodAffinity.withRequiredDuringSchedulingIgnoredDuringExecution

withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)

"If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied."

fn spec.affinity.additionalPodAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin

withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)

"If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied."

Note: This function appends passed data to existing values

obj spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution

"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred."

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

"weight associated with matching the corresponding podAffinityTerm,\nin the range 1-100."

obj spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm

"Required. A pod affinity term, associated with the corresponding weight."

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMatchLabelKeys

withMatchLabelKeys(matchLabelKeys)

"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with labelSelector as key in (value)\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default)."

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMatchLabelKeysMixin

withMatchLabelKeysMixin(matchLabelKeys)

"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with labelSelector as key in (value)\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default)."

Note: This function appends passed data to existing values

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMismatchLabelKeys

withMismatchLabelKeys(mismatchLabelKeys)

"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with labelSelector as key notin (value)\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default)."

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMismatchLabelKeysMixin

withMismatchLabelKeysMixin(mismatchLabelKeys)

"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with labelSelector as key notin (value)\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default)."

Note: This function appends passed data to existing values

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces

withNamespaces(namespaces)

"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

Note: This function appends passed data to existing values

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey

withTopologyKey(topologyKey)

"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed."

obj spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector

"A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods."

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin

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.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

Note: This function appends passed data to existing values

obj spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector

"A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces."

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressionsMixin

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.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

fn spec.affinity.additionalPodAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

Note: This function appends passed data to existing values

obj spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution

"If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied."

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMatchLabelKeys

withMatchLabelKeys(matchLabelKeys)

"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with labelSelector as key in (value)\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default)."

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMatchLabelKeysMixin

withMatchLabelKeysMixin(matchLabelKeys)

"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with labelSelector as key in (value)\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default)."

Note: This function appends passed data to existing values

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMismatchLabelKeys

withMismatchLabelKeys(mismatchLabelKeys)

"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with labelSelector as key notin (value)\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default)."

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMismatchLabelKeysMixin

withMismatchLabelKeysMixin(mismatchLabelKeys)

"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with labelSelector as key notin (value)\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default)."

Note: This function appends passed data to existing values

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces

withNamespaces(namespaces)

"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

Note: This function appends passed data to existing values

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey

withTopologyKey(topologyKey)

"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed."

obj spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector

"A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods."

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin

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.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

Note: This function appends passed data to existing values

obj spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector

"A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces."

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressionsMixin

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.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

fn spec.affinity.additionalPodAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

Note: This function appends passed data to existing values

obj spec.affinity.additionalPodAntiAffinity

"AdditionalPodAntiAffinity allows to specify pod anti-affinity terms to be added to the ones generated\nby the operator if EnablePodAntiAffinity is set to true (default) or to be used exclusively if set to false."

fn spec.affinity.additionalPodAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred."

fn spec.affinity.additionalPodAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred."

Note: This function appends passed data to existing values

fn spec.affinity.additionalPodAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecution

withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)

"If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied."

fn spec.affinity.additionalPodAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin

withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)

"If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied."

Note: This function appends passed data to existing values

obj spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

"The scheduler will prefer to schedule pods to nodes that satisfy\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred."

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

"weight associated with matching the corresponding podAffinityTerm,\nin the range 1-100."

obj spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm

"Required. A pod affinity term, associated with the corresponding weight."

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMatchLabelKeys

withMatchLabelKeys(matchLabelKeys)

"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with labelSelector as key in (value)\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default)."

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMatchLabelKeysMixin

withMatchLabelKeysMixin(matchLabelKeys)

"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with labelSelector as key in (value)\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default)."

Note: This function appends passed data to existing values

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMismatchLabelKeys

withMismatchLabelKeys(mismatchLabelKeys)

"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with labelSelector as key notin (value)\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default)."

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMismatchLabelKeysMixin

withMismatchLabelKeysMixin(mismatchLabelKeys)

"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with labelSelector as key notin (value)\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default)."

Note: This function appends passed data to existing values

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces

withNamespaces(namespaces)

"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

Note: This function appends passed data to existing values

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey

withTopologyKey(topologyKey)

"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed."

obj spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector

"A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods."

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin

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.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

Note: This function appends passed data to existing values

obj spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector

"A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces."

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressionsMixin

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.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

fn spec.affinity.additionalPodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

Note: This function appends passed data to existing values

obj spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

"If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied."

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMatchLabelKeys

withMatchLabelKeys(matchLabelKeys)

"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with labelSelector as key in (value)\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default)."

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMatchLabelKeysMixin

withMatchLabelKeysMixin(matchLabelKeys)

"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with labelSelector as key in (value)\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default)."

Note: This function appends passed data to existing values

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMismatchLabelKeys

withMismatchLabelKeys(mismatchLabelKeys)

"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with labelSelector as key notin (value)\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default)."

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMismatchLabelKeysMixin

withMismatchLabelKeysMixin(mismatchLabelKeys)

"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with labelSelector as key notin (value)\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default)."

Note: This function appends passed data to existing values

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces

withNamespaces(namespaces)

"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

Note: This function appends passed data to existing values

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey

withTopologyKey(topologyKey)

"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed."

obj spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector

"A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods."

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin

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.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

Note: This function appends passed data to existing values

obj spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector

"A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces."

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressionsMixin

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.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

fn spec.affinity.additionalPodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity

"NodeAffinity describes node affinity scheduling rules for the pod.\nMore info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity"

fn spec.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(s) with the highest sum are the most preferred."

fn spec.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(s) with the highest sum are the most preferred."

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(s) with the highest sum are the most preferred."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

"Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100."

obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference

"A node selector term, associated with the corresponding weight."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressions

withMatchExpressions(matchExpressions)

"A list of node selector requirements by node's labels."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"A list of node selector requirements by node's labels."

Note: This function appends passed data to existing values

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFields

withMatchFields(matchFields)

"A list of node selector requirements by node's fields."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

"A list of node selector requirements by node's fields."

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions

"A list of node selector requirements by node's labels."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValues

withValues(values)

"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValuesMixin

withValuesMixin(values)

"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields

"A list of node selector requirements by node's fields."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValues

withValues(values)

"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValuesMixin

withValuesMixin(values)

"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

"If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to an update), the system\nmay or may not try to eventually evict the pod from its node."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms

withNodeSelectorTerms(nodeSelectorTerms)

"Required. A list of node selector terms. The terms are ORed."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTermsMixin

withNodeSelectorTermsMixin(nodeSelectorTerms)

"Required. A list of node selector terms. The terms are ORed."

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

"Required. A list of node selector terms. The terms are ORed."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressions

withMatchExpressions(matchExpressions)

"A list of node selector requirements by node's labels."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"A list of node selector requirements by node's labels."

Note: This function appends passed data to existing values

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFields

withMatchFields(matchFields)

"A list of node selector requirements by node's fields."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

"A list of node selector requirements by node's fields."

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions

"A list of node selector requirements by node's labels."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValues

withValues(values)

"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValuesMixin

withValuesMixin(values)

"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields

"A list of node selector requirements by node's fields."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValues

withValues(values)

"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValuesMixin

withValuesMixin(values)

"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.affinity.tolerations

"Tolerations is a list of Tolerations that should be set for all the pods, in order to allow them to run\non tainted nodes.\nMore info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/"

fn spec.affinity.tolerations.withEffect

withEffect(effect)

"Effect indicates the taint effect to match. Empty means match all taint effects.\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute."

fn spec.affinity.tolerations.withKey

withKey(key)

"Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys."

fn spec.affinity.tolerations.withOperator

withOperator(operator)

"Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category."

fn spec.affinity.tolerations.withTolerationSeconds

withTolerationSeconds(tolerationSeconds)

"TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system."

fn spec.affinity.tolerations.withValue

withValue(value)

"Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string."

obj spec.backup

"The configuration to be used for backups"

fn spec.backup.withRetentionPolicy

withRetentionPolicy(retentionPolicy)

"RetentionPolicy is the retention policy to be used for backups\nand WALs (i.e. '60d'). The retention policy is expressed in the form\nof XXu where XX is a positive integer and u is in [dwm] -\ndays, weeks, months.\nIt's currently only applicable when using the BarmanObjectStore method."

fn spec.backup.withTarget

withTarget(target)

"The policy to decide which instance should perform backups. Available\noptions are empty string, which will default to prefer-standby policy,\nprimary to have backups run always on primary instances, prefer-standby\nto have backups run preferably on the most updated standby, if available."

obj spec.backup.barmanObjectStore

"The configuration for the barman-cloud tool suite"

fn spec.backup.barmanObjectStore.withDestinationPath

withDestinationPath(destinationPath)

"The path where to store the backup (i.e. s3://bucket/path/to/folder)\nthis path, with different destination folders, will be used for WALs\nand for data"

fn spec.backup.barmanObjectStore.withEndpointURL

withEndpointURL(endpointURL)

"Endpoint to be used to upload data to the cloud,\noverriding the automatic endpoint discovery"

fn spec.backup.barmanObjectStore.withHistoryTags

withHistoryTags(historyTags)

"HistoryTags is a list of key value pairs that will be passed to the\nBarman --history-tags option."

fn spec.backup.barmanObjectStore.withHistoryTagsMixin

withHistoryTagsMixin(historyTags)

"HistoryTags is a list of key value pairs that will be passed to the\nBarman --history-tags option."

Note: This function appends passed data to existing values

fn spec.backup.barmanObjectStore.withServerName

withServerName(serverName)

"The server name on S3, the cluster name is used if this\nparameter is omitted"

fn spec.backup.barmanObjectStore.withTags

withTags(tags)

"Tags is a list of key value pairs that will be passed to the\nBarman --tags option."

fn spec.backup.barmanObjectStore.withTagsMixin

withTagsMixin(tags)

"Tags is a list of key value pairs that will be passed to the\nBarman --tags option."

Note: This function appends passed data to existing values

obj spec.backup.barmanObjectStore.azureCredentials

"The credentials to use to upload data to Azure Blob Storage"

fn spec.backup.barmanObjectStore.azureCredentials.withInheritFromAzureAD

withInheritFromAzureAD(inheritFromAzureAD)

"Use the Azure AD based authentication without providing explicitly the keys."

obj spec.backup.barmanObjectStore.azureCredentials.connectionString

"The connection string to be used"

fn spec.backup.barmanObjectStore.azureCredentials.connectionString.withKey

withKey(key)

"The key to select"

fn spec.backup.barmanObjectStore.azureCredentials.connectionString.withName

withName(name)

"Name of the referent."

obj spec.backup.barmanObjectStore.azureCredentials.storageAccount

"The storage account where to upload data"

fn spec.backup.barmanObjectStore.azureCredentials.storageAccount.withKey

withKey(key)

"The key to select"

fn spec.backup.barmanObjectStore.azureCredentials.storageAccount.withName

withName(name)

"Name of the referent."

obj spec.backup.barmanObjectStore.azureCredentials.storageKey

"The storage account key to be used in conjunction\nwith the storage account name"

fn spec.backup.barmanObjectStore.azureCredentials.storageKey.withKey

withKey(key)

"The key to select"

fn spec.backup.barmanObjectStore.azureCredentials.storageKey.withName

withName(name)

"Name of the referent."

obj spec.backup.barmanObjectStore.azureCredentials.storageSasToken

"A shared-access-signature to be used in conjunction with\nthe storage account name"

fn spec.backup.barmanObjectStore.azureCredentials.storageSasToken.withKey

withKey(key)

"The key to select"

fn spec.backup.barmanObjectStore.azureCredentials.storageSasToken.withName

withName(name)

"Name of the referent."

obj spec.backup.barmanObjectStore.data

"The configuration to be used to backup the data files\nWhen not defined, base backups files will be stored uncompressed and may\nbe unencrypted in the object store, according to the bucket default\npolicy."

fn spec.backup.barmanObjectStore.data.withAdditionalCommandArgs

withAdditionalCommandArgs(additionalCommandArgs)

"AdditionalCommandArgs represents additional arguments that can be appended\nto the 'barman-cloud-backup' command-line invocation. These arguments\nprovide flexibility to customize the backup process further according to\nspecific requirements or configurations.\n\nExample:\nIn a scenario where specialized backup options are required, such as setting\na specific timeout or defining custom behavior, users can use this field\nto specify additional command arguments.\n\nNote:\nIt's essential to ensure that the provided arguments are valid and supported\nby the 'barman-cloud-backup' command, to avoid potential errors or unintended\nbehavior during execution."

fn spec.backup.barmanObjectStore.data.withAdditionalCommandArgsMixin

withAdditionalCommandArgsMixin(additionalCommandArgs)

"AdditionalCommandArgs represents additional arguments that can be appended\nto the 'barman-cloud-backup' command-line invocation. These arguments\nprovide flexibility to customize the backup process further according to\nspecific requirements or configurations.\n\nExample:\nIn a scenario where specialized backup options are required, such as setting\na specific timeout or defining custom behavior, users can use this field\nto specify additional command arguments.\n\nNote:\nIt's essential to ensure that the provided arguments are valid and supported\nby the 'barman-cloud-backup' command, to avoid potential errors or unintended\nbehavior during execution."

Note: This function appends passed data to existing values

fn spec.backup.barmanObjectStore.data.withCompression

withCompression(compression)

"Compress a backup file (a tar file per tablespace) while streaming it\nto the object store. Available options are empty string (no\ncompression, default), gzip, bzip2 or snappy."

fn spec.backup.barmanObjectStore.data.withEncryption

withEncryption(encryption)

"Whenever to force the encryption of files (if the bucket is\nnot already configured for that).\nAllowed options are empty string (use the bucket policy, default),\nAES256 and aws:kms"

fn spec.backup.barmanObjectStore.data.withImmediateCheckpoint

withImmediateCheckpoint(immediateCheckpoint)

"Control whether the I/O workload for the backup initial checkpoint will\nbe limited, according to the checkpoint_completion_target setting on\nthe PostgreSQL server. If set to true, an immediate checkpoint will be\nused, meaning PostgreSQL will complete the checkpoint as soon as\npossible. false by default."

fn spec.backup.barmanObjectStore.data.withJobs

withJobs(jobs)

"The number of parallel jobs to be used to upload the backup, defaults\nto 2"

obj spec.backup.barmanObjectStore.endpointCA

"EndpointCA store the CA bundle of the barman endpoint.\nUseful when using self-signed certificates to avoid\nerrors with certificate issuer and barman-cloud-wal-archive"

fn spec.backup.barmanObjectStore.endpointCA.withKey

withKey(key)

"The key to select"

fn spec.backup.barmanObjectStore.endpointCA.withName

withName(name)

"Name of the referent."

obj spec.backup.barmanObjectStore.googleCredentials

"The credentials to use to upload data to Google Cloud Storage"

fn spec.backup.barmanObjectStore.googleCredentials.withGkeEnvironment

withGkeEnvironment(gkeEnvironment)

"If set to true, will presume that it's running inside a GKE environment,\ndefault to false."

obj spec.backup.barmanObjectStore.googleCredentials.applicationCredentials

"The secret containing the Google Cloud Storage JSON file with the credentials"

fn spec.backup.barmanObjectStore.googleCredentials.applicationCredentials.withKey

withKey(key)

"The key to select"

fn spec.backup.barmanObjectStore.googleCredentials.applicationCredentials.withName

withName(name)

"Name of the referent."

obj spec.backup.barmanObjectStore.s3Credentials

"The credentials to use to upload data to S3"

fn spec.backup.barmanObjectStore.s3Credentials.withInheritFromIAMRole

withInheritFromIAMRole(inheritFromIAMRole)

"Use the role based authentication without providing explicitly the keys."

obj spec.backup.barmanObjectStore.s3Credentials.accessKeyId

"The reference to the access key id"

fn spec.backup.barmanObjectStore.s3Credentials.accessKeyId.withKey

withKey(key)

"The key to select"

fn spec.backup.barmanObjectStore.s3Credentials.accessKeyId.withName

withName(name)

"Name of the referent."

obj spec.backup.barmanObjectStore.s3Credentials.region

"The reference to the secret containing the region name"

fn spec.backup.barmanObjectStore.s3Credentials.region.withKey

withKey(key)

"The key to select"

fn spec.backup.barmanObjectStore.s3Credentials.region.withName

withName(name)

"Name of the referent."

obj spec.backup.barmanObjectStore.s3Credentials.secretAccessKey

"The reference to the secret access key"

fn spec.backup.barmanObjectStore.s3Credentials.secretAccessKey.withKey

withKey(key)

"The key to select"

fn spec.backup.barmanObjectStore.s3Credentials.secretAccessKey.withName

withName(name)

"Name of the referent."

obj spec.backup.barmanObjectStore.s3Credentials.sessionToken

"The references to the session key"

fn spec.backup.barmanObjectStore.s3Credentials.sessionToken.withKey

withKey(key)

"The key to select"

fn spec.backup.barmanObjectStore.s3Credentials.sessionToken.withName

withName(name)

"Name of the referent."

obj spec.backup.barmanObjectStore.wal

"The configuration for the backup of the WAL stream.\nWhen not defined, WAL files will be stored uncompressed and may be\nunencrypted in the object store, according to the bucket default policy."

fn spec.backup.barmanObjectStore.wal.withArchiveAdditionalCommandArgs

withArchiveAdditionalCommandArgs(archiveAdditionalCommandArgs)

"Additional arguments that can be appended to the 'barman-cloud-wal-archive'\ncommand-line invocation. These arguments provide flexibility to customize\nthe WAL archive process further, according to specific requirements or configurations.\n\nExample:\nIn a scenario where specialized backup options are required, such as setting\na specific timeout or defining custom behavior, users can use this field\nto specify additional command arguments.\n\nNote:\nIt's essential to ensure that the provided arguments are valid and supported\nby the 'barman-cloud-wal-archive' command, to avoid potential errors or unintended\nbehavior during execution."

fn spec.backup.barmanObjectStore.wal.withArchiveAdditionalCommandArgsMixin

withArchiveAdditionalCommandArgsMixin(archiveAdditionalCommandArgs)

"Additional arguments that can be appended to the 'barman-cloud-wal-archive'\ncommand-line invocation. These arguments provide flexibility to customize\nthe WAL archive process further, according to specific requirements or configurations.\n\nExample:\nIn a scenario where specialized backup options are required, such as setting\na specific timeout or defining custom behavior, users can use this field\nto specify additional command arguments.\n\nNote:\nIt's essential to ensure that the provided arguments are valid and supported\nby the 'barman-cloud-wal-archive' command, to avoid potential errors or unintended\nbehavior during execution."

Note: This function appends passed data to existing values

fn spec.backup.barmanObjectStore.wal.withCompression

withCompression(compression)

"Compress a WAL file before sending it to the object store. Available\noptions are empty string (no compression, default), gzip, bzip2 or snappy."

fn spec.backup.barmanObjectStore.wal.withEncryption

withEncryption(encryption)

"Whenever to force the encryption of files (if the bucket is\nnot already configured for that).\nAllowed options are empty string (use the bucket policy, default),\nAES256 and aws:kms"

fn spec.backup.barmanObjectStore.wal.withMaxParallel

withMaxParallel(maxParallel)

"Number of WAL files to be either archived in parallel (when the\nPostgreSQL instance is archiving to a backup object store) or\nrestored in parallel (when a PostgreSQL standby is fetching WAL\nfiles from a recovery object store). If not specified, WAL files\nwill be processed one at a time. It accepts a positive integer as a\nvalue - with 1 being the minimum accepted value."

fn spec.backup.barmanObjectStore.wal.withRestoreAdditionalCommandArgs

withRestoreAdditionalCommandArgs(restoreAdditionalCommandArgs)

"Additional arguments that can be appended to the 'barman-cloud-wal-restore'\ncommand-line invocation. These arguments provide flexibility to customize\nthe WAL restore process further, according to specific requirements or configurations.\n\nExample:\nIn a scenario where specialized backup options are required, such as setting\na specific timeout or defining custom behavior, users can use this field\nto specify additional command arguments.\n\nNote:\nIt's essential to ensure that the provided arguments are valid and supported\nby the 'barman-cloud-wal-restore' command, to avoid potential errors or unintended\nbehavior during execution."

fn spec.backup.barmanObjectStore.wal.withRestoreAdditionalCommandArgsMixin

withRestoreAdditionalCommandArgsMixin(restoreAdditionalCommandArgs)

"Additional arguments that can be appended to the 'barman-cloud-wal-restore'\ncommand-line invocation. These arguments provide flexibility to customize\nthe WAL restore process further, according to specific requirements or configurations.\n\nExample:\nIn a scenario where specialized backup options are required, such as setting\na specific timeout or defining custom behavior, users can use this field\nto specify additional command arguments.\n\nNote:\nIt's essential to ensure that the provided arguments are valid and supported\nby the 'barman-cloud-wal-restore' command, to avoid potential errors or unintended\nbehavior during execution."

Note: This function appends passed data to existing values

obj spec.backup.volumeSnapshot

"VolumeSnapshot provides the configuration for the execution of volume snapshot backups."

fn spec.backup.volumeSnapshot.withAnnotations

withAnnotations(annotations)

"Annotations key-value pairs that will be added to .metadata.annotations snapshot resources."

fn spec.backup.volumeSnapshot.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations key-value pairs that will be added to .metadata.annotations snapshot resources."

Note: This function appends passed data to existing values

fn spec.backup.volumeSnapshot.withClassName

withClassName(className)

"ClassName specifies the Snapshot Class to be used for PG_DATA PersistentVolumeClaim.\nIt is the default class for the other types if no specific class is present"

fn spec.backup.volumeSnapshot.withLabels

withLabels(labels)

"Labels are key-value pairs that will be added to .metadata.labels snapshot resources."

fn spec.backup.volumeSnapshot.withLabelsMixin

withLabelsMixin(labels)

"Labels are key-value pairs that will be added to .metadata.labels snapshot resources."

Note: This function appends passed data to existing values

fn spec.backup.volumeSnapshot.withOnline

withOnline(online)

"Whether the default type of backup with volume snapshots is\nonline/hot (true, default) or offline/cold (false)"

fn spec.backup.volumeSnapshot.withSnapshotOwnerReference

withSnapshotOwnerReference(snapshotOwnerReference)

"SnapshotOwnerReference indicates the type of owner reference the snapshot should have"

fn spec.backup.volumeSnapshot.withTablespaceClassName

withTablespaceClassName(tablespaceClassName)

"TablespaceClassName specifies the Snapshot Class to be used for the tablespaces.\ndefaults to the PGDATA Snapshot Class, if set"

fn spec.backup.volumeSnapshot.withTablespaceClassNameMixin

withTablespaceClassNameMixin(tablespaceClassName)

"TablespaceClassName specifies the Snapshot Class to be used for the tablespaces.\ndefaults to the PGDATA Snapshot Class, if set"

Note: This function appends passed data to existing values

fn spec.backup.volumeSnapshot.withWalClassName

withWalClassName(walClassName)

"WalClassName specifies the Snapshot Class to be used for the PG_WAL PersistentVolumeClaim."

obj spec.backup.volumeSnapshot.onlineConfiguration

"Configuration parameters to control the online/hot backup with volume snapshots"

fn spec.backup.volumeSnapshot.onlineConfiguration.withImmediateCheckpoint

withImmediateCheckpoint(immediateCheckpoint)

"Control whether the I/O workload for the backup initial checkpoint will\nbe limited, according to the checkpoint_completion_target setting on\nthe PostgreSQL server. If set to true, an immediate checkpoint will be\nused, meaning PostgreSQL will complete the checkpoint as soon as\npossible. false by default."

fn spec.backup.volumeSnapshot.onlineConfiguration.withWaitForArchive

withWaitForArchive(waitForArchive)

"If false, the function will return immediately after the backup is completed,\nwithout waiting for WAL to be archived.\nThis behavior is only useful with backup software that independently monitors WAL archiving.\nOtherwise, WAL required to make the backup consistent might be missing and make the backup useless.\nBy default, or when this parameter is true, pg_backup_stop will wait for WAL to be archived when archiving is\nenabled.\nOn a standby, this means that it will wait only when archive_mode = always.\nIf write activity on the primary is low, it may be useful to run pg_switch_wal on the primary in order to trigger\nan immediate segment switch."

obj spec.bootstrap

"Instructions to bootstrap this cluster"

obj spec.bootstrap.initdb

"Bootstrap the cluster via initdb"

fn spec.bootstrap.initdb.withDataChecksums

withDataChecksums(dataChecksums)

"Whether the -k option should be passed to initdb,\nenabling checksums on data pages (default: false)"

fn spec.bootstrap.initdb.withDatabase

withDatabase(database)

"Name of the database used by the application. Default: app."

fn spec.bootstrap.initdb.withEncoding

withEncoding(encoding)

"The value to be passed as option --encoding for initdb (default:UTF8)"

fn spec.bootstrap.initdb.withLocaleCType

withLocaleCType(localeCType)

"The value to be passed as option --lc-ctype for initdb (default:C)"

fn spec.bootstrap.initdb.withLocaleCollate

withLocaleCollate(localeCollate)

"The value to be passed as option --lc-collate for initdb (default:C)"

fn spec.bootstrap.initdb.withOptions

withOptions(options)

"The list of options that must be passed to initdb when creating the cluster.\nDeprecated: This could lead to inconsistent configurations,\nplease use the explicit provided parameters instead.\nIf defined, explicit values will be ignored."

fn spec.bootstrap.initdb.withOptionsMixin

withOptionsMixin(options)

"The list of options that must be passed to initdb when creating the cluster.\nDeprecated: This could lead to inconsistent configurations,\nplease use the explicit provided parameters instead.\nIf defined, explicit values will be ignored."

Note: This function appends passed data to existing values

fn spec.bootstrap.initdb.withOwner

withOwner(owner)

"Name of the owner of the database in the instance to be used\nby applications. Defaults to the value of the database key."

fn spec.bootstrap.initdb.withPostInitApplicationSQL

withPostInitApplicationSQL(postInitApplicationSQL)

"List of SQL queries to be executed as a superuser in the application\ndatabase right after the cluster has been created - to be used with extreme care\n(by default empty)"

fn spec.bootstrap.initdb.withPostInitApplicationSQLMixin

withPostInitApplicationSQLMixin(postInitApplicationSQL)

"List of SQL queries to be executed as a superuser in the application\ndatabase right after the cluster has been created - to be used with extreme care\n(by default empty)"

Note: This function appends passed data to existing values

fn spec.bootstrap.initdb.withPostInitSQL

withPostInitSQL(postInitSQL)

"List of SQL queries to be executed as a superuser in the postgres\ndatabase right after the cluster has been created - to be used with extreme care\n(by default empty)"

fn spec.bootstrap.initdb.withPostInitSQLMixin

withPostInitSQLMixin(postInitSQL)

"List of SQL queries to be executed as a superuser in the postgres\ndatabase right after the cluster has been created - to be used with extreme care\n(by default empty)"

Note: This function appends passed data to existing values

fn spec.bootstrap.initdb.withPostInitTemplateSQL

withPostInitTemplateSQL(postInitTemplateSQL)

"List of SQL queries to be executed as a superuser in the template1\ndatabase right after the cluster has been created - to be used with extreme care\n(by default empty)"

fn spec.bootstrap.initdb.withPostInitTemplateSQLMixin

withPostInitTemplateSQLMixin(postInitTemplateSQL)

"List of SQL queries to be executed as a superuser in the template1\ndatabase right after the cluster has been created - to be used with extreme care\n(by default empty)"

Note: This function appends passed data to existing values

fn spec.bootstrap.initdb.withWalSegmentSize

withWalSegmentSize(walSegmentSize)

"The value in megabytes (1 to 1024) to be passed to the --wal-segsize\noption for initdb (default: empty, resulting in PostgreSQL default: 16MB)"

obj spec.bootstrap.initdb.import

"Bootstraps the new cluster by importing data from an existing PostgreSQL\ninstance using logical backup (pg_dump and pg_restore)"

fn spec.bootstrap.initdb.import.withDatabases

withDatabases(databases)

"The databases to import"

fn spec.bootstrap.initdb.import.withDatabasesMixin

withDatabasesMixin(databases)

"The databases to import"

Note: This function appends passed data to existing values

fn spec.bootstrap.initdb.import.withPostImportApplicationSQL

withPostImportApplicationSQL(postImportApplicationSQL)

"List of SQL queries to be executed as a superuser in the application\ndatabase right after is imported - to be used with extreme care\n(by default empty). Only available in microservice type."

fn spec.bootstrap.initdb.import.withPostImportApplicationSQLMixin

withPostImportApplicationSQLMixin(postImportApplicationSQL)

"List of SQL queries to be executed as a superuser in the application\ndatabase right after is imported - to be used with extreme care\n(by default empty). Only available in microservice type."

Note: This function appends passed data to existing values

fn spec.bootstrap.initdb.import.withRoles

withRoles(roles)

"The roles to import"

fn spec.bootstrap.initdb.import.withRolesMixin

withRolesMixin(roles)

"The roles to import"

Note: This function appends passed data to existing values

fn spec.bootstrap.initdb.import.withSchemaOnly

withSchemaOnly(schemaOnly)

"When set to true, only the pre-data and post-data sections of\npg_restore are invoked, avoiding data import. Default: false."

fn spec.bootstrap.initdb.import.withType

withType(type)

"The import type. Can be microservice or monolith."

obj spec.bootstrap.initdb.import.source

"The source of the import"

fn spec.bootstrap.initdb.import.source.withExternalCluster

withExternalCluster(externalCluster)

"The name of the externalCluster used for import"

obj spec.bootstrap.initdb.postInitApplicationSQLRefs

"List of references to ConfigMaps or Secrets containing SQL files\nto be executed as a superuser in the application database right after\nthe cluster has been created. The references are processed in a specific order:\nfirst, all Secrets are processed, followed by all ConfigMaps.\nWithin each group, the processing order follows the sequence specified\nin their respective arrays.\n(by default empty)"

fn spec.bootstrap.initdb.postInitApplicationSQLRefs.withConfigMapRefs

withConfigMapRefs(configMapRefs)

"ConfigMapRefs holds a list of references to ConfigMaps"

fn spec.bootstrap.initdb.postInitApplicationSQLRefs.withConfigMapRefsMixin

withConfigMapRefsMixin(configMapRefs)

"ConfigMapRefs holds a list of references to ConfigMaps"

Note: This function appends passed data to existing values

fn spec.bootstrap.initdb.postInitApplicationSQLRefs.withSecretRefs

withSecretRefs(secretRefs)

"SecretRefs holds a list of references to Secrets"

fn spec.bootstrap.initdb.postInitApplicationSQLRefs.withSecretRefsMixin

withSecretRefsMixin(secretRefs)

"SecretRefs holds a list of references to Secrets"

Note: This function appends passed data to existing values

obj spec.bootstrap.initdb.postInitApplicationSQLRefs.configMapRefs

"ConfigMapRefs holds a list of references to ConfigMaps"

fn spec.bootstrap.initdb.postInitApplicationSQLRefs.configMapRefs.withKey

withKey(key)

"The key to select"

fn spec.bootstrap.initdb.postInitApplicationSQLRefs.configMapRefs.withName

withName(name)

"Name of the referent."

obj spec.bootstrap.initdb.postInitApplicationSQLRefs.secretRefs

"SecretRefs holds a list of references to Secrets"

fn spec.bootstrap.initdb.postInitApplicationSQLRefs.secretRefs.withKey

withKey(key)

"The key to select"

fn spec.bootstrap.initdb.postInitApplicationSQLRefs.secretRefs.withName

withName(name)

"Name of the referent."

obj spec.bootstrap.initdb.postInitSQLRefs

"List of references to ConfigMaps or Secrets containing SQL files\nto be executed as a superuser in the postgres database right after\nthe cluster has been created. The references are processed in a specific order:\nfirst, all Secrets are processed, followed by all ConfigMaps.\nWithin each group, the processing order follows the sequence specified\nin their respective arrays.\n(by default empty)"

fn spec.bootstrap.initdb.postInitSQLRefs.withConfigMapRefs

withConfigMapRefs(configMapRefs)

"ConfigMapRefs holds a list of references to ConfigMaps"

fn spec.bootstrap.initdb.postInitSQLRefs.withConfigMapRefsMixin

withConfigMapRefsMixin(configMapRefs)

"ConfigMapRefs holds a list of references to ConfigMaps"

Note: This function appends passed data to existing values

fn spec.bootstrap.initdb.postInitSQLRefs.withSecretRefs

withSecretRefs(secretRefs)

"SecretRefs holds a list of references to Secrets"

fn spec.bootstrap.initdb.postInitSQLRefs.withSecretRefsMixin

withSecretRefsMixin(secretRefs)

"SecretRefs holds a list of references to Secrets"

Note: This function appends passed data to existing values

obj spec.bootstrap.initdb.postInitSQLRefs.configMapRefs

"ConfigMapRefs holds a list of references to ConfigMaps"

fn spec.bootstrap.initdb.postInitSQLRefs.configMapRefs.withKey

withKey(key)

"The key to select"

fn spec.bootstrap.initdb.postInitSQLRefs.configMapRefs.withName

withName(name)

"Name of the referent."

obj spec.bootstrap.initdb.postInitSQLRefs.secretRefs

"SecretRefs holds a list of references to Secrets"

fn spec.bootstrap.initdb.postInitSQLRefs.secretRefs.withKey

withKey(key)

"The key to select"

fn spec.bootstrap.initdb.postInitSQLRefs.secretRefs.withName

withName(name)

"Name of the referent."

obj spec.bootstrap.initdb.postInitTemplateSQLRefs

"List of references to ConfigMaps or Secrets containing SQL files\nto be executed as a superuser in the template1 database right after\nthe cluster has been created. The references are processed in a specific order:\nfirst, all Secrets are processed, followed by all ConfigMaps.\nWithin each group, the processing order follows the sequence specified\nin their respective arrays.\n(by default empty)"

fn spec.bootstrap.initdb.postInitTemplateSQLRefs.withConfigMapRefs

withConfigMapRefs(configMapRefs)

"ConfigMapRefs holds a list of references to ConfigMaps"

fn spec.bootstrap.initdb.postInitTemplateSQLRefs.withConfigMapRefsMixin

withConfigMapRefsMixin(configMapRefs)

"ConfigMapRefs holds a list of references to ConfigMaps"

Note: This function appends passed data to existing values

fn spec.bootstrap.initdb.postInitTemplateSQLRefs.withSecretRefs

withSecretRefs(secretRefs)

"SecretRefs holds a list of references to Secrets"

fn spec.bootstrap.initdb.postInitTemplateSQLRefs.withSecretRefsMixin

withSecretRefsMixin(secretRefs)

"SecretRefs holds a list of references to Secrets"

Note: This function appends passed data to existing values

obj spec.bootstrap.initdb.postInitTemplateSQLRefs.configMapRefs

"ConfigMapRefs holds a list of references to ConfigMaps"

fn spec.bootstrap.initdb.postInitTemplateSQLRefs.configMapRefs.withKey

withKey(key)

"The key to select"

fn spec.bootstrap.initdb.postInitTemplateSQLRefs.configMapRefs.withName

withName(name)

"Name of the referent."

obj spec.bootstrap.initdb.postInitTemplateSQLRefs.secretRefs

"SecretRefs holds a list of references to Secrets"

fn spec.bootstrap.initdb.postInitTemplateSQLRefs.secretRefs.withKey

withKey(key)

"The key to select"

fn spec.bootstrap.initdb.postInitTemplateSQLRefs.secretRefs.withName

withName(name)

"Name of the referent."

obj spec.bootstrap.initdb.secret

"Name of the secret containing the initial credentials for the\nowner of the user database. If empty a new secret will be\ncreated from scratch"

fn spec.bootstrap.initdb.secret.withName

withName(name)

"Name of the referent."

obj spec.bootstrap.pg_basebackup

"Bootstrap the cluster taking a physical backup of another compatible\nPostgreSQL instance"

fn spec.bootstrap.pg_basebackup.withDatabase

withDatabase(database)

"Name of the database used by the application. Default: app."

fn spec.bootstrap.pg_basebackup.withOwner

withOwner(owner)

"Name of the owner of the database in the instance to be used\nby applications. Defaults to the value of the database key."

fn spec.bootstrap.pg_basebackup.withSource

withSource(source)

"The name of the server of which we need to take a physical backup"

obj spec.bootstrap.pg_basebackup.secret

"Name of the secret containing the initial credentials for the\nowner of the user database. If empty a new secret will be\ncreated from scratch"

fn spec.bootstrap.pg_basebackup.secret.withName

withName(name)

"Name of the referent."

obj spec.bootstrap.recovery

"Bootstrap the cluster from a backup"

fn spec.bootstrap.recovery.withDatabase

withDatabase(database)

"Name of the database used by the application. Default: app."

fn spec.bootstrap.recovery.withOwner

withOwner(owner)

"Name of the owner of the database in the instance to be used\nby applications. Defaults to the value of the database key."

fn spec.bootstrap.recovery.withSource

withSource(source)

"The external cluster whose backup we will restore. This is also\nused as the name of the folder under which the backup is stored,\nso it must be set to the name of the source cluster\nMutually exclusive with backup."

obj spec.bootstrap.recovery.backup

"The backup object containing the physical base backup from which to\ninitiate the recovery procedure.\nMutually exclusive with source and volumeSnapshots."

fn spec.bootstrap.recovery.backup.withName

withName(name)

"Name of the referent."

obj spec.bootstrap.recovery.backup.endpointCA

"EndpointCA store the CA bundle of the barman endpoint.\nUseful when using self-signed certificates to avoid\nerrors with certificate issuer and barman-cloud-wal-archive."

fn spec.bootstrap.recovery.backup.endpointCA.withKey

withKey(key)

"The key to select"

fn spec.bootstrap.recovery.backup.endpointCA.withName

withName(name)

"Name of the referent."

obj spec.bootstrap.recovery.recoveryTarget

"By default, the recovery process applies all the available\nWAL files in the archive (full recovery). However, you can also\nend the recovery as soon as a consistent state is reached or\nrecover to a point-in-time (PITR) by specifying a RecoveryTarget object,\nas expected by PostgreSQL (i.e., timestamp, transaction Id, LSN, ...).\nMore info: https://www.postgresql.org/docs/current/runtime-config-wal.html#RUNTIME-CONFIG-WAL-RECOVERY-TARGET"

fn spec.bootstrap.recovery.recoveryTarget.withBackupID

withBackupID(backupID)

"The ID of the backup from which to start the recovery process.\nIf empty (default) the operator will automatically detect the backup\nbased on targetTime or targetLSN if specified. Otherwise use the\nlatest available backup in chronological order."

fn spec.bootstrap.recovery.recoveryTarget.withExclusive

withExclusive(exclusive)

"Set the target to be exclusive. If omitted, defaults to false, so that\nin Postgres, recovery_target_inclusive will be true"

fn spec.bootstrap.recovery.recoveryTarget.withTargetImmediate

withTargetImmediate(targetImmediate)

"End recovery as soon as a consistent state is reached"

fn spec.bootstrap.recovery.recoveryTarget.withTargetLSN

withTargetLSN(targetLSN)

"The target LSN (Log Sequence Number)"

fn spec.bootstrap.recovery.recoveryTarget.withTargetName

withTargetName(targetName)

"The target name (to be previously created\nwith pg_create_restore_point)"

fn spec.bootstrap.recovery.recoveryTarget.withTargetTLI

withTargetTLI(targetTLI)

"The target timeline (\"latest\" or a positive integer)"

fn spec.bootstrap.recovery.recoveryTarget.withTargetTime

withTargetTime(targetTime)

"The target time as a timestamp in the RFC3339 standard"

fn spec.bootstrap.recovery.recoveryTarget.withTargetXID

withTargetXID(targetXID)

"The target transaction ID"

obj spec.bootstrap.recovery.secret

"Name of the secret containing the initial credentials for the\nowner of the user database. If empty a new secret will be\ncreated from scratch"

fn spec.bootstrap.recovery.secret.withName

withName(name)

"Name of the referent."

obj spec.bootstrap.recovery.volumeSnapshots

"The static PVC data source(s) from which to initiate the\nrecovery procedure. Currently supporting VolumeSnapshot\nand PersistentVolumeClaim resources that map an existing\nPVC group, compatible with CloudNativePG, and taken with\na cold backup copy on a fenced Postgres instance (limitation\nwhich will be removed in the future when online backup\nwill be implemented).\nMutually exclusive with backup."

fn spec.bootstrap.recovery.volumeSnapshots.withTablespaceStorage

withTablespaceStorage(tablespaceStorage)

"Configuration of the storage for PostgreSQL tablespaces"

fn spec.bootstrap.recovery.volumeSnapshots.withTablespaceStorageMixin

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"

fn spec.bootstrap.recovery.volumeSnapshots.storage.withApiGroup

withApiGroup(apiGroup)

"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required."

fn spec.bootstrap.recovery.volumeSnapshots.storage.withKind

withKind(kind)

"Kind is the type of resource being referenced"

fn spec.bootstrap.recovery.volumeSnapshots.storage.withName

withName(name)

"Name is the name of resource being referenced"

obj spec.bootstrap.recovery.volumeSnapshots.walStorage

"Configuration of the storage for PostgreSQL WAL (Write-Ahead Log)"

fn spec.bootstrap.recovery.volumeSnapshots.walStorage.withApiGroup

withApiGroup(apiGroup)

"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required."

fn spec.bootstrap.recovery.volumeSnapshots.walStorage.withKind

withKind(kind)

"Kind is the type of resource being referenced"

fn spec.bootstrap.recovery.volumeSnapshots.walStorage.withName

withName(name)

"Name is the name of resource being referenced"

obj spec.certificates

"The configuration for the CA and related certificates"

fn spec.certificates.withClientCASecret

withClientCASecret(clientCASecret)

"The secret containing the Client CA certificate. If not defined, a new secret will be created\nwith a self-signed CA and will be used to generate all the client certificates.
\n
\nContains:
\n
\n- ca.crt: CA that should be used to validate the client certificates,\nused as ssl_ca_file of all the instances.
\n- ca.key: key used to generate client certificates, if ReplicationTLSSecret is provided,\nthis can be omitted.
"

fn spec.certificates.withReplicationTLSSecret

withReplicationTLSSecret(replicationTLSSecret)

"The secret of type kubernetes.io/tls containing the client certificate to authenticate as\nthe streaming_replica user.\nIf not defined, ClientCASecret must provide also ca.key, and a new secret will be\ncreated using the provided CA."

fn spec.certificates.withServerAltDNSNames

withServerAltDNSNames(serverAltDNSNames)

"The list of the server alternative DNS names to be added to the generated server TLS certificates, when required."

fn spec.certificates.withServerAltDNSNamesMixin

withServerAltDNSNamesMixin(serverAltDNSNames)

"The list of the server alternative DNS names to be added to the generated server TLS certificates, when required."

Note: This function appends passed data to existing values

fn spec.certificates.withServerCASecret

withServerCASecret(serverCASecret)

"The secret containing the Server CA certificate. If not defined, a new secret will be created\nwith a self-signed CA and will be used to generate the TLS certificate ServerTLSSecret.
\n
\nContains:
\n
\n- ca.crt: CA that should be used to validate the server certificate,\nused as sslrootcert in client connection strings.
\n- ca.key: key used to generate Server SSL certs, if ServerTLSSecret is provided,\nthis can be omitted.
"

fn spec.certificates.withServerTLSSecret

withServerTLSSecret(serverTLSSecret)

"The secret of type kubernetes.io/tls containing the server TLS certificate and key that will be set as\nssl_cert_file and ssl_key_file so that clients can connect to postgres securely.\nIf not defined, ServerCASecret must provide also ca.key and a new secret will be\ncreated using the provided CA."

obj spec.env

"Env follows the Env format to pass environment variables\nto the pods created in the cluster"

fn spec.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.env.withValue

withValue(value)

"Variable references $(VAR_NAME) are expanded\nusing the previously defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\n\"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".\nEscaped references will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\"."

obj spec.env.valueFrom

"Source for the environment variable's value. Cannot be used if value is not empty."

obj spec.env.valueFrom.configMapKeyRef

"Selects a key of a ConfigMap."

fn spec.env.valueFrom.configMapKeyRef.withKey

withKey(key)

"The key to select."

fn spec.env.valueFrom.configMapKeyRef.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.env.valueFrom.configMapKeyRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.env.valueFrom.fieldRef

"Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'],\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs."

fn spec.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.env.valueFrom.resourceFieldRef

"Selects a resource of the container: only resources limits and requests\n(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."

fn spec.env.valueFrom.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.env.valueFrom.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.env.valueFrom.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.env.valueFrom.secretKeyRef

"Selects a key of a secret in the pod's namespace"

fn spec.env.valueFrom.secretKeyRef.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.env.valueFrom.secretKeyRef.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.env.valueFrom.secretKeyRef.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.envFrom

"EnvFrom follows the EnvFrom format to pass environment variables\nsources to the pods to be used by Env"

fn spec.envFrom.withPrefix

withPrefix(prefix)

"An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER."

obj spec.envFrom.configMapRef

"The ConfigMap to select from"

fn spec.envFrom.configMapRef.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.envFrom.configMapRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap must be defined"

obj spec.envFrom.secretRef

"The Secret to select from"

fn spec.envFrom.secretRef.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.envFrom.secretRef.withOptional

withOptional(optional)

"Specify whether the Secret must be defined"

obj spec.ephemeralVolumeSource

"EphemeralVolumeSource allows the user to configure the source of ephemeral volumes."

obj spec.ephemeralVolumeSource.volumeClaimTemplate

"Will be used to create a stand-alone PVC to provision the volume.\nThe pod in which this EphemeralVolumeSource is embedded will be the\nowner of the PVC, i.e. the PVC will be deleted together with the\npod. The name of the PVC will be <pod name>-<volume name> where\n<volume name> is the name from the PodSpec.Volumes array\nentry. Pod validation will reject the pod if the concatenated name\nis not valid for a PVC (for example, too long).\n\nAn existing PVC with that name that is not owned by the pod\nwill not be used for the pod to avoid using an unrelated\nvolume by mistake. Starting the pod is then blocked until\nthe unrelated PVC is removed. If such a pre-created PVC is\nmeant to be used by the pod, the PVC has to updated with an\nowner reference to the pod once the pod exists. Normally\nthis should not be necessary, but it may be useful when\nmanually reconstructing a broken cluster.\n\nThis field is read-only and no changes will be made by Kubernetes\nto the PVC after it has been created.\n\nRequired, must not be nil."

fn spec.ephemeralVolumeSource.volumeClaimTemplate.withMetadata

withMetadata(metadata)

"May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation."

fn spec.ephemeralVolumeSource.volumeClaimTemplate.withMetadataMixin

withMetadataMixin(metadata)

"May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation."

Note: This function appends passed data to existing values

obj spec.ephemeralVolumeSource.volumeClaimTemplate.spec

"The specification for the PersistentVolumeClaim. The entire content is\ncopied unchanged into the PVC that gets created from this\ntemplate. The same fields as in a PersistentVolumeClaim\nare also valid here."

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.withAccessModes

withAccessModes(accessModes)

"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.withAccessModesMixin

withAccessModesMixin(accessModes)

"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"

Note: This function appends passed data to existing values

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.withStorageClassName

withStorageClassName(storageClassName)

"storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.withVolumeAttributesClassName

withVolumeAttributesClassName(volumeAttributesClassName)

"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\n(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default)."

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.withVolumeMode

withVolumeMode(volumeMode)

"volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec."

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.withVolumeName

withVolumeName(volumeName)

"volumeName is the binding reference to the PersistentVolume backing this claim."

obj spec.ephemeralVolumeSource.volumeClaimTemplate.spec.dataSource

"dataSource field can be used to specify either:\n An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource."

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.dataSource.withApiGroup

withApiGroup(apiGroup)

"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required."

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.dataSource.withKind

withKind(kind)

"Kind is the type of resource being referenced"

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.dataSource.withName

withName(name)

"Name is the name of resource being referenced"

obj spec.ephemeralVolumeSource.volumeClaimTemplate.spec.dataSourceRef

"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled."

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.dataSourceRef.withApiGroup

withApiGroup(apiGroup)

"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required."

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.dataSourceRef.withKind

withKind(kind)

"Kind is the type of resource being referenced"

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.dataSourceRef.withName

withName(name)

"Name is the name of resource being referenced"

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.dataSourceRef.withNamespace

withNamespace(namespace)

"Namespace is the namespace of resource being referenced\nNote 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.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled."

obj spec.ephemeralVolumeSource.volumeClaimTemplate.spec.resources

"resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources"

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.resources.withRequests

withRequests(requests)

"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.resources.withRequestsMixin

withRequestsMixin(requests)

"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

obj spec.ephemeralVolumeSource.volumeClaimTemplate.spec.selector

"selector is a label query over volumes to consider for binding."

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.selector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.selector.withMatchExpressionsMixin

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.ephemeralVolumeSource.volumeClaimTemplate.spec.selector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.selector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.ephemeralVolumeSource.volumeClaimTemplate.spec.selector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.selector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.selector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.selector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

fn spec.ephemeralVolumeSource.volumeClaimTemplate.spec.selector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

Note: This function appends passed data to existing values

obj spec.ephemeralVolumesSizeLimit

"EphemeralVolumesSizeLimit allows the user to set the limits for the ephemeral\nvolumes"

fn spec.ephemeralVolumesSizeLimit.withShm

withShm(shm)

"Shm is the size limit of the shared memory volume"

fn spec.ephemeralVolumesSizeLimit.withTemporaryData

withTemporaryData(temporaryData)

"TemporaryData is the size limit of the temporary data volume"

obj spec.externalClusters

"The list of external clusters which are used in the configuration"

fn spec.externalClusters.withConnectionParameters

withConnectionParameters(connectionParameters)

"The list of connection parameters, such as dbname, host, username, etc"

fn spec.externalClusters.withConnectionParametersMixin

withConnectionParametersMixin(connectionParameters)

"The list of connection parameters, such as dbname, host, username, etc"

Note: This function appends passed data to existing values

fn spec.externalClusters.withName

withName(name)

"The server name, required"

obj spec.externalClusters.barmanObjectStore

"The configuration for the barman-cloud tool suite"

fn spec.externalClusters.barmanObjectStore.withDestinationPath

withDestinationPath(destinationPath)

"The path where to store the backup (i.e. s3://bucket/path/to/folder)\nthis path, with different destination folders, will be used for WALs\nand for data"

fn spec.externalClusters.barmanObjectStore.withEndpointURL

withEndpointURL(endpointURL)

"Endpoint to be used to upload data to the cloud,\noverriding the automatic endpoint discovery"

fn spec.externalClusters.barmanObjectStore.withHistoryTags

withHistoryTags(historyTags)

"HistoryTags is a list of key value pairs that will be passed to the\nBarman --history-tags option."

fn spec.externalClusters.barmanObjectStore.withHistoryTagsMixin

withHistoryTagsMixin(historyTags)

"HistoryTags is a list of key value pairs that will be passed to the\nBarman --history-tags option."

Note: This function appends passed data to existing values

fn spec.externalClusters.barmanObjectStore.withServerName

withServerName(serverName)

"The server name on S3, the cluster name is used if this\nparameter is omitted"

fn spec.externalClusters.barmanObjectStore.withTags

withTags(tags)

"Tags is a list of key value pairs that will be passed to the\nBarman --tags option."

fn spec.externalClusters.barmanObjectStore.withTagsMixin

withTagsMixin(tags)

"Tags is a list of key value pairs that will be passed to the\nBarman --tags option."

Note: This function appends passed data to existing values

obj spec.externalClusters.barmanObjectStore.azureCredentials

"The credentials to use to upload data to Azure Blob Storage"

fn spec.externalClusters.barmanObjectStore.azureCredentials.withInheritFromAzureAD

withInheritFromAzureAD(inheritFromAzureAD)

"Use the Azure AD based authentication without providing explicitly the keys."

obj spec.externalClusters.barmanObjectStore.azureCredentials.connectionString

"The connection string to be used"

fn spec.externalClusters.barmanObjectStore.azureCredentials.connectionString.withKey

withKey(key)

"The key to select"

fn spec.externalClusters.barmanObjectStore.azureCredentials.connectionString.withName

withName(name)

"Name of the referent."

obj spec.externalClusters.barmanObjectStore.azureCredentials.storageAccount

"The storage account where to upload data"

fn spec.externalClusters.barmanObjectStore.azureCredentials.storageAccount.withKey

withKey(key)

"The key to select"

fn spec.externalClusters.barmanObjectStore.azureCredentials.storageAccount.withName

withName(name)

"Name of the referent."

obj spec.externalClusters.barmanObjectStore.azureCredentials.storageKey

"The storage account key to be used in conjunction\nwith the storage account name"

fn spec.externalClusters.barmanObjectStore.azureCredentials.storageKey.withKey

withKey(key)

"The key to select"

fn spec.externalClusters.barmanObjectStore.azureCredentials.storageKey.withName

withName(name)

"Name of the referent."

obj spec.externalClusters.barmanObjectStore.azureCredentials.storageSasToken

"A shared-access-signature to be used in conjunction with\nthe storage account name"

fn spec.externalClusters.barmanObjectStore.azureCredentials.storageSasToken.withKey

withKey(key)

"The key to select"

fn spec.externalClusters.barmanObjectStore.azureCredentials.storageSasToken.withName

withName(name)

"Name of the referent."

obj spec.externalClusters.barmanObjectStore.data

"The configuration to be used to backup the data files\nWhen not defined, base backups files will be stored uncompressed and may\nbe unencrypted in the object store, according to the bucket default\npolicy."

fn spec.externalClusters.barmanObjectStore.data.withAdditionalCommandArgs

withAdditionalCommandArgs(additionalCommandArgs)

"AdditionalCommandArgs represents additional arguments that can be appended\nto the 'barman-cloud-backup' command-line invocation. These arguments\nprovide flexibility to customize the backup process further according to\nspecific requirements or configurations.\n\nExample:\nIn a scenario where specialized backup options are required, such as setting\na specific timeout or defining custom behavior, users can use this field\nto specify additional command arguments.\n\nNote:\nIt's essential to ensure that the provided arguments are valid and supported\nby the 'barman-cloud-backup' command, to avoid potential errors or unintended\nbehavior during execution."

fn spec.externalClusters.barmanObjectStore.data.withAdditionalCommandArgsMixin

withAdditionalCommandArgsMixin(additionalCommandArgs)

"AdditionalCommandArgs represents additional arguments that can be appended\nto the 'barman-cloud-backup' command-line invocation. These arguments\nprovide flexibility to customize the backup process further according to\nspecific requirements or configurations.\n\nExample:\nIn a scenario where specialized backup options are required, such as setting\na specific timeout or defining custom behavior, users can use this field\nto specify additional command arguments.\n\nNote:\nIt's essential to ensure that the provided arguments are valid and supported\nby the 'barman-cloud-backup' command, to avoid potential errors or unintended\nbehavior during execution."

Note: This function appends passed data to existing values

fn spec.externalClusters.barmanObjectStore.data.withCompression

withCompression(compression)

"Compress a backup file (a tar file per tablespace) while streaming it\nto the object store. Available options are empty string (no\ncompression, default), gzip, bzip2 or snappy."

fn spec.externalClusters.barmanObjectStore.data.withEncryption

withEncryption(encryption)

"Whenever to force the encryption of files (if the bucket is\nnot already configured for that).\nAllowed options are empty string (use the bucket policy, default),\nAES256 and aws:kms"

fn spec.externalClusters.barmanObjectStore.data.withImmediateCheckpoint

withImmediateCheckpoint(immediateCheckpoint)

"Control whether the I/O workload for the backup initial checkpoint will\nbe limited, according to the checkpoint_completion_target setting on\nthe PostgreSQL server. If set to true, an immediate checkpoint will be\nused, meaning PostgreSQL will complete the checkpoint as soon as\npossible. false by default."

fn spec.externalClusters.barmanObjectStore.data.withJobs

withJobs(jobs)

"The number of parallel jobs to be used to upload the backup, defaults\nto 2"

obj spec.externalClusters.barmanObjectStore.endpointCA

"EndpointCA store the CA bundle of the barman endpoint.\nUseful when using self-signed certificates to avoid\nerrors with certificate issuer and barman-cloud-wal-archive"

fn spec.externalClusters.barmanObjectStore.endpointCA.withKey

withKey(key)

"The key to select"

fn spec.externalClusters.barmanObjectStore.endpointCA.withName

withName(name)

"Name of the referent."

obj spec.externalClusters.barmanObjectStore.googleCredentials

"The credentials to use to upload data to Google Cloud Storage"

fn spec.externalClusters.barmanObjectStore.googleCredentials.withGkeEnvironment

withGkeEnvironment(gkeEnvironment)

"If set to true, will presume that it's running inside a GKE environment,\ndefault to false."

obj spec.externalClusters.barmanObjectStore.googleCredentials.applicationCredentials

"The secret containing the Google Cloud Storage JSON file with the credentials"

fn spec.externalClusters.barmanObjectStore.googleCredentials.applicationCredentials.withKey

withKey(key)

"The key to select"

fn spec.externalClusters.barmanObjectStore.googleCredentials.applicationCredentials.withName

withName(name)

"Name of the referent."

obj spec.externalClusters.barmanObjectStore.s3Credentials

"The credentials to use to upload data to S3"

fn spec.externalClusters.barmanObjectStore.s3Credentials.withInheritFromIAMRole

withInheritFromIAMRole(inheritFromIAMRole)

"Use the role based authentication without providing explicitly the keys."

obj spec.externalClusters.barmanObjectStore.s3Credentials.accessKeyId

"The reference to the access key id"

fn spec.externalClusters.barmanObjectStore.s3Credentials.accessKeyId.withKey

withKey(key)

"The key to select"

fn spec.externalClusters.barmanObjectStore.s3Credentials.accessKeyId.withName

withName(name)

"Name of the referent."

obj spec.externalClusters.barmanObjectStore.s3Credentials.region

"The reference to the secret containing the region name"

fn spec.externalClusters.barmanObjectStore.s3Credentials.region.withKey

withKey(key)

"The key to select"

fn spec.externalClusters.barmanObjectStore.s3Credentials.region.withName

withName(name)

"Name of the referent."

obj spec.externalClusters.barmanObjectStore.s3Credentials.secretAccessKey

"The reference to the secret access key"

fn spec.externalClusters.barmanObjectStore.s3Credentials.secretAccessKey.withKey

withKey(key)

"The key to select"

fn spec.externalClusters.barmanObjectStore.s3Credentials.secretAccessKey.withName

withName(name)

"Name of the referent."

obj spec.externalClusters.barmanObjectStore.s3Credentials.sessionToken

"The references to the session key"

fn spec.externalClusters.barmanObjectStore.s3Credentials.sessionToken.withKey

withKey(key)

"The key to select"

fn spec.externalClusters.barmanObjectStore.s3Credentials.sessionToken.withName

withName(name)

"Name of the referent."

obj spec.externalClusters.barmanObjectStore.wal

"The configuration for the backup of the WAL stream.\nWhen not defined, WAL files will be stored uncompressed and may be\nunencrypted in the object store, according to the bucket default policy."

fn spec.externalClusters.barmanObjectStore.wal.withArchiveAdditionalCommandArgs

withArchiveAdditionalCommandArgs(archiveAdditionalCommandArgs)

"Additional arguments that can be appended to the 'barman-cloud-wal-archive'\ncommand-line invocation. These arguments provide flexibility to customize\nthe WAL archive process further, according to specific requirements or configurations.\n\nExample:\nIn a scenario where specialized backup options are required, such as setting\na specific timeout or defining custom behavior, users can use this field\nto specify additional command arguments.\n\nNote:\nIt's essential to ensure that the provided arguments are valid and supported\nby the 'barman-cloud-wal-archive' command, to avoid potential errors or unintended\nbehavior during execution."

fn spec.externalClusters.barmanObjectStore.wal.withArchiveAdditionalCommandArgsMixin

withArchiveAdditionalCommandArgsMixin(archiveAdditionalCommandArgs)

"Additional arguments that can be appended to the 'barman-cloud-wal-archive'\ncommand-line invocation. These arguments provide flexibility to customize\nthe WAL archive process further, according to specific requirements or configurations.\n\nExample:\nIn a scenario where specialized backup options are required, such as setting\na specific timeout or defining custom behavior, users can use this field\nto specify additional command arguments.\n\nNote:\nIt's essential to ensure that the provided arguments are valid and supported\nby the 'barman-cloud-wal-archive' command, to avoid potential errors or unintended\nbehavior during execution."

Note: This function appends passed data to existing values

fn spec.externalClusters.barmanObjectStore.wal.withCompression

withCompression(compression)

"Compress a WAL file before sending it to the object store. Available\noptions are empty string (no compression, default), gzip, bzip2 or snappy."

fn spec.externalClusters.barmanObjectStore.wal.withEncryption

withEncryption(encryption)

"Whenever to force the encryption of files (if the bucket is\nnot already configured for that).\nAllowed options are empty string (use the bucket policy, default),\nAES256 and aws:kms"

fn spec.externalClusters.barmanObjectStore.wal.withMaxParallel

withMaxParallel(maxParallel)

"Number of WAL files to be either archived in parallel (when the\nPostgreSQL instance is archiving to a backup object store) or\nrestored in parallel (when a PostgreSQL standby is fetching WAL\nfiles from a recovery object store). If not specified, WAL files\nwill be processed one at a time. It accepts a positive integer as a\nvalue - with 1 being the minimum accepted value."

fn spec.externalClusters.barmanObjectStore.wal.withRestoreAdditionalCommandArgs

withRestoreAdditionalCommandArgs(restoreAdditionalCommandArgs)

"Additional arguments that can be appended to the 'barman-cloud-wal-restore'\ncommand-line invocation. These arguments provide flexibility to customize\nthe WAL restore process further, according to specific requirements or configurations.\n\nExample:\nIn a scenario where specialized backup options are required, such as setting\na specific timeout or defining custom behavior, users can use this field\nto specify additional command arguments.\n\nNote:\nIt's essential to ensure that the provided arguments are valid and supported\nby the 'barman-cloud-wal-restore' command, to avoid potential errors or unintended\nbehavior during execution."

fn spec.externalClusters.barmanObjectStore.wal.withRestoreAdditionalCommandArgsMixin

withRestoreAdditionalCommandArgsMixin(restoreAdditionalCommandArgs)

"Additional arguments that can be appended to the 'barman-cloud-wal-restore'\ncommand-line invocation. These arguments provide flexibility to customize\nthe WAL restore process further, according to specific requirements or configurations.\n\nExample:\nIn a scenario where specialized backup options are required, such as setting\na specific timeout or defining custom behavior, users can use this field\nto specify additional command arguments.\n\nNote:\nIt's essential to ensure that the provided arguments are valid and supported\nby the 'barman-cloud-wal-restore' command, to avoid potential errors or unintended\nbehavior during execution."

Note: This function appends passed data to existing values

obj spec.externalClusters.password

"The reference to the password to be used to connect to the server.\nIf a password is provided, CloudNativePG creates a PostgreSQL\npassfile at /controller/external/NAME/pass (where \"NAME\" is the\ncluster's name). This passfile is automatically referenced in the\nconnection string when establishing a connection to the remote\nPostgreSQL server from the current PostgreSQL Cluster. This ensures\nsecure and efficient password management for external clusters."

fn spec.externalClusters.password.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.externalClusters.password.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.externalClusters.password.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.externalClusters.sslCert

"The reference to an SSL certificate to be used to connect to this\ninstance"