Citus: Distributive Extension

Pigsty 4-node citus config, 1 coordinator & 3 data nodes

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

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