Parameters

Parameter reference for Pigsty

INFRA

Parameters about pigsty infrastructure components: local yum repo, nginx, dnsmasq, prometheus, grafana, loki, alertmanager, pushgateway, blackbox_exporter, etc…

META

This section contains some metadata of current pigsty deployments, such as version string, admin node IP address, repo mirror region and http(s) proxy when downloading pacakges.

1. version: v2.0.2                # pigsty version string
2. admin_ip: 10.10.10.10             # admin node ip address
3. region: default                   # upstream mirror region: default,china,europe
4. proxy_env:                        # global proxy env when downloading packages
5. 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"
6. # http_proxy:  # set your proxy here: e.g http://user:pass@proxy.xxx.com
7. # https_proxy: # set your proxy here: e.g http://user:pass@proxy.xxx.com
8. # all_proxy:   # set your proxy here: e.g http://user:pass@proxy.xxx.com

version

name: version, type: string, level: G

pigsty version string

default value:v2.0.2

It will be used for pigsty introspection & content rendering.

admin_ip

name: admin_ip, type: ip, level: G

admin node ip address

default value:10.10.10.10

Node with this ip address will be treated as admin node, usually point to the first node that install Pigsty.

The default value 10.10.10.10 is a placeholder which will be replaced during configure

This parameter is referenced by many other parameters, such as:

• infra_portal
• repo_endpoint
• dns_records
• node_default_etc_hosts
• node_etc_hosts
• node_repo_local_urls

The exact string ${admin_ip} will be replaced with the actual admin_ip for above parameters.

region

name: region, type: enum, level: G

upstream mirror region: default,china,europe

default value: default

If a region other than default is set, and there’s a corresponding entry in repo_upstream.[repo].baseurl, it will be used instead of default.

For example, if china is used, pigsty will use China mirrors designated in repo_upstream if applicable.

proxy_env

name: proxy_env, type: dict, level: G

global proxy env when downloading packages

default value:

1. proxy_env: # global proxy env when downloading packages
2. http_proxy: 'http://username:password@proxy.address.com'
3. https_proxy: 'http://username:password@proxy.address.com'
4. all_proxy: 'http://username:password@proxy.address.com'
5. no_proxy: "localhost,127.0.0.1,10.0.0.0/8,192.168.0.0/16,*.pigsty,*.aliyun.com,mirrors.aliyuncs.com,mirrors.tuna.tsinghua.edu.cn,mirrors.zju.edu.cn"

It’s quite important to use http proxy in restricted production environment, or your Internet access is blocked (e.g. Mainland China)

CA

Self-Signed CA used by pigsty. It is required to support advanced security features.

1. ca_method: create                 # create,recreate,copy, create by default
2. ca_cn: pigsty-ca                  # ca common name, fixed as pigsty-ca
3. cert_validity: 7300d              # cert validity, 20 years by default

ca_method

name: ca_method, type: enum, level: G

available options: create,recreate,copy

default value: create

• create: Create a new CA public-private key pair if not exists, use if exists
• recreate: Always re-create a new CA public-private key pair
• copy: Copy the existing CA public and private keys from local files/pki/ca, abort if missing

If you already have a pair of ca.crt and ca.key, put them under files/pki/ca and set ca_method to copy.

ca_cn

name: ca_cn, type: string, level: G

ca common name, not recommending to change it.

default value: pigsty-ca

you can check that with openssl x509 -text -in /etc/pki/ca.crt

cert_validity

name: cert_validity, type: interval, level: G

cert validity, 20 years by default, which is enough for most scenarios

default value: 7300d

INFRA_ID

Infrastructure identity and portal definition.

``` 1. #infra_seq: 1 # infra node identity, explicitly required 2. infra_portal: # infra services exposed via portal 3. home : { domain: h.pigsty } 4. grafana : { domain: g.pigsty ,endpoint: "${admin_ip}:3000" ,websocket: true } 5. prometheus : { domain: p.pigsty ,endpoint: "${admin_ip}:9090" } 6. alertmanager : { domain: a.pigsty ,endpo

（本文超出站点单文档体积上限，已截断）