Skip to content

acid.v1.operatorConfiguration

Index

Fields

fn new

new(name)

new returns an instance of OperatorConfiguration

obj configuration

fn configuration.withCrd_categories

withCrd_categories(crd_categories)

fn configuration.withCrd_categoriesMixin

withCrd_categoriesMixin(crd_categories)

Note: This function appends passed data to existing values

fn configuration.withDocker_image

withDocker_image(docker_image)

fn configuration.withEnable_crd_registration

withEnable_crd_registration(enable_crd_registration)

fn configuration.withEnable_crd_validation

withEnable_crd_validation(enable_crd_validation)

"deprecated"

fn configuration.withEnable_lazy_spilo_upgrade

withEnable_lazy_spilo_upgrade(enable_lazy_spilo_upgrade)

fn configuration.withEnable_pgversion_env_var

withEnable_pgversion_env_var(enable_pgversion_env_var)

fn configuration.withEnable_shm_volume

withEnable_shm_volume(enable_shm_volume)

fn configuration.withEnable_spilo_wal_path_compat

withEnable_spilo_wal_path_compat(enable_spilo_wal_path_compat)

fn configuration.withEnable_team_id_clustername_prefix

withEnable_team_id_clustername_prefix(enable_team_id_clustername_prefix)

fn configuration.withEtcd_host

withEtcd_host(etcd_host)

fn configuration.withIgnore_instance_limits_annotation_key

withIgnore_instance_limits_annotation_key(ignore_instance_limits_annotation_key)

fn configuration.withKubernetes_use_configmaps

withKubernetes_use_configmaps(kubernetes_use_configmaps)

fn configuration.withMax_instances

withMax_instances(max_instances)

"-1 = disabled"

fn configuration.withMin_instances

withMin_instances(min_instances)

"-1 = disabled"

fn configuration.withRepair_period

withRepair_period(repair_period)

fn configuration.withResync_period

withResync_period(resync_period)

fn configuration.withSet_memory_request_to_limit

withSet_memory_request_to_limit(set_memory_request_to_limit)

fn configuration.withSidecar_docker_images

withSidecar_docker_images(sidecar_docker_images)

fn configuration.withSidecar_docker_imagesMixin

withSidecar_docker_imagesMixin(sidecar_docker_images)

Note: This function appends passed data to existing values

fn configuration.withSidecars

withSidecars(sidecars)

fn configuration.withSidecarsMixin

withSidecarsMixin(sidecars)

Note: This function appends passed data to existing values

fn configuration.withWorkers

withWorkers(workers)

obj configuration.aws_or_gcp

fn configuration.aws_or_gcp.withAdditional_secret_mount

withAdditional_secret_mount(additional_secret_mount)

fn configuration.aws_or_gcp.withAdditional_secret_mount_path

withAdditional_secret_mount_path(additional_secret_mount_path)

fn configuration.aws_or_gcp.withAws_region

withAws_region(aws_region)

fn configuration.aws_or_gcp.withEnable_ebs_gp3_migration

withEnable_ebs_gp3_migration(enable_ebs_gp3_migration)

fn configuration.aws_or_gcp.withEnable_ebs_gp3_migration_max_size

withEnable_ebs_gp3_migration_max_size(enable_ebs_gp3_migration_max_size)

fn configuration.aws_or_gcp.withGcp_credentials

withGcp_credentials(gcp_credentials)

fn configuration.aws_or_gcp.withKube_iam_role

withKube_iam_role(kube_iam_role)

fn configuration.aws_or_gcp.withLog_s3_bucket

withLog_s3_bucket(log_s3_bucket)

fn configuration.aws_or_gcp.withWal_az_storage_account

withWal_az_storage_account(wal_az_storage_account)

fn configuration.aws_or_gcp.withWal_gs_bucket

withWal_gs_bucket(wal_gs_bucket)

fn configuration.aws_or_gcp.withWal_s3_bucket

withWal_s3_bucket(wal_s3_bucket)

obj configuration.connection_pooler

fn configuration.connection_pooler.withConnection_pooler_default_cpu_limit

withConnection_pooler_default_cpu_limit(connection_pooler_default_cpu_limit)

fn configuration.connection_pooler.withConnection_pooler_default_cpu_request

withConnection_pooler_default_cpu_request(connection_pooler_default_cpu_request)

fn configuration.connection_pooler.withConnection_pooler_default_memory_limit

withConnection_pooler_default_memory_limit(connection_pooler_default_memory_limit)

fn configuration.connection_pooler.withConnection_pooler_default_memory_request

withConnection_pooler_default_memory_request(connection_pooler_default_memory_request)

fn configuration.connection_pooler.withConnection_pooler_image

withConnection_pooler_image(connection_pooler_image)

fn configuration.connection_pooler.withConnection_pooler_max_db_connections

withConnection_pooler_max_db_connections(connection_pooler_max_db_connections)

fn configuration.connection_pooler.withConnection_pooler_mode

withConnection_pooler_mode(connection_pooler_mode)

fn configuration.connection_pooler.withConnection_pooler_number_of_instances

withConnection_pooler_number_of_instances(connection_pooler_number_of_instances)

fn configuration.connection_pooler.withConnection_pooler_schema

withConnection_pooler_schema(connection_pooler_schema)

fn configuration.connection_pooler.withConnection_pooler_user

withConnection_pooler_user(connection_pooler_user)

obj configuration.debug

fn configuration.debug.withDebug_logging

withDebug_logging(debug_logging)

fn configuration.debug.withEnable_database_access

withEnable_database_access(enable_database_access)

obj configuration.kubernetes

fn configuration.kubernetes.withAdditional_pod_capabilities

withAdditional_pod_capabilities(additional_pod_capabilities)

fn configuration.kubernetes.withAdditional_pod_capabilitiesMixin

withAdditional_pod_capabilitiesMixin(additional_pod_capabilities)

Note: This function appends passed data to existing values

fn configuration.kubernetes.withCluster_domain

withCluster_domain(cluster_domain)

fn configuration.kubernetes.withCluster_labels

withCluster_labels(cluster_labels)

fn configuration.kubernetes.withCluster_labelsMixin

withCluster_labelsMixin(cluster_labels)

Note: This function appends passed data to existing values

fn configuration.kubernetes.withCluster_name_label

withCluster_name_label(cluster_name_label)

fn configuration.kubernetes.withCustom_pod_annotations

withCustom_pod_annotations(custom_pod_annotations)

fn configuration.kubernetes.withCustom_pod_annotationsMixin

withCustom_pod_annotationsMixin(custom_pod_annotations)

Note: This function appends passed data to existing values

fn configuration.kubernetes.withDelete_annotation_date_key

withDelete_annotation_date_key(delete_annotation_date_key)

fn configuration.kubernetes.withDelete_annotation_name_key

withDelete_annotation_name_key(delete_annotation_name_key)

fn configuration.kubernetes.withDownscaler_annotations

withDownscaler_annotations(downscaler_annotations)

fn configuration.kubernetes.withDownscaler_annotationsMixin

withDownscaler_annotationsMixin(downscaler_annotations)

Note: This function appends passed data to existing values

fn configuration.kubernetes.withEnable_cross_namespace_secret

withEnable_cross_namespace_secret(enable_cross_namespace_secret)

fn configuration.kubernetes.withEnable_finalizers

withEnable_finalizers(enable_finalizers)

fn configuration.kubernetes.withEnable_init_containers

withEnable_init_containers(enable_init_containers)

fn configuration.kubernetes.withEnable_owner_references

withEnable_owner_references(enable_owner_references)

fn configuration.kubernetes.withEnable_persistent_volume_claim_deletion

withEnable_persistent_volume_claim_deletion(enable_persistent_volume_claim_deletion)

fn configuration.kubernetes.withEnable_pod_antiaffinity

withEnable_pod_antiaffinity(enable_pod_antiaffinity)

fn configuration.kubernetes.withEnable_pod_disruption_budget

withEnable_pod_disruption_budget(enable_pod_disruption_budget)

fn configuration.kubernetes.withEnable_readiness_probe

withEnable_readiness_probe(enable_readiness_probe)

fn configuration.kubernetes.withEnable_secrets_deletion

withEnable_secrets_deletion(enable_secrets_deletion)

fn configuration.kubernetes.withEnable_sidecars

withEnable_sidecars(enable_sidecars)

fn configuration.kubernetes.withIgnored_annotations

withIgnored_annotations(ignored_annotations)

fn configuration.kubernetes.withIgnored_annotationsMixin

withIgnored_annotationsMixin(ignored_annotations)

Note: This function appends passed data to existing values

fn configuration.kubernetes.withInfrastructure_roles_secret_name

withInfrastructure_roles_secret_name(infrastructure_roles_secret_name)

fn configuration.kubernetes.withInfrastructure_roles_secrets

withInfrastructure_roles_secrets(infrastructure_roles_secrets)

fn configuration.kubernetes.withInfrastructure_roles_secretsMixin

withInfrastructure_roles_secretsMixin(infrastructure_roles_secrets)

Note: This function appends passed data to existing values

fn configuration.kubernetes.withInherited_annotations

withInherited_annotations(inherited_annotations)

fn configuration.kubernetes.withInherited_annotationsMixin

withInherited_annotationsMixin(inherited_annotations)

Note: This function appends passed data to existing values

fn configuration.kubernetes.withInherited_labels

withInherited_labels(inherited_labels)

fn configuration.kubernetes.withInherited_labelsMixin

withInherited_labelsMixin(inherited_labels)

Note: This function appends passed data to existing values

fn configuration.kubernetes.withMaster_pod_move_timeout

withMaster_pod_move_timeout(master_pod_move_timeout)

fn configuration.kubernetes.withNode_readiness_label

withNode_readiness_label(node_readiness_label)

fn configuration.kubernetes.withNode_readiness_labelMixin

withNode_readiness_labelMixin(node_readiness_label)

Note: This function appends passed data to existing values

fn configuration.kubernetes.withNode_readiness_label_merge

withNode_readiness_label_merge(node_readiness_label_merge)

fn configuration.kubernetes.withOauth_token_secret_name

withOauth_token_secret_name(oauth_token_secret_name)

fn configuration.kubernetes.withPdb_master_label_selector

withPdb_master_label_selector(pdb_master_label_selector)

fn configuration.kubernetes.withPdb_name_format

withPdb_name_format(pdb_name_format)

fn configuration.kubernetes.withPod_antiaffinity_preferred_during_scheduling

withPod_antiaffinity_preferred_during_scheduling(pod_antiaffinity_preferred_during_scheduling)

fn configuration.kubernetes.withPod_antiaffinity_topology_key

withPod_antiaffinity_topology_key(pod_antiaffinity_topology_key)

fn configuration.kubernetes.withPod_environment_configmap

withPod_environment_configmap(pod_environment_configmap)

fn configuration.kubernetes.withPod_environment_secret

withPod_environment_secret(pod_environment_secret)

fn configuration.kubernetes.withPod_management_policy

withPod_management_policy(pod_management_policy)

fn configuration.kubernetes.withPod_priority_class_name

withPod_priority_class_name(pod_priority_class_name)

fn configuration.kubernetes.withPod_role_label

withPod_role_label(pod_role_label)

fn configuration.kubernetes.withPod_service_account_definition

withPod_service_account_definition(pod_service_account_definition)

fn configuration.kubernetes.withPod_service_account_name

withPod_service_account_name(pod_service_account_name)

fn configuration.kubernetes.withPod_service_account_role_binding_definition

withPod_service_account_role_binding_definition(pod_service_account_role_binding_definition)

fn configuration.kubernetes.withPod_terminate_grace_period

withPod_terminate_grace_period(pod_terminate_grace_period)

fn configuration.kubernetes.withSecret_name_template

withSecret_name_template(secret_name_template)

fn configuration.kubernetes.withShare_pgsocket_with_sidecars

withShare_pgsocket_with_sidecars(share_pgsocket_with_sidecars)

fn configuration.kubernetes.withSpilo_allow_privilege_escalation

withSpilo_allow_privilege_escalation(spilo_allow_privilege_escalation)

fn configuration.kubernetes.withSpilo_fsgroup

withSpilo_fsgroup(spilo_fsgroup)

fn configuration.kubernetes.withSpilo_privileged

withSpilo_privileged(spilo_privileged)

fn configuration.kubernetes.withSpilo_runasgroup

withSpilo_runasgroup(spilo_runasgroup)

fn configuration.kubernetes.withSpilo_runasuser

withSpilo_runasuser(spilo_runasuser)

fn configuration.kubernetes.withStorage_resize_mode

withStorage_resize_mode(storage_resize_mode)

fn configuration.kubernetes.withToleration

withToleration(toleration)

fn configuration.kubernetes.withTolerationMixin

withTolerationMixin(toleration)

Note: This function appends passed data to existing values

fn configuration.kubernetes.withWatched_namespace

withWatched_namespace(watched_namespace)

obj configuration.kubernetes.infrastructure_roles_secrets

fn configuration.kubernetes.infrastructure_roles_secrets.withDefaultrolevalue

withDefaultrolevalue(defaultrolevalue)

fn configuration.kubernetes.infrastructure_roles_secrets.withDefaultuservalue

withDefaultuservalue(defaultuservalue)

fn configuration.kubernetes.infrastructure_roles_secrets.withDetails

withDetails(details)

fn configuration.kubernetes.infrastructure_roles_secrets.withPasswordkey

withPasswordkey(passwordkey)

fn configuration.kubernetes.infrastructure_roles_secrets.withRolekey

withRolekey(rolekey)

fn configuration.kubernetes.infrastructure_roles_secrets.withSecretname

withSecretname(secretname)

fn configuration.kubernetes.infrastructure_roles_secrets.withTemplate

withTemplate(template)

fn configuration.kubernetes.infrastructure_roles_secrets.withUserkey

withUserkey(userkey)

obj configuration.kubernetes.persistent_volume_claim_retention_policy

fn configuration.kubernetes.persistent_volume_claim_retention_policy.withWhen_deleted

withWhen_deleted(when_deleted)

fn configuration.kubernetes.persistent_volume_claim_retention_policy.withWhen_scaled

withWhen_scaled(when_scaled)

obj configuration.load_balancer

fn configuration.load_balancer.withCustom_service_annotations

withCustom_service_annotations(custom_service_annotations)

fn configuration.load_balancer.withCustom_service_annotationsMixin

withCustom_service_annotationsMixin(custom_service_annotations)

Note: This function appends passed data to existing values

fn configuration.load_balancer.withDb_hosted_zone

withDb_hosted_zone(db_hosted_zone)

fn configuration.load_balancer.withEnable_master_load_balancer

withEnable_master_load_balancer(enable_master_load_balancer)

fn configuration.load_balancer.withEnable_master_pooler_load_balancer

withEnable_master_pooler_load_balancer(enable_master_pooler_load_balancer)

fn configuration.load_balancer.withEnable_replica_load_balancer

withEnable_replica_load_balancer(enable_replica_load_balancer)

fn configuration.load_balancer.withEnable_replica_pooler_load_balancer

withEnable_replica_pooler_load_balancer(enable_replica_pooler_load_balancer)

fn configuration.load_balancer.withExternal_traffic_policy

withExternal_traffic_policy(external_traffic_policy)

fn configuration.load_balancer.withMaster_dns_name_format

withMaster_dns_name_format(master_dns_name_format)

fn configuration.load_balancer.withMaster_legacy_dns_name_format

withMaster_legacy_dns_name_format(master_legacy_dns_name_format)

fn configuration.load_balancer.withReplica_dns_name_format

withReplica_dns_name_format(replica_dns_name_format)

fn configuration.load_balancer.withReplica_legacy_dns_name_format

withReplica_legacy_dns_name_format(replica_legacy_dns_name_format)

obj configuration.logging_rest_api

fn configuration.logging_rest_api.withApi_port

withApi_port(api_port)

fn configuration.logging_rest_api.withCluster_history_entries

withCluster_history_entries(cluster_history_entries)

fn configuration.logging_rest_api.withRing_log_lines

withRing_log_lines(ring_log_lines)

obj configuration.logical_backup

fn configuration.logical_backup.withLogical_backup_azure_storage_account_key

withLogical_backup_azure_storage_account_key(logical_backup_azure_storage_account_key)

fn configuration.logical_backup.withLogical_backup_azure_storage_account_name

withLogical_backup_azure_storage_account_name(logical_backup_azure_storage_account_name)

fn configuration.logical_backup.withLogical_backup_azure_storage_container

withLogical_backup_azure_storage_container(logical_backup_azure_storage_container)

fn configuration.logical_backup.withLogical_backup_cpu_limit

withLogical_backup_cpu_limit(logical_backup_cpu_limit)

fn configuration.logical_backup.withLogical_backup_cpu_request

withLogical_backup_cpu_request(logical_backup_cpu_request)

fn configuration.logical_backup.withLogical_backup_cronjob_environment_secret

withLogical_backup_cronjob_environment_secret(logical_backup_cronjob_environment_secret)

fn configuration.logical_backup.withLogical_backup_docker_image

withLogical_backup_docker_image(logical_backup_docker_image)

fn configuration.logical_backup.withLogical_backup_google_application_credentials

withLogical_backup_google_application_credentials(logical_backup_google_application_credentials)

fn configuration.logical_backup.withLogical_backup_job_prefix

withLogical_backup_job_prefix(logical_backup_job_prefix)

fn configuration.logical_backup.withLogical_backup_memory_limit

withLogical_backup_memory_limit(logical_backup_memory_limit)

fn configuration.logical_backup.withLogical_backup_memory_request

withLogical_backup_memory_request(logical_backup_memory_request)

fn configuration.logical_backup.withLogical_backup_provider

withLogical_backup_provider(logical_backup_provider)

fn configuration.logical_backup.withLogical_backup_s3_access_key_id

withLogical_backup_s3_access_key_id(logical_backup_s3_access_key_id)

fn configuration.logical_backup.withLogical_backup_s3_bucket

withLogical_backup_s3_bucket(logical_backup_s3_bucket)

fn configuration.logical_backup.withLogical_backup_s3_bucket_prefix

withLogical_backup_s3_bucket_prefix(logical_backup_s3_bucket_prefix)

fn configuration.logical_backup.withLogical_backup_s3_endpoint

withLogical_backup_s3_endpoint(logical_backup_s3_endpoint)

fn configuration.logical_backup.withLogical_backup_s3_region

withLogical_backup_s3_region(logical_backup_s3_region)

fn configuration.logical_backup.withLogical_backup_s3_retention_time

withLogical_backup_s3_retention_time(logical_backup_s3_retention_time)

fn configuration.logical_backup.withLogical_backup_s3_secret_access_key

withLogical_backup_s3_secret_access_key(logical_backup_s3_secret_access_key)

fn configuration.logical_backup.withLogical_backup_s3_sse

withLogical_backup_s3_sse(logical_backup_s3_sse)

fn configuration.logical_backup.withLogical_backup_schedule

withLogical_backup_schedule(logical_backup_schedule)

obj configuration.major_version_upgrade

fn configuration.major_version_upgrade.withMajor_version_upgrade_mode

withMajor_version_upgrade_mode(major_version_upgrade_mode)

fn configuration.major_version_upgrade.withMajor_version_upgrade_team_allow_list

withMajor_version_upgrade_team_allow_list(major_version_upgrade_team_allow_list)

fn configuration.major_version_upgrade.withMajor_version_upgrade_team_allow_listMixin

withMajor_version_upgrade_team_allow_listMixin(major_version_upgrade_team_allow_list)

Note: This function appends passed data to existing values

fn configuration.major_version_upgrade.withMinimal_major_version

withMinimal_major_version(minimal_major_version)

fn configuration.major_version_upgrade.withTarget_major_version

withTarget_major_version(target_major_version)

obj configuration.patroni

fn configuration.patroni.withEnable_patroni_failsafe_mode

withEnable_patroni_failsafe_mode(enable_patroni_failsafe_mode)

obj configuration.postgres_pod_resources

fn configuration.postgres_pod_resources.withDefault_cpu_limit

withDefault_cpu_limit(default_cpu_limit)

fn configuration.postgres_pod_resources.withDefault_cpu_request

withDefault_cpu_request(default_cpu_request)

fn configuration.postgres_pod_resources.withDefault_memory_limit

withDefault_memory_limit(default_memory_limit)

fn configuration.postgres_pod_resources.withDefault_memory_request

withDefault_memory_request(default_memory_request)

fn configuration.postgres_pod_resources.withMax_cpu_request

withMax_cpu_request(max_cpu_request)

fn configuration.postgres_pod_resources.withMax_memory_request

withMax_memory_request(max_memory_request)

fn configuration.postgres_pod_resources.withMin_cpu_limit

withMin_cpu_limit(min_cpu_limit)

fn configuration.postgres_pod_resources.withMin_memory_limit

withMin_memory_limit(min_memory_limit)

obj configuration.scalyr

fn configuration.scalyr.withScalyr_api_key

withScalyr_api_key(scalyr_api_key)

fn configuration.scalyr.withScalyr_cpu_limit

withScalyr_cpu_limit(scalyr_cpu_limit)

fn configuration.scalyr.withScalyr_cpu_request

withScalyr_cpu_request(scalyr_cpu_request)

fn configuration.scalyr.withScalyr_image

withScalyr_image(scalyr_image)

fn configuration.scalyr.withScalyr_memory_limit

withScalyr_memory_limit(scalyr_memory_limit)

fn configuration.scalyr.withScalyr_memory_request

withScalyr_memory_request(scalyr_memory_request)

fn configuration.scalyr.withScalyr_server_url

withScalyr_server_url(scalyr_server_url)

obj configuration.teams_api

fn configuration.teams_api.withEnable_admin_role_for_users

withEnable_admin_role_for_users(enable_admin_role_for_users)

fn configuration.teams_api.withEnable_postgres_team_crd

withEnable_postgres_team_crd(enable_postgres_team_crd)

fn configuration.teams_api.withEnable_postgres_team_crd_superusers

withEnable_postgres_team_crd_superusers(enable_postgres_team_crd_superusers)

fn configuration.teams_api.withEnable_team_member_deprecation

withEnable_team_member_deprecation(enable_team_member_deprecation)

fn configuration.teams_api.withEnable_team_superuser

withEnable_team_superuser(enable_team_superuser)

fn configuration.teams_api.withEnable_teams_api

withEnable_teams_api(enable_teams_api)

fn configuration.teams_api.withPam_configuration

withPam_configuration(pam_configuration)

fn configuration.teams_api.withPam_role_name

withPam_role_name(pam_role_name)

fn configuration.teams_api.withPostgres_superuser_teams

withPostgres_superuser_teams(postgres_superuser_teams)

fn configuration.teams_api.withPostgres_superuser_teamsMixin

withPostgres_superuser_teamsMixin(postgres_superuser_teams)

Note: This function appends passed data to existing values

fn configuration.teams_api.withProtected_role_names

withProtected_role_names(protected_role_names)

fn configuration.teams_api.withProtected_role_namesMixin

withProtected_role_namesMixin(protected_role_names)

Note: This function appends passed data to existing values

fn configuration.teams_api.withRole_deletion_suffix

withRole_deletion_suffix(role_deletion_suffix)

fn configuration.teams_api.withTeam_admin_role

withTeam_admin_role(team_admin_role)

fn configuration.teams_api.withTeam_api_role_configuration

withTeam_api_role_configuration(team_api_role_configuration)

fn configuration.teams_api.withTeam_api_role_configurationMixin

withTeam_api_role_configurationMixin(team_api_role_configuration)

Note: This function appends passed data to existing values

fn configuration.teams_api.withTeams_api_url

withTeams_api_url(teams_api_url)

obj configuration.timeouts

fn configuration.timeouts.withPatroni_api_check_interval

withPatroni_api_check_interval(patroni_api_check_interval)

fn configuration.timeouts.withPatroni_api_check_timeout

withPatroni_api_check_timeout(patroni_api_check_timeout)

fn configuration.timeouts.withPod_deletion_wait_timeout

withPod_deletion_wait_timeout(pod_deletion_wait_timeout)

fn configuration.timeouts.withPod_label_wait_timeout

withPod_label_wait_timeout(pod_label_wait_timeout)

fn configuration.timeouts.withReady_wait_interval

withReady_wait_interval(ready_wait_interval)

fn configuration.timeouts.withReady_wait_timeout

withReady_wait_timeout(ready_wait_timeout)

fn configuration.timeouts.withResource_check_interval

withResource_check_interval(resource_check_interval)

fn configuration.timeouts.withResource_check_timeout

withResource_check_timeout(resource_check_timeout)

obj configuration.users

fn configuration.users.withAdditional_owner_roles

withAdditional_owner_roles(additional_owner_roles)

fn configuration.users.withAdditional_owner_rolesMixin

withAdditional_owner_rolesMixin(additional_owner_roles)

Note: This function appends passed data to existing values

fn configuration.users.withEnable_password_rotation

withEnable_password_rotation(enable_password_rotation)

fn configuration.users.withPassword_rotation_interval

withPassword_rotation_interval(password_rotation_interval)

fn configuration.users.withPassword_rotation_user_retention

withPassword_rotation_user_retention(password_rotation_user_retention)

fn configuration.users.withReplication_username

withReplication_username(replication_username)

fn configuration.users.withSuper_username

withSuper_username(super_username)

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"

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"