Demo: 4-node Full

Pigsty 4-node local sandbox demo config

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

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