コンテナで使用する環境変数
管理コンテナおよび転送コンテナで使用する環境変数について説明します。
管理コンテナで使用する環境変数の一覧
管理コンテナで使用する環境変数は以下のとおりです。
|
環境変数 |
説明 |
省略 |
省略時の値 |
値の範囲 |
備考 |
|---|---|---|---|---|---|
|
システム動作 |
|||||
|
HULFT_CONTROL_ROOT_PASSWORD |
HULFT10のルートユーザーのパスワードを設定 |
○ |
|
英数字および記号 |
省略時はrootユーザーへのログイン不可 |
|
HULFT_CONTROL_CONTAINER_ENDPOINT_URL |
管理コンテナのエンドポイントURLを設定 |
× |
|
英数字および記号 |
URL形式 |
|
HULFT_CONTROL_SERVER_SHUTDOWN_TIMEOUT_SECONDS |
管理コンテナサーバを停止時に強制終了までの時間（秒） |
○ |
30 |
0～3600 |
|
|
転送コンテナ接続 |
|||||
|
HULFT_CONTROL_TRANSFER_CONTAINER_ENDPOINT_URL |
転送コンテナのエンドポイントURLを設定 |
× |
|
英数字および記号 |
URL形式 |
|
DB接続 |
|||||
|
HULFT_CONTROL_DB_HOST |
データベースの接続先ホスト名 |
× |
|
英数字、“-”および“.” |
255バイト以内 |
|
HULFT_CONTROL_DB_PORT |
データベースの接続先ポート |
○ |
3306 |
1～65535 |
|
|
HULFT_CONTROL_DB_USERNAME |
データベースへの接続時に使用するユーザー名 |
× |
|
|
|
|
HULFT_CONTROL_DB_PASSWORD |
データベースへの接続時に使用するパスワード |
○ |
|
|
|
|
HULFT_CONTROL_DB_NAME |
データベースのデータベース名 |
× |
|
|
|
|
HULFT_CONTROL_DB_TABLE_PREFIX |
データベースのテーブルのプレフィックス |
○ |
|
英小文字数字、“_” |
12バイト以内 |
|
HULFT_CONTROL_DB_COLUMN_ENCRYPTION_KEY |
データベースのカラムの暗号化鍵 |
× |
|
英数字および記号 |
|
|
HULFT_CONTROL_DB_MAX_CONNECT_RETRY |
データベースへの接続時のリトライ回数 |
○ |
30 |
0～9999 |
|
|
SAML設定 |
|||||
|
HULFT_CONTROL_SAML_SECRET_KEY |
SAML秘密鍵 |
○ |
|
|
SSOでSAML認証を使用する際に使用 |
|
HULFT_CONTROL_SAML_CERT |
SAML証明書 |
○ |
|
|
SSOでSAML認証を使用する際に使用 |
|
○ |
: |
省略可 |
|
× |
: |
省略不可 |
|
環境変数 |
説明 |
省略 |
備考 |
|---|---|---|---|
|
HTTP_PROXY http_proxy |
HTTP通信に使用するプロキシ |
○ |
管理コンテナがHTTP通信時に接続先となるプロキシを指定します。 管理コンテナで発生するアウトバウンド通信については「管理コンテナの通信要件」を参照してください。 |
|
HTTPS_PROXY https_proxy |
HTTPS通信に使用するプロキシ |
○ |
管理コンテナがHTTPS通信時に接続先となるプロキシを指定します。 管理コンテナで発生するアウトバウンド通信については「管理コンテナの通信要件」を参照してください。 |
|
NO_PROXY no_proxy |
プロキシの除外設定 |
○ |
プロキシ設定を使用しない接続先ホストを指定します。 管理コンテナで発生するアウトバウンド通信については「管理コンテナの通信要件」を参照してください。 |
|
○ |
: |
省略可 |
|
× |
: |
省略不可 |
「HTTP_PROXY」または「HTTPS_PROXY」を指定した場合は、内部通信がプロキシを使わないように、「NO_PROXY」に以下を指定してください。
-
「HULFT_CONTROL_TRANSFER_CONTAINER_ENDPOINT_URL」に指定したURLのホスト名
-
転送コンテナが起動するノードのIP
管理コンテナは「Go言語」で開発されています。
このため、「Goランタイム」が利用する環境変数の影響を受ける場合があります。環境変数の影響内容については、Go言語の仕様をご確認ください。
管理コンテナで使用する環境変数
- HULFT_CONTROL_ROOT_PASSWORD
-
rootユーザーのパスワードを指定します。
他のユーザーを作成しrootユーザーへのログインが不要になった場合は、指定を省略してください。
- HULFT_CONTROL_CONTAINER_ENDPOINT_URL
-
ユーザーがHULFT管理画面に接続するときに使用するURLを指定します。
ブラウザでの接続時に指定するURLと一致していない場合、HULFT管理画面でログインに失敗します。
- HULFT_CONTROL_SERVER_SHUTDOWN_TIMEOUT_SECONDS
-
管理コンテナがプロセスの終了シグナルを受け取ってから実行中の処理の終了を待つ時間を秒単位で指定します。
時間内に実行中の処理が完了しなかった場合、管理コンテナは強制終了します。
- HULFT_CONTROL_TRANSFER_CONTAINER_ENDPOINT_URL
-
転送コンテナが内部通信を受け付けているURLを指定します。
http:// もしくは https:// の形式でホスト名まで指定してください。
管理コンテナが転送コンテナに要求を発行する際に使用します。
転送コンテナに接続できない場合、一部のWebAPIの実行時にエラーになります。
- HULFT_CONTROL_DB_HOST
-
管理コンテナが接続するDBのホスト名を指定します。
DBに接続できない場合、管理コンテナは起動に失敗します。
- HULFT_CONTROL_DB_PORT
-
管理コンテナが接続するDBのポート番号を指定します。
- HULFT_CONTROL_DB_USERNAME
-
DBで使用するユーザー名を指定します。
- HULFT_CONTROL_DB_PASSWORD
-
DBで使用するユーザーのパスワードを指定します。
- HULFT_CONTROL_DB_NAME
-
DBで使用するデータベース名を指定します。
使用するデータベースは管理コンテナ起動前に作成しておく必要があります。
- HULFT_CONTROL_DB_TABLE_PREFIX
-
DBに作成するテーブルの名前に付けるプレフィックスを指定します。
- HULFT_CONTROL_DB_COLUMN_ENCRYPTION_KEY
-
DBにセキュリティに関する情報を保存する際に使用する暗号鍵を指定します。
暗号鍵を紛失した場合、一部の管理情報は復元ができなくなります。
- HULFT_CONTROL_DB_MAX_CONNECT_RETRY
-
DBへの接続に失敗したとき、再接続を試みる回数を指定します。
“0”を指定した場合は、再接続を行いません。
再接続を試みるまでの待ち時間は1秒で固定です。
- HULFT_CONTROL_SAML_SECRET_KEY
-
SAMLアサーションの署名に必要なサービスプロバイダのSAML秘密鍵を指定します。
SAMLの設定についての詳細は「アドミニストレーション ガイド」の「SAMLを使用したSSO設定」を参照してください。
- HULFT_CONTROL_SAML_CERT
-
SAMLアサーションの署名に必要なサービスプロバイダのSAML証明書を指定します。
SAMLの設定についての詳細は「アドミニストレーション ガイド」の「SAMLを使用したSSO設定」を参照してください。
転送コンテナで使用する環境変数の一覧
転送コンテナで使用する環境変数は以下のとおりです。
|
環境変数 |
説明 |
省略 |
省略時の値 |
値の範囲 |
備考 |
|---|---|---|---|---|---|
|
認証情報 |
|||||
|
HULFT_TRANSFER_CONTROL_TOKEN |
管理コンテナへの接続時に使用するアクセストークン |
○ |
|
|
128バイト |
|
HULFT_TRANSFER_CONTROL_PASSWORD |
管理コンテナへの接続時に使用するパスワード |
○ |
|
英数字および記号 |
アクセストークンが未指定の場合に使用される |
|
管理コンテナ接続 |
|||||
|
HULFT_TRANSFER_CONTROL_URL |
管理コンテナの接続先URL |
× |
|
英数字および記号 |
URL形式 |
|
HULFT_TRANSFER_CONTROL_TIMEOUT |
管理コンテナへの接続時のタイムアウト値（ミリ秒） |
○ |
60000 |
10000～259200000 |
|
|
HULFT_TRANSFER_CONTROL_RETRY_COUNT_LIMIT |
管理コンテナへの接続時のリトライ回数上限 |
○ |
10 |
0～9999 |
|
|
HULFT_TRANSFER_CONTROL_RETRY_INTERVAL |
管理コンテナへの接続時のリトライ間隔（ミリ秒） |
○ |
1000 |
0～9999000 |
|
|
○ |
: |
省略可 |
|
× |
: |
省略不可 |
|
環境変数 |
説明 |
省略 |
備考 |
|---|---|---|---|
|
AWS_DEFAULT_REGION |
デフォルトでリクエストを送信するサーバーの AWS リージョン |
○ |
ファイル転送で使用するS3バケットリージョンを指定します。 |
|
HTTP_PROXY http_proxy |
HTTP通信に使用するプロキシ |
○ |
転送コンテナがHTTP通信時に接続先となるプロキシを指定します。 転送コンテナで発生するアウトバウンド通信については「転送コンテナの通信要件」を参照してください。 |
|
HTTPS_PROXY https_proxy |
HTTPS通信に使用するプロキシ |
○ |
転送コンテナがHTTPS通信時に接続先となるプロキシを指定します。 転送コンテナで発生するアウトバウンド通信については「転送コンテナの通信要件」を参照してください。 |
|
NO_PROXY no_proxy |
プロキシの除外設定 |
○ |
プロキシ設定を使用しない接続先ホストを指定します。 転送コンテナで発生するアウトバウンド通信については「転送コンテナの通信要件」を参照してください。 |
|
○ |
: |
省略可 |
|
× |
: |
省略不可 |
「HTTP_PROXY」または「HTTPS_PROXY」を指定した場合は、内部通信がプロキシを使わないように、「NO_PROXY」に以下を指定してください。
-
「HULFT_TRANSFER_CONTROL_URL」に指定したURLのホスト名
-
AWSサービスが利用するエンドポイント（169.254.169.254, 169.254.170.2）
転送コンテナで使用する環境変数
- HULFT_TRANSFER_CONTROL_TOKEN
-
管理画面のユーザー管理で発行したアクセストークンを指定します。
管理コンテナ接続時に指定したアクセストークンによる認証を実施します。
初回起動時にはこの認証方法は使用できません。パスワード認証を使用してください。
アクセストークンの発行方法についての詳細は「アドミニストレーション ガイド」の「アクセストークンを使用した認証の設定」を参照してください。
- HULFT_TRANSFER_CONTROL_PASSWORD
-
rootユーザーのパスワードを指定します。
管理コンテナ接続時に指定したパスワードによる認証を実施します。
rootユーザーのパスワードは管理コンテナの環境変数「HULFT_CONTROL_ROOT_PASSWORD」で指定します。
パスワード認証を使用する場合、転送コンテナは一定時間ごとに管理コンテナに対してログイン処理を実施します。
転送コンテナから管理コンテナへの不要なログイン処理を減らすため、アクセストークンを指定した認証を推奨しています。
- HULFT_TRANSFER_CONTROL_URL
-
管理コンテナがWeb APIを受け付けているURLを指定します。
http:// もしくは https:// の形式でポート番号も含めて指定してください。
転送コンテナが管理コンテナに要求を発行する際に使用します。
管理コンテナに接続できない場合、転送コンテナは起動に失敗します。
- HULFT_TRANSFER_CONTROL_TIMEOUT
-
管理コンテナから応答がない場合のタイムアウト時間をミリ秒単位で指定します。タイムアウトした場合は、通信異常と判断して通信を切断します。
ネットワークの異常を検知するための時間なので、ご使用のネットワークに適した値を設定してください。
- HULFT_TRANSFER_CONTROL_RETRY_COUNT_LIMIT
-
管理コンテナへの接続に失敗したとき、再接続を試みる回数を指定します。
“0”を指定した場合は、再接続を行いません。
- HULFT_TRANSFER_CONTROL_RETRY_INTERVAL
-
管理コンテナへの接続に失敗したとき、再接続を試みるまでの待ち時間をミリ秒単位で指定します。