構成リファレンス

顧客が編集する構成は、すべてデプロイパッケージのルートにある以下の 2 ファイルに集約されています。

• config.yaml: OpenLM Platform の構成（ドメイン、データベース、Ingress など）
• passwords.yaml: 同梱データベースで使用するパスワード

インストーラーはこの 2 ファイルを読み込み、インストール時に Helm チャートの value と Kubernetes Secret にレンダリングします。インストーラーをもう一度実行すると、その時点のファイル内容からすべてが再レンダリングされます。

必須フィールド

次の 3 つのフィールドを設定します。空の場合、インストーラーは停止します。

openlm_system_domain: "openlm.yourcompany.com"    # FQDN used to access the platform
tls_cert_path:        "/etc/openlm/certs/tls.crt"
tls_key_path:         "/etc/openlm/certs/tls.key"

それ以外のフィールドは、すべて単一 VM ですべて同梱版を使うデプロイ向けの既定値が設定されています。

データベースの選択肢

OpenLM Platform は 2 つの役割のデータベースを使用します。

• 運用（Operational）: ライブ状態、ID、アロケーション。書き込みスループットが高く、クエリは小さい。
• レポーティング（Reporting）: BI ツール向けの履歴利用データおよび ETL 出力。大規模な分析クエリを扱う。

各役割には、以下のいずれかのバックエンドを選べます。

バックエンド	モード	使用可能なロール	補足
MariaDB	同梱	運用	運用ロールの既定値
PostgreSQL	同梱	レポーティングのみ	レポーティングロールの既定値。運用および identity のバックエンドには使用できません。
SQL Server	外部	両ロール	顧客提供
MySQL	外部	運用のみ	顧客提供

推奨パターン

次の 2 つのパターンのいずれかを使用します。

1. すべて同梱: 運用は MariaDB、レポーティングは PostgreSQL。自己完結型で、追加で管理すべきものはありません。SQL Server インフラや DBA チームがない場合に使用します。
2. すべて外部 SQL Server: 両ロールを同一の外部 SQL Server インスタンス上の別データベースに格納します。SQL Server を既に運用している場合に使用します。

同梱と外部を混在させる構成もサポートされていますが、一般的ではありません。

レポーティングデータベース

config.yaml で、レポーティングデータベースのフィールドを設定します。

reporting_db_type:     "PostgreSQL"    # or "SqlServer_SQLServerAuth"
reporting_db_host:     "postgres-postgresql.openlm-infrastructure.svc.cluster.local"
reporting_db_port:     5432
reporting_db_username: "postgres"
reporting_db_password: "GENERATED"     # Substituted from passwords.yaml
reporting_db_name:     "openlm_reporting_db"

外部 SQL Server を使う場合は、reporting_db_password に実際のパスワードを設定し（GENERATED のままにはしない）、データベースを事前に作成するか、ユーザーに作成権限を付与しておきます。タイプが SqlServer_SQLServerAuth のとき、同梱の PostgreSQL はインストールされません。

外部 SQL Server ではスキーマ作成はお客様の作業です

インストーラーがレポートスキーマのスクリプトを適用するのは、同梱の PostgreSQL に対してのみです。reporting_db_type が SqlServer_SQLServerAuth の場合、この手順は完全にスキップされるため、レポートスキーマの作成はお客様の責任となります。

運用データベース

config.yaml で、運用データベースのフィールドを設定します。

operational_db_type:     "MariaDB"     # Options: MariaDB, MySQL, SqlServer_SQLServerAuth
operational_db_host:     "mariadb.openlm-infrastructure.svc.cluster.local"
operational_db_port:     3306
operational_db_username: "root"
operational_db_password: "GENERATED"
operational_db_name:     "openlm_operational_db"
identity_db_name:        "openlm_identity_db"
dss_db_name:             "openlm_dss_db"

運用ロールは、operational、identity、DSS の 3 つの論理データベースを使用します。同梱の MariaDB を使う場合、3 つとも自動的に作成されます。

運用データベース名には _none が付きます

operational_db_name は接続先のデータベース名そのものではなく、プレフィックスです。OpenLM Platform が実際に接続するのは <operational_db_name>_none で、既定値の場合は openlm_operational_db_none になります。

同梱の MariaDB では、このサフィックス付きのデータベースが自動的に作成されます。外部 SQL Server では、DBA がサフィックス付きの名前で作成する必要があります。openlm_operational_db という名前で作成した場合、OpenLM Platform は接続できません。

identity と DSS のデータベースは、identity_db_name と dss_db_name に設定した名前がそのまま使用され、サフィックスは付きません。

メッセージブローカー（Kafka）

config.yaml で、Kafka のフィールドを設定します。

kafka_bootstrap_servers: "kafka.openlm-infrastructure.svc.cluster.local:9092"

# Only set the SASL fields when connecting to an external/managed Kafka:
kafka_sasl_mechanism:         ""    # e.g. ScramSha512
kafka_sasl_username:          ""
kafka_sasl_password:          ""
kafka_security_protocol:      ""    # e.g. SASLSSL
kafka_ssl_endpoint_algorithm: ""    # e.g. https
kafka_consumer_timeout_ms:    ""    # e.g. 6000

• 既定: クラスタ内で同梱の Kafka を起動し、認証は使用しません。
• 外部 Kafka: kafka_bootstrap_servers を外部エンドポイントに設定し、SASL フィールドを記入します。同梱の Kafka をあわせて無効にしたい場合は、OpenLM サポートまでお問い合わせください。

kafka_consumer_timeout_ms は consumer の poll タイムアウトを上書きします。レイテンシの大きいマネージドブローカーで OpenLM サポートから引き上げを指示された場合を除き、空のままにしてください。

ドキュメントストア（MongoDB）

config.yaml で、MongoDB の接続文字列を設定します。

mongo_connection_string: "mongodb://admin:GENERATED@mongodb.openlm-infrastructure.svc.cluster.local:27017"

リテラル文字列 GENERATED は、インストール時に passwords.yaml の mongodb_root_password に置換されます。外部 MongoDB はサポートされていません。OpenLM Platform は同梱の MongoDB を前提とします。

警告

MongoDB 接続文字列の末尾に / を付けないでください。一部のクライアントが拒否します。

キャッシュ（Redis）

config.yaml で、Redis の接続文字列を設定します。

redis_connection_string: "redis-master.openlm-infrastructure.svc.cluster.local:6379"

Redis はクラスタ内部で認証なしで動作します。外部 Redis はサポートされていません。

Ingress

config.yaml で、Ingress のフィールドを設定します。

ingress_type:       "traefik"    # Options: traefik, nginx, gateway-api, openshift
ingress_class_name: "traefik"

既定値は traefik で、K3s と共にインストールされます。標準的な VM デプロイでは、既定値のまま変更する必要はありません。

それ以外の選択肢は、独自の Ingress レイヤーを既に運用しているクラスタ向けです。これらを指定する場合、対応するコントローラーをインストーラー実行前に導入し、利用可能な状態にしておく必要があります。インストーラーがコントローラーをデプロイすることはありません。また K3s では、同梱の Traefik を無効にしてください。無効にしないと、2 つのコントローラーがポート 80 と 443 を奪い合います。

ingress_class_name は、使用するコントローラーが登録する IngressClass と一致させる必要があります（例: ingress-nginx コントローラーなら nginx）。

ノードアフィニティ

config.yaml で、ノードアフィニティのラベルを設定します。

affinity_label_main_workload:      ""
affinity_label_reporting_workload: ""

Platform as VM では、すべてが単一ノード上で動作するため、両方とも空のままにしてください。これらは、main ワークロードと reporting ワークロードを専用ノードプールに固定するマルチノードクラスタ向けの設定です。

ストレージクラス

config.yaml で、ストレージクラスを設定します。

k8s_storage_class: "local-path"

local-path は K3s の既定値で、永続ボリュームのデータを VM のローカルディスクに保存します。単一 VM デプロイにはこれが適切で、VM のスナップショットを取得すれば自動的にバックアップされます。

ホスト側で別のプロビジョナー（NFS、Longhorn、Ceph など）を既に導入している場合は、ここで切り替えられます。インストーラーを実行する前に、導入済みで準備ができていることを確認します。

この設定でデータベースは移動しません

k8s_storage_class が適用されるのは、OpenLM Platform サービスの永続ボリューム要求（PVC）のみです。同梱の MariaDB、PostgreSQL、MongoDB、Kafka、Redis のチャートは local-path に固定されており、この設定を参照しません。そのため、ここで何を指定してもこれらのデータは VM のローカルディスクに残ります。

DNS のないエアギャップネットワーク

OpenLM Platform ドメインをホストできる DNS サーバーがないネットワークに VM がある場合、インストーラーが K3s の内部 DNS にパッチを適用し、クラスタ内でドメインを正しく解決できるようにします。config.yaml に次の値を設定します。

openlm_system_domain: "openlm.internal"
tls_cert_path:        "/etc/openlm/certs/tls.crt"
tls_key_path:         "/etc/openlm/certs/tls.key"

add_coredns_hosts_entry: true
coredns_hosts_entry_ip:  "10.20.30.40"    # The VM's IP

エンドユーザーが VM に到達する手段は引き続き必要です。VM の IP アドレス、クライアントごとの hosts ファイルのエントリ、または社内 DNS サーバーを用意します。

パスワードファイル

passwords.yaml で、パスワードを設定します。

postgres_password:     "changeme"
mariadb_root_password: "changeme"
mongodb_root_password: "changeme"

これらのパスワードは、次の用途で使用されます。

1. インストール時に同梱データベースを初期化する。
2. OpenLM Platform サービスが同じパスワードで接続できるよう構成する。

データベースを使用しない場合（例: reporting_db_type が SqlServer_SQLServerAuth のとき）、対応するパスワードの値は無視されます。

パスワードはインストール時に設定されます

パスワードは、データベースを最初に作成するときに設定されます。インストール後に passwords.yaml を変更しても、稼働中のデータベースは更新されません。以後は、各データベース独自のコマンドでパスワードをローテーションしてください。

構成例（全体）

次のパターンは、config.yaml の完全な例です。

既定の単一 VM、すべて同梱

これは最もシンプルなデプロイです。データベースを含め、すべてが 1 台の VM 上で動作します。config.yaml に次の値を設定します。

openlm_system_domain: "openlm.yourcompany.com"
tls_cert_path:        "/etc/openlm/certs/tls.crt"
tls_key_path:         "/etc/openlm/certs/tls.key"
# Everything else: defaults

両データベースロールを外部 SQL Server に配置

既存の SQL Server インスタンスがある場合に、このパターンを使用します。同梱の PostgreSQL と MariaDB はインストールされません。DBA は事前に 4 つのデータベースを作成するか、アプリケーションユーザーに作成権限を付与する必要があります。さらに、レポートスキーマの作成も必要です。

このパターンの値では、作成すべき 4 つのデータベースは次のとおりです。

データベース	作成する名前
運用	openlm_operational_db_none（_none サフィックスに注意）
Identity	openlm_identity_db
DSS	openlm_dss_db
レポーティング	openlm_reporting_db

config.yaml に次の値を設定します。

openlm_system_domain: "openlm.yourcompany.com"
tls_cert_path:        "/etc/openlm/certs/tls.crt"
tls_key_path:         "/etc/openlm/certs/tls.key"

reporting_db_type:     "SqlServer_SQLServerAuth"
reporting_db_host:     "mssql.yourcompany.com"
reporting_db_port:     1433
reporting_db_username: "openlm_app"
reporting_db_password: "<sql-server-password>"
reporting_db_name:     "openlm_reporting_db"

operational_db_type:     "SqlServer_SQLServerAuth"
operational_db_host:     "mssql.yourcompany.com"
operational_db_port:     1433
operational_db_username: "openlm_app"
operational_db_password: "<sql-server-password>"
operational_db_name:     "openlm_operational_db"
identity_db_name:        "openlm_identity_db"
dss_db_name:             "openlm_dss_db"

<sql-server-password> を、SQL Server ユーザーのパスワードに置き換えます。

外部 Kafka（例: AWS MSK）

既に運用しているイベントバスを OpenLM Platform と共有させたい場合に、このパターンを使用します。config.yaml に次の値を設定します。

openlm_system_domain: "openlm.yourcompany.com"
tls_cert_path:        "/etc/openlm/certs/tls.crt"
tls_key_path:         "/etc/openlm/certs/tls.key"

kafka_bootstrap_servers:     "b-1.mycluster.xxxxx.kafka.us-east-1.amazonaws.com:9092"
kafka_sasl_mechanism:        "ScramSha512"
kafka_sasl_username:         "openlm-user"
kafka_sasl_password:         "<msk-password>"
kafka_security_protocol:      "SASLSSL"
kafka_ssl_endpoint_algorithm: "https"

<msk-password> を、Kafka ユーザーのパスワードに置き換えます。

外部 DNS がないエアギャップネットワーク

VM が稼働するネットワークに OpenLM Platform ドメインをホストできる DNS サーバーがない構成です。エンドユーザーは IP またはローカルの hosts エントリ経由で OpenLM Platform に到達します。config.yaml に次の値を設定します。

openlm_system_domain: "openlm.internal"
tls_cert_path:        "/etc/openlm/certs/tls.crt"
tls_key_path:         "/etc/openlm/certs/tls.key"

add_coredns_hosts_entry: true
coredns_hosts_entry_ip:  "10.20.30.40"