DCS3:3 DCS Servers

Pigsty 3 meta x 3 node minimal HA setup

  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. ######################################################################
  10. ######################################################################
  11. # Sandbox (4-node) #
  12. #====================================================================#
  13. # admin user : vagrant (nopass ssh & sudo already set) #
  14. # 1. meta-1 : 10.10.10.10 (2 Core | 4GB) pg-meta-1 #
  15. # 2. meta-2 : 10.10.10.11 (1 Core | 1GB) pg-meta-2 #
  16. # 3. meta-3 : 10.10.10.12 (1 Core | 1GB) pg-meta-3 #
  17. # VIP 2: (l2 vip is available inside same LAN ) #
  18. # pg-meta ---> 10.10.10.2 ---> 10.10.10.10 #
  19. # Bootstrap with: #
  20. # ./infra-demo.yml #
  21. ######################################################################
  22. all:
  23. ##################################################################
  24. # CLUSTERS #
  25. ##################################################################
  26. # meta nodes, nodes, pgsql, redis, pgsql clusters are defined as
  27. # k:v pair inside `all.children`. Where the key is cluster name
  28. # and value is cluster definition consist of two parts:
  29. # `hosts`: cluster members ip and instance level variables
  30. # `vars` : cluster level variables
  31. ##################################################################
  32. children: # groups definition
  33. #================================================================#
  34. # Meta Nodes: Admin Controller #
  35. #================================================================#
  36. meta: # meta nodes are defined in this special group "meta"
  37. vars:
  38. meta_node: true # mark this group as meta nodes
  39. ansible_group_priority: 99 # overwrite with the highest priority
  40. nginx_enabled: true # setup repo & underlying nginx
  41. nameserver_enabled: false # setup dnsmasq
  42. prometheus_enabled: true # setup prometheus
  43. grafana_enabled: true # setup grafana
  44. loki_enabled: true # setup loki
  45. docker_enabled: true # setup docker
  46. dcs_safeguard: false # protect dcs server from fat fingers
  47. hosts: # add nodes to group 'meta'
  48. 10.10.10.10: { nodename: meta-1 }
  49. 10.10.10.11: { nodename: meta-2, nginx_enabled: false , prometheus_enabled: false }
  50. 10.10.10.12: { nodename: meta-3, nginx_enabled: false , loki_enabled: false }
  51. #================================================================#
  52. #================================================================#
  53. # PGSQL Clusters #
  54. #================================================================#
  55. #----------------------------------#
  56. # pgsql cluster: pg-meta (CMDB) #
  57. #----------------------------------#
  58. pg-meta:
  59. hosts:
  60. 10.10.10.10: { pg_seq: 1, pg_role: primary }
  61. 10.10.10.11: { pg_seq: 2, pg_role: replica }
  62. 10.10.10.12: { pg_seq: 3, pg_role: replica , pg_offline_query: true }
  63. vars:
  64. pg_cluster: pg-meta
  65. pg_users:
  66. - { name: dbuser_meta , password: DBUser.Meta , pgbouncer: true , roles: [ dbrole_admin ] , comment: pigsty admin user }
  67. - { name: dbuser_view , password: DBUser.Viewer , pgbouncer: true , roles: [ dbrole_readonly ] , comment: read-only viewer for meta database }
  68. pg_databases:
  69. - name: meta
  70. baseline: cmdb.sql
  71. comment: pigsty meta database
  72. connlimit: -1
  73. schemas: [ pigsty ]
  74. extensions:
  75. - { name: adminpack, schema: pg_catalog }
  76. - { name: postgis, schema: public }
  77. - { name: timescaledb }
  78. vip_mode: l2
  79. vip_address: 10.10.10.2
  80. vip_cidrmask: 8
  81. vip_interface: eth1
  82. node_crontab:
  83. - '00 01 * * * postgres /pg/bin/pg-backup 2>>/pg/log/backup.log'
  84. - '* * * * * postgres /usr/pgsql/bin/pgbench meta -nv -T15 -c2 2>>/pg/log/bench.log' # some random load
  85. #----------------------------------#
  86. # pgsql cluster: pg-meta-delay #
  87. #----------------------------------#
  88. pg-meta-delay:
  89. hosts:
  90. 10.10.10.13: { pg_seq: 1, pg_role: primary, pg_upstream: 10.10.10.10, pg_delay: 1h }
  91. vars:
  92. pg_cluster: pg-meta-delay
  93. ####################################################################
  94. # VARS #
  95. ####################################################################
  96. vars: # global variables
  97. version: v1.5.1 # pigsty version string
  98. #================================================================#
  99. # VARS: INFRA #
  100. #================================================================#
  101. #-----------------------------------------------------------------
  102. # CONNECT
  103. #-----------------------------------------------------------------
  104. # INSTANCE level ansible connect parameters
  105. # ansible_user: vagrant # which user to be used (when connecting to remote nodes)
  106. # ansible_port: 22 # which port to be used (when connecting to remote nodes)
  107. # ansible_host: meta # ssh alias host name (when connecting to remote nodes)
  108. # ansible_ssh_private_key_file: ~/.ssh/id_rsa # ssh private key file
  109. # ansible_ssh_common_args: '-o StrictHostKeyChecking=no' # ssh common args
  110. proxy_env: # global proxy env when downloading packages
  111. 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"
  112. # http_proxy: # set your proxy here: e.g http://user:pass@proxy.xxx.com
  113. # https_proxy: # set your proxy here: e.g http://user:pass@proxy.xxx.com
  114. # all_proxy: # set your proxy here: e.g http://user:pass@proxy.xxx.com
  115. #-----------------------------------------------------------------
  116. # CA
  117. #-----------------------------------------------------------------
  118. ca_method: create # create|copy|recreate
  119. ca_subject: "/CN=root-ca" # self-signed CA subject
  120. ca_homedir: /ca # ca cert directory
  121. ca_cert: ca.crt # ca public key/cert
  122. ca_key: ca.key # ca private key
  123. #-----------------------------------------------------------------
  124. # NGINX
  125. #-----------------------------------------------------------------
  126. nginx_enabled: true # build local repo on this node
  127. nginx_port: 80 # repo listen address, must same as repo_address
  128. nginx_home: /www # default repo home dir
  129. nginx_upstream: # domain names and upstream servers
  130. - { name: home , domain: pigsty , endpoint: "10.10.10.10:80" }
  131. - { name: grafana , domain: g.pigsty , endpoint: "10.10.10.10:3000" }
  132. - { name: loki , domain: l.pigsty , endpoint: "10.10.10.10:3100" }
  133. - { name: prometheus , domain: p.pigsty , endpoint: "10.10.10.10:9090" }
  134. - { name: alertmanager , domain: a.pigsty , endpoint: "10.10.10.10:9093" }
  135. - { name: consul , domain: c.pigsty , endpoint: "127.0.0.1:8500" }
  136. nginx_indexes: # application nav links on home page
  137. - { name: Explain , url : '/pev2' , comment: 'postgres explain visualizer' }
  138. - { name: Package , url : '/pigsty' , comment: 'local yum repo packages' }
  139. - { name: PG Logs , url : '/logs' , comment: 'postgres raw csv logs' }
  140. - { name: Schemas , url : '/schema' , comment: 'schemaspy summary report' }
  141. - { name: Reports , url : '/report' , comment: 'pgbadger summary report' }
  142. #-----------------------------------------------------------------
  143. # REPO
  144. #-----------------------------------------------------------------
  145. repo_name: pigsty # repo name, pigsty by default
  146. repo_address: pigsty # external address to this repo (ip:port or url)
  147. repo_rebuild: false # force re-download packages
  148. repo_remove: true # remove existing upstream repo
  149. repo_upstreams: # where to download packages?
  150. - name: base
  151. description: CentOS-$releasever - Base
  152. gpgcheck: no
  153. baseurl:
  154. - https://mirrors.tuna.tsinghua.edu.cn/centos/$releasever/os/$basearch/
  155. - http://mirrors.aliyun.com/centos/$releasever/os/$basearch/
  156. - http://mirror.centos.org/centos/$releasever/os/$basearch/
  157. - name: updates
  158. description: CentOS-$releasever - Updates
  159. gpgcheck: no
  160. baseurl:
  161. - https://mirrors.tuna.tsinghua.edu.cn/centos/$releasever/updates/$basearch/
  162. - http://mirrors.aliyun.com/centos/$releasever/updates/$basearch/
  163. - http://mirror.centos.org/centos/$releasever/updates/$basearch/
  164. - name: extras
  165. description: CentOS-$releasever - Extras
  166. baseurl:
  167. - https://mirrors.tuna.tsinghua.edu.cn/centos/$releasever/extras/$basearch/
  168. - http://mirrors.aliyun.com/centos/$releasever/extras/$basearch/
  169. - http://mirror.centos.org/centos/$releasever/extras/$basearch/
  170. gpgcheck: no
  171. - name: epel
  172. description: CentOS $releasever - epel
  173. gpgcheck: no
  174. baseurl:
  175. - https://mirrors.tuna.tsinghua.edu.cn/epel/$releasever/$basearch
  176. - http://mirrors.aliyun.com/epel/$releasever/$basearch
  177. - http://download.fedoraproject.org/pub/epel/$releasever/$basearch
  178. - name: grafana
  179. description: Grafana Official Yum Repo
  180. enabled: yes
  181. gpgcheck: no
  182. baseurl:
  183. - https://mirrors.tuna.tsinghua.edu.cn/grafana/yum/rpm
  184. - https://packages.grafana.com/oss/rpm
  185. - name: prometheus
  186. description: Prometheus and exporters
  187. gpgcheck: no
  188. baseurl: https://packagecloud.io/prometheus-rpm/release/el/$releasever/$basearch
  189. - name: pgdg-common
  190. description: PostgreSQL common RPMs for RHEL/CentOS $releasever - $basearch
  191. gpgcheck: no
  192. baseurl:
  193. - http://mirrors.tuna.tsinghua.edu.cn/postgresql/repos/yum/common/redhat/rhel-$releasever-$basearch
  194. - https://download.postgresql.org/pub/repos/yum/common/redhat/rhel-$releasever-$basearch
  195. - name: pgdg14
  196. description: PostgreSQL 14 for RHEL/CentOS $releasever - $basearch
  197. gpgcheck: no
  198. baseurl:
  199. - https://mirrors.tuna.tsinghua.edu.cn/postgresql/repos/yum/14/redhat/rhel-$releasever-$basearch
  200. - https://download.postgresql.org/pub/repos/yum/14/redhat/rhel-$releasever-$basearch
  201. - name: timescaledb
  202. description: TimescaleDB for RHEL/CentOS $releasever - $basearch
  203. gpgcheck: no
  204. baseurl:
  205. - https://packagecloud.io/timescale/timescaledb/el/7/$basearch
  206. - name: centos-sclo
  207. description: CentOS-$releasever - SCLo
  208. gpgcheck: no
  209. #mirrorlist: http://mirrorlist.centos.org?arch=$basearch&release=$releasever&repo=sclo-sclo
  210. baseurl: http://mirrors.aliyun.com/centos/$releasever/sclo/$basearch/sclo/
  211. - name: centos-sclo-rh
  212. description: CentOS-$releasever - SCLo rh
  213. gpgcheck: no
  214. #mirrorlist: http://mirrorlist.centos.org?arch=$basearch&release=7&repo=sclo-rh
  215. baseurl: http://mirrors.aliyun.com/centos/$releasever/sclo/$basearch/rh/
  216. - name: nginx
  217. description: Nginx Official Yum Repo
  218. skip_if_unavailable: true
  219. gpgcheck: no
  220. baseurl: http://nginx.org/packages/centos/$releasever/$basearch/
  221. - name: harbottle # for latest consul & kubernetes
  222. description: Copr repo for main owned by harbottle
  223. skip_if_unavailable: true
  224. gpgcheck: no
  225. baseurl: https://download.copr.fedorainfracloud.org/results/harbottle/main/epel-$releasever-$basearch/
  226. - name: pg_probackup # for pg_probackup
  227. description: PG_PROBACKUP Centos packages for PostgresPro Standard and Enterprise - $basearch
  228. skip_if_unavailable: true
  229. gpgcheck: no
  230. baseurl: https://repo.postgrespro.ru/pg_probackup-forks/rpm/latest/centos-$releasever-$basearch
  231. - name: docker-ce # for latest docker
  232. description: Docker CE Stable - $basearch
  233. skip_if_unavailable: true
  234. gpgcheck: no
  235. baseurl:
  236. - https://mirrors.aliyun.com/docker-ce/linux/centos/$releasever/$basearch/stable
  237. - https://download.docker.com/linux/centos/$releasever/$basearch/stable
  238. repo_packages: # which packages to be included # what to download #
  239. - epel-release nginx wget yum-utils yum createrepo sshpass zip unzip # ---- boot ---- #
  240. - ntp chrony uuid lz4 bzip2 nc pv jq vim-enhanced make patch bash lsof wget git tuned perf ftp lrzsz rsync # ---- node ---- #
  241. - numactl grubby sysstat dstat iotop bind-utils net-tools tcpdump socat ipvsadm telnet ca-certificates keepalived # ----- utils ----- #
  242. - readline zlib openssl openssh-clients libyaml libxml2 libxslt libevent perl perl-devel perl-ExtUtils* # --- deps:pg --- #
  243. - readline-devel zlib-devel uuid-devel libuuid-devel libxml2-devel libxslt-devel openssl-devel libicu-devel # --- deps:devel -- #
  244. - grafana prometheus2 pushgateway alertmanager mtail consul consul_exporter consul-template etcd dnsmasq # ----- meta ----- #
  245. - node_exporter nginx_exporter blackbox_exporter redis_exporter # ---- exporter --- #
  246. - ansible python python-pip python-psycopg2 # - ansible & py3 - #
  247. - python3 python3-psycopg2 python36-requests python3-etcd python3-consul python36-urllib3 python36-idna python36-pyOpenSSL python36-cryptography
  248. - patroni patroni-consul patroni-etcd pgbouncer pg_cli pgbadger pg_activity tail_n_mail # -- pgsql common - #
  249. - pgcenter boxinfo check_postgres emaj pgbconsole pg_bloat_check pgquarrel barman barman-cli pgloader pgFormatter pitrery pspg pgxnclient PyGreSQL
  250. - postgresql14* postgis32_14* citus_14* pglogical_14* timescaledb-2-postgresql-14 pg_repack_14 wal2json_14 # -- pg14 packages -#
  251. - 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
  252. - pg_statement_rollback_14 system_stats_14 plproxy_14 plsh_14 pldebugger_14 plpgsql_check_14 pgmemcache_14 # plr_14
  253. - 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
  254. - hypopg_14 geoip_14 rum_14 hll_14 ip4r_14 prefix_14 pguri_14 tdigest_14 topn_14 periods_14
  255. - bgw_replstatus_14 count_distinct_14 credcheck_14 ddlx_14 extra_window_functions_14 logerrors_14 mysqlcompat_14 orafce_14
  256. - repmgr_14 pg_auth_mon_14 pg_auto_failover_14 pg_background_14 pg_bulkload_14 pg_catcheck_14 pg_comparator_14
  257. - pg_cron_14 pg_fkpart_14 pg_jobmon_14 pg_partman_14 pg_permissions_14 pg_prioritize_14 pgagent_14
  258. - pgaudit16_14 pgauditlogtofile_14 pgcryptokey_14 pgexportdoc_14 pgfincore_14 pgimportdoc_14 powa_14 pgmp_14 pgq_14
  259. - pgquarrel-0.7.0-1 pgsql_tweaks_14 pgtap_14 pgtt_14 postgresql-unit_14 postgresql_anonymizer_14 postgresql_faker_14
  260. - safeupdate_14 semver_14 set_user_14 sslutils_14 table_version_14 # pgrouting_14 osm2pgrouting_14
  261. - clang coreutils diffutils rpm-build rpm-devel rpmlint rpmdevtools bison flex # gcc gcc-c++ # - build utils - #
  262. - docker-ce docker-compose kubelet kubectl kubeadm kubernetes-cni helm # - cloud native- #
  263. repo_url_packages: # extra packages from url
  264. - https://github.com/Vonng/loki-rpm/releases/download/v2.5.0/loki-2.5.0.x86_64.rpm
  265. - https://github.com/Vonng/loki-rpm/releases/download/v2.5.0/promtail-2.5.0.x86_64.rpm
  266. - https://github.com/Vonng/pg_exporter/releases/download/v0.5.0/pg_exporter-0.5.0.x86_64.rpm
  267. - https://github.com/cybertec-postgresql/vip-manager/releases/download/v1.0.2/vip-manager-1.0.2-1.x86_64.rpm
  268. - https://github.com/Vonng/haproxy-rpm/releases/download/v2.5.7/haproxy-2.5.7-1.el7.x86_64.rpm
  269. - https://github.com/Vonng/pigsty-pkg/releases/download/misc/redis-6.2.7-1.el7.remi.x86_64.rpm
  270. - https://github.com/dalibo/pev2/releases/download/v0.24.0/pev2.tar.gz
  271. - https://github.com/Vonng/pigsty-pkg/releases/download/misc/polysh-0.4-1.noarch.rpm
  272. #-----------------------------------------------------------------
  273. # NAMESERVER
  274. #-----------------------------------------------------------------
  275. nameserver_enabled: false # setup dnsmasq
  276. dns_records: # dynamic dns record resolved by dnsmasq
  277. - 10.10.10.2 pg-meta # sandbox vip for pg-meta
  278. - 10.10.10.3 pg-test # sandbox vip for pg-test
  279. - 10.10.10.10 pg-meta-1 # sandbox instance pg-meta-1
  280. - 10.10.10.11 pg-test-1 # sandbox instance node-1
  281. - 10.10.10.12 pg-test-2 # sandbox instance node-2
  282. - 10.10.10.13 pg-test-3 # sandbox instance node-3
  283. #-----------------------------------------------------------------
  284. # PROMETHEUS
  285. #-----------------------------------------------------------------
  286. prometheus_enabled: true # setup prometheus
  287. prometheus_data_dir: /data/prometheus/data
  288. prometheus_options: '--storage.tsdb.retention=15d'
  289. prometheus_reload: false # reload prometheus instead of recreate it?
  290. prometheus_sd_method: static # service discovery method: static|consul
  291. prometheus_sd_interval: 5s # service discovery refresh interval
  292. prometheus_scrape_interval: 10s # global scrape & evaluation interval
  293. prometheus_scrape_timeout: 8s # scrape timeout
  294. #-----------------------------------------------------------------
  295. # EXPORTER
  296. #-----------------------------------------------------------------
  297. exporter_install: none # none|yum|binary, none by default
  298. exporter_repo_url: '' # if set, repo will be added to /etc/yum.repos.d/
  299. exporter_metrics_path: /metrics # default metric path for pg related exporter
  300. #-----------------------------------------------------------------
  301. # GRAFANA
  302. #-----------------------------------------------------------------
  303. grafana_enabled: true # enable grafana? only works on meta nodes
  304. grafana_endpoint: http://10.10.10.10:3000 # grafana endpoint url
  305. grafana_admin_username: admin # default grafana admin username
  306. grafana_admin_password: pigsty # default grafana admin password
  307. grafana_database: sqlite3 # default grafana database type: sqlite3|postgres
  308. grafana_pgurl: postgres://dbuser_grafana:DBUser.Grafana@meta:5436/grafana
  309. grafana_plugin_method: install # none|install|always, none will skip plugin install
  310. grafana_plugin_cache: /www/pigsty/plugins.tgz # path to grafana plugins cache tarball
  311. grafana_plugin_list: # plugins that will be downloaded via grafana-cli
  312. - marcusolsson-csv-datasource
  313. - marcusolsson-json-datasource
  314. - marcusolsson-treemap-panel
  315. grafana_plugin_git: # plugins that will be downloaded via git
  316. - https://github.com/Vonng/vonng-echarts-panel
  317. #-----------------------------------------------------------------
  318. # LOKI
  319. #-----------------------------------------------------------------
  320. loki_enabled: true # enable loki? only works on meta nodes
  321. loki_clean: false # whether remove existing loki data
  322. loki_endpoint: http://10.10.10.10:3100/loki/api/v1/push # where to push data
  323. loki_options: '-config.file=/etc/loki.yml -config.expand-env=true'
  324. loki_data_dir: /data/loki # default loki data dir
  325. loki_retention: 15d # log retention period
  326. #-----------------------------------------------------------------
  327. # DCS
  328. #-----------------------------------------------------------------
  329. dcs_name: pigsty # consul dc name
  330. dcs_servers: # dcs server dict in name:ip format
  331. meta-1: 10.10.10.10 # using existing external dcs cluster is recommended for HA
  332. meta-2: 10.10.10.11 # node with ip in dcs_servers will be initialized as dcs servers
  333. meta-3: 10.10.10.12 # it's recommend to reuse meta nodes as dcs servers if no ad hoc cluster available
  334. dcs_registry: consul # where to register services: none | consul | etcd | both
  335. dcs_safeguard: false # if true, running dcs will NOT be removed
  336. dcs_clean: true # if true, running dcs will be purged during node init, DANGEROUS
  337. #-----------------------------------------------------------------
  338. # CONSUL
  339. #-----------------------------------------------------------------
  340. consul_enabled: true # enable consul server/agent by default?
  341. consul_data_dir: /data/consul # consul data dir (/data/consul by default)
  342. #-----------------------------------------------------------------
  343. # ETCD
  344. #-----------------------------------------------------------------
  345. etcd_enabled: true # enable etcd server by default?
  346. etcd_data_dir: /data/etcd # etcd data dir (/data/etcd by default)
  347. #================================================================#
  348. # VARS: NODES #
  349. #================================================================#
  350. # global variables for nodes (including meta)
  351. #-----------------------------------------------------------------
  352. # NODE_IDENTITY
  353. #-----------------------------------------------------------------
  354. meta_node: false # node with meta_node flag will be marked as admin node
  355. # nodename: # [OPTIONAL] # node instance identity, used as `ins`, hostname by default
  356. node_cluster: nodes # [OPTIONAL] # node cluster identity, used as `cls`, 'nodes' by default
  357. nodename_overwrite: true # overwrite node's hostname with nodename?
  358. nodename_exchange: false # exchange nodename among play hosts?
  359. #-----------------------------------------------------------------
  360. # NODE_DNS
  361. #-----------------------------------------------------------------
  362. node_etc_hosts_default: # static dns records in /etc/hosts
  363. - 10.10.10.10 meta pigsty p.pigsty g.pigsty a.pigsty c.pigsty l.pigsty
  364. - 10.10.10.10 api.pigsty adm.pigsty cli.pigsty ddl.pigsty lab.pigsty git.pigsty sss.pigsty
  365. node_etc_hosts: [] # extra static dns records in /etc/hosts
  366. node_dns_method: add # add (default) | none (skip) | overwrite (remove old settings)
  367. node_dns_servers: # dynamic nameserver in /etc/resolv.conf
  368. - 10.10.10.10
  369. node_dns_options: # dns resolv options
  370. - options single-request-reopen timeout:1 rotate
  371. - domain service.consul
  372. #-----------------------------------------------------------------
  373. # NODE_REPO
  374. #-----------------------------------------------------------------
  375. node_repo_method: local # none|local: ad local repo|public: add upstream directly
  376. node_repo_remove: true # remove existing repo on nodes?
  377. node_repo_local_urls: # list local repo url, if node_repo_method = local
  378. - http://pigsty/pigsty.repo
  379. node_packages: [ ] # extra packages for all nodes
  380. node_packages_default: # common packages for all nodes
  381. - wget,sshpass,ntp,chrony,tuned,uuid,lz4,make,patch,bash,lsof,wget,unzip,git,ftp,vim-minimal,ca-certificates
  382. - numactl,grubby,sysstat,dstat,iotop,bind-utils,net-tools,tcpdump,socat,ipvsadm,telnet,tuned,nc,pv,jq,perf
  383. - readline,zlib,openssl,openssl-libs,openssh-clients,python3,python36-requests,node_exporter,consul,etcd,promtail
  384. node_packages_meta: # extra packages for meta nodes
  385. - grafana,prometheus2,alertmanager,loki,nginx_exporter,blackbox_exporter,pushgateway,redis,postgresql14
  386. - nginx,ansible,pgbadger,python-psycopg2,dnsmasq,coreutils,diffutils,polysh,docker-ce,docker-compose
  387. node_packages_meta_pip: jupyterlab
  388. #-----------------------------------------------------------------
  389. # NODE_TUNE
  390. #-----------------------------------------------------------------
  391. node_disable_firewall: true # disable firewall
  392. node_disable_selinux: true # disable selinux
  393. node_disable_numa: false # disable numa (node reboot required)
  394. node_disable_swap: false # disable swap, use with caution
  395. node_static_network: true # keep dns resolver settings after reboot
  396. node_disk_prefetch: false # setup disk prefetch on HDD to increase performance
  397. node_kernel_modules: [ softdog, br_netfilter, ip_vs, ip_vs_rr, ip_vs_rr, ip_vs_wrr, ip_vs_sh ]
  398. node_tune: tiny # install and activate tuned profile: none|oltp|olap|crit|tiny
  399. node_sysctl_params: { } # set additional sysctl parameters, k:v format
  400. #-----------------------------------------------------------------
  401. # NODE_ADMIN
  402. #-----------------------------------------------------------------
  403. node_data_dir: /data # main data directory
  404. node_admin_enabled: true # create a default admin user defined by `node_admin_*` ?
  405. node_admin_uid: 88 # uid and gid for this admin user
  406. node_admin_username: dba # name of this admin user, dba by default
  407. node_admin_ssh_exchange: true # exchange admin ssh key among each pgsql cluster ?
  408. node_admin_pk_current: true # add current user's ~/.ssh/id_rsa.pub to admin authorized_keys ?
  409. node_admin_pk_list: # ssh public keys to be added to admin user (REPLACE WITH YOURS!)
  410. - 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC7IMAMNavYtWwzAJajKqwdn3ar5BhvcwCnBTxxEkXhGlCO2vfgosSAQMEflfgvkiI5nM1HIFQ8KINlx1XLO7SdL5KdInG5LIJjAFh0pujS4kNCT9a5IGvSq1BrzGqhbEcwWYdju1ZPYBcJm/MG+JD0dYCh8vfrYB/cYMD0SOmNkQ== vagrant@pigsty.com'
  411. #-----------------------------------------------------------------
  412. # NODE_TIME
  413. #-----------------------------------------------------------------
  414. node_timezone: Asia/Hong_Kong # default node timezone, empty will not change
  415. node_ntp_enabled: true # enable ntp service? false will leave ntp service untouched
  416. node_ntp_service: ntp # ntp service provider: ntp|chrony
  417. node_ntp_servers: # default NTP servers
  418. - pool cn.pool.ntp.org iburst
  419. - pool pool.ntp.org iburst
  420. - pool time.pool.aliyun.com iburst
  421. - server 10.10.10.10 iburst
  422. - server ntp.tuna.tsinghua.edu.cn iburst
  423. node_crontab_overwrite: true # true will overwrite /etc/crontab, false will append crontab
  424. node_crontab: [ ] # crontab entries in /etc/crontab
  425. #-----------------------------------------------------------------
  426. # DOCKER
  427. #-----------------------------------------------------------------
  428. docker_enabled: false # enable docker on all nodes? (you can enable them on meta nodes only)
  429. docker_cgroups_driver: systemd # docker cgroup fs driver
  430. docker_registry_mirrors: [] # docker registry mirror
  431. docker_image_cache: /tmp/docker.tgz # docker images tarball to be loaded if exists
  432. #-----------------------------------------------------------------
  433. # NODE_EXPORTER
  434. #-----------------------------------------------------------------
  435. node_exporter_enabled: true # setup node_exporter on instance
  436. node_exporter_port: 9100 # default port for node exporter
  437. node_exporter_options: '--no-collector.softnet --no-collector.nvme --collector.ntp --collector.tcpstat --collector.processes'
  438. #-----------------------------------------------------------------
  439. # PROMTAIL
  440. #-----------------------------------------------------------------
  441. promtail_enabled: true # enable promtail logging collector?
  442. promtail_clean: false # remove promtail status file? false by default
  443. promtail_port: 9080 # default listen address for promtail
  444. promtail_options: '-config.file=/etc/promtail.yml -config.expand-env=true'
  445. promtail_positions: /var/log/positions.yaml # position status for promtail
  446. #================================================================#
  447. # VARS: PGSQL #
  448. #================================================================#
  449. #-----------------------------------------------------------------
  450. # PG_IDENTITY
  451. #-----------------------------------------------------------------
  452. # pg_cluster: # <CLUSTER> <REQUIRED> : pgsql cluster name
  453. # pg_role: replica # <INSTANCE> <REQUIRED> : pg role : primary, replica, offline
  454. # pg_seq: 0 # <INSTANCE> <REQUIRED> : instance seq number
  455. # pg_instances: {} # <INSTANCE> : define multiple pg instances on node, used by monly & gpsql
  456. # pg_upstream: # <INSTANCE> : replication upstream ip addr
  457. # pg_shard: # <CLUSTER> : pgsql shard name
  458. # pg_sindex: 0 # <CLUSTER> : pgsql shard index
  459. # gp_role: master # <CLUSTER> : gpsql role, master or segment
  460. pg_offline_query: false # <INSTANCE> [FLAG] set to true to enable offline query on this instance (instance level)
  461. pg_backup: false # <INSTANCE> [FLAG] store base backup on this node (instance level, reserved)
  462. pg_weight: 100 # <INSTANCE> [FLAG] default load balance weight (instance level)
  463. pg_hostname: true # [FLAG] reuse postgres identity name as node identity?
  464. pg_preflight_skip: false # [FLAG] skip preflight identity check
  465. #-----------------------------------------------------------------
  466. # PG_BUSINESS
  467. #-----------------------------------------------------------------
  468. # overwrite these variables on <CLUSTER> level
  469. pg_users: [] # business users
  470. pg_databases: [] # business databases
  471. pg_services_extra: [] # extra services
  472. pg_hba_rules_extra: [] # extra hba rules
  473. pgbouncer_hba_rules_extra: [] # extra pgbouncer hba rules
  474. # WARNING: change these in production environment!
  475. pg_admin_username: dbuser_dba
  476. pg_admin_password: DBUser.DBA
  477. pg_monitor_username: dbuser_monitor
  478. pg_monitor_password: DBUser.Monitor
  479. pg_replication_username: replicator
  480. pg_replication_password: DBUser.Replicator
  481. #-----------------------------------------------------------------
  482. # PG_INSTALL
  483. #-----------------------------------------------------------------
  484. pg_dbsu: postgres # os user for database, postgres by default (unwise to change it)
  485. pg_dbsu_uid: 26 # os dbsu uid and gid, 26 for default postgres users and groups
  486. pg_dbsu_sudo: limit # dbsu sudo privilege: none|limit|all|nopass, limit by default
  487. pg_dbsu_home: /var/lib/pgsql # postgresql home directory
  488. pg_dbsu_ssh_exchange: true # exchange postgres dbsu ssh key among same cluster ?
  489. pg_version: 14 # default postgresql version to be installed
  490. pgdg_repo: false # add pgdg official repo before install (in case of no local repo available)
  491. pg_add_repo: false # add postgres relate repo before install ?
  492. pg_bin_dir: /usr/pgsql/bin # postgres binary dir, default is /usr/pgsql/bin, which use /usr/pgsql -> /usr/pgsql-{ver}
  493. pg_packages: # postgresql related packages. `${pg_version} will be replaced by `pg_version`
  494. - postgresql${pg_version}* # postgresql kernel packages
  495. - postgis32_${pg_version}* # postgis
  496. - citus_${pg_version}* # citus
  497. - timescaledb-2-postgresql-${pg_version} # timescaledb
  498. - pgbouncer pg_exporter pgbadger pg_activity node_exporter consul haproxy vip-manager
  499. - patroni patroni-consul patroni-etcd python3 python3-psycopg2 python36-requests python3-etcd
  500. - python3-consul python36-urllib3 python36-idna python36-pyOpenSSL python36-cryptography
  501. pg_extensions: # postgresql extensions, `${pg_version} will be replaced by actual `pg_version`
  502. - pg_repack_${pg_version} pg_qualstats_${pg_version} pg_stat_kcache_${pg_version} pg_stat_monitor_${pg_version} wal2json_${pg_version}
  503. # - ogr_fdw${pg_version} mysql_fdw_${pg_version} redis_fdw_${pg_version} mongo_fdw${pg_version} hdfs_fdw_${pg_version}
  504. # - count_distinct${version} ddlx_${version} geoip${version} orafce${version}
  505. # - hypopg_${version} ip4r${version} jsquery_${version} logerrors_${version} periods_${version} pg_auto_failover_${version} pg_catcheck${version}
  506. # - pg_fkpart${version} pg_jobmon${version} pg_partman${version} pg_prioritize_${version} pg_track_settings${version} pgaudit15_${version}
  507. # - pgcryptokey${version} pgexportdoc${version} pgimportdoc${version} pgmemcache-${version} pgmp${version} pgq-${version} pgquarrel pgrouting_${version}
  508. # - pguint${version} pguri${version} prefix${version} safeupdate_${version} semver${version} table_version${version} tdigest${version}
  509. #-----------------------------------------------------------------
  510. # PG_BOOTSTRAP
  511. #-----------------------------------------------------------------
  512. pg_safeguard: false # true will disable pg_clean at all, even for pgsql-remove.yml
  513. pg_clean: true # true will clean running postgres during pgsql init (DANGEROUS)
  514. pg_data: /pg/data # postgres data directory (soft link)
  515. pg_fs_main: /data # primary data disk mount point /pg -> {{ pg_fs_main }}/postgres/{{ pg_instance }}
  516. pg_fs_bkup: /data/backups # backup disk mount point /pg/* -> {{ pg_fs_bkup }}/postgres/{{ pg_instance }}/*
  517. pg_dummy_filesize: 64MiB # /pg/dummy hold some disk space for emergency use
  518. pg_listen: '0.0.0.0' # postgres listen address, '0.0.0.0' (all ipv4 addr) by default
  519. pg_port: 5432 # postgres port, 5432 by default
  520. pg_localhost: /var/run/postgresql # localhost unix socket dir for connection
  521. patroni_enabled: true # if not enabled, no postgres cluster will be created
  522. patroni_mode: default # pause|default|remove
  523. pg_dcs_type: consul # which dcs to use: consul or etcd or raft
  524. pg_namespace: /pg # top level key namespace in dcs
  525. patroni_port: 8008 # default patroni port
  526. patroni_watchdog_mode: automatic # watchdog mode: off|automatic|required
  527. pg_conf: tiny.yml # pgsql template: {oltp|olap|crit|tiny}.yml
  528. pg_libs: 'timescaledb, pg_stat_statements, auto_explain' # extensions to be loaded
  529. pg_delay: 0 # apply delay for standby cluster leader
  530. pg_checksum: false # enable data checksum by default
  531. pg_encoding: UTF8 # database cluster encoding, UTF8 by default
  532. pg_locale: C # database cluster local, C by default
  533. pg_lc_collate: C # database cluster collate, C by default
  534. pg_lc_ctype: en_US.UTF8 # database character type, en_US.UTF8 by default (for i18n full-text search)
  535. pgbouncer_enabled: true # if not enabled, pgbouncer will not be created
  536. pgbouncer_port: 6432 # pgbouncer port, 6432 by default
  537. pgbouncer_poolmode: transaction # pooling mode: session|transaction|statement, transaction pooling by default
  538. pgbouncer_max_db_conn: 100 # max connection to single database, DO NOT set this larger than postgres max conn or db connlimit
  539. #-----------------------------------------------------------------
  540. # PG_PROVISION
  541. #-----------------------------------------------------------------
  542. pg_provision: true # whether provisioning postgres cluster
  543. pg_init: pg-init # init script for cluster template
  544. pg_default_roles:
  545. - { name: dbrole_readonly , login: false , comment: role for global read-only access } # production read-only role
  546. - { name: dbrole_readwrite , login: false , roles: [dbrole_readonly], comment: role for global read-write access } # production read-write role
  547. - { name: dbrole_offline , login: false , comment: role for restricted read-only access (offline instance) } # restricted-read-only role
  548. - { name: dbrole_admin , login: false , roles: [pg_monitor, dbrole_readwrite] , comment: role for object creation } # production DDL change role
  549. - { name: postgres , superuser: true , comment: system superuser } # system dbsu, name is designated by `pg_dbsu`
  550. - { name: dbuser_dba , superuser: true , roles: [dbrole_admin] , comment: system admin user } # admin dbsu, name is designated by `pg_admin_username`
  551. - { name: replicator , replication: true , bypassrls: true , roles: [pg_monitor, dbrole_readonly] , comment: system replicator } # replicator
  552. - { name: dbuser_monitor , roles: [pg_monitor, dbrole_readonly] , comment: system monitor user , parameters: {log_min_duration_statement: 1000 } } # monitor user
  553. - { name: dbuser_stats , password: DBUser.Stats , roles: [dbrole_offline] , comment: business offline user for offline queries and ETL } # ETL user
  554. pg_default_privileges: # - privileges - #
  555. - GRANT USAGE ON SCHEMAS TO dbrole_readonly
  556. - GRANT SELECT ON TABLES TO dbrole_readonly
  557. - GRANT SELECT ON SEQUENCES TO dbrole_readonly
  558. - GRANT EXECUTE ON FUNCTIONS TO dbrole_readonly
  559. - GRANT USAGE ON SCHEMAS TO dbrole_offline
  560. - GRANT SELECT ON TABLES TO dbrole_offline
  561. - GRANT SELECT ON SEQUENCES TO dbrole_offline
  562. - GRANT EXECUTE ON FUNCTIONS TO dbrole_offline
  563. - GRANT INSERT, UPDATE, DELETE ON TABLES TO dbrole_readwrite
  564. - GRANT USAGE, UPDATE ON SEQUENCES TO dbrole_readwrite
  565. - GRANT TRUNCATE, REFERENCES, TRIGGER ON TABLES TO dbrole_admin
  566. - GRANT CREATE ON SCHEMAS TO dbrole_admin
  567. pg_default_schemas: [ monitor ] # default schemas to be created
  568. pg_default_extensions: # default extensions to be created
  569. - { name: 'pg_stat_statements', schema: 'monitor' }
  570. - { name: 'pgstattuple', schema: 'monitor' }
  571. - { name: 'pg_qualstats', schema: 'monitor' }
  572. - { name: 'pg_buffercache', schema: 'monitor' }
  573. - { name: 'pageinspect', schema: 'monitor' }
  574. - { name: 'pg_prewarm', schema: 'monitor' }
  575. - { name: 'pg_visibility', schema: 'monitor' }
  576. - { name: 'pg_freespacemap', schema: 'monitor' }
  577. - { name: 'pg_repack', schema: 'monitor' }
  578. - name: postgres_fdw
  579. - name: file_fdw
  580. - name: btree_gist
  581. - name: btree_gin
  582. - name: pg_trgm
  583. - name: intagg
  584. - name: intarray
  585. pg_reload: true # reload postgres after hba changes
  586. pg_hba_rules: # postgres host-based authentication rules
  587. - title: allow meta node password access
  588. role: common
  589. rules:
  590. - host all all 10.10.10.10/32 md5
  591. - title: allow intranet admin password access
  592. role: common
  593. rules:
  594. - host all +dbrole_admin 10.0.0.0/8 md5
  595. - host all +dbrole_admin 172.16.0.0/12 md5
  596. - host all +dbrole_admin 192.168.0.0/16 md5
  597. - title: allow intranet password access
  598. role: common
  599. rules:
  600. - host all all 10.0.0.0/8 md5
  601. - host all all 172.16.0.0/12 md5
  602. - host all all 192.168.0.0/16 md5
  603. - title: allow local read/write (local production user via pgbouncer)
  604. role: common
  605. rules:
  606. - local all +dbrole_readonly md5
  607. - host all +dbrole_readonly 127.0.0.1/32 md5
  608. - title: allow offline query (ETL,SAGA,Interactive) on offline instance
  609. role: offline
  610. rules:
  611. - host all +dbrole_offline 10.0.0.0/8 md5
  612. - host all +dbrole_offline 172.16.0.0/12 md5
  613. - host all +dbrole_offline 192.168.0.0/16 md5
  614. pgbouncer_hba_rules: # pgbouncer host-based authentication rules
  615. - title: local password access
  616. role: common
  617. rules:
  618. - local all all md5
  619. - host all all 127.0.0.1/32 md5
  620. - title: intranet password access
  621. role: common
  622. rules:
  623. - host all all 10.0.0.0/8 md5
  624. - host all all 172.16.0.0/12 md5
  625. - host all all 192.168.0.0/16 md5
  626. #-----------------------------------------------------------------
  627. # PG_EXPORTER
  628. #-----------------------------------------------------------------
  629. pg_exporter_enabled: true # setup pg_exporter on instance
  630. pg_exporter_config: pg_exporter.yml # use fast cache exporter for demo
  631. pg_exporter_port: 9630 # pg_exporter listen port
  632. pg_exporter_params: 'sslmode=disable' # url query parameters for pg_exporter
  633. pg_exporter_url: '' # optional, overwrite auto-generate postgres connstr
  634. pg_exporter_auto_discovery: true # optional, discovery available database on target instance ?
  635. pg_exporter_exclude_database: 'template0,template1,postgres' # optional, comma separated list of database that WILL NOT be monitored when auto-discovery enabled
  636. pg_exporter_include_database: '' # optional, comma separated list of database that WILL BE monitored when auto-discovery enabled, empty string will disable include mode
  637. pg_exporter_options: '--log.level=info --log.format="logger:syslog?appname=pg_exporter&local=7"'
  638. pgbouncer_exporter_enabled: true # setup pgbouncer_exporter on instance (if you don't have pgbouncer, disable it)
  639. pgbouncer_exporter_port: 9631 # pgbouncer_exporter listen port
  640. pgbouncer_exporter_url: '' # optional, overwrite auto-generate pgbouncer connstr
  641. pgbouncer_exporter_options: '--log.level=info --log.format="logger:syslog?appname=pgbouncer_exporter&local=7"'
  642. #-----------------------------------------------------------------
  643. # PG_SERVICE
  644. #-----------------------------------------------------------------
  645. pg_services: # how to expose postgres service in cluster?
  646. - name: primary # service name {{ pg_cluster }}-primary
  647. src_ip: "*"
  648. src_port: 5433
  649. dst_port: pgbouncer # 5433 route to pgbouncer
  650. check_url: /primary # primary health check, success when instance is primary
  651. selector: "[]" # select all instance as primary service candidate
  652. - name: replica # service name {{ pg_cluster }}-replica
  653. src_ip: "*"
  654. src_port: 5434
  655. dst_port: pgbouncer
  656. check_url: /read-only # read-only health check. (including primary)
  657. selector: "[]" # select all instance as replica service candidate
  658. selector_backup: "[? pg_role == `primary` || pg_role == `offline` ]"
  659. - name: default # service's actual name is {{ pg_cluster }}-default
  660. src_ip: "*" # service bind ip address, * for all, vip for cluster virtual ip address
  661. src_port: 5436 # bind port, mandatory
  662. dst_port: postgres # target port: postgres|pgbouncer|port_number , pgbouncer(6432) by default
  663. check_method: http # health check method: only http is available for now
  664. check_port: patroni # health check port: patroni|pg_exporter|port_number , patroni by default
  665. check_url: /primary # health check url path, / as default
  666. check_code: 200 # health check http code, 200 as default
  667. selector: "[]" # instance selector
  668. haproxy: # haproxy specific fields
  669. maxconn: 3000 # default front-end connection
  670. balance: roundrobin # load balance algorithm (roundrobin by default)
  671. default_server_options: 'inter 3s fastinter 1s downinter 5s rise 3 fall 3 on-marked-down shutdown-sessions slowstart 30s maxconn 3000 maxqueue 128 weight 100'
  672. - name: offline # service name {{ pg_cluster }}-offline
  673. src_ip: "*"
  674. src_port: 5438
  675. dst_port: postgres
  676. check_url: /replica # offline MUST be a replica
  677. selector: "[? pg_role == `offline` || pg_offline_query ]" # instances with pg_role == 'offline' or instance marked with 'pg_offline_query == true'
  678. selector_backup: "[? pg_role == `replica` && !pg_offline_query]" # replica are used as backup server in offline service
  679. haproxy_enabled: true # enable haproxy on this node?
  680. haproxy_reload: true # reload haproxy after config?
  681. haproxy_auth_enabled: false # enable authentication for haproxy admin?
  682. haproxy_admin_username: admin # default haproxy admin username
  683. haproxy_admin_password: pigsty # default haproxy admin password
  684. haproxy_exporter_port: 9101 # default admin/exporter port
  685. haproxy_client_timeout: 24h # client side connection timeout
  686. haproxy_server_timeout: 24h # server side connection timeout
  687. vip_mode: none # none | l2 | l4 , l4 not implemented yet
  688. vip_reload: true # reload vip after config?
  689. # vip_address: 127.0.0.1 # virtual ip address ip (l2 or l4)
  690. # vip_cidrmask: 24 # virtual ip address cidr mask (l2 only)
  691. # vip_interface: eth0 # virtual ip network interface (l2 only)
  692. # dns_mode: vip # vip|all|selector: how to resolve cluster DNS?
  693. # dns_selector: '[]' # if dns_mode == vip, filter instances been resolved
  694. #================================================================#
  695. # VARS: REDIS #
  696. #================================================================#
  697. # REDIS are not enabled by default
  698. #-----------------------------------------------------------------
  699. # REDIS_IDENTITY
  700. #-----------------------------------------------------------------
  701. #redis_cluster: redis-test # name of this redis cluster @ cluster level
  702. #redis_node: 1 # redis node identifier, integer sequence @ node level
  703. #redis_instances: {} # redis instances definition of this redis node @ node level
  704. #-----------------------------------------------------------------
  705. # REDIS_NODE
  706. #-----------------------------------------------------------------
  707. redis_fs_main: /data # main fs mountpoint for redis data
  708. redis_exporter_enabled: true # install redis exporter on redis nodes?
  709. redis_exporter_port: 9121 # default port for redis exporter
  710. redis_exporter_options: '' # default cli args for redis exporter
  711. #-----------------------------------------------------------------
  712. # REDIS_PROVISION
  713. #-----------------------------------------------------------------
  714. redis_safeguard: false # force redis_clean = abort if true
  715. redis_clean: true # abort|skip|clean if redis server already exists
  716. redis_rmdata: true # remove redis data when purging redis server?
  717. redis_mode: standalone # standalone,cluster,sentinel
  718. redis_conf: redis.conf # config template path (except sentinel)
  719. redis_bind_address: '0.0.0.0' # bind address, empty string turns to inventory_hostname
  720. redis_max_memory: 1GB # max memory used by each redis instance
  721. redis_mem_policy: allkeys-lru # memory eviction policy
  722. redis_password: '' # masterauth & requirepass password, disable by empty string
  723. redis_rdb_save: ['1200 1'] # redis rdb save directives, disable with empty list
  724. redis_aof_enabled: false # redis aof enabled
  725. redis_rename_commands: {} # rename dangerous commands
  726. redis_cluster_replicas: 1 # how many replicas for a master in redis cluster ?
  727. ...

Last modified 2022-06-20: add timescaledb (3c335f4)