当前位置：首页 > article >正文

Patroni配置3-环境变量配置设置

article 2024/10/12 0:04:16

全局/通用

Log

Citus

Consul

Etcd

Etcdv3

ZooKeeper

Exhibitor

Raft（已弃用）

PostgreSQL

REST API

CTL

环境配置设置

可以通过系统环境变量覆盖Patroni配置文件中定义的一些配置参数。本文档列出了Patroni处理的所有环境变量。通过这些变量设置的值总是优先于Patroni配置文件中设置的值。

全局/通用

PATRONI_CONFIGURATION：可以通过PATRONI_CONFIGURATION环境变量设置Patroni的整个配置。在这种情况下，将不会考虑任何其他环境变量！

PATRONI_NAME：当前Patroni实例运行的节点的名称。在集群中必须唯一。

PATRONI_NAMESPACE：Patroni在配置存储中保存集群信息的路径。默认值：“/service”。

PATRONI_SCOPE：集群名称。

Log

PATRONI_LOG_TYPE：设置日志的格式。可以是plain（纯文本）或json。要使用json格式，必须安装jsonlogger。默认值为plain。

PATRONI_LOG_LEVEL：设置一般日志级别。默认值为INFO（参见Python日志文档）。

PATRONI_LOG_TRACEBACK_LEVEL：设置回溯信息可见的级别。默认值为ERROR。如果只想在启用PATRONI_LOG_LEVEL=DEBUG时看到回溯信息，可以将其设置为DEBUG。

PATRONI_LOG_FORMAT：设置日志格式化字符串。如果日志类型为plain，日志格式应为字符串。请参考LogRecord属性了解可用属性。如果日志类型为json，日志格式除了字符串外还可以是列表。每个列表项应对应LogRecord属性。请注意，只需要字段名，并且应省略%(和)。如果希望以不同的键名打印日志字段，请使用字典，其中字典键是日志字段，值是希望在日志中打印的字段名。默认值为%(asctime)s %(levelname)s: %(message)s。

PATRONI_LOG_DATEFORMAT：设置日期时间格式化字符串。（参见formatTime()文档）

PATRONI_LOG_STATIC_FIELDS：向日志添加额外字段。此选项仅在日志类型设置为json时可用。例如PATRONI_LOG_STATIC_FIELDS="{app: patroni}"。

PATRONI_LOG_MAX_QUEUE_SIZE：Patroni使用两步日志记录。日志记录被写入内存队列，并且有一个单独的线程从队列中拉取它们并写入stderr或文件。内部队列的最大大小默认限制为1000条记录，这足以保留过去1小时20分钟的日志。

PATRONI_LOG_DIR：写入应用程序日志的目录。该目录必须存在且可由执行Patroni的用户写入。如果设置了此环境变量，应用程序将默认保留4个25MB的日志。可以使用PATRONI_LOG_FILE_NUM和PATRONI_LOG_FILE_SIZE（见下文）调整这些保留值。

PATRONI_LOG_MODE：日志文件的权限（例如，0644）。如果未指定，权限将根据当前umask值设置。

PATRONI_LOG_FILE_NUM：保留的应用程序日志数量。

PATRONI_LOG_FILE_SIZE：触发日志滚动的patroni.log文件大小（以字节为单位）。

PATRONI_LOG_LOGGERS：按Python模块重新定义日志级别。例如PATRONI_LOG_LOGGERS="{patroni.postmaster: WARNING, urllib3: DEBUG}"。

Citus

启用Patroni与Citus的集成。如果已配置，Patroni将负责在协调器上注册Citus工作节点。您可以在此处找到关于Citus支持的更多信息。

PATRONI_CITUS_GROUP：Citus组ID，整数。使用0表示协调器，1、2等表示工作节点。

PATRONI_CITUS_DATABASE：应创建Citus扩展的数据库。在协调器和所有工作节点上必须相同。当前仅支持一个数据库。

Consul

PATRONI_CONSUL_HOST：Consul本地代理的主机:端口。

PATRONI_CONSUL_URL：Consul本地代理的URL，格式为：http(s)://host:port。

PATRONI_CONSUL_PORT：（可选）Consul端口。

PATRONI_CONSUL_SCHEME：（可选）http或https，默认为http。

PATRONI_CONSUL_TOKEN：（可选）ACL令牌。

PATRONI_CONSUL_VERIFY：（可选）是否验证HTTPS请求的SSL证书。

PATRONI_CONSUL_CACERT：（可选）CA证书。如果存在，将启用验证。

PATRONI_CONSUL_CERT：（可选）包含客户端证书的文件。

PATRONI_CONSUL_KEY：（可选）包含客户端密钥的文件。如果密钥是证书的一部分，则可以为空。

PATRONI_CONSUL_DC：（可选）要通信的数据中心。默认情况下，使用主机所在的数据中心。

PATRONI_CONSUL_CONSISTENCY：（可选）选择Consul一致性模式。可能的值为default、consistent或stale（更多详细信息请参见Consul API参考）。

PATRONI_CONSUL_CHECKS：（可选）用于会话的Consul健康检查列表。默认情况下使用空列表。

PATRONI_CONSUL_REGISTER_SERVICE：（可选）是否使用由scope参数定义的名称和根据节点角色（master、primary、replica或standby-leader）定义的标签注册服务。默认为false。

PATRONI_CONSUL_SERVICE_TAGS：（可选）除角色（primary/replica/standby-leader）外，要添加到Consul服务的额外静态标签。默认情况下使用空列表。

PATRONI_CONSUL_SERVICE_CHECK_INTERVAL：（可选）对注册的URL执行健康检查的频率。

PATRONI_CONSUL_SERVICE_CHECK_TLS_SERVER_NAME：（可选）通过TLS连接时覆盖SNI主机，另请参阅Consul代理检查API参考。

Etcd

PATRONI_ETCD_PROXY：etcd的代理URL。如果您通过代理连接到etcd，请使用此参数而不是PATRONI_ETCD_URL。

PATRONI_ETCD_URL：etcd的URL，格式为：http(s)://(username:password@)host:port。

PATRONI_ETCD_HOSTS：etcd端点的列表，格式为‘host1:port1’,‘host2:port2’,等…

PATRONI_ETCD_USE_PROXIES：如果此参数设置为true，Patroni将把主机视为代理列表，并且不会执行etcd集群的拓扑发现，而是坚持使用固定的主机列表。

PATRONI_ETCD_PROTOCOL：http或https，如果未指定，则使用http。如果指定了URL或代理，则会从它们中获取协议。

PATRONI_ETCD_HOST：etcd端点的主机:端口。

PATRONI_ETCD_SRV：用于集群自动发现的SRV记录搜索域。Patroni将尝试按指定顺序（直到首次成功）查询这些SRV服务名称的指定域：_etcd-client-ssl, _etcd-client, _etcd-ssl, _etcd, _etcd-server-ssl, _etcd-server。如果检索到_etcd-server-ssl或_etcd-server的SRV记录，则使用ETCD对等协议查询ETCD以获取可用成员。否则，将使用SRV记录中的主机。

PATRONI_ETCD_SRV_SUFFIX：在发现期间查询的SRV名称配置的后缀。使用此标志来区分同一域下的多个etcd集群。仅与PATRONI_ETCD_SRV结合使用。例如，如果设置了PATRONI_ETCD_SRV_SUFFIX=foo和PATRONI_ETCD_SRV=example.org，则将执行以下DNS SRV查询：_etcd-client-ssl-foo._tcp.example.com（以及每个可能的ETCD SRV服务名称的类似查询）。

PATRONI_ETCD_USERNAME：用于etcd身份验证的用户名。

PATRONI_ETCD_PASSWORD：用于etcd身份验证的密码。

PATRONI_ETCD_CACERT：CA证书。如果存在，将启用验证。

PATRONI_ETCD_CERT：包含客户端证书的文件。

PATRONI_ETCD_KEY：包含客户端密钥的文件。如果密钥是证书的一部分，则可以为空。

Etcdv3

Etcdv3的环境变量名称与Etcd相似，只需在变量名中使用ETCD3代替ETCD即可。例如：PATRONI_ETCD3_HOST、PATRONI_ETCD3_CACERT等。

警告

使用协议版本2创建的键在协议版本3中不可见，反之亦然。因此，仅通过更新Patroni配置无法从Etcd切换到Etcdv3。此外，Patroni使用Etcd的gRPC-gateway（代理）与V3 API进行通信，这意味着无法使用TLS通用名称进行身份验证。

ZooKeeper

PATRONI_ZOOKEEPER_HOSTS：ZooKeeper集群成员的逗号分隔列表：“'host1:port1','host2:port2','etc…'”。重要的是要对每个实体进行引用！

PATRONI_ZOOKEEPER_USE_SSL：（可选）是否使用SSL。默认为false。如果设置为false，则忽略所有SSL特定参数。

PATRONI_ZOOKEEPER_CACERT：（可选）CA证书。如果存在，将启用验证。

PATRONI_ZOOKEEPER_CERT：（可选）包含客户端证书的文件。

PATRONI_ZOOKEEPER_KEY：（可选）包含客户端密钥的文件。

PATRONI_ZOOKEEPER_KEY_PASSWORD：（可选）客户端密钥密码。

PATRONI_ZOOKEEPER_VERIFY：（可选）是否验证证书。默认为true。

PATRONI_ZOOKEEPER_SET_ACLS：（可选）如果设置，则配置Kazoo为创建的每个ZNode应用默认ACL。ACL将采用“x509”模式，并应指定为以主体为键、一个或多个权限作为值中列表的字典。权限可能是CREATE、READ、WRITE、DELETE或ADMIN。例如，set_acls: {CN=principal1: [CREATE, READ], CN=principal2: [ALL]}。

PATRONI_ZOOKEEPER_AUTH_DATA：（可选）用于连接的身份验证凭据。应为以方案为键、凭据为值的字典。默认为空字典。

注意

要支持SSL，需要安装kazoo>=2.6.0。

Exhibitor

PATRONI_EXHIBITOR_HOSTS：Exhibitor（ZooKeeper）节点的初始列表，格式为：“host1,host2,etc…”。每当Exhibitor（ZooKeeper）集群拓扑发生变化时，此列表都会自动更新。

PATRONI_EXHIBITOR_PORT：Exhibitor端口。

Kubernetes

PATRONI_KUBERNETES_BYPASS_API_SERVICE：（可选）在与Kubernetes API通信时，Patroni通常依赖于kubernetes服务，该服务的地址通过KUBERNETES_SERVICE_HOST环境变量在pods中公开。如果PATRONI_KUBERNETES_BYPASS_API_SERVICE设置为true，Patroni将解析服务后面的API节点列表并直接连接到它们。

PATRONI_KUBERNETES_NAMESPACE：（可选）Patroni pod运行的Kubernetes命名空间。默认值为default。

PATRONI_KUBERNETES_LABELS：格式为{label1: value1, label2: value2}的标签。这些标签将用于查找与当前集群关联的现有对象（Pods和Endpoints或ConfigMaps）。此外，Patroni还会在它创建的每个对象（Endpoint或ConfigMap）上设置这些标签。

PATRONI_KUBERNETES_SCOPE_LABEL：（可选）包含集群名称的标签的名称。默认值为cluster-name。

PATRONI_KUBERNETES_ROLE_LABEL：（可选）包含角色（primary、replica或其他自定义值）的标签的名称。Patroni将在其运行的pod上设置此标签。默认值为role。

PATRONI_KUBERNETES_LEADER_LABEL_VALUE：（可选）当Postgres角色为主节点时，pod标签的值。默认值为primary。

PATRONI_KUBERNETES_FOLLOWER_LABEL_VALUE：（可选）当Postgres角色为从节点时，pod标签的值。默认值为replica。

PATRONI_KUBERNETES_STANDBY_LEADER_LABEL_VALUE：（可选）当Postgres角色为standby_leader时，pod标签的值。默认值为primary。

PATRONI_KUBERNETES_TMP_ROLE_LABEL：（可选）包含角色（primary或replica）的临时标签的名称。此标签的值将始终使用相应角色的默认值。仅在必要时设置。

PATRONI_KUBERNETES_USE_ENDPOINTS：（可选）如果设置为true，Patroni将使用Endpoints而不是ConfigMaps来运行领导者选举并保持集群状态。

PATRONI_KUBERNETES_POD_IP：（可选）Patroni运行的pod的IP地址。当启用PATRONI_KUBERNETES_USE_ENDPOINTS时，此值是必需的，并用于在pod的PostgreSQL被提升时填充领导者Endpoint的子集。

PATRONI_KUBERNETES_PORTS：（可选）如果Service对象有端口的名称，则相同的名称必须出现在Endpoint对象中，否则服务将无法工作。例如，如果您的服务定义为{Kind: Service, spec: {ports: [{name: postgresql, port: 5432, targetPort: 5432}]}}，则您需要设置PATRONI_KUBERNETES_PORTS='[{"name": "postgresql", "port": 5432}]'，并且Patroni将使用它来更新领导者Endpoint的子集。此参数仅在设置PATRONI_KUBERNETES_USE_ENDPOINTS时使用。

PATRONI_KUBERNETES_CACERT：（可选）指定包含用于验证Kubernetes API SSL证书的受信任CA证书的CA_BUNDLE文件的文件。如果未提供，Patroni将使用ServiceAccount机密提供的值。

PATRONI_RETRIABLE_HTTP_CODES：（可选）从K8s API重试的HTTP状态码列表。默认情况下，Patroni会在500、503和504上重试，或者如果K8s API响应具有retry-after HTTP头。

Raft（已弃用）

PATRONI_RAFT_SELF_ADDR：用于监听Raft连接的ip:port。self_addr必须可从集群中的其他节点访问。如果未设置，则该节点不会参与共识。

PATRONI_RAFT_BIND_ADDR：（可选）用于监听Raft连接的ip:port。如果未指定，则使用self_addr。

PATRONI_RAFT_PARTNER_ADDRS：集群中其他Patroni节点的列表，格式为"'ip1:port1','ip2:port2'"。重要的是要对每个实体进行引用！

PATRONI_RAFT_DATA_DIR：存储Raft日志和快照的目录。如果未指定，则使用当前工作目录。

PATRONI_RAFT_PASSWORD：（可选）使用指定密码加密Raft流量，需要cryptography python模块。

PostgreSQL

PATRONI_POSTGRESQL_LISTEN：PostgreSQL 监听的 IP 地址和端口。可以允许多个以逗号分隔的地址，但最后一个地址后必须附加端口号（用冒号分隔），例如：listen: 127.0.0.1,127.0.0.2:5432。Patroni 将使用此列表中的第一个地址来建立到 PostgreSQL 节点的本地连接。

PATRONI_POSTGRESQL_CONNECT_ADDRESS：其他节点和应用程序访问 PostgreSQL 使用的 IP 地址和端口。

PATRONI_POSTGRESQL_PROXY_ADDRESS：与 PostgreSQL 并行运行的连接池（例如 pgbouncer）可访问的 IP 地址和端口。该值将作为 proxy_url 写入到分布式配置存储（DCS）的成员键中，并可用于服务发现。

PATRONI_POSTGRESQL_DATA_DIR：PostgreSQL 数据目录的位置，可以是已存在的，也可以由 Patroni 初始化。

PATRONI_POSTGRESQL_CONFIG_DIR：PostgreSQL 配置目录的位置，默认为数据目录。该目录必须可由 Patroni 写入。

PATRONI_POSTGRESQL_BIN_DIR：PostgreSQL 二进制文件的路径（包括 pg_ctl, initdb, pg_controldata, pg_basebackup, postgres, pg_isready, pg_rewind）。默认值为空字符串，意味着将使用 PATH 环境变量来查找这些可执行文件。

PATRONI_POSTGRESQL_BIN_PG_CTL（可选）：pg_ctl 二进制文件的自定义名称。

PATRONI_POSTGRESQL_BIN_INITDB（可选）：initdb 二进制文件的自定义名称。

PATRONI_POSTGRESQL_BIN_PG_CONTROLDATA（可选）：pg_controldata 二进制文件的自定义名称。

PATRONI_POSTGRESQL_BIN_PG_BASEBACKUP（可选）：pg_basebackup 二进制文件的自定义名称。

PATRONI_POSTGRESQL_BIN_POSTGRES（可选）：postgres 二进制文件的自定义名称。

PATRONI_POSTGRESQL_BIN_IS_READY（可选）：pg_isready 二进制文件的自定义名称。

PATRONI_POSTGRESQL_BIN_PG_REWIND（可选）：pg_rewind 二进制文件的自定义名称。

PATRONI_POSTGRESQL_PGPASS：.pgpass 密码文件的路径。Patroni 在执行 pg_basebackup 和其他某些操作时会创建此文件。该文件的位置必须可由 Patroni 写入。

PATRONI_REPLICATION_USERNAME：复制用户名；该用户将在初始化期间创建。副本将使用此用户通过流复制访问复制源。

PATRONI_REPLICATION_PASSWORD：复制密码；该用户将在初始化期间创建。

PATRONI_REPLICATION_SSLMODE（可选）：映射到 sslmode 连接参数，允许客户端指定与服务器进行 TLS 协商的类型。有关每种模式的工作原理的更多信息，请参阅 PostgreSQL 文档。默认模式是 prefer。

PATRONI_REPLICATION_SSLKEY（可选）：映射到 sslkey 连接参数，指定客户端证书使用的密钥的位置。

PATRONI_REPLICATION_SSLPASSWORD（可选）：映射到 sslpassword 连接参数，指定在 PATRONI_REPLICATION_SSLKEY 中指定的密钥的密码。

PATRONI_REPLICATION_SSLCERT（可选）：映射到 sslcert 连接参数，指定客户端证书的位置。

PATRONI_REPLICATION_SSLROOTCERT（可选）：对应 sslrootcert 连接参数，指定包含一个或多个证书颁发机构（CA）证书的文件的位置，客户端将使用这些证书来验证服务器的证书。

PATRONI_REPLICATION_SSLCRL（可选）：对应 sslcrl 连接参数，指定包含证书吊销列表（CRL）的文件的位置。客户端将拒绝连接到此列表中包含证书的任何服务器。

PATRONI_REPLICATION_SSLCRLDIR（可选）：对应 sslcrldir 连接参数，指定包含证书吊销列表文件的目录的位置。客户端将拒绝连接到此目录中包含证书的任何服务器。

PATRONI_REPLICATION_GSSENCMODE（可选）：对应 gssencmode 连接参数，决定与服务器协商安全GSS TCP/IP连接的优先级或是否进行协商。

PATRONI_REPLICATION_CHANNEL_BINDING（可选）：对应 channel_binding 连接参数，控制客户端对通道绑定的使用。

PATRONI_SUPERUSER_USERNAME：超级用户的名称，在初始化（initdb）期间设置，之后由Patroni用于连接到PostgreSQL。此用户也被pg_rewind使用。

PATRONI_SUPERUSER_PASSWORD：超级用户的密码，在初始化期间设置。

PATRONI_SUPERUSER_SSLMODE（可选）：对应 sslmode 连接参数，允许客户端指定与服务器进行TLS协商的模式类型。有关每种模式的工作方式的更多信息，请参阅PostgreSQL文档。默认模式是prefer。

PATRONI_SUPERUSER_SSLKEY（可选）：对应 sslkey 连接参数，指定与客户端证书一起使用的密钥的位置。

PATRONI_SUPERUSER_SSLPASSWORD（可选）：对应 sslpassword 连接参数，指定在PATRONI_SUPERUSER_SSLKEY中指定的密钥的密码。

PATRONI_SUPERUSER_SSLCERT（可选）：对应 sslcert 连接参数，指定客户端证书的位置。

PATRONI_SUPERUSER_SSLROOTCERT（可选）：同上，用于超级用户验证服务器证书。

PATRONI_SUPERUSER_SSLCRL（可选）：同上，用于超级用户访问证书吊销列表。

PATRONI_SUPERUSER_SSLCRLDIR（可选）：同上，用于超级用户访问包含证书吊销列表的目录。

PATRONI_SUPERUSER_GSSENCMODE（可选）：同上，用于超级用户与服务器协商安全连接。

PATRONI_SUPERUSER_CHANNEL_BINDING（可选）：同上，用于超级用户控制通道绑定。

PATRONI_REWIND_USERNAME（可选）：pg_rewind用户的名称，在PostgreSQL 11+初始化期间创建，并授予所有必要权限。

PATRONI_REWIND_PASSWORD（可选）：pg_rewind用户的密码，在初始化期间设置。

PATRONI_REWIND_SSLMODE（可选）：同上，用于pg_rewind指定TLS协商模式。

PATRONI_REWIND_SSLKEY（可选）：同上，用于pg_rewind指定密钥位置。

PATRONI_REWIND_SSLPASSWORD（可选）：同上，用于pg_rewind指定密钥密码。

PATRONI_REWIND_SSLCERT（可选）：同上，用于pg_rewind指定客户端证书位置。

PATRONI_REWIND_SSLROOTCERT（可选）：同上，用于pg_rewind验证服务器证书。

PATRONI_REWIND_SSLCRL（可选）：同上，用于pg_rewind访问证书吊销列表。

PATRONI_REWIND_SSLCRLDIR（可选）：同上，用于pg_rewind访问包含证书吊销列表的目录。

PATRONI_REWIND_GSSENCMODE（可选）：同上，用于pg_rewind与服务器协商安全连接。

PATRONI_REWIND_CHANNEL_BINDING（可选）：同上，用于pg_rewind控制通道绑定。

REST API

PATRONI_RESTAPI_CONNECT_ADDRESS：访问REST API所需的IP地址和端口。

PATRONI_RESTAPI_LISTEN：Patroni将监听以提供HAProxy健康检查信息的IP地址和端口。

PATRONI_RESTAPI_USERNAME：用于保护不安全REST API端点的基本认证用户名。

PATRONI_RESTAPI_PASSWORD：用于保护不安全REST API端点的基本认证密码。

PATRONI_RESTAPI_CERTFILE：指定PEM格式的证书文件。如果未指定或留空，API服务器将不使用SSL运行。

PATRONI_RESTAPI_KEYFILE：指定PEM格式的密钥文件。

PATRONI_RESTAPI_KEYFILE_PASSWORD：指定用于解密密钥文件的密码。

PATRONI_RESTAPI_CAFILE：指定包含受信任CA证书的CA_BUNDLE文件，用于验证客户端证书。

PATRONI_RESTAPI_CIPHERS：（可选）指定允许的加密套件（例如，“ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES128-GCM-SHA256:!SSLv1:!SSLv2:!SSLv3:!TLSv1:!TLSv1.1”）。

PATRONI_RESTAPI_VERIFY_CLIENT：无（默认）、可选或必需。当设置为“无”时，REST API不会检查客户端证书。当设置为“必需”时，所有REST API调用都需要客户端证书。当设置为“可选”时，所有不安全的REST API端点都需要客户端证书。如果设置为“必需”，则证书签名验证成功时，客户端认证成功。对于“可选”，仅对PUT、POST、PATCH和DELETE请求检查客户端证书。

PATRONI_RESTAPI_ALLOWLIST：（可选）指定允许调用不安全REST API端点的主机集合。单个元素可以是主机名、IP地址或使用CIDR表示法的网络地址。默认允许所有。如果设置了allowlist或allowlist_include_members，则未包含的内容将被拒绝。

PATRONI_RESTAPI_ALLOWLIST_INCLUDE_MEMBERS：（可选）如果设置为true，则允许从DCS中注册的其他集群成员（IP地址或主机名从成员的api_url中获取）访问不安全的REST API端点。请注意，操作系统可能会为出站连接使用不同的IP。

PATRONI_RESTAPI_HTTP_EXTRA_HEADERS：（可选）HTTP头允许REST API服务器在HTTP响应中传递额外信息。

PATRONI_RESTAPI_HTTPS_EXTRA_HEADERS：（可选）当启用TLS时，HTTPS头允许REST API服务器在HTTP响应中传递额外信息。这还将传递在http_extra_headers中设置的额外信息。

PATRONI_RESTAPI_REQUEST_QUEUE_SIZE：（可选）设置Patroni REST API使用的TCP套接字的请求队列大小。一旦队列满了，进一步的请求将收到“连接被拒绝”错误。默认值为5。

警告

PATRONI_RESTAPI_CONNECT_ADDRESS必须可从给定Patroni集群的所有节点访问。Patroni在领导者选举期间使用它来查找具有最小复制延迟的节点。

如果您启用了客户端证书验证（PATRONI_RESTAPI_VERIFY_CLIENT设置为“必需”），则还必须在PATRONI_CTL_CERTFILE、PATRONI_CTL_KEYFILE、PATRONI_CTL_KEYFILE_PASSWORD中提供有效的客户端证书。如果未提供，Patroni将无法正常工作。