Demo：Public Demo

Pigsty 4-node public demo config

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

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