メインコンテンツまでスキップ

変数リファレンス — データレイクが読むもの

データレイク コンテナが 実際に読む 変数だけを集めました。基本値の正本はコンテナ内の plantpulse-datalake-cli/config/defaults.env で、ホストから渡された値がそれを上書きします。ホスト側の値全体(DOCKER_* を含む)は 環境変数リファレンス にあります。

「ある」と「届く」は違う

下表の「ホストから変更できるか」列が いいえ の変数は、サイドカーに少なくともコンテナに入りません。compose がその名前をデータレイクに渡さないためです。その値は defaults.env またはテンプレートが決めます。

シークレット — ないとどうなるか

pd が知るシークレットは 3 つのリストです。値はどこにも基本値がなく、サイドカー → compose → 環境変数でのみ入ります。

リスト変数ない場合
必須PP_REDIS_PASSWORD PP_PG_PASSWORD PP_CASSANDRA_PASSWORD PP_MINIO_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 startexit 3 で停止し、不足している名前をすべて列挙します。compose も :? で要求するため、スタックがまったく起動しません
ワーカー追加PP_PG_REPLICA_PASSWORDWORKER ノードでのみ必須
オプション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-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・第 2 インターフェイス時のみ)
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言語・タイムゾーンサイドカー

ストレージ

変数基本値ホストから変更できるか
PP_REDIS_USER · PP_REDIS_PORTredis · 6379アカウント名のみ (ポートは不可)
PP_PG_USER · PP_POSTGRES_PORT · PP_DB_NAMEplantpulse · 5432 · ppアカウント名・DB 名 (ポートは不可)
PP_CASSANDRA_USER · PP_CASSANDRA_PORT · PP_KEYSPACEcassandra · 9042 · ppアカウント名・キースペース (ポートは不可)
PP_MINIO_USER · PP_MINIO_PORT · PP_MINIO_BUCKETminio · 9000 · plantpulseアカウント名のみ
PP_PG_REPLICA_USERreplicaサイドカー

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 · ppサイドカー
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管理コンソール ログイン名サイドカー
PP_DATALAKE_ADMIN_PASSWORDサイドカーが決定管理コンソール パスワード。空の場合、コンソールのみ無効passwd.sh
PP_DATALAKE_ADMIN_API_KEYなしログ エンドポイントの X-API-Key。空の場合、キー認証のみ無効passwd.sh
PP_DATALAKE_ADMIN_PORT4949コンテナ内のリッスン ポート。4950 は同じコンソールの TLSいいえ
PP_DATALAKE_ADMIN_LOGS_ENABLEDtruefalse の場合、コンソール ログ画面のみ無効サイドカー
PP_DATA_GATEWAY_WEB_USER · PP_DATA_GATEWAY_WEB_PASSWORDadmin · なしデータ ゲートウェイ コンソール(SQL)ログイン。空の場合、そのコンソールのみ閉鎖サイドカー
PP_CEP_WEB_USER · PP_CEP_WEB_PASSWORDadmin · なしCEP コンソール ログイン。空の場合、そのコンソールのみ閉鎖サイドカー
PP_BACKUP_SCHEDULE_ENABLEDtrueバックアップ タイマー グローバル スイッチサイドカー

その他のコンソール設定セット(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ワーカーごとに証明書 1 つ。両方が一致する必要があり、ビルドがパスします

証明書そのものは plantpulse-certs コンテナが生成します → セキュリティ設定

PD_ で始まる変数

PD_ はデータレイク「ローカル変数」です。オペレータが設定するのは 2 つだけ で、残り 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 が当てるソースが虚偽になります

関連ドキュメント