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

インストールワークシート

途中で作業を止めずに済むよう、始める前に、インストールで必要になるすべての値を 1 つのファイルにまとめてください。インストールに必要な値は、名前、アドレス、パスワードなど約 15 個です。

このワークシートの使い方​

ファイルを一度作成し、各ステップの前に読み込みます。

  1. ワークシート のブロックを、ワークステーション上のテキストファイル(例: openlm-install.env)にコピーします。

  2. CHANGE-ME と書かれた値をすべて置き換えます。引用符は残してください。

  3. インストールの各ステップの前に、ファイルをシェルに読み込みます。

    source ./openlm-install.env

このガイドのすべてのコマンドはこれらの変数名を使用するため、コマンドをそのままコピーして貼り付けられます。

このファイルにはパスワードが含まれます

openlm-install.env は、他のパスワードファイルと同様に保管してください。共有フォルダーにも Git にも置かないでください。インストールが完了したら、削除するか、パスワード管理ツールに移してください。

ワークシート​

次のブロックをコピーします。

# ── openlm-install.env ─────────────────────────────────────────────────────────

# The platform release you are installing. Take it from the release notes.
export OPENLM_VERSION="1.0.0-rc.4"

# Your cluster
export NS="openlm" # keep this: the platform is built for "openlm"
export STORAGE_CLASS="CHANGE-ME" # kubectl get storageclass (for example gp3, managed-csi, local-path)
export INGRESS_CLASS="CHANGE-ME" # kubectl get ingressclass (for example traefik, nginx). OpenShift: leave as is
export ON_OPENSHIFT="false" # true on OpenShift, ROSA and ARO

# Your web address (no https://, no trailing slash)
export DOMAIN="CHANGE-ME" # for example openlm.example.com

# The TLS certificate for $DOMAIN (files on this workstation)
export TLS_CERT_FILE="./fullchain.pem" # certificate + intermediates (+ root for a private CA)
export TLS_KEY_FILE="./privkey.pem" # private key, not password-protected

# SQL Server
export SQL_HOST="CHANGE-ME" # host name or IP that pods can reach
export SQL_PORT="1433"
export SQL_USER="CHANGE-ME"
export SQL_PASSWORD="CHANGE-ME"
export SQL_ENCRYPT="True" # True for Azure SQL / RDS / any SQL with TLS; False only for a plain lab SQL
export DB_PREFIX="openlm" # databases become openlm_identity, openlm_reporting, ...

# MongoDB: a full connection string. It must NOT end with "/"
export MONGO_URI="mongodb://CHANGE-ME-user:CHANGE-ME-password@CHANGE-ME-host:27017"

# Kafka: bootstrap servers, comma-separated host:port
export KAFKA_BOOTSTRAP="CHANGE-ME:9092"

# Redis
export REDIS_HOST="CHANGE-ME" # host name, no port
export REDIS_PORT="6379"
export REDIS_PASSWORD="CHANGE-ME"
export REDIS_TLS="false" # true for ElastiCache with in-transit encryption, Azure Redis, etc.

# Generated once, kept for upgrades. Leave these lines as they are.
export HANGFIRE_PASSWORD="${HANGFIRE_PASSWORD:-$(openssl rand -hex 16)}"
export GATEWAY_SECRET="${GATEWAY_SECRET:-$(openssl rand -hex 24)}"
生成された値を保持する

最後の 2 行は、ファイルを初めて読み込んだときにランダムなパスワードを作成します。最初の source の後でそれらをファイルに書き込み、以降のすべてのステップとすべてのアップグレードで同じ値を使うようにしてください。

echo "export HANGFIRE_PASSWORD=\"$HANGFIRE_PASSWORD\"" >> ./openlm-install.env
echo "export GATEWAY_SECRET=\"$GATEWAY_SECRET\"" >> ./openlm-install.env

各値の意味​

次の表に、各値の入手先を示します。

変数入手先例
OPENLM_VERSIONリリースノート の最新のエントリ、または OpenLM から提供されたバージョン1.0.0
STORAGE_CLASSkubectl get storageclass。チームから別の指示がない限り、(default) と表示されているものを選びます。gp3
INGRESS_CLASSkubectl get ingressclasstraefik
ON_OPENSHIFTOpenShift、ROSA、ARO では true、それ以外では falsefalse
DOMAINユーザーが開く DNS 名。ステップ 1 でネットワークチームが作成します。openlm.example.com
SQL_HOST、SQL_PORTデータベースチーム。Pod が SQL Server に到達するときの名前を使用します。ノート PC から使う名前と同じとは限りません。sql01.corp.example.com
SQL_USER、SQL_PASSWORD4 つのデータベースを所有する SQL ログイン(Windows アカウントではない)openlm_app
SQL_ENCRYPTSQL Server が暗号化接続を受け付ける場合は True。マネージドクラウドの SQL サービスはすべて受け付けます。True
DB_PREFIX任意。英字、数字、_ のみ使用できます。openlm
MONGO_URIMongoDB チーム。ユーザーとパスワードを含めます。MongoDB が TLS を使用する場合は、ポートの後に ?tls=true(またはプロバイダーが指定するオプション)を追加します。mongodb://openlm:…@mongo.example.com:27017
KAFKA_BOOTSTRAPKafka チーム。Pod からそのアドレスに到達できる必要があります。kafka-0.kafka:9092
REDIS_*Redis チームredis.example.com、6379
確認

ファイルを記入したら、次のコマンドを実行します。すべての値が設定されていれば、何も表示されません。

source ./openlm-install.env && grep -n "CHANGE-ME" ./openlm-install.env

行が表示された場合は、その値を記入してください。

ドキュメントチームは、大規模言語モデルを使ってこのページを下書きすることがあります。公開前に、テクニカルライターがすべてのページをレビューし、製品と照らし合わせて検証します。最終的な判断は人間が行います。