config

Documentation

Index

• type Auth
• type CRD
• type Config
  • func Copy(c *Config) Config
  • func NewFromMap(m map[string]string) *Config
  • func (c Config) MustMarshal() string
• type LogicalBackup
• type Resources
• type Scalyr
• type StringTemplate
  • func (f *StringTemplate) Decode(value string) error
  • func (f *StringTemplate) Format(a ...string) string
  • func (f StringTemplate) MarshalJSON() ([]byte, error)

Types

type Auth

type Auth struct {
	SecretNameTemplate            StringTemplate      `name:"secret_name_template" default:"{username}.{cluster}.credentials.{tprkind}.{tprgroup}"`
	PamRoleName                   string              `name:"pam_role_name" default:"zalandos"`
	PamConfiguration              string              `name:"pam_configuration" default:"https://info.example.com/oauth2/tokeninfo?access_token= uid realm=/employees"`
	TeamsAPIUrl                   string              `name:"teams_api_url" default:"https://teams.example.com/api/"`
	OAuthTokenSecretName          spec.NamespacedName `name:"oauth_token_secret_name" default:"postgresql-operator"`
	InfrastructureRolesSecretName spec.NamespacedName `name:"infrastructure_roles_secret_name"`
	SuperUsername                 string              `name:"super_username" default:"postgres"`
	ReplicationUsername           string              `name:"replication_username" default:"standby"`
}

Auth describes authentication specific configuration parameters

type CRD

type CRD struct {
	ReadyWaitInterval   time.Duration `name:"ready_wait_interval" default:"4s"`
	ReadyWaitTimeout    time.Duration `name:"ready_wait_timeout" default:"30s"`
	ResyncPeriod        time.Duration `name:"resync_period" default:"30m"`
	RepairPeriod        time.Duration `name:"repair_period" default:"5m"`
	EnableCRDValidation *bool         `name:"enable_crd_validation" default:"true"`
}

CRD describes CustomResourceDefinition specific configuration parameters

type Config

type Config struct {
	CRD
	Resources
	Auth
	Scalyr
	LogicalBackup

	WatchedNamespace      string            `name:"watched_namespace"`    // special values: "*" means 'watch all namespaces', the empty string "" means 'watch a namespace where operator is deployed to'
	EtcdHost              string            `name:"etcd_host" default:""` // special values: the empty string "" means Patroni will use K8s as a DCS
	DockerImage           string            `name:"docker_image" default:"registry.opensource.zalan.do/acid/spilo-12:1.6-p2"`
	Sidecars              map[string]string `name:"sidecar_docker_images"`
	PodServiceAccountName string            `name:"pod_service_account_name" default:"postgres-pod"`
	// value of this string must be valid JSON or YAML; see initPodServiceAccount
	PodServiceAccountDefinition            string            `name:"pod_service_account_definition" default:""`
	PodServiceAccountRoleBindingDefinition string            `name:"pod_service_account_role_binding_definition" default:""`
	MasterPodMoveTimeout                   time.Duration     `name:"master_pod_move_timeout" default:"20m"`
	DbHostedZone                           string            `name:"db_hosted_zone" default:"db.example.com"`
	AWSRegion                              string            `name:"aws_region" default:"eu-central-1"`
	WALES3Bucket                           string            `name:"wal_s3_bucket"`
	LogS3Bucket                            string            `name:"log_s3_bucket"`
	KubeIAMRole                            string            `name:"kube_iam_role"`
	AdditionalSecretMount                  string            `name:"additional_secret_mount"`
	AdditionalSecretMountPath              string            `name:"additional_secret_mount_path" default:"/meta/credentials"`
	DebugLogging                           bool              `name:"debug_logging" default:"true"`
	EnableDBAccess                         bool              `name:"enable_database_access" default:"true"`
	EnableTeamsAPI                         bool              `name:"enable_teams_api" default:"true"`
	EnableTeamSuperuser                    bool              `name:"enable_team_superuser" default:"false"`
	TeamAdminRole                          string            `name:"team_admin_role" default:"admin"`
	EnableAdminRoleForUsers                bool              `name:"enable_admin_role_for_users" default:"true"`
	EnableMasterLoadBalancer               bool              `name:"enable_master_load_balancer" default:"true"`
	EnableReplicaLoadBalancer              bool              `name:"enable_replica_load_balancer" default:"false"`
	CustomServiceAnnotations               map[string]string `name:"custom_service_annotations"`
	CustomPodAnnotations                   map[string]string `name:"custom_pod_annotations"`
	EnablePodAntiAffinity                  bool              `name:"enable_pod_antiaffinity" default:"false"`
	PodAntiAffinityTopologyKey             string            `name:"pod_antiaffinity_topology_key" default:"kubernetes.io/hostname"`
	// deprecated and kept for backward compatibility
	EnableLoadBalancer        *bool             `name:"enable_load_balancer"`
	MasterDNSNameFormat       StringTemplate    `name:"master_dns_name_format" default:"{cluster}.{team}.{hostedzone}"`
	ReplicaDNSNameFormat      StringTemplate    `name:"replica_dns_name_format" default:"{cluster}-repl.{team}.{hostedzone}"`
	PDBNameFormat             StringTemplate    `name:"pdb_name_format" default:"postgres-{cluster}-pdb"`
	EnablePodDisruptionBudget *bool             `name:"enable_pod_disruption_budget" default:"true"`
	EnableInitContainers      *bool             `name:"enable_init_containers" default:"true"`
	EnableSidecars            *bool             `name:"enable_sidecars" default:"true"`
	Workers                   uint32            `name:"workers" default:"4"`
	APIPort                   int               `name:"api_port" default:"8080"`
	RingLogLines              int               `name:"ring_log_lines" default:"100"`
	ClusterHistoryEntries     int               `name:"cluster_history_entries" default:"1000"`
	TeamAPIRoleConfiguration  map[string]string `name:"team_api_role_configuration" default:"log_statement:all"`
	PodTerminateGracePeriod   time.Duration     `name:"pod_terminate_grace_period" default:"5m"`
	PodManagementPolicy       string            `name:"pod_management_policy" default:"ordered_ready"`
	ProtectedRoles            []string          `name:"protected_role_names" default:"admin"`
	PostgresSuperuserTeams    []string          `name:"postgres_superuser_teams" default:""`
	SetMemoryRequestToLimit   bool              `name:"set_memory_request_to_limit" default:"false"`
}

Config describes operator config

func Copy

func Copy(c *Config) Config

Copy creates a copy of the config

func NewFromMap

func NewFromMap(m map[string]string) *Config

NewFromMap creates Config from the map

func (Config) MustMarshal

func (c Config) MustMarshal() string

MustMarshal marshals the config or panics

type LogicalBackup

type LogicalBackup struct {
	LogicalBackupSchedule          string `name:"logical_backup_schedule" default:"30 00 * * *"`
	LogicalBackupDockerImage       string `name:"logical_backup_docker_image" default:"registry.opensource.zalan.do/acid/logical-backup"`
	LogicalBackupS3Bucket          string `name:"logical_backup_s3_bucket" default:""`
	LogicalBackupS3Region          string `name:"logical_backup_s3_region" default:""`
	LogicalBackupS3Endpoint        string `name:"logical_backup_s3_endpoint" default:""`
	LogicalBackupS3AccessKeyID     string `name:"logical_backup_s3_access_key_id" default:""`
	LogicalBackupS3SecretAccessKey string `name:"logical_backup_s3_secret_access_key" default:""`
	LogicalBackupS3SSE             string `name:"logical_backup_s3_sse" default:"AES256"`
}

LogicalBackup defines configuration for logical backup

type Resources

type Resources struct {
	ResourceCheckInterval   time.Duration     `name:"resource_check_interval" default:"3s"`
	ResourceCheckTimeout    time.Duration     `name:"resource_check_timeout" default:"10m"`
	PodLabelWaitTimeout     time.Duration     `name:"pod_label_wait_timeout" default:"10m"`
	PodDeletionWaitTimeout  time.Duration     `name:"pod_deletion_wait_timeout" default:"10m"`
	PodTerminateGracePeriod time.Duration     `name:"pod_terminate_grace_period" default:"5m"`
	SpiloFSGroup            *int64            `name:"spilo_fsgroup"`
	PodPriorityClassName    string            `name:"pod_priority_class_name"`
	ClusterDomain           string            `name:"cluster_domain" default:"cluster.local"`
	SpiloPrivileged         bool              `name:"spilo_privileged" default:"false"`
	ClusterLabels           map[string]string `name:"cluster_labels" default:"application:spilo"`
	InheritedLabels         []string          `name:"inherited_labels" default:""`
	ClusterNameLabel        string            `name:"cluster_name_label" default:"cluster-name"`
	PodRoleLabel            string            `name:"pod_role_label" default:"spilo-role"`
	PodToleration           map[string]string `name:"toleration" default:""`
	DefaultCPURequest       string            `name:"default_cpu_request" default:"100m"`
	DefaultMemoryRequest    string            `name:"default_memory_request" default:"100Mi"`
	DefaultCPULimit         string            `name:"default_cpu_limit" default:"1"`
	DefaultMemoryLimit      string            `name:"default_memory_limit" default:"500Mi"`
	MinCPULimit             string            `name:"min_cpu_limit" default:"250m"`
	MinMemoryLimit          string            `name:"min_memory_limit" default:"250Mi"`
	PodEnvironmentConfigMap string            `name:"pod_environment_configmap" default:""`
	NodeReadinessLabel      map[string]string `name:"node_readiness_label" default:""`
	MaxInstances            int32             `name:"max_instances" default:"-1"`
	MinInstances            int32             `name:"min_instances" default:"-1"`
	ShmVolume               *bool             `name:"enable_shm_volume" default:"true"`
}

Resources describes kubernetes resource specific configuration parameters

type Scalyr

type Scalyr struct {
	ScalyrAPIKey        string `name:"scalyr_api_key" default:""`
	ScalyrImage         string `name:"scalyr_image" default:""`
	ScalyrServerURL     string `name:"scalyr_server_url" default:"https://upload.eu.scalyr.com"`
	ScalyrCPURequest    string `name:"scalyr_cpu_request" default:"100m"`
	ScalyrMemoryRequest string `name:"scalyr_memory_request" default:"50Mi"`
	ScalyrCPULimit      string `name:"scalyr_cpu_limit" default:"1"`
	ScalyrMemoryLimit   string `name:"scalyr_memory_limit" default:"500Mi"`
}

Scalyr holds the configuration for the Scalyr Agent sidecar for log shipping:

type StringTemplate

type StringTemplate string

StringTemplate is a convenience alias

func (*StringTemplate) Decode

func (f *StringTemplate) Decode(value string) error

Decode cast value to StringTemplate

func (*StringTemplate) Format

func (f *StringTemplate) Format(a ...string) string

Format formatted string from StringTemplate

func (StringTemplate) MarshalJSON

func (f StringTemplate) MarshalJSON() ([]byte, error)

MarshalJSON converts a StringTemplate to byte slice