Auto：默认单机模板

非沙箱环境下单机安装Pigsty时，默认使用此配置模板

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

最后修改 2022-06-18: v1.5.1 (8de4142)