DCS3：3节点DCS

此模板使用3个DCS节点（Consul/ETCD），为最小化生产高可用配置，并自带一个1小时的延时从库

``` 1. --- 2. ###################################################################### 3. # File : pigsty.yml 4. # Desc : Pigsty 3 meta x 3 node minimal HA setup 5. # Link : https://pigsty.cc/#/v-config 6. # Ctime : 2020-05-22 7. # Mtime : 2022-05-22 8. # Copyright (C) 2018-2022 Ruohang Feng (rh@vonng.com) 9. ######################################################################

  2. Sandbox (4-node)

  3. ====================================================================

  4. admin user : vagrant (nopass ssh & sudo already set)

  5. 1. meta-1 : 10.10.10.10 (2 Core | 4GB) pg-meta-1

  6. 2. meta-2 : 10.10.10.11 (1 Core | 1GB) pg-meta-2

  7. 3. meta-3 : 10.10.10.12 (1 Core | 1GB) pg-meta-3

  8. VIP 2: (l2 vip is available inside same LAN )

  9. pg-meta ---> 10.10.10.2 ---> 10.10.10.10

  10. Bootstrap with:

  11. ./infra-demo.yml

  13. all:

  15. CLUSTERS

  17. meta nodes, nodes, pgsql, redis, pgsql clusters are defined as

  18. k:v pair inside all.children. Where the key is cluster name

  19. and value is cluster definition consist of two parts:

  20. hosts: cluster members ip and instance level variables

  21. vars : cluster level variables

  23. children: # groups definition

  24. ================================================================

  25. Meta Nodes: Admin Controller

  26. ================================================================

  27. meta: # meta nodes are defined in this special group "meta"
  28. vars:
  29. meta_node: true # mark this group as meta nodes

  30. ansible_group_priority: 99 # overwrite with the highest priority

  31. nginx_enabled: true # setup repo & underlying nginx

  32. nameserver_enabled: false # setup dnsmasq
  33. prometheus_enabled: true # setup prometheus
  34. grafana_enabled: true # setup grafana
  35. loki_enabled: true # setup loki
  36. docker_enabled: true # setup docker

  37. dcs_safeguard: false # protect dcs server from fat fingers

  38. hosts: # add nodes to group 'meta'

  39. 10.10.10.10: { nodename: meta-1 }
  40. 10.10.10.11: { nodename: meta-2, nginx_enabled: false , prometheus_enabled: false }
  41. 10.10.10.12: { nodename: meta-3, nginx_enabled: false , loki_enabled: false }

  42. ================================================================

  43. ================================================================

  44. PGSQL Clusters

  45. ================================================================

  46. ----------------------------------

  47. pgsql cluster: pg-meta (CMDB)

  48. ----------------------------------

  49. pg-meta:
  50. hosts:
  51. 10.10.10.10: { pg_seq: 1, pg_role: primary }
  52. 10.10.10.11: { pg_seq: 2, pg_role: replica }
  53. 10.10.10.12: { pg_seq: 3, pg_role: replica , pg_offline_query: true }
  54. vars:
  55. pg_cluster: pg-meta
  56. pg_users:
    • { name: dbuser_meta , password: DBUser.Meta , pgbouncer: true , roles: [ dbrole_admin ] , comment: pigsty admin user }
    • { name: dbuser_view , password: DBUser.Viewer , pgbouncer: true , roles: [ dbrole_readonly ] , comment: read-only viewer for meta database }
  59. pg_databases:
    • name: meta
  61. baseline: cmdb.sql
  62. comment: pigsty meta database
  63. connlimit: -1
  64. schemas: [ pigsty ]
  65. extensions:
    • { name: adminpack, schema: pg_catalog }
    • { name: postgis, schema: public }
    • { name: timescaledb }

  69. vip_mode: l2

  70. vip_address: 10.10.10.2
  71. vip_cidrmask: 8
  72. vip_interface: eth1
  73. node_crontab:
    • '00 01 * * * postgres /pg/bin/pg-backup 2>>/pg/log/backup.log'
    • '* * * * * postgres /usr/pgsql/bin/pgbench meta -nv -T15 -c2 2>>/pg/log/bench.log' # some random load

  76. ----------------------------------

  77. pgsql cluster: pg-meta-delay

  78. ----------------------------------

  79. pg-meta-delay:
  80. hosts:
  81. 10.10.10.13: { pg_seq: 1, pg_role: primary, pg_upstream: 10.10.10.10, pg_delay: 1h }
  82. vars:

  83. pg_cluster: pg-meta-delay

  85. VARS

  87. vars: # global variables

  88. version: v1.5.1 # pigsty version string

  89. ================================================================

  90. VARS: INFRA

  91. ================================================================

  92. -----------------------------------------------------------------

  93. CONNECT

  94. -----------------------------------------------------------------

  95. INSTANCE level ansible connect parameters

  96. ansible_user: vagrant # which user to be used (when connecting to remote nodes)

  97. ansible_port: 22 # which port to be used (when connecting to remote nodes)

  98. ansible_host: meta # ssh alias host name (when connecting to remote nodes)

  99. ansible_ssh_private_key_file: ~/.ssh/id_rsa # ssh private key file

  100. ansible_ssh_common_args: '-o StrictHostKeyChecking=no' # ssh common args

  101. proxy_env: # global proxy env when downloading packages

  102. no_proxy: "localhost,127.0.0.1,10.0.0.0/8,192.168.0.0/16,.pigsty,.aliyun.com,mirrors.,.myqcloud.com,*.tsinghua.edu.cn"

  103. http_proxy: # set your proxy here: e.g http://user:pass@proxy.xxx.com

  104. https_proxy: # set your proxy here: e.g http://user:pass@proxy.xxx.com

  105. all_proxy: # set your proxy here: e.g http://user:pass@proxy.xxx.com

  106. -----------------------------------------------------------------

  107. CA

  108. -----------------------------------------------------------------

  109. ca_method: create # create|copy|recreate
  110. ca_subject: "/CN=root-ca" # self-signed CA subject
  111. ca_homedir: /ca # ca cert directory
  112. ca_cert: ca.crt # ca public key/cert

  113. ca_key: ca.key # ca private key

  114. -----------------------------------------------------------------

  115. NGINX

  116. -----------------------------------------------------------------

  117. nginx_enabled: true # build local repo on this node
  118. nginx_port: 80 # repo listen address, must same as repo_address

  119. nginx_home: /www # default repo home dir

  120. nginx_upstream: # domain names and upstream servers

    • { name: home , domain: pigsty , endpoint: "10.10.10.10:80" }
    • { name: grafana , domain: g.pigsty , endpoint: "10.10.10.10:3000" }
    • { name: loki , domain: l.pigsty , endpoint: "10.10.10.10:3100" }
    • { name: prometheus , domain: p.pigsty , endpoint: "10.10.10.10:9090" }
    • { name: alertmanager , domain: a.pigsty , endpoint: "10.10.10.10:9093" }
    • { name: consul , domain: c.pigsty , endpoint: "127.0.0.1:8500" }

  127. nginx_indexes: # application nav links on home page

    • { name: Explain , url : '/pev2' , comment: 'postgres explain visualizer' }
    • { name: Package , url : '/pigsty' , comment: 'local yum repo packages' }
    • { name: PG Logs , url : '/logs' , comment: 'postgres raw csv logs' }
    • { name: Schemas , url : '/schema' , comment: 'schemaspy summary report' }
    • { name: Reports , url : '/report' , comment: 'pgbadger summary report' }

  133. -----------------------------------------------------------------

  134. REPO

  135. -----------------------------------------------------------------

  136. repo_name: pigsty # repo name, pigsty by default
  137. repo_address: pigsty # external address to this repo (ip:port or url)
  138. repo_rebuild: false # force re-download packages
  139. repo_remove: true # remove existing upstream repo
  140. repo_upstreams: # where to download packages?
    • name: base
  142. description: CentOS-$releasever - Base
  143. gpgcheck: no
  144. baseurl:
    • https://mirrors.tuna.tsinghua.edu.cn/centos/$releasever/os/$basearch/
    • http://mirrors.aliyun.com/centos/$releasever/os/$basearch/
    • http://mirror.centos.org/centos/$releasever/os/$basearch/
    • name: updates
  149. description: CentOS-$releasever - Updates
  150. gpgcheck: no
  151. baseurl:
    • https://mirrors.tuna.tsinghua.edu.cn/centos/$releasever/updates/$basearch/
    • http://mirrors.aliyun.com/centos/$releasever/updates/$basearch/
    • http://mirror.centos.org/centos/$releasever/updates/$basearch/
    • name: extras
  156. description: CentOS-$releasever - Extras
  157. baseurl:
    • https://mirrors.tuna.tsinghua.edu.cn/centos/$releasever/extras/$basearch/
    • http://mirrors.aliyun.com/centos/$releasever/extras/$basearch/
    • http://mirror.centos.org/centos/$releasever/extras/$basearch/
  161. gpgcheck: no
    • name: epel
  163. description: CentOS $releasever - epel
  164. gpgcheck: no
  165. baseurl:
    • https://mirrors.tuna.tsinghua.edu.cn/epel/$releasever/$basearch
    • http://mirrors.aliyun.com/epel/$releasever/$basearch
    • http://download.fedoraproject.org/pub/epel/$releasever/$basearch
    • name: grafana
  170. description: Grafana Official Yum Repo
  171. enabled: yes
  172. gpgcheck: no
  173. baseurl:
    • https://mirrors.tuna.tsinghua.edu.cn/grafana/yum/rpm
    • https://packages.grafana.com/oss/rpm
    • name: prometheus
  177. description: Prometheus and exporters
  178. gpgcheck: no
  179. baseurl: https://packagecloud.io/prometheus-rpm/release/el/$releasever/$basearch
    • name: pgdg-common
  181. description: PostgreSQL common RPMs for RHEL/CentOS $releasever - $basearch
  182. gpgcheck: no
  183. baseurl:
    • http://mirrors.tuna.tsinghua.edu.cn/postgresql/repos/yum/common/redhat/rhel-$releasever-$basearch
    • https://download.postgresql.org/pub/repos/yum/common/redhat/rhel-$releasever-$basearch
    • name: pgdg14
  187. description: PostgreSQL 14 for RHEL/CentOS $releasever - $basearch
  188. gpgcheck: no
  189. baseurl:
    • https://mirrors.tuna.tsinghua.edu.cn/postgresql/repos/yum/14/redhat/rhel-$releasever-$basearch
    • https://download.postgresql.org/pub/repos/yum/14/redhat/rhel-$releasever-$basearch
    • name: timescaledb
  193. description: TimescaleDB for RHEL/CentOS $releasever - $basearch
  194. gpgcheck: no
  195. baseurl:
    • https://packagecloud.io/timescale/timescaledb/el/7/$basearch
    • name: centos-sclo
  198. description: CentOS-$releasever - SCLo
  199. gpgcheck: no

  200. mirrorlist: http://mirrorlist.centos.org?arch=$basearch&release=$releasever&repo=sclo-sclo

  201. baseurl: http://mirrors.aliyun.com/centos/$releasever/sclo/$basearch/sclo/
    • name: centos-sclo-rh
  203. description: CentOS-$releasever - SCLo rh
  204. gpgcheck: no

  205. mirrorlist: http://mirrorlist.centos.org?arch=$basearch&release=7&repo=sclo-rh

  206. baseurl: http://mirrors.aliyun.com/centos/$releasever/sclo/$basearch/rh/
    • name: nginx
  208. description: Nginx Official Yum Repo
  209. skip_if_unavailable: true
  210. gpgcheck: no
  211. baseurl: http://nginx.org/packages/centos/$releasever/$basearch/
    • name: harbottle # for latest consul & kubernetes
  213. description: Copr repo for main owned by harbottle
  214. skip_if_unavailable: true
  215. gpgcheck: no
  216. baseurl: https://download.copr.fedorainfracloud.org/results/harbottle/main/epel-$releasever-$basearch/
    • name: pg_probackup # for pg_probackup
  218. description: PG_PROBACKUP Centos packages for PostgresPro Standard and Enterprise - $basearch
  219. skip_if_unavailable: true
  220. gpgcheck: no
  221. baseurl: https://repo.postgrespro.ru/pg_probackup-forks/rpm/latest/centos-$releasever-$basearch
    • name: docker-ce # for latest docker
  223. description: Docker CE Stable - $basearch
  224. skip_if_unavailable: true
  225. gpgcheck: no
  226. baseurl:
    • https://mirrors.aliyun.com/docker-ce/linux/centos/$releasever/$basearch/stable
    • https://download.docker.com/linux/centos/$releasever/$basearch/stable

  229. repo_packages: # which packages to be included # what to download #

    • epel-release nginx wget yum-utils yum createrepo sshpass zip unzip # ---- boot ---- #
    • ntp chrony uuid lz4 bzip2 nc pv jq vim-enhanced make patch bash lsof wget git tuned perf ftp lrzsz rsync # ---- node ---- #
    • numactl grubby sysstat dstat iotop bind-utils net-tools tcpdump socat ipvsadm telnet ca-certificates keepalived # ----- utils ----- #
    • readline zlib openssl openssh-clients libyaml libxml2 libxslt libevent perl perl-devel perl-ExtUtils* # --- deps:pg --- #
    • readline-devel zlib-devel uuid-devel libuuid-devel libxml2-devel libxslt-devel openssl-devel libicu-devel # --- deps:devel -- #
    • grafana prometheus2 pushgateway alertmanager mtail consul consul_exporter consul-template etcd dnsmasq # ----- meta ----- #
    • node_exporter nginx_exporter blackbox_exporter redis_exporter # ---- exporter --- #
    • ansible python python-pip python-psycopg2 # - ansible & py3 - #
    • python3 python3-psycopg2 python36-requests python3-etcd python3-consul python36-urllib3 python36-idna python36-pyOpenSSL python36-cryptography
    • patroni patroni-consul patroni-etcd pgbouncer pg_cli pgbadger pg_activity tail_n_mail # -- pgsql common - #
    • pgcenter boxinfo check_postgres emaj pgbconsole pg_bloat_check pgquarrel barman barman-cli pgloader pgFormatter pitrery pspg pgxnclient PyGreSQL
    • postgresql14 postgis32_14 citus_14 pglogical_14 timescaledb-2-postgresql-14 pg_repack_14 wal2json_14 # -- pg14 packages -#
    • pg_qualstats_14 pg_stat_kcache_14 pg_stat_monitor_14 pg_top_14 pg_track_settings_14 pg_wait_sampling_14 pg_probackup-std-14
    • pg_statement_rollback_14 system_stats_14 plproxy_14 plsh_14 pldebugger_14 plpgsql_check_14 pgmemcache_14 # plr_14
    • mysql_fdw_14 ogr_fdw_14 tds_fdw_14 sqlite_fdw_14 firebird_fdw_14 hdfs_fdw_14 mongo_fdw_14 osm_fdw_14 pgbouncer_fdw_14
    • hypopg_14 geoip_14 rum_14 hll_14 ip4r_14 prefix_14 pguri_14 tdigest_14 topn_14 periods_14
    • bgw_replstatus_14 count_distinct_14 credcheck_14 ddlx_14 extra_window_functions_14 logerrors_14 mysqlcompat_14 orafce_14
    • repmgr_14 pg_auth_mon_14 pg_auto_failover_14 pg_background_14 pg_bulkload_14 pg_catcheck_14 pg_comparator_14
    • pg_cron_14 pg_fkpart_14 pg_jobmon_14 pg_partman_14 pg_permissions_14 pg_prioritize_14 pgagent_14
    • pgaudit16_14 pgauditlogtofile_14 pgcryptokey_14 pgexportdoc_14 pgfincore_14 pgimportdoc_14 powa_14 pgmp_14 pgq_14
    • pgquarrel-0.7.0-1 pgsql_tweaks_14 pgtap_14 pgtt_14 postgresql-unit_14 postgresql_anonymizer_14 postgresql_faker_14
    • safeupdate_14 semver_14 set_user_14 sslutils_14 table_version_14 # pgrouting_14 osm2pgrouting_14
    • clang coreutils diffutils rpm-build rpm-devel rpmlint rpmdevtools bison flex # gcc gcc-c++ # - build utils - #
    • docker-ce docker-compose kubelet kubectl kubeadm kubernetes-cni helm # - cloud native- #

  254. repo_url_packages: # extra packages from url

    • https://github.com/Vonng/loki-rpm/releases/download/v2.5.0/loki-2.5.0.x86_64.rpm
    • https://github.com/Vonng/loki-rpm/releases/download/v2.5.0/promtail-2.5.0.x86_64.rpm
    • https://github.com/Vonng/pg_exporter/releases/download/v0.5.0/pg_exporter-0.5.0.x86_64.rpm
    • https://github.com/cybertec-postgresql/vip-manager/releases/download/v1.0.2/vip-manager-1.0.2-1.x86_64.rpm
    • https://github.com/Vonng/haproxy-rpm/releases/download/v2.5.7/haproxy-2.5.7-1.el7.x86_64.rpm
    • https://github.com/Vonng/pigsty-pkg/releases/download/misc/redis-6.2.7-1.el7.remi.x86_64.rpm
    • https://github.com/dalibo/pev2/releases/download/v0.24.0/pev2.tar.gz
    • https://github.com/Vonng/pigsty-pkg/releases/download/misc/polysh-0.4-1.noarch.rpm

  263. -----------------------------------------------------------------

  264. NAMESERVER

  265. -----------------------------------------------------------------

  266. nameserver_enabled: false # setup dnsmasq
  267. dns_records: # dynamic dns record resolved by dnsmasq
    • 10.10.10.2 pg-meta # sandbox vip for pg-meta
    • 10.10.10.3 pg-test # sandbox vip for pg-test
    • 10.10.10.10 pg-meta-1 # sandbox instance pg-meta-1
    • 10.10.10.11 pg-test-1 # sandbox instance node-1
    • 10.10.10.12 pg-test-2 # sandbox instance node-2
    • 10.10.10.13 pg-test-3 # sandbox instance node-3

  274. -----------------------------------------------------------------

  275. PROMETHEUS

  276. -----------------------------------------------------------------

  277. prometheus_enabled: true # setup prometheus
  278. prometheus_data_dir: /data/prometheus/data
  279. prometheus_options: '--storage.tsdb.retention=15d'
  280. prometheus_reload: false # reload prometheus instead of recreate it?
  281. prometheus_sd_method: static # service discovery method: static|consul
  282. prometheus_sd_interval: 5s # service discovery refresh interval
  283. prometheus_scrape_interval: 10s # global scrape & evaluation interval

  284. prometheus_scrape_timeout: 8s # scrape timeout

  285. -----------------------------------------------------------------

  286. EXPORTER

  287. -----------------------------------------------------------------

  288. exporter_install: none # none|yum|binary, none by default
  289. exporter_repo_url: '' # if set, repo will be added to /etc/yum.repos.d/

  290. exporter_metrics_path: /metrics # default metric path for pg related exporter

  291. -----------------------------------------------------------------

  292. GRAFANA

  293. -----------------------------------------------------------------

  294. grafana_enabled: true # enable grafana? only works on meta nodes
  295. grafana_endpoint: http://10.10.10.10:3000 # grafana endpoint url
  296. grafana_admin_username: admin # default grafana admin username
  297. grafana_admin_password: pigsty # default grafana admin password
  298. grafana_database: sqlite3 # default grafana database type: sqlite3|postgres

  299. grafana_pgurl: postgres://dbuser_grafana:DBUser.Grafana@meta:5436/grafana

  300. grafana_plugin_method: install # none|install|always, none will skip plugin install

  301. grafana_plugin_cache: /www/pigsty/plugins.tgz # path to grafana plugins cache tarball
  302. grafana_plugin_list: # plugins that will be downloaded via grafana-cli
    • marcusolsson-csv-datasource
    • marcusolsson-json-datasource
    • marcusolsson-treemap-panel
  306. grafana_plugin_git: # plugins that will be downloaded via git
    • https://github.com/Vonng/vonng-echarts-panel

  308. -----------------------------------------------------------------

  309. LOKI

  310. -----------------------------------------------------------------

  311. loki_enabled: true # enable loki? only works on meta nodes
  312. loki_clean: false # whether remove existing loki data
  313. loki_endpoint: http://10.10.10.10:3100/loki/api/v1/push # where to push data
  314. loki_options: '-config.file=/etc/loki.yml -config.expand-env=true'
  315. loki_data_dir: /data/loki # default loki data dir

  316. loki_retention: 15d # log retention period

  317. -----------------------------------------------------------------

  318. DCS

  319. -----------------------------------------------------------------

  320. dcs_name: pigsty # consul dc name
  321. dcs_servers: # dcs server dict in name:ip format
  322. meta-1: 10.10.10.10 # using existing external dcs cluster is recommended for HA
  323. meta-2: 10.10.10.11 # node with ip in dcs_servers will be initialized as dcs servers
  324. meta-3: 10.10.10.12 # it's recommend to reuse meta nodes as dcs servers if no ad hoc cluster available
  325. dcs_registry: consul # where to register services: none | consul | etcd | both
  326. dcs_safeguard: false # if true, running dcs will NOT be removed

  327. dcs_clean: true # if true, running dcs will be purged during node init, DANGEROUS

  328. -----------------------------------------------------------------

  329. CONSUL

  330. -----------------------------------------------------------------

  331. consul_enabled: true # enable consul server/agent by default?

  332. consul_data_dir: /data/consul # consul data dir (/data/consul by default)

  333. -----------------------------------------------------------------

  334. ETCD

  335. -----------------------------------------------------------------

  336. etcd_enabled: true # enable etcd server by default?

  337. etcd_data_dir: /data/etcd # etcd data dir (/data/etcd by default)

  338. ================================================================

  339. VARS: NODES

  340. ================================================================

  341. global variables for nodes (including meta)

  342. -----------------------------------------------------------------

  343. NODE_IDENTITY

  344. -----------------------------------------------------------------

  345. meta_node: false # node with meta_node flag will be marked as admin node

  346. nodename: # [OPTIONAL] # node instance identity, used as ins, hostname by default

  347. node_cluster: nodes # [OPTIONAL] # node cluster identity, used as cls, 'nodes' by default
  348. nodename_overwrite: true # overwrite node's hostname with nodename?

  349. nodename_exchange: false # exchange nodename among play hosts?

  350. -----------------------------------------------------------------

  351. NODE_DNS

  352. -----------------------------------------------------------------

  353. node_etc_hosts_default: # static dns records in /etc/hosts
    • 10.10.10.10 meta pigsty p.pigsty g.pigsty a.pigsty c.pigsty l.pigsty
    • 10.10.10.10 api.pigsty adm.pigsty cli.pigsty ddl.pigsty lab.pigsty git.pigsty sss.pigsty

  356. node_etc_hosts: [] # extra static dns records in /etc/hosts

  357. node_dns_method: add # add (default) | none (skip) | overwrite (remove old settings)

  358. node_dns_servers: # dynamic nameserver in /etc/resolv.conf
    • 10.10.10.10
  360. node_dns_options: # dns resolv options
    • options single-request-reopen timeout:1 rotate
    • domain service.consul

  363. -----------------------------------------------------------------

  364. NODE_REPO

  365. -----------------------------------------------------------------

  366. node_repo_method: local # none|local: ad local repo|public: add upstream directly
  367. node_repo_remove: true # remove existing repo on nodes?
  368. node_repo_local_urls: # list local repo url, if node_repo_method = local
    • http://pigsty/pigsty.repo

  370. node_packages: [ ] # extra packages for all nodes

  371. node_packages_default: # common packages for all nodes
    • wget,sshpass,ntp,chrony,tuned,uuid,lz4,make,patch,bash,lsof,wget,unzip,git,ftp,vim-minimal,ca-certificates
    • numactl,grubby,sysstat,dstat,iotop,bind-utils,net-tools,tcpdump,socat,ipvsadm,telnet,tuned,nc,pv,jq,perf
    • readline,zlib,openssl,openssl-libs,openssh-clients,python3,python36-requests,node_exporter,consul,etcd,promtail
  375. node_packages_meta: # extra packages for meta nodes
    • grafana,prometheus2,alertmanager,loki,nginx_exporter,blackbox_exporter,pushgateway,redis,postgresql14
    • nginx,ansible,pgbadger,python-psycopg2,dnsmasq,coreutils,diffutils,polysh,docker-ce,docker-compose

  378. node_packages_meta_pip: jupyterlab

  379. -----------------------------------------------------------------

  380. NODE_TUNE

  381. -----------------------------------------------------------------

  382. node_disable_firewall: true # disable firewall
  383. node_disable_selinux: true # disable selinux
  384. node_disable_numa: false # disable numa (node reboot required)
  385. node_disable_swap: false # disable swap, use with caution
  386. node_static_network: true # keep dns resolver settings after reboot
  387. node_disk_prefetch: false # setup disk prefetch on HDD to increase performance
  388. node_kernel_modules: [ softdog, br_netfilter, ip_vs, ip_vs_rr, ip_vs_rr, ip_vs_wrr, ip_vs_sh ]
  389. node_tune: tiny # install and activate tuned profile: none|oltp|olap|crit|tiny

  390. node_sysctl_params: { } # set additional sysctl parameters, k:v format

  391. -----------------------------------------------------------------

  392. NODE_ADMIN

  393. -----------------------------------------------------------------

  394. node_data_dir: /data # main data directory
  395. node_admin_enabled: true # create a default admin user defined by node_admin_* ?
  396. node_admin_uid: 88 # uid and gid for this admin user
  397. node_admin_username: dba # name of this admin user, dba by default
  398. node_admin_ssh_exchange: true # exchange admin ssh key among each pgsql cluster ?
  399. node_admin_pk_current: true # add current user's ~/.ssh/id_rsa.pub to admin authorized_keys ?
  400. node_admin_pk_list: # ssh public keys to be added to admin user (REPLACE WITH YOURS!)
    • 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC7IMAMNavYtWwzAJajKqwdn3ar5BhvcwCnBTxxEkXhGlCO2vfgosSAQMEflfgvkiI5nM1HIFQ8KINlx1XLO7SdL5KdInG5LIJjAFh0pujS4kNCT9a5IGvSq1BrzGqhbEcwWYdju1ZPYBcJm/MG+JD0dYCh8vfrYB/cYMD0SOmNkQ== vagrant@pigsty.com'

  402. -----------------------------------------------------------------

  403. NODE_TIME

  404. -----------------------------------------------------------------

  405. node_timezone: Asia/Hong_Kong # default node timezone, empty will not change
  406. node_ntp_enabled: true # enable ntp service? false will leave ntp service untouched
  407. node_ntp_service: ntp # ntp service provider: ntp|chrony
  408. node_ntp_servers: # default NTP servers
    • pool cn.pool.ntp.org iburst
    • pool pool.ntp.org iburst
    • pool time.pool.aliyun.com iburst
    • server 10.10.10.10 iburst
    • server ntp.tuna.tsinghua.edu.cn iburst
  414. node_crontab_overwrite: true # true will overwrite /etc/crontab, false will append crontab

  415. node_crontab: [ ] # crontab entries in /etc/crontab

  416. -----------------------------------------------------------------

  417. DOCKER

  418. -----------------------------------------------------------------

  419. docker_enabled: false # enable docker on all nodes? (you can enable them on meta nodes only)
  420. docker_cgroups_driver: systemd # docker cgroup fs driver
  421. docker_registry_mirrors: [] # docker registry mirror

  422. docker_image_cache: /tmp/docker.tgz # docker images tarball to be loaded if exists

  423. -----------------------------------------------------------------

  424. NODE_EXPORTER

  425. -----------------------------------------------------------------

  426. node_exporter_enabled: true # setup node_exporter on instance
  427. node_exporter_port: 9100 # default port for node exporter

  428. node_exporter_options: '--no-collector.softnet --no-collector.nvme --collector.ntp --collector.tcpstat --collector.processes'

  429. -----------------------------------------------------------------

  430. PROMTAIL

  431. -----------------------------------------------------------------

  432. promtail_enabled: true # enable promtail logging collector?
  433. promtail_clean: false # remove promtail status file? false by default
  434. promtail_port: 9080 # default listen address for promtail
  435. promtail_options: '-config.file=/etc/promtail.yml -config.expand-env=true'

  436. promtail_positions: /var/log/positions.yaml # position status for promtail

  437. ================================================================

  438. VARS: PGSQL

  439. ================================================================

  440. -----------------------------------------------------------------

  441. PG_IDENTITY

  442. -----------------------------------------------------------------

  443. pg_cluster: # <CLUSTER> <REQUIRED> : pgsql cluster name

  444. pg_role: replica # <INSTANCE> <REQUIRED> : pg role : primary, replica, offline

  445. pg_seq: 0 # <INSTANCE> <REQUIRED> : instance seq number

  446. pg_instances: {} # <INSTANCE> : define multiple pg instances on node, used by monly & gpsql

  447. pg_upstream: # <INSTANCE> : replication upstream ip addr

  448. pg_shard: # <CLUSTER> : pgsql shard name

  449. pg_sindex: 0 # <CLUSTER> : pgsql shard index

  450. gp_role: master # <CLUSTER> : gpsql role, master or segment

  451. pg_offline_query: false # <INSTANCE> [FLAG] set to true to enable offline query on this instance (instance level)

  452. pg_backup: false # <INSTANCE> [FLAG] store base backup on this node (instance level, reserved)
  453. pg_weight: 100 # <INSTANCE> [FLAG] default load balance weight (instance level)
  454. pg_hostname: true # [FLAG] reuse postgres identity name as node identity?

  455. pg_preflight_skip: false # [FLAG] skip preflight identity check

  456. -----------------------------------------------------------------

  457. PG_BUSINESS

  458. -----------------------------------------------------------------

  459. overwrite these variables on <CLUSTER> level

  460. pg_users: [] # business users
  461. pg_databases: [] # business databases
  462. pg_services_extra: [] # extra services
  463. pg_hba_rules_extra: [] # extra hba rules

  464. pgbouncer_hba_rules_extra: [] # extra pgbouncer hba rules

  465. WARNING: change these in production environment!

  466. pg_admin_username: dbuser_dba
  467. pg_admin_password: DBUser.DBA
  468. pg_monitor_username: dbuser_monitor
  469. pg_monitor_password: DBUser.Monitor
  470. pg_replication_username: replicator

  471. pg_replication_password: DBUser.Replicator

  472. -----------------------------------------------------------------

  473. PG_INSTALL

  474. -----------------------------------------------------------------

  475. pg_dbsu: postgres # os user for database, postgres by default (unwise to change it)
  476. pg_dbsu_uid: 26 # os dbsu uid and gid, 26 for default postgres users and groups
  477. pg_dbsu_sudo: limit # dbsu sudo privilege: none|limit|all|nopass, limit by default
  478. pg_dbsu_home: /var/lib/pgsql # postgresql home directory
  479. pg_dbsu_ssh_exchange: true # exchange postgres dbsu ssh key among same cluster ?
  480. pg_version: 14 # default postgresql version to be installed
  481. pgdg_repo: false # add pgdg official repo before install (in case of no local repo available)
  482. pg_add_repo: false # add postgres relate repo before install ?
  483. pg_bin_dir: /usr/pgsql/bin # postgres binary dir, default is /usr/pgsql/bin, which use /usr/pgsql -> /usr/pgsql-{ver}
  484. pg_packages: # postgresql related packages. ${pg_version} will be replaced bypg_version`
    • postgresql${pg_version}* # postgresql kernel packages
    • postgis32_${pg_version}* # postgis
    • citus_${pg_version}* # citus
    • timescaledb-2-postgresql-${pg_version} # timescaledb
    • pgbouncer pg_exporter pgbadger pg_activity node_exporter consul haproxy vip-manager
    • patroni patroni-consul patroni-etcd python3 python3-psycopg2 python36-requests python3-etcd
    • python3-consul python36-urllib3 python36-idna python36-pyOpenSSL python36-cryptography
  492. pg_extensions: # postgresql extensions, ${pg_version} will be replaced by actualpg_version`
    • pg_repack_${pg_version} pg_qualstats_${pg_version} pg_stat_kcache_${pg_version} pg_stat_monitor_${pg_version} wal2json_${pg_version}

  494. - ogr_fdw${pg_version} mysql_fdw_${pg_version} redis_fdw_${pg_version} mongo_fdw${pg_version} hdfs_fdw_${pg_version}

  495. - count_distinct${version} ddlx_${version} geoip${version} orafce${version}

  496. - hypopg_${version} ip4r${version} jsquery_${version} logerrors_${version} periods_${version} pg_auto_failover_${version} pg_catcheck${version}

  497. - pg_fkpart${version} pg_jobmon${version} pg_partman${version} pg_prioritize_${version} pg_track_settings${version} pgaudit15_${version}

  498. - pgcryptokey${version} pgexportdoc${version} pgimportdoc${version} pgmemcache-${version} pgmp${version} pgq-${version} pgquarrel pgrouting_${version}

  499. - pguint${version} pguri${version} prefix${version} safeupdate_${version} semver${version} table_version${version} tdigest${version}

  500. -----------------------------------------------------------------

  501. PG_BOOTSTRAP

  502. -----------------------------------------------------------------

  503. pg_safeguard: false # true will disable pg_clean at all, even for pgsql-remove.yml
  504. pg_clean: true # true will clean running postgres during pgsql init (DANGEROUS)
  505. pg_data: /pg/data # postgres data directory (soft link)
  506. pg_fs_main: /data # primary data disk mount point /pg -> {{ pg_fs_main }}/postgres/{{ pg_instance }}
  507. pg_fs_bkup: /data/backups # backup disk mount point /pg/ -> {{ pg_fs_bkup }}/postgres/{{ pg_instance }}/
  508. pg_dummy_filesize: 64MiB # /pg/dummy hold some disk space for emergency use
  509. pg_listen: '0.0.0.0' # postgres listen address, '0.0.0.0' (all ipv4 addr) by default
  510. pg_port: 5432 # postgres port, 5432 by default
  511. pg_localhost: /var/run/postgresql # localhost unix socket dir for connection
  512. patroni_enabled: true # if not enabled, no postgres cluster will be created
  513. patroni_mode: default # pause|default|remove
  514. pg_dcs_type: consul # which dcs to use: consul or etcd or raft
  515. pg_namespace: /pg # top level key namespace in dcs
  516. patroni_port: 8008 # default patroni port
  517. patroni_watchdog_mode: automatic # watchdog mode: off|automatic|required
  518. pg_conf: tiny.yml # pgsql template: {oltp|olap|crit|tiny}.yml
  519. pg_libs: 'timescaledb, pg_stat_statements, auto_explain' # extensions to be loaded
  520. pg_delay: 0 # apply delay for standby cluster leader
  521. pg_checksum: false # enable data checksum by default
  522. pg_encoding: UTF8 # database cluster encoding, UTF8 by default
  523. pg_locale: C # database cluster local, C by default
  524. pg_lc_collate: C # database cluster collate, C by default
  525. pg_lc_ctype: en_US.UTF8 # database character type, en_US.UTF8 by default (for i18n full-text search)
  526. pgbouncer_enabled: true # if not enabled, pgbouncer will not be created
  527. pgbouncer_port: 6432 # pgbouncer port, 6432 by default
  528. pgbouncer_poolmode: transaction # pooling mode: session|transaction|statement, transaction pooling by default

  529. pgbouncer_max_db_conn: 100 # max connection to single database, DO NOT set this larger than postgres max conn or db connlimit

  530. -----------------------------------------------------------------

  531. PG_PROVISION

  532. -----------------------------------------------------------------

  533. pg_provision: true # whether provisioning postgres cluster

  534. pg_init: pg-init # init script for cluster template

  535. pg_default_roles:

    • { name: dbrole_readonly , login: false , comment: role for global read-only access } # production read-only role
    • { name: dbrole_readwrite , login: false , roles: [dbrole_readonly], comment: role for global read-write access } # production read-write role
    • { name: dbrole_offline , login: false , comment: role for restricted read-only access (offline instance) } # restricted-read-only role
    • { name: dbrole_admin , login: false , roles: [pg_monitor, dbrole_readwrite] , comment: role for object creation } # production DDL change role
    • { name: postgres , superuser: true , comment: system superuser } # system dbsu, name is designated by pg_dbsu
    • { name: dbuser_dba , superuser: true , roles: [dbrole_admin] , comment: system admin user } # admin dbsu, name is designated by pg_admin_username
    • { name: replicator , replication: true , bypassrls: true , roles: [pg_monitor, dbrole_readonly] , comment: system replicator } # replicator
    • { name: dbuser_monitor , roles: [pg_monitor, dbrole_readonly] , comment: system monitor user , parameters: {log_min_duration_statement: 1000 } } # monitor user
    • { name: dbuser_stats , password: DBUser.Stats , roles: [dbrole_offline] , comment: business offline user for offline queries and ETL } # ETL user
  545. pg_default_privileges: # - privileges - #
    • GRANT USAGE ON SCHEMAS TO dbrole_readonly
    • GRANT SELECT ON TABLES TO dbrole_readonly
    • GRANT SELECT ON SEQUENCES TO dbrole_readonly
    • GRANT EXECUTE ON FUNCTIONS TO dbrole_readonly
    • GRANT USAGE ON SCHEMAS TO dbrole_offline
    • GRANT SELECT ON TABLES TO dbrole_offline
    • GRANT SELECT ON SEQUENCES TO dbrole_offline
    • GRANT EXECUTE ON FUNCTIONS TO dbrole_offline
    • GRANT INSERT, UPDATE, DELETE ON TABLES TO dbrole_readwrite
    • GRANT USAGE, UPDATE ON SEQUENCES TO dbrole_readwrite
    • GRANT TRUNCATE, REFERENCES, TRIGGER ON TABLES TO dbrole_admin
    • GRANT CREATE ON SCHEMAS TO dbrole_admin
  558. pg_default_schemas: [ monitor ] # default schemas to be created
  559. pg_default_extensions: # default extensions to be created
    • { name: 'pg_stat_statements', schema: 'monitor' }
    • { name: 'pgstattuple', schema: 'monitor' }
    • { name: 'pg_qualstats', schema: 'monitor' }
    • { name: 'pg_buffercache', schema: 'monitor' }
    • { name: 'pageinspect', schema: 'monitor' }
    • { name: 'pg_prewarm', schema: 'monitor' }
    • { name: 'pg_visibility', schema: 'monitor' }
    • { name: 'pg_freespacemap', schema: 'monitor' }
    • { name: 'pg_repack', schema: 'monitor' }
    • name: postgres_fdw
    • name: file_fdw
    • name: btree_gist
    • name: btree_gin
    • name: pg_trgm
    • name: intagg
    • name: intarray

  576. pg_reload: true # reload postgres after hba changes

  577. pg_hba_rules: # postgres host-based authentication rules
    • title: allow meta node password access
  579. role: common
  580. rules:
    • host all all 10.10.10.10/32 md5
    • title: allow intranet admin password access
  583. role: common
  584. rules:
    • host all +dbrole_admin 10.0.0.0/8 md5
    • host all +dbrole_admin 172.16.0.0/12 md5
    • host all +dbrole_admin 192.168.0.0/16 md5
    • title: allow intranet password access
  589. role: common
  590. rules:
    • host all all 10.0.0.0/8 md5
    • host all all 172.16.0.0/12 md5
    • host all all 192.168.0.0/16 md5
    • title: allow local read/write (local production user via pgbouncer)
  595. role: common
  596. rules:
    • local all +dbrole_readonly md5
    • host all +dbrole_readonly 127.0.0.1/32 md5
    • title: allow offline query (ETL,SAGA,Interactive) on offline instance
  600. role: offline
  601. rules:
    • host all +dbrole_offline 10.0.0.0/8 md5
    • host all +dbrole_offline 172.16.0.0/12 md5
    • host all +dbrole_offline 192.168.0.0/16 md5

  605. pgbouncer_hba_rules: # pgbouncer host-based authentication rules

    • title: local password access
  607. role: common
  608. rules:
    • local all all md5
    • host all all 127.0.0.1/32 md5
    • title: intranet password access
  612. role: common
  613. rules:
    • host all all 10.0.0.0/8 md5
    • host all all 172.16.0.0/12 md5
    • host all all 192.168.0.0/16 md5

  617. -----------------------------------------------------------------

  618. PG_EXPORTER

  619. -----------------------------------------------------------------

  620. pg_exporter_enabled: true # setup pg_exporter on instance
  621. pg_exporter_config: pg_exporter.yml # use fast cache exporter for demo
  622. pg_exporter_port: 9630 # pg_exporter listen port
  623. pg_exporter_params: 'sslmode=disable' # url query parameters for pg_exporter
  624. pg_exporter_url: '' # optional, overwrite auto-generate postgres connstr
  625. pg_exporter_auto_discovery: true # optional, discovery available database on target instance ?
  626. pg_exporter_exclude_database: 'template0,template1,postgres' # optional, comma separated list of database that WILL NOT be monitored when auto-discovery enabled
  627. pg_exporter_include_database: '' # optional, comma separated list of database that WILL BE monitored when auto-discovery enabled, empty string will disable include mode
  628. pg_exporter_options: '--log.level=info --log.format="logger:syslog?appname=pg_exporter&local=7"'
  629. pgbouncer_exporter_enabled: true # setup pgbouncer_exporter on instance (if you don't have pgbouncer, disable it)
  630. pgbouncer_exporter_port: 9631 # pgbouncer_exporter listen port
  631. pgbouncer_exporter_url: '' # optional, overwrite auto-generate pgbouncer connstr

  632. pgbouncer_exporter_options: '--log.level=info --log.format="logger:syslog?appname=pgbouncer_exporter&local=7"'

  633. -----------------------------------------------------------------

  634. PG_SERVICE

  635. -----------------------------------------------------------------

  636. pg_services: # how to expose postgres service in cluster?
    • name: primary # service name {{ pg_cluster }}-primary
  638. src_ip: "*"
  639. src_port: 5433
  640. dst_port: pgbouncer # 5433 route to pgbouncer
  641. check_url: /primary # primary health check, success when instance is primary
  642. selector: "[]" # select all instance as pr

（本文超出站点单文档体积上限，已截断）