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

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

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

「存在する」と「到達する」は異なります

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

シークレット — ない場合はどうなるか​

pd が知っているシークレットは3つのリストです。値にはどこにもデフォルトがなく、サイドカー → 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 も :? で要求するため、スタック自体が起動しません
ワーカー追加PP_PG_REPLICA_PASSWORDWORKER ノードでのみ必須
任意PP_DATALAKE_ADMIN_PASSWORD PP_DATALAKE_ADMIN_API_KEY PP_DATA_GATEWAY_WEB_PASSWORD PP_CEP_WEB_PASSWORDその機能1つだけが無効になります。スタックは正常起動。pd doctor が名前を教えてくれます

変更方法は パスワード・APIキーの変更 にあります。派生値セット(PP_TLS_TRUSTSTORE_PASSWORD · PP_REDIS_TRUSTSTORE_PASSWORD · PP_MQ_TRUSTSTORE_PASSWORD)は keystore パスワードから生成され、個別には設定しません。

ノード・アドレス​

変数デフォルト値意味ホストで変更できるか
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_S3_USER · PP_S3_PORT · PP_S3_BUCKETrustfs · 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 — 時系列1点の寿命

時系列エンジンが書き込みのたびにこの 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コンテナ内の listen ポート。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 が設定する出所が偽になります

関連ドキュメント​