コンテナ Gateway の環境変数

リストされている環境変数は、コンテナ Gateway アプリケーションに固有のものです。これらの環境変数の使用方法について理解を深めるには、Docker Engine および OpenShift に関する以下のドキュメントを参照してください。CA Technologies では、詳細な説明を検索する前に、まず以下のドキュメント リンク内のサンプル ファイルを参照することをお勧めします。
gateway10cr2
このトピックでは、コンテナ Gateway アプリケーションに固有の環境変数を説明します。これらの変数は、最初は Gateway 展開ファイル
docker-compose.yml
用に記述されたもので、「ENVIRONMENTAL_VALUES」形式に従っています。Gateway バージョン 10.0 CR 2 以降、クラウドベースのコンテナ Gateway クラスタで推奨される展開方法は、Helm チャートです。このページで説明されているものと同じ環境変数は、Helm チャート内の
values.yaml
設定ファイルで使用できますが、Helm パラメータのラベル付け規則が異なっている可能性があります。Helm チャート テンプレート ファイルで定義されているその他の非 Gateway 固有の変数(パラメータ)も、サンプルの
values.yaml
ファイルに含まれています。
Gateway の使用可能な環境変数
変数
説明
ACCEPT_LICENSE
必須です。デフォルト値: -
ACCEPT_LICENSE 環境変数を
true
に設定し、
Layer7 API Gateway
の有効な商用ライセンスがあることを確認します。また、
Layer7 API Gateway
の使用を管理する EULA (End User License Agreement、エンド ユーザ ライセンス使用条件)の条項を確認および受諾したことも確認します。
この値の大文字と小文字は区別されます。
SSG_JVM_HEAP
(オプション)デフォルト値: 2G
使用する JVM ヒープ サイズ。
この値は、数値の後に
m
M
k
K
g
、または
G
(大文字と小文字は区別されません)が付加された形式になります。たとえば、「4G」または「4g」(4 ギガバイト)、「3M」または「3m」(3 メガバイト)などです。
mem_limit
値は、
SSG_JVM_HEAP
値より 1 GB 大きい値または 50% 大きい値のうち、いずれか大きい方にする必要があります。
メモリ設定のガイドラインについては、「コンテナ Gateway のリソースを設定するためのガイドライン」を参照してください。
SSG_ADMIN_USERNAME
SSG_ADMIN_PASSWORD
(オプション)デフォルト値: random
Policy Manager の認証情報のログ記録を定義します。
ユーザ名とパスワード(12 文字以上を推奨)に ASCII 英数字、および次のいずれかの記号を含めると、セキュリティが向上します:
! @ . = - _ ^ + ; : # , %
設定ファイル内にパスワードなどの機密データをプレーン テキストで埋め込むのは、開発環境やテスト環境で利便性を高める場合に限ってください。多くのコンテナ PaaS 環境は、機密データを適切に管理するためのメカニズムを提供します。例については、「」の「シークレット」を参照してください。
Policy Manager の接続を無効にするには、
SSG_ADMIN_USERNAME
変数と
SSG_ADMIN_PASSWORD
変数を空のままにします。Policy Manager のアクセスを無効にすることは、実稼働環境で変更を加える際に、コンテナの再展開を適用する場合に最適です。ブートストラップされた派生イメージがある場合にも、これを実行します。
SSG_DATABASE_JDBC_URL
(オプション)デフォルト値: -
MySQL データベースへの接続に使用される JDBC 接続の URL。この URL が定義されていない場合、コンテナ Gateway では、代わりにデフォルトで組み込みデータベースを使用するように設定されます。
  1. 有効な URL が指定されている場合、コンテナ Gateway はこの JDBC 接続を使用して、MySQL データベース(MySQL モード)に接続します。
  2. URL が指定されていない(空、または宣言されていない)場合、コンテナ Gateway はデフォルトで組み込みのデータベース(Derby モード)に設定されます。
  • Policy Manager を使用する場合は、
    SSG_ADMIN_USERNAME
    および
    SSG_ADMIN_PASSWORD
    が定義されていることを確認します。
  • この JDBC URL は、セカンダリ データベース接続を設定するために使用できます(例:
    jdbc:mysql://mysql-server-primary:3306,mysql-server-secondary:3306/ssg
    )。
SSG_DATABASE_USER
SSG_DATABASE_JDBC_URL が指定されている場合は必須です。デフォルト値: -
MySQL サーバに接続しているユーザ。パスワードには、ASCII 英数字および次の記号を含めることができます:
! @ . = - _ ^ + ; : # , %
  • Layer7 のサンプル展開ファイルを使用する場合:
  1. このユーザは、MySQL サービスの環境セクションで定義されている
    MYSQL_USER
    ユーザ名と一致する必要があります。
  2. root
    以外のユーザ名を指定する
    場合は、MYSQL_DATA
    BASE エントリも定義する必要があります。データベース ユーザが適切な権限を持つには、このエントリが必要です。
  • 独自の MySQL インスタンスを展開している場合は、MySQL インスタンス上に作成したアカウントの認証情報と一致するように、この環境変数を設定します。
SSG_DATABASE_PASSWORD
SSG_DATABASE_JDBC_URL が指定されている場合は必須です。デフォルト値: -
MySQL サーバへの接続に使用されるパスワード。パスワードには、ASCII 英数字および次の記号を含めることができます:
! @ . = - _ ^ + ; : # , %
  • サンプル展開ファイルを使用している場合、この環境変数は、MySQL サービスの環境セクションで定義されている
    MYSQL_PASSWORD
    と一致する必要があります。
  • 独自の MySQL インスタンスを展開している場合は、MySQL インスタンス上に作成したアカウントの認証情報と一致するように、この環境変数を設定します。
SSG_DATABASE_WAIT_TIMEOUT
(オプション)デフォルト値: 300 秒(5 分)。
データベースが使用可能になるまでの待機時間(秒単位)。この値は、
SSG_DATABASE_JDBC_URL
が指定されている場合にコンテナ Gateway によって使用されます。
SSG_CLUSTER_HOST
SSG_DATABASE_JDBC_URL が指定されている場合は必須です。デフォルト: ${hostname}
コンテナ Gateway のクラスタ
hostname
有効な値は、引用符で囲まれたサービス エンドポイントの完全修飾ドメイン名(FQDN)です(例:
mygateway.mycompany.com
)。
SSG_CLUSTER_PASSWORD
SSG_DATABASE_JDBC_URL が指定されている場合は必須です。デフォルト値: random
クラスタ パスワード。
ユーザ名とパスワード(12 文字以上を推奨)に ASCII 英数字、および次のいずれかの記号を含めると、セキュリティが向上します:
! @ . = - _ ^ + ; : # ,
EXTRA_JAVA_ARGS
(オプション)デフォルト値: -
この変数は、ここで Java コマンド ラインに追加する追加の JVM プロパティ、または設定する Gateway システム プロパティを定義します。複数のエントリはスペースで区切ります。文字列は引用符で囲みます。
例(読みやすいように改行を追加しています)
EXTRA_JAVA_ARGS: "-XX:ParallelGCThreads=4
-Dcom.l7tech.bootstrap.env.license.enable=true
-Dcom.l7tech.bootstrap.autoTrustSslKey=trustAnchor,TrustedFor.SSL,TrustedFor.SAML_ISSUER"
  • -Dcom.l7tech.server.siteminder.enabled=true
    を使用して、CA Single Sign-On (Siteminder)を有効にします。デフォルトでは、この機能は
    無効
    です。
  • -Dcom.l7tech.bootstrap.env.license.enable=true
    を使用して、SSG ライセンス gzip、base64 文字列を環境変数としてロードすることを有効にします。これは、デフォルトでは
    無効
    です。
  • MySQL データベースを使用する際に、
    -Dcom.l7tech.service.metrics.enabled=false
    を使用してサービス メトリックを無効にします。これは、デフォルトでは
    有効
    です。このトグルは常に無効となっているため、組み込みデータベースはこのトグルを使用しません。
EXTRA_JAVA_ARGS で定義されているプロパティは、Gateway システム プロパティで定義されている同じプロパティより優先されます。ただし、EXTRA_JAVA_ARGS の値によって
system.properties
ファイルが変更されることはありません。
SSG_SSL_KEY
(オプション)デフォルト値: -
重要:
SSG_SSL_KEY
環境変数は、開発環境またはテスト環境でのみ使用してください。設定ファイルで SSL キー ライセンスがプレーン テキストで公開されるため、実稼働環境での使用はお勧め
しません
。シークレット ボリュームとしてライセンス ファイルをマウントすることをお勧めします。
Gateway のデフォルトの SSL キー(base64 エンコード文字列)。詳細については、「秘密鍵の管理」を参照してください。
この Linux コマンド
cat /path/to/key.p12 | base64
の出力から文字列をコピーします(Windows OS を実行している場合は、
–wrap=0
base64
コマンドに追加します)。
SSG_SSL_KEY_PASS
(オプション)デフォルト値: -
Gateway のデフォルトの SSL キー パスワード。
p12
キーがパスワード保護されていない場合は、空のままにできます。
SSG_LICENSE
(オプション)デフォルトで無効です。
重要:
SSG_LICENSE
環境変数は、開発環境またはテスト環境でのみ使用してください。設定ファイルで(エンコードされた)ライセンスがプレーン テキストで公開されるため、実稼働環境での使用はお勧め
しません
。シークレット ボリュームとしてライセンス ファイルをマウントすることをお勧めします。
Gzip で圧縮された、Base64 でエンコードされた文字列(スペース文字または改行なし)の
Layer7 API Gateway
ライセンスコンテナ Gateway の運用には、有効なライセンスが必要となります。
この
SSG_LICENSE
環境変数を使用して、単一の Gateway ライセンスをインストールします。複数のライセンスをインストールするには、シークレット ボリュームとしてライセンス ファイルをマウントする方法を使用することを推奨します。
廃止された環境変数
以下の変数は、旧バージョンのコンテナ Gateway で使用されていましたが、現在は使用されていません。
変数
SSG_CLUSTER_COMMAND
SSG_DATABASE_TYPE
SSG_DATABASE_HOST
SSG_DATABASE_PORT
SSG_DATABASE_NAME
SSG_DATABASE_ADMIN_USER
SSG_DATABASE_ADMIN_PASS
SSG_INTERNAL_SERVICES