跳到主要内容

变量参考 — 数据湖读取的内容

此处仅收录了数据湖容器实际读取的变量。默认值的权威来源在容器内的 plantpulse-datalake-cli/config/defaults.env 中,从主机传入的值会覆盖它。主机端的全部值(包括 DOCKER_*)见环境变量参考。

「存在」和「可达」是两回事

下表「是否可在主机更改」列中为否的变量,即使在 sidecar 中定义也不会传入容器。因为 compose 不会将这些名称传给数据湖。其值由 defaults.env 或模板决定。

密钥 — 若缺失会怎样​

pd 已知的密钥分为三个列表。这些值在任何地方都没有默认值,只能通过 sidecar → compose → 环境变量的路径传入。

列表变量若缺失
必需PP_REDIS_PASSWORD PP_PG_PASSWORD PP_CASSANDRA_PASSWORD PP_S3_PASSWORD PP_MQ_PASSWORD PP_TSE_PASSWORD PP_SPARK_PASSWORD PP_HIVE_PASSWORD PP_GRAVITINO_PASSWORD PP_TEMPORAL_PASSWORD PP_KESTRA_DB_PASSWORD PP_KESTRA_ADMIN_PASSWORD PP_TLS_KEYSTORE_PASSWORD PP_CEP_API_KEY PP_DATA_GATEWAY_API_KEYpd start 会以 exit 3 退出,并列出所有缺失的名称。compose 也会通过 :? 强制要求,导致栈根本无法启动
Worker 附加项PP_PG_REPLICA_PASSWORD仅在 WORKER 节点上必需
可选PP_DATALAKE_ADMIN_PASSWORD PP_DATALAKE_ADMIN_API_KEY PP_DATA_GATEWAY_WEB_PASSWORD PP_CEP_WEB_PASSWORD仅该功能会被禁用。栈正常启动。pd doctor 会告知名称

更改方法见更改密码 · API 密钥。三个派生值(PP_TLS_TRUSTSTORE_PASSWORD · PP_REDIS_TRUSTSTORE_PASSWORD · PP_MQ_TRUSTSTORE_PASSWORD)由密钥库密码生成,无需单独设置。

节点 · 地址​

变量默认值含义是否可在主机更改
PP_MODEMASTERMASTER / WORKER。Worker 由 worker-add.sh 决定节点文件
PP_HOST_IP10.99.0.100(compose 网络固定 IP)此容器的地址。广告地址的基础通过 DOCKER_PP_IP
PP_MASTER_IPPP_HOST_IP其他盒子连接此数据湖的地址节点文件
PP_SERVICE_IP空值NAT 后的公网 IP。会包含在 TLS SAN 中通过节点文件 DOCKER_PP_EXTERNAL_IP
PP_KAFKA_ADVERTISED_HOST启动时推导Kafka 向客户端通告的地址节点文件(仅在 NAT 或第二接口时)
PP_CLUSTER_CORES主机核心数 − 2 (4 ~ 30)通告给 Spark 等应用的核心数DOCKER_PP_CLUSTER_CORES
PP_DATA_DISK_NAME从主机检测用于测量磁盘使用率的设备DOCKER_PP_DATA_DISK_NAME
PP_DATA_DIR · PP_TEMP_DIR · PP_BACKUP_DIR/data1/pp-data · /data1/pp-temp · /data1/pp-backup卷挂载位置否(compose 字面量)
PP_LANG · PP_TZen · Asia/Seoul语言 · 时区sidecar

存储库​

变量默认值是否可在主机更改
PP_REDIS_USER · PP_REDIS_PORTredis · 6379仅账户名(端口不可)
PP_PG_USER · PP_POSTGRES_PORT · PP_DB_NAMEplantpulse · 5432 · pp账户名 · 数据库名(端口不可)
PP_CASSANDRA_USER · PP_CASSANDRA_PORT · PP_KEYSPACEcassandra · 9042 · pp账户名 · 键空间(端口不可)
PP_S3_USER · PP_S3_PORT · PP_S3_BUCKETrustfs · 9000 · plantpulse仅账户名
PP_PG_REPLICA_USERreplicasidecar

PP_KEYSPACE · PP_DB_NAME · PP_TOPIC_PREFIX 是由数据湖创建、应用读取的标识符,因此它们被放置在 compose 的 x-pp-secrets 锚点中,以同时作用于两端。安装后更改它们将创建新名称的空存储库,而旧数据仍留在旧名称下。

分析 · 消息传递 · 时序 · 工作流​

变量默认值是否可在主机更改
PP_HIVE_USER · PP_HIVE_PORT · PP_HIVE_DBhive · 9083 · hive-metastore-230仅账户名
PP_SPARK_USER · PP_SPARK_PORT · PP_SPARK_WEBUI_PORT · PP_KYUUBI_PORTspark · 7077 · 4440 · 10000仅账户名
PP_GRAVITINO_USER · PP_GRAVITINO_ICEBERG_REST_PORTgravitino · 19001仅账户名
PP_MQ_USER · PP_TOPIC_PREFIXmq · ppsidecar
PP_KAFKA_PORT · PP_KAFKA_TLS_PORT · PP_KAFKA_CONTROLLER_PORT9092 · 9094 · 9093否
PP_MQTT_PORT · PP_MQTT_TLS_PORT1883 · 1884否
PP_TSE_USER · PP_TSE_PORT · PP_TSE_TLS_PORT · PP_TSE_PROTOCOLtse · 7800 · 7801 · http仅账户名
PP_TSE_DATAPOINT_TTL31536000(365 天)否 — 通过模板编辑
PP_TEMPORAL_USER · PP_TEMPORAL_PORTtemporal · 7233仅账户名
PP_KESTRA_DB_USER · PP_KESTRA_ADMIN_EMAIL · PP_KESTRA_PORTkestra · admin@plantpulse.io · 8380账户名 · 电子邮件
PP_CEP_PORT · PP_CEP_TLS_PORT · PP_CEP_PROTOCOL7400 · 7401 · http否
PP_DATA_GATEWAY_PORT · PP_DATA_GATEWAY_TLS_PORT · PP_DATA_GATEWAY_PROTOCOL5500 · 5501 · http否
PP_TSE_DATAPOINT_TTL — 时序单点的生命周期

时序引擎在每次写入时记录此 TTL(INSERT … USING TTL)。因此,更改值后,将只对新写入的行生效,已写入的行仍按旧值过期。上调不会使数据复活,下调也不会缩短过期时间。要更改,请修改 /etc/kopens/conf/plantpulse-timeseries-engine.conf.template。

管理控制台 · 查询控制台​

变量默认值含义是否可在主机更改
PP_DATALAKE_ADMIN_USERadmin管理控制台登录名sidecar
PP_DATALAKE_ADMIN_PASSWORDsidecar 决定管理控制台密码。若为空,仅禁用控制台passwd.sh
PP_DATALAKE_ADMIN_API_KEY无日志端点的 X-API-Key。若为空,仅禁用密钥认证passwd.sh
PP_DATALAKE_ADMIN_PORT4949容器内监听端口。4950 是同一控制台的 TLS否
PP_DATALAKE_ADMIN_LOGS_ENABLEDtrue若为 false,仅控制台日志界面会离线sidecar
PP_DATA_GATEWAY_WEB_USER · PP_DATA_GATEWAY_WEB_PASSWORDadmin · 无数据网关控制台(SQL)登录。若为空,仅禁用该控制台sidecar
PP_CEP_WEB_USER · PP_CEP_WEB_PASSWORDadmin · 无CEP 控制台登录。若为空,仅禁用该控制台sidecar
PP_BACKUP_SCHEDULE_ENABLEDtrue备份定时器全局开关sidecar

其他控制台设置组(PP_DATALAKE_ADMIN_PD_PATH · PP_DATALAKE_ADMIN_LOG_ROOT · PP_DATALAKE_ADMIN_BACKUP_HISTORY)由 compose 以字面量方式注入。无需更改。

TLS​

变量默认值含义
PP_TLS_ENABLEDtrue主开关
PP_TLS_CERT_DIR/var/security/plantpulse证书目录
PP_TLS_DOMAIN · PP_TLS_VALID_DAYSplantpulse.io · 3650证书域名 · 有效期
PP_TLS_SAN_IPS · PP_TLS_SAN_DNS主机 IP · 主机名证书 SAN。必须包含外部连接 IP
PP_TLS_NODE_NAMES · PP_MAX_WORKERSmaster worker-1 … worker-5 · 5每个 Worker 一个证书。两者必须匹配才能通过构建

证书本身由 plantpulse-certs 容器创建 → 安全设置

以 PD_ 开头的变量​

PD_ 是数据湖的「局部变量」。操作员可以设置的仅有两个,其余约 270 个是脚本内部变量或镜像内置的戳记。

变量含义
PD_HOMEpd 存放的树。由镜像确定
PD_OPTIONS组件 on/off JSON — {"enable-hive": false}。省略的键默认开启。当前 compose 栈不会将此值传给容器 → FAQ
PD_IMAGE_TAG · PD_IMAGE_BUILD_VERSION · PD_IMAGE_BUILT_AT · PD_IMAGE_VCS_REF镜像戳记。请勿修改 — 否则 pd env · pd doctor 提供的来源将变为不实

相关文档​