63 KiB
63 KiB
PostgeSQL в K3s
Самый простой способ установить PostgreSQL в k3s -- просто создать один под со своим PVC и ConfigMap для конфигурирования. Достаточно для тестов и небольших приложений, и доступность будет обеспечена на приемлемом уровне.
Доступность порта 5432 (не обязательно)
Мне для разработки и тестирования на моем рабочем компе (вне k3s) нужно, чтобы PostgreSQL был доступен снаружи кластера (внутри домашней сети). Это можно сделать двумя способами:
- Через
NodePort: сервиса Kubernetes, который открывает указанный порт на всех узлах (нодах) кластера. Порты, обычно, находятся в диапазоне 30000–32767, и NodePort проксирует на нужный порт внутри кластера, таким образом, направляя запросы к нужным подам. Это решение удобно, так как довольно просто в настройке и не требует Traefik, но порт будет открыт на всех нодах и будет потеряно централизованное управление маршрутизацией, которое даёт Traefik (например, HostSNI или TLS termination) и, возможно, потребуется внешний балансировщик нагрузки, если нод несколько. - Через
IngressRouteTCPв Traefik: это более гибкий способ, который позволяет использовать маршрутизации трафика, включая поддержку HostSNI (например с доступом через домен с сертификатами (TLS termination). Маршрутизацией на порта внутри кластер в нужный контейнер обеспечивает Traefik.
В продакшене делать порт доступным вне кластера вообще не обязательно. Внутри кластера порт всегда доступен
в контейнере PostgreSQL, и любые приложения илди сервисы кластера смогут обращаться к нему по имени
(имя_контейнера:порт).
Мне, для моих задач, больше подходит второй вариант (с IngressRouteTCP), так как я уже использую Traefik
для маршрутизации. Но для того чтобы "вывесить порт" наружу кластера, нужно изменить статические манифесты,
и настроить Traefik для прослушивания и маршрутизации дополнительных портов. Нам понадобится Helm Chart
(для конфигурации Traefik), и добавления нового entryPoint для порта 5432.
У меня уже есть манифест Helm Chart (Helm -- это такой пакетный менеджер для Kubernetes), в котором настраивал
доступ и открывал порт 2222 для SSH внутрь контейнер Gitea.
Добавлю туда и 5432-порт для PostgreSQL:
# ~/k3s/traefik/traefik.yaml
# "Статичные" манифесты, которые применяются при старте Traefik
# Helm-манифест: установка нестандартных праметров Treafik
apiVersion: helm.cattle.io/v1
kind: HelmChartConfig
metadata:
name: traefik
namespace: kube-system
spec:
valuesContent: |-
additionalArguments:
# ...
# ...
- --entrypoints.postgres.address=:5432 # Добавляем entryPoint для PostgreSQL (5432 порт)
ports:
# ...
# ...
postgres:
port: 5432 # Внутренний порт в контейнере Traefik
expose:
default: true # Доступен по умолчанию
exposedPort: 5432 # Порт на хосте (включая VIP с Keepalived)
protocol: TCP # Это TCP трафик
---
...
...
После применения:
kubectl apply -f ~/k3s/traefik/traefik.yaml
Traefik перезапустится и настройки вступят в силу.
Создание манифестов для PostgreSQL
Теперь создадим манифесты для PostgreSQL. Они будут включать:
- Пространство имён
postgresql(если его нет). - PersistentVolumeClaim (PVC) для хранения данных PostgreSQL.
- ConfigMap (их будет несколько) для кастомизации настроек PostgreSQL.
- Deployment для PostgreSQL с монтированием PVC и ConfigMap-ов.
- Секрет для хранения пароля PostgreSQL (тоже может быть несколько, если нужно).
- Service для внутреннего доступа к PostgreSQL.
- IngressRouteTCP для внешнего доступа к PostgreSQL по порту 5432.
# ~/k3s/postgresql/postgresql.yaml
# Все манифесты для PostgreSQL (без наворотов вроде репликаций, высокой доступности через Patroni и т.д.)
# 1. Манифест создания пространства имён `postgresql`. Если оно уже есть — kubectl apply ничего не изменит
apiVersion: v1
kind: Namespace
metadata:
name: postgresql # Имя пространства имён для PostgreSQL
---
# 2. Манифест PVC (Longhorn) -- том в блочном хранилище с данными (базами) PostgreSQL
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
name: postgres-data # Имя PVC-хранилища
namespace: postgresql # в пространстве имен `postgresql`
spec:
accessModes:
- ReadWriteOnce
storageClassName: longhorn # Используем Longhorn как класс хранения
resources:
requests:
storage: 2Gi # Запрашиваемое хранилище 2 Гб (позже можно изменить на большее)
---
# 3. Манифесты ConfigMap конфига ...
# 3.1. Этот ConfigMap будет подключаться в `/etc/postgresql/postgresql.conf` в контейнере PostgreSQL.
# При инициализации, после initdb, создается дефолтный `postgresql.conf` внутри $PGDATA,
# каталоге с данными (в нашем случае в `/var/lib/postgresql/db/postgresql.conf`). Если
# смонтировать `postgresql.conf` сразу в каталог $PGDATA, инициализация не произойдет,
# так как при инициализации требуется именно *ЧИСТЫЙ* каталог. И, вот прям неожиданно,
# в этом конфиге по умолчанию нет `include_dir = ...`, а значит, никакие кастомные
# конфиги из каталога `/etc/postgresql/conf.d` не будут подключаться, и придется для
# изменения настроек ВСЕГДА править `postgresql.conf` вручную после инициализации, уже
# внутри пода (или командами внутри `psql`), что не очень удобно (1) и не оставляет следов,
# так как кто все эти изменения будет документировать (2)?
# И так, ConfigMap `postgresql-init-config` монтируется в `/etc/postgresql/postgresql.conf`,
# а затем через `args` и `POSTGRES_INITDB_ARGS` подцепляем его в хвост дефолтного конфига.
apiVersion: v1
kind: ConfigMap
metadata:
name: postgresql-init-config
namespace: postgresql
data:
postgresql.conf: |-
listen_addresses = '*'
dynamic_shared_memory_type = posix
max_wal_size = 1GB
min_wal_size = 80MB
datestyle = 'iso, mdy'
lc_messages = 'en_US.utf8'
lc_monetary = 'en_US.utf8'
lc_numeric = 'en_US.utf8'
lc_time = 'en_US.utf8'
default_text_search_config = 'pg_catalog.russian'
include_dir = '/etc/postgresql/conf.d'
---
# 3.2. Манифесты ConfigMap для кастомизации (или один ConfigMap с несколькими ключами) будет
# смонтирован в контейнер PostgreSQL, в каталог `/etc/postgresql/conf.d`. Конфиги в этом
# каталоге будут автоматически "подхвачены" при запуске и могут добавлять и переопределять
# настройки. Они применяются последовательно (в алфавитно-литеральном порядке) и потому
# имя (или ключ) монтирования важен, так как него зависит порядок применения кастомизации
# (конфиг O1-xxx будет применён раньше, чем O2-xxx и т.д.).
apiVersion: v1
kind: ConfigMap
metadata:
name: postgres-custom-config-dir
namespace: postgresql # в пространстве имен `postgresql`
data:
# Пример кастомного конфига PostgreSQL
01-custom.conf: |-
max_connections = 120
shared_buffers = 256MB
log_min_duration_statement = 1000
work_mem = 6MB
# Еще один кастомный конфиг (устанавливает часовой пояс)
02-timezone.conf: |-
log_timezone = 'Europe/Moscow'
timezone = 'Europe/Moscow'
---
# 4. Deployment: PostgreSQL
apiVersion: apps/v1
kind: Deployment
metadata:
name: postgres
namespace: postgresql
spec:
replicas: 1
selector:
matchLabels:
app: postgres
template:
metadata:
labels:
app: postgres
spec:
containers:
- name: postgres
image: postgres:16 # Используем официальный образ PostgreSQL версии 16
ports:
- containerPort: 5432 # Порт PostgreSQL внутри контейнера
# Дополнительный аргумент... он подключает наш `postgresql.conf` (из ConfigMap), смонтированный
# в контейнер в каталог `/etc/postgresql/` (через ConfigMap) в хвост конфига по умолчанию.
args: ["-c", "config_file=/etc/postgresql/postgresql.conf"]
env:
- name: POSTGRES_INITDB_ARGS # То же самое, что и выше...
value: "--set=config_file=/etc/postgresql/postgresql.conf"
- name: POSTGRES_PASSWORD # По умолчанию postgres создаёт пользователя `postgres` c
# паролем, который можно задать через переменную окружения POSTGRES_PASSWORD.
# Если переменную с паролем не указать, то контейнер не стартует и завершит работу с ошибкой.
# Так что POSTGRES_PASSWORD -- обязательная переменная.
valueFrom:
secretKeyRef: # Получаем пароль из секрета:
name: postgres-secret # Имя секрета
key: password # Ключ в секрете, содержащий пароль
# - name: POSTGRES_USER # В принципе, имя пользователя по умолчанию тоже можно изменить
# value: postgres
- name: POSTGRES_DB # Имя базы данных, которая будет создана при запуске (по умолчанию: `postgres`)
value: postgres
- name: PGDATA # Каталог, где PostgreSQL будет хранить свои данные
value: /var/lib/postgresql/db
- name: POSTGRES_CONFIG_DIR # Каталог, где PostgreSQL будет искать кастомные конфигурационные файлы
value: /etc/postgresql/conf.d # ...и туда мы будем монтирвовать конфиги через ConfigMap
- name: TZ # Часовой пояс, который будет в поде
value: Europe/Moscow
volumeMounts: # Монтируем тома:
- name: data # Данные PostgreSQL в Longhorn (PVC)
mountPath: /var/lib/postgresql/ # в каталог внутри контейнера (он не совпадает с PGDATA, т.к.
# PVC Longhorn всегда создает каталог `lost+found` в новом томе,
# а PostgreSQL _нужен_ пустой каталог для инициализации)
- name: config
mountPath: /etc/postgresql/postgresql.conf
subPath: postgresql.conf
# mountPath: /var/lib/postgresql/config
#- name: config
# mountPath: /docker-entrypoint-initdb.d/postgresql.conf
# subPath: postgresql.conf
- name: custom-configs # Кастомные конифиги PostgreSQL из ConfigMap
mountPath: /etc/postgresql/conf.d # в каталог внутри контейнера
# Проверка "живости" контейнера (Liveness Probe). Kubernetes будет выполнять периодически команду 'command'.
# Если она начнет возвращать ошибку (например, если PostgreSQL "завис"), то kubelet перезапустит pod.
livenessProbe:
exec:
command: ["pg_isready", "-U", "postgres"] # Проверяем доступность PostgreSQL для пользователя 'postgres'
initialDelaySeconds: 15 # Подождать 15 секунд после запуска контейнера перед первой проверкой
periodSeconds: 25 # Повторять проверку каждые 25 секунд
timeoutSeconds: 3 # Считаем ошибкой, если команда не ответила за 3 секунды
failureThreshold: 5 # Подряд 5 неудач — и pod будет перезапущен
# Проверка "готовности" контейнера (Readiness Probe). Kubernetes использует `command`, чтобы понять: можно ли
# направлять трафик в этот pod. Если проверка не прошла -> pod "не готов" -> не получает запросы от сервиса.
readinessProbe:
exec:
command: ["pg_isready", "-U", "postgres"]
initialDelaySeconds: 10
periodSeconds: 10
timeoutSeconds: 3
failureThreshold: 3
volumes: # Используемые тома:
- name: data # Том PVC (Longhorn) для хранения данных
persistentVolumeClaim:
claimName: postgres-data
- name: config
configMap:
name: postgresql-init-config
- name: custom-configs # Конфиги (ключи) из ConfigMap для кастомизации PostgreSQL
configMap:
name: postgres-custom-config-dir
---
# 5. Секреты PostgreSQL
# Следует отметить, что секреты в Kubernetes хранятся в виде base64-строк, и это не шифрование, а просто кодирование.
# Так что то, что он указан в манифесте в открытом виде, не увеличит уязвимость (все равно все можно получить из
# команды `kubectl get secret postgres-secret -o yaml`).
apiVersion: v1
kind: Secret
metadata:
name: postgres-secret # имя секрета
namespace: postgresql # в пространстве имен `postgresql`
type: Opaque # Тип данных секрета
stringData: # Используем stringData для удобства
password: xXxXxXxX... # ключ: значение (тут укажем пароль)
---
# 6. Service: внутренний доступ к контейнеру PostgreSQL
apiVersion: v1
kind: Service
metadata:
name: postgres
namespace: postgresql
spec:
selector:
app: postgres
ports:
- name: pg
protocol: TCP
port: 5432
targetPort: 5432
---
# 7. IngressRouteTCP: внешний доступ на pg.local (через порт 5432, а доменное имя, чтоб не указывать VIP-адрес)
apiVersion: traefik.io/v1alpha1
kind: IngressRouteTCP
metadata:
name: postgres
namespace: postgresql
spec:
entryPoints:
- postgres # используем entryPoint, который мы добавили в HelmChart для Traefik (5432 порт)
routes:
- match: HostSNI("*") # доменное имя, по которому будет доступен сервис
services:
- name: postgres # через имя сервиса обращаемся к контейнеру PostgreSQL
port: 5432 # порт внутри контейнера, на который будет направлен трафик
Все "тонкие моменты", а их не мало, разъяснены в комментариях.
Еще интересного, чего нет в комментариях: В IngressRouteTCP пришлось указать HostSNI("*") (без имени
домена). Это потому, что HostSNI() в IngressRouteTCP работает только при TLS (SSL) соединении. SNI (Server
Name Indication) — это часть TLS handshake. Когда клиент подключается по TCP без TLS, не передаёт никакое
имя хоста — просто IP и порт. Соответственно, Traefik не может сопоставить имя pg.local с каким-либо маршрутом,
потому что имя не приходит. Именно по этому, если нет TLS, то инструкция HostSNI("pg.local") не сработает,
а HostSNI("*") просто матчит все входящие TCP без проверки имени. В принципе, это нормально для домашней
сети, ведь порт 5432 не виден из внешнего в интернет. Но в "злом" продакшн или для критических данных между
базой PostgreSQL и приложением лучше использовать TLS, чтобы защитить данные от перехвата; и тогда понадобится
TLS; и тогда можно будет использовать HostSNI("pg.local") для маршрутизации.
Примерим манифесты:
kubectl apply -f ~/k3s/postgresql/postgresql.yaml
Посмотреть пароль к базе данных можно так (когда секрет уже создан):
kubectl get secret -n postgresql postgres-secret -o jsonpath="{.data.password}" | base64 -d && echo
Посмотреть логи развертывания так:
kubectl logs -n postgresql deployment/postgres
Покажут много интересного, и все настройки будут "по умолчанию". Настройки нашего, примонтированного и подключенного
через config_file = ... конфига, не покажут!
В конце будет:
PostgreSQL init process complete; ready for start up.
2025-05-25 08:00:10.025 UTC [1] LOG: starting PostgreSQL 16.9 (Debian 16.9-1.pgdg120+1) on aarch64-unknown-linux-gnu, compiled by gcc (Debian 12.2.0-14) 12.2.0, 64-bit
2025-05-25 08:00:10.026 UTC [1] LOG: listening on IPv4 address "0.0.0.0", port 5432
2025-05-25 08:00:10.026 UTC [1] LOG: listening on IPv6 address "::", port 5432
2025-05-25 08:00:10.040 UTC [1] LOG: listening on Unix socket "/var/run/postgresql/.s.PGSQL.5432"
2025-05-25 08:00:10.069 UTC [63] LOG: database system was shut down at 2025-05-25 08:00:09 UTC
2025-05-25 08:00:10.095 UTC [1] LOG: database system is ready to accept connections
Все. Можно подключаться к базе данных.
Проверки
Посмотреть статус пода PostgreSQL:
kubectl get pods -n postgresql -o wide
Увидим что-то вроде:
NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES
postgres-xxxxxxxxxx-xxxxx 1/1 Running 0 46m 10.42.0.44 opi5 <none> <none>
Зайти внутрь пода (взять имя пода можно из вывода предыдущей команды):
kubectl exec -it -n postgresql postgres-xxxxxxxxxx-xxxxx -- /bin/bash
Если что-то не развернулось, то удалять в следующей последовательности (сначала deployment, потом PVC, потом под, хотя он сам удалится при удалении deployment):
kubectl delete deployment postgres -n postgresql
kubectl delete pvc postgres-data -n postgresql
kubectl delete pod -l app=postgres -n postgresql
Настройки
Теперь, благодаря нашим ConfiMap с кастомными конфигами, можно легко менять настройки PostgreSQL. Только не забывать
после изменения конфигов, делать им kubectl apply ... и перезапускать под PostgreSQL, чтобы изменения вступили
в силу.
Еще из необходимого, что пока нельзя сделать через манифесты, то через веб-интерфейс Longhorn установить для тома
с базой Data Locality в best-effort, чтобы Longhorn держал одну из реплик тома на ноде, где запущен контейнер.
Это ускорить работу PostgreSQL, так как не будет сетевых задержек при обращении к данным.
Подключения
Для подключения к базе данных PostgreSQL можно использовать любой клиент или коннектор, поддерживающий PostgreSQL.
А для работы из командной строки с внешнего хоста (и использование psql) установить клиент PostgreSQL.
Для MacOS
Через Homebrew:
brew install libpq
Можно после добавить libpq в PATH, или использовать полный путь /opt/homebrew/opt/libpq/bin/psql
Для Linux
Для Debian/Ubuntu:
sudo apt install postgresql-client
Для Windows
Не знаю, наверное можно использовать PostgreSQL для Windows.
Конфиг PostgreSQL по умолчанию (на всякий случай)
# -----------------------------
# PostgreSQL configuration file
# -----------------------------
#
# This file consists of lines of the form:
#
# name = value
#
# (The "=" is optional.) Whitespace may be used. Comments are introduced with
# "#" anywhere on a line. The complete list of parameter names and allowed
# values can be found in the PostgreSQL documentation.
#
# The commented-out settings shown in this file represent the default values.
# Re-commenting a setting is NOT sufficient to revert it to the default value;
# you need to reload the server.
#
# This file is read on server startup and when the server receives a SIGHUP
# signal. If you edit the file on a running system, you have to SIGHUP the
# server for the changes to take effect, run "pg_ctl reload", or execute
# "SELECT pg_reload_conf()". Some parameters, which are marked below,
# require a server shutdown and restart to take effect.
#
# Any parameter can also be given as a command-line option to the server, e.g.,
# "postgres -c log_connections=on". Some parameters can be changed at run time
# with the "SET" SQL command.
#
# Memory units: B = bytes Time units: us = microseconds
# kB = kilobytes ms = milliseconds
# MB = megabytes s = seconds
# GB = gigabytes min = minutes
# TB = terabytes h = hours
# d = days
#------------------------------------------------------------------------------
# FILE LOCATIONS
#------------------------------------------------------------------------------
# The default values of these variables are driven from the -D command-line
# option or PGDATA environment variable, represented here as ConfigDir.
#data_directory = 'ConfigDir' # use data in another directory
# (change requires restart)
#hba_file = 'ConfigDir/pg_hba.conf' # host-based authentication file
# (change requires restart)
#ident_file = 'ConfigDir/pg_ident.conf' # ident configuration file
# (change requires restart)
# If external_pid_file is not explicitly set, no extra PID file is written.
#external_pid_file = '' # write an extra PID file
# (change requires restart)
#------------------------------------------------------------------------------
# CONNECTIONS AND AUTHENTICATION
#------------------------------------------------------------------------------
# - Connection Settings -
listen_addresses = '*'
# comma-separated list of addresses;
# defaults to 'localhost'; use '*' for all
# (change requires restart)
#port = 5432 # (change requires restart)
max_connections = 100 # (change requires restart)
#reserved_connections = 0 # (change requires restart)
#superuser_reserved_connections = 3 # (change requires restart)
#unix_socket_directories = '/var/run/postgresql' # comma-separated list of directories
# (change requires restart)
#unix_socket_group = '' # (change requires restart)
#unix_socket_permissions = 0777 # begin with 0 to use octal notation
# (change requires restart)
#bonjour = off # advertise server via Bonjour
# (change requires restart)
#bonjour_name = '' # defaults to the computer name
# (change requires restart)
# - TCP settings -
# see "man tcp" for details
#tcp_keepalives_idle = 0 # TCP_KEEPIDLE, in seconds;
# 0 selects the system default
#tcp_keepalives_interval = 0 # TCP_KEEPINTVL, in seconds;
# 0 selects the system default
#tcp_keepalives_count = 0 # TCP_KEEPCNT;
# 0 selects the system default
#tcp_user_timeout = 0 # TCP_USER_TIMEOUT, in milliseconds;
# 0 selects the system default
#client_connection_check_interval = 0 # time between checks for client
# disconnection while running queries;
# 0 for never
# - Authentication -
#authentication_timeout = 1min # 1s-600s
#password_encryption = scram-sha-256 # scram-sha-256 or md5
#scram_iterations = 4096
#db_user_namespace = off
# GSSAPI using Kerberos
#krb_server_keyfile = 'FILE:${sysconfdir}/krb5.keytab'
#krb_caseins_users = off
#gss_accept_delegation = off
# - SSL -
#ssl = off
#ssl_ca_file = ''
#ssl_cert_file = 'server.crt'
#ssl_crl_file = ''
#ssl_crl_dir = ''
#ssl_key_file = 'server.key'
#ssl_ciphers = 'HIGH:MEDIUM:+3DES:!aNULL' # allowed SSL ciphers
#ssl_prefer_server_ciphers = on
#ssl_ecdh_curve = 'prime256v1'
#ssl_min_protocol_version = 'TLSv1.2'
#ssl_max_protocol_version = ''
#ssl_dh_params_file = ''
#ssl_passphrase_command = ''
#ssl_passphrase_command_supports_reload = off
#------------------------------------------------------------------------------
# RESOURCE USAGE (except WAL)
#------------------------------------------------------------------------------
# - Memory -
shared_buffers = 128MB # min 128kB
# (change requires restart)
#huge_pages = try # on, off, or try
# (change requires restart)
#huge_page_size = 0 # zero for system default
# (change requires restart)
#temp_buffers = 8MB # min 800kB
#max_prepared_transactions = 0 # zero disables the feature
# (change requires restart)
# Caution: it is not advisable to set max_prepared_transactions nonzero unless
# you actively intend to use prepared transactions.
#work_mem = 4MB # min 64kB
#hash_mem_multiplier = 2.0 # 1-1000.0 multiplier on hash table work_mem
#maintenance_work_mem = 64MB # min 1MB
#autovacuum_work_mem = -1 # min 1MB, or -1 to use maintenance_work_mem
#logical_decoding_work_mem = 64MB # min 64kB
#max_stack_depth = 2MB # min 100kB
#shared_memory_type = mmap # the default is the first option
# supported by the operating system:
# mmap
# sysv
# windows
# (change requires restart)
dynamic_shared_memory_type = posix # the default is usually the first option
# supported by the operating system:
# posix
# sysv
# windows
# mmap
# (change requires restart)
#min_dynamic_shared_memory = 0MB # (change requires restart)
#vacuum_buffer_usage_limit = 256kB # size of vacuum and analyze buffer access strategy ring;
# 0 to disable vacuum buffer access strategy;
# range 128kB to 16GB
# - Disk -
#temp_file_limit = -1 # limits per-process temp file space
# in kilobytes, or -1 for no limit
# - Kernel Resources -
#max_files_per_process = 1000 # min 64
# (change requires restart)
# - Cost-Based Vacuum Delay -
#vacuum_cost_delay = 0 # 0-100 milliseconds (0 disables)
#vacuum_cost_page_hit = 1 # 0-10000 credits
#vacuum_cost_page_miss = 2 # 0-10000 credits
#vacuum_cost_page_dirty = 20 # 0-10000 credits
#vacuum_cost_limit = 200 # 1-10000 credits
# - Background Writer -
#bgwriter_delay = 200ms # 10-10000ms between rounds
#bgwriter_lru_maxpages = 100 # max buffers written/round, 0 disables
#bgwriter_lru_multiplier = 2.0 # 0-10.0 multiplier on buffers scanned/round
#bgwriter_flush_after = 512kB # measured in pages, 0 disables
# - Asynchronous Behavior -
#backend_flush_after = 0 # measured in pages, 0 disables
#effective_io_concurrency = 1 # 1-1000; 0 disables prefetching
#maintenance_io_concurrency = 10 # 1-1000; 0 disables prefetching
#max_worker_processes = 8 # (change requires restart)
#max_parallel_workers_per_gather = 2 # limited by max_parallel_workers
#max_parallel_maintenance_workers = 2 # limited by max_parallel_workers
#max_parallel_workers = 8 # number of max_worker_processes that
# can be used in parallel operations
#parallel_leader_participation = on
#old_snapshot_threshold = -1 # 1min-60d; -1 disables; 0 is immediate
# (change requires restart)
#------------------------------------------------------------------------------
# WRITE-AHEAD LOG
#------------------------------------------------------------------------------
# - Settings -
#wal_level = replica # minimal, replica, or logical
# (change requires restart)
#fsync = on # flush data to disk for crash safety
# (turning this off can cause
# unrecoverable data corruption)
#synchronous_commit = on # synchronization level;
# off, local, remote_write, remote_apply, or on
#wal_sync_method = fsync # the default is the first option
# supported by the operating system:
# open_datasync
# fdatasync (default on Linux and FreeBSD)
# fsync
# fsync_writethrough
# open_sync
#full_page_writes = on # recover from partial page writes
#wal_log_hints = off # also do full page writes of non-critical updates
# (change requires restart)
#wal_compression = off # enables compression of full-page writes;
# off, pglz, lz4, zstd, or on
#wal_init_zero = on # zero-fill new WAL files
#wal_recycle = on # recycle WAL files
#wal_buffers = -1 # min 32kB, -1 sets based on shared_buffers
# (change requires restart)
#wal_writer_delay = 200ms # 1-10000 milliseconds
#wal_writer_flush_after = 1MB # measured in pages, 0 disables
#wal_skip_threshold = 2MB
#commit_delay = 0 # range 0-100000, in microseconds
#commit_siblings = 5 # range 1-1000
# - Checkpoints -
#checkpoint_timeout = 5min # range 30s-1d
#checkpoint_completion_target = 0.9 # checkpoint target duration, 0.0 - 1.0
#checkpoint_flush_after = 256kB # measured in pages, 0 disables
#checkpoint_warning = 30s # 0 disables
max_wal_size = 1GB
min_wal_size = 80MB
# - Prefetching during recovery -
#recovery_prefetch = try # prefetch pages referenced in the WAL?
#wal_decode_buffer_size = 512kB # lookahead window used for prefetching
# (change requires restart)
# - Archiving -
#archive_mode = off # enables archiving; off, on, or always
# (change requires restart)
#archive_library = '' # library to use to archive a WAL file
# (empty string indicates archive_command should
# be used)
#archive_command = '' # command to use to archive a WAL file
# placeholders: %p = path of file to archive
# %f = file name only
# e.g. 'test ! -f /mnt/server/archivedir/%f && cp %p /mnt/server/archivedir/%f'
#archive_timeout = 0 # force a WAL file switch after this
# number of seconds; 0 disables
# - Archive Recovery -
# These are only used in recovery mode.
#restore_command = '' # command to use to restore an archived WAL file
# placeholders: %p = path of file to restore
# %f = file name only
# e.g. 'cp /mnt/server/archivedir/%f %p'
#archive_cleanup_command = '' # command to execute at every restartpoint
#recovery_end_command = '' # command to execute at completion of recovery
# - Recovery Target -
# Set these only when performing a targeted recovery.
#recovery_target = '' # 'immediate' to end recovery as soon as a
# consistent state is reached
# (change requires restart)
#recovery_target_name = '' # the named restore point to which recovery will proceed
# (change requires restart)
#recovery_target_time = '' # the time stamp up to which recovery will proceed
# (change requires restart)
#recovery_target_xid = '' # the transaction ID up to which recovery will proceed
# (change requires restart)
#recovery_target_lsn = '' # the WAL LSN up to which recovery will proceed
# (change requires restart)
#recovery_target_inclusive = on # Specifies whether to stop:
# just after the specified recovery target (on)
# just before the recovery target (off)
# (change requires restart)
#recovery_target_timeline = 'latest' # 'current', 'latest', or timeline ID
# (change requires restart)
#recovery_target_action = 'pause' # 'pause', 'promote', 'shutdown'
# (change requires restart)
#------------------------------------------------------------------------------
# REPLICATION
#------------------------------------------------------------------------------
# - Sending Servers -
# Set these on the primary and on any standby that will send replication data.
#max_wal_senders = 10 # max number of walsender processes
# (change requires restart)
#max_replication_slots = 10 # max number of replication slots
# (change requires restart)
#wal_keep_size = 0 # in megabytes; 0 disables
#max_slot_wal_keep_size = -1 # in megabytes; -1 disables
#wal_sender_timeout = 60s # in milliseconds; 0 disables
#track_commit_timestamp = off # collect timestamp of transaction commit
# (change requires restart)
# - Primary Server -
# These settings are ignored on a standby server.
#synchronous_standby_names = '' # standby servers that provide sync rep
# method to choose sync standbys, number of sync standbys,
# and comma-separated list of application_name
# from standby(s); '*' = all
# - Standby Servers -
# These settings are ignored on a primary server.
#primary_conninfo = '' # connection string to sending server
#primary_slot_name = '' # replication slot on sending server
#hot_standby = on # "off" disallows queries during recovery
# (change requires restart)
#max_standby_archive_delay = 30s # max delay before canceling queries
# when reading WAL from archive;
# -1 allows indefinite delay
#max_standby_streaming_delay = 30s # max delay before canceling queries
# when reading streaming WAL;
# -1 allows indefinite delay
#wal_receiver_create_temp_slot = off # create temp slot if primary_slot_name
# is not set
#wal_receiver_status_interval = 10s # send replies at least this often
# 0 disables
#hot_standby_feedback = off # send info from standby to prevent
# query conflicts
#wal_receiver_timeout = 60s # time that receiver waits for
# communication from primary
# in milliseconds; 0 disables
#wal_retrieve_retry_interval = 5s # time to wait before retrying to
# retrieve WAL after a failed attempt
#recovery_min_apply_delay = 0 # minimum delay for applying changes during recovery
# - Subscribers -
# These settings are ignored on a publisher.
#max_logical_replication_workers = 4 # taken from max_worker_processes
# (change requires restart)
#max_sync_workers_per_subscription = 2 # taken from max_logical_replication_workers
#max_parallel_apply_workers_per_subscription = 2 # taken from max_logical_replication_workers
#------------------------------------------------------------------------------
# QUERY TUNING
#------------------------------------------------------------------------------
# - Planner Method Configuration -
#enable_async_append = on
#enable_bitmapscan = on
#enable_gathermerge = on
#enable_hashagg = on
#enable_hashjoin = on
#enable_incremental_sort = on
#enable_indexscan = on
#enable_indexonlyscan = on
#enable_material = on
#enable_memoize = on
#enable_mergejoin = on
#enable_nestloop = on
#enable_parallel_append = on
#enable_parallel_hash = on
#enable_partition_pruning = on
#enable_partitionwise_join = off
#enable_partitionwise_aggregate = off
#enable_presorted_aggregate = on
#enable_seqscan = on
#enable_sort = on
#enable_tidscan = on
# - Planner Cost Constants -
#seq_page_cost = 1.0 # measured on an arbitrary scale
#random_page_cost = 4.0 # same scale as above
#cpu_tuple_cost = 0.01 # same scale as above
#cpu_index_tuple_cost = 0.005 # same scale as above
#cpu_operator_cost = 0.0025 # same scale as above
#parallel_setup_cost = 1000.0 # same scale as above
#parallel_tuple_cost = 0.1 # same scale as above
#min_parallel_table_scan_size = 8MB
#min_parallel_index_scan_size = 512kB
#effective_cache_size = 4GB
#jit_above_cost = 100000 # perform JIT compilation if available
# and query more expensive than this;
# -1 disables
#jit_inline_above_cost = 500000 # inline small functions if query is
# more expensive than this; -1 disables
#jit_optimize_above_cost = 500000 # use expensive JIT optimizations if
# query is more expensive than this;
# -1 disables
# - Genetic Query Optimizer -
#geqo = on
#geqo_threshold = 12
#geqo_effort = 5 # range 1-10
#geqo_pool_size = 0 # selects default based on effort
#geqo_generations = 0 # selects default based on effort
#geqo_selection_bias = 2.0 # range 1.5-2.0
#geqo_seed = 0.0 # range 0.0-1.0
# - Other Planner Options -
#default_statistics_target = 100 # range 1-10000
#constraint_exclusion = partition # on, off, or partition
#cursor_tuple_fraction = 0.1 # range 0.0-1.0
#from_collapse_limit = 8
#jit = on # allow JIT compilation
#join_collapse_limit = 8 # 1 disables collapsing of explicit
# JOIN clauses
#plan_cache_mode = auto # auto, force_generic_plan or
# force_custom_plan
#recursive_worktable_factor = 10.0 # range 0.001-1000000
#------------------------------------------------------------------------------
# REPORTING AND LOGGING
#------------------------------------------------------------------------------
# - Where to Log -
#log_destination = 'stderr' # Valid values are combinations of
# stderr, csvlog, jsonlog, syslog, and
# eventlog, depending on platform.
# csvlog and jsonlog require
# logging_collector to be on.
# This is used when logging to stderr:
#logging_collector = off # Enable capturing of stderr, jsonlog,
# and csvlog into log files. Required
# to be on for csvlogs and jsonlogs.
# (change requires restart)
# These are only used if logging_collector is on:
#log_directory = 'log' # directory where log files are written,
# can be absolute or relative to PGDATA
#log_filename = 'postgresql-%Y-%m-%d_%H%M%S.log' # log file name pattern,
# can include strftime() escapes
#log_file_mode = 0600 # creation mode for log files,
# begin with 0 to use octal notation
#log_rotation_age = 1d # Automatic rotation of logfiles will
# happen after that time. 0 disables.
#log_rotation_size = 10MB # Automatic rotation of logfiles will
# happen after that much log output.
# 0 disables.
#log_truncate_on_rotation = off # If on, an existing log file with the
# same name as the new log file will be
# truncated rather than appended to.
# But such truncation only occurs on
# time-driven rotation, not on restarts
# or size-driven rotation. Default is
# off, meaning append to existing files
# in all cases.
# These are relevant when logging to syslog:
#syslog_facility = 'LOCAL0'
#syslog_ident = 'postgres'
#syslog_sequence_numbers = on
#syslog_split_messages = on
# This is only relevant when logging to eventlog (Windows):
# (change requires restart)
#event_source = 'PostgreSQL'
# - When to Log -
#log_min_messages = warning # values in order of decreasing detail:
# debug5
# debug4
# debug3
# debug2
# debug1
# info
# notice
# warning
# error
# log
# fatal
# panic
#log_min_error_statement = error # values in order of decreasing detail:
# debug5
# debug4
# debug3
# debug2
# debug1
# info
# notice
# warning
# error
# log
# fatal
# panic (effectively off)
#log_min_duration_statement = -1 # -1 is disabled, 0 logs all statements
# and their durations, > 0 logs only
# statements running at least this number
# of milliseconds
#log_min_duration_sample = -1 # -1 is disabled, 0 logs a sample of statements
# and their durations, > 0 logs only a sample of
# statements running at least this number
# of milliseconds;
# sample fraction is determined by log_statement_sample_rate
#log_statement_sample_rate = 1.0 # fraction of logged statements exceeding
# log_min_duration_sample to be logged;
# 1.0 logs all such statements, 0.0 never logs
#log_transaction_sample_rate = 0.0 # fraction of transactions whose statements
# are logged regardless of their duration; 1.0 logs all
# statements from all transactions, 0.0 never logs
#log_startup_progress_interval = 10s # Time between progress updates for
# long-running startup operations.
# 0 disables the feature, > 0 indicates
# the interval in milliseconds.
# - What to Log -
#debug_print_parse = off
#debug_print_rewritten = off
#debug_print_plan = off
#debug_pretty_print = on
#log_autovacuum_min_duration = 10min # log autovacuum activity;
# -1 disables, 0 logs all actions and
# their durations, > 0 logs only
# actions running at least this number
# of milliseconds.
#log_checkpoints = on
#log_connections = off
#log_disconnections = off
#log_duration = off
#log_error_verbosity = default # terse, default, or verbose messages
#log_hostname = off
#log_line_prefix = '%m [%p] ' # special values:
# %a = application name
# %u = user name
# %d = database name
# %r = remote host and port
# %h = remote host
# %b = backend type
# %p = process ID
# %P = process ID of parallel group leader
# %t = timestamp without milliseconds
# %m = timestamp with milliseconds
# %n = timestamp with milliseconds (as a Unix epoch)
# %Q = query ID (0 if none or not computed)
# %i = command tag
# %e = SQL state
# %c = session ID
# %l = session line number
# %s = session start timestamp
# %v = virtual transaction ID
# %x = transaction ID (0 if none)
# %q = stop here in non-session
# processes
# %% = '%'
# e.g. '<%u%%%d> '
#log_lock_waits = off # log lock waits >= deadlock_timeout
#log_recovery_conflict_waits = off # log standby recovery conflict waits
# >= deadlock_timeout
#log_parameter_max_length = -1 # when logging statements, limit logged
# bind-parameter values to N bytes;
# -1 means print in full, 0 disables
#log_parameter_max_length_on_error = 0 # when logging an error, limit logged
# bind-parameter values to N bytes;
# -1 means print in full, 0 disables
#log_statement = 'none' # none, ddl, mod, all
#log_replication_commands = off
#log_temp_files = -1 # log temporary files equal or larger
# than the specified size in kilobytes;
# -1 disables, 0 logs all temp files
log_timezone = 'Etc/UTC'
# - Process Title -
#cluster_name = '' # added to process titles if nonempty
# (change requires restart)
#update_process_title = on
#------------------------------------------------------------------------------
# STATISTICS
#------------------------------------------------------------------------------
# - Cumulative Query and Index Statistics -
#track_activities = on
#track_activity_query_size = 1024 # (change requires restart)
#track_counts = on
#track_io_timing = off
#track_wal_io_timing = off
#track_functions = none # none, pl, all
#stats_fetch_consistency = cache # cache, none, snapshot
# - Monitoring -
#compute_query_id = auto
#log_statement_stats = off
#log_parser_stats = off
#log_planner_stats = off
#log_executor_stats = off
#------------------------------------------------------------------------------
# AUTOVACUUM
#------------------------------------------------------------------------------
#autovacuum = on # Enable autovacuum subprocess? 'on'
# requires track_counts to also be on.
#autovacuum_max_workers = 3 # max number of autovacuum subprocesses
# (change requires restart)
#autovacuum_naptime = 1min # time between autovacuum runs
#autovacuum_vacuum_threshold = 50 # min number of row updates before
# vacuum
#autovacuum_vacuum_insert_threshold = 1000 # min number of row inserts
# before vacuum; -1 disables insert
# vacuums
#autovacuum_analyze_threshold = 50 # min number of row updates before
# analyze
#autovacuum_vacuum_scale_factor = 0.2 # fraction of table size before vacuum
#autovacuum_vacuum_insert_scale_factor = 0.2 # fraction of inserts over table
# size before insert vacuum
#autovacuum_analyze_scale_factor = 0.1 # fraction of table size before analyze
#autovacuum_freeze_max_age = 200000000 # maximum XID age before forced vacuum
# (change requires restart)
#autovacuum_multixact_freeze_max_age = 400000000 # maximum multixact age
# before forced vacuum
# (change requires restart)
#autovacuum_vacuum_cost_delay = 2ms # default vacuum cost delay for
# autovacuum, in milliseconds;
# -1 means use vacuum_cost_delay
#autovacuum_vacuum_cost_limit = -1 # default vacuum cost limit for
# autovacuum, -1 means use
# vacuum_cost_limit
#------------------------------------------------------------------------------
# CLIENT CONNECTION DEFAULTS
#------------------------------------------------------------------------------
# - Statement Behavior -
#client_min_messages = notice # values in order of decreasing detail:
# debug5
# debug4
# debug3
# debug2
# debug1
# log
# notice
# warning
# error
#search_path = '"$user", public' # schema names
#row_security = on
#default_table_access_method = 'heap'
#default_tablespace = '' # a tablespace name, '' uses the default
#default_toast_compression = 'pglz' # 'pglz' or 'lz4'
#temp_tablespaces = '' # a list of tablespace names, '' uses
# only default tablespace
#check_function_bodies = on
#default_transaction_isolation = 'read committed'
#default_transaction_read_only = off
#default_transaction_deferrable = off
#session_replication_role = 'origin'
#statement_timeout = 0 # in milliseconds, 0 is disabled
#lock_timeout = 0 # in milliseconds, 0 is disabled
#idle_in_transaction_session_timeout = 0 # in milliseconds, 0 is disabled
#idle_session_timeout = 0 # in milliseconds, 0 is disabled
#vacuum_freeze_table_age = 150000000
#vacuum_freeze_min_age = 50000000
#vacuum_failsafe_age = 1600000000
#vacuum_multixact_freeze_table_age = 150000000
#vacuum_multixact_freeze_min_age = 5000000
#vacuum_multixact_failsafe_age = 1600000000
#bytea_output = 'hex' # hex, escape
#xmlbinary = 'base64'
#xmloption = 'content'
#gin_pending_list_limit = 4MB
#createrole_self_grant = '' # set and/or inherit
# - Locale and Formatting -
datestyle = 'iso, mdy'
#intervalstyle = 'postgres'
timezone = 'Etc/UTC'
#timezone_abbreviations = 'Default' # Select the set of available time zone
# abbreviations. Currently, there are
# Default
# Australia (historical usage)
# India
# You can create your own file in
# share/timezonesets/.
#extra_float_digits = 1 # min -15, max 3; any value >0 actually
# selects precise output mode
#client_encoding = sql_ascii # actually, defaults to database
# encoding
# These settings are initialized by initdb, but they can be changed.
lc_messages = 'en_US.utf8' # locale for system error message
# strings
lc_monetary = 'en_US.utf8' # locale for monetary formatting
lc_numeric = 'en_US.utf8' # locale for number formatting
lc_time = 'en_US.utf8' # locale for time formatting
#icu_validation_level = warning # report ICU locale validation
# errors at the given level
# default configuration for text search
default_text_search_config = 'pg_catalog.english'
# - Shared Library Preloading -
#local_preload_libraries = ''
#session_preload_libraries = ''
#shared_preload_libraries = '' # (change requires restart)
#jit_provider = 'llvmjit' # JIT library to use
# - Other Defaults -
#dynamic_library_path = '$libdir'
#extension_destdir = '' # prepend path when loading extensions
# and shared objects (added by Debian)
#gin_fuzzy_search_limit = 0
#------------------------------------------------------------------------------
# LOCK MANAGEMENT
#------------------------------------------------------------------------------
#deadlock_timeout = 1s
#max_locks_per_transaction = 64 # min 10
# (change requires restart)
#max_pred_locks_per_transaction = 64 # min 10
# (change requires restart)
#max_pred_locks_per_relation = -2 # negative values mean
# (max_pred_locks_per_transaction
# / -max_pred_locks_per_relation) - 1
#max_pred_locks_per_page = 2 # min 0
#------------------------------------------------------------------------------
# VERSION AND PLATFORM COMPATIBILITY
#------------------------------------------------------------------------------
# - Previous PostgreSQL Versions -
#array_nulls = on
#backslash_quote = safe_encoding # on, off, or safe_encoding
#escape_string_warning = on
#lo_compat_privileges = off
#quote_all_identifiers = off
#standard_conforming_strings = on
#synchronize_seqscans = on
# - Other Platforms and Clients -
#transform_null_equals = off
#------------------------------------------------------------------------------
# ERROR HANDLING
#------------------------------------------------------------------------------
#exit_on_error = off # terminate session on any error?
#restart_after_crash = on # reinitialize after backend crash?
#data_sync_retry = off # retry or panic on failure to fsync
# data?
# (change requires restart)
#recovery_init_sync_method = fsync # fsync, syncfs (Linux 5.8+)
#------------------------------------------------------------------------------
# CONFIG FILE INCLUDES
#------------------------------------------------------------------------------
# These options allow settings to be loaded from files other than the
# default postgresql.conf. Note that these are directives, not variable
# assignments, so they can usefully be given more than once.
#include_dir = '...' # include files ending in '.conf' from
# a directory, e.g., 'conf.d'
#include_if_exists = '...' # include file only if it exists
#include = '...' # include file
#------------------------------------------------------------------------------
# CUSTOMIZED OPTIONS
#------------------------------------------------------------------------------
# Add settings for extensions here