旧バージョンのドキュメントを参照しています。最新のドキュメントはこちらをご参照ください。

Kong Gatewayライセンス

Kong Gatewayは、ライセンスの有無にかかわらず使用できます。Enterprise機能では、Kong Gatewayは Kong Konnectライセンスファイルの存在と有効性を適用します。

機能	フリーモード	Enterpriseサブスクリプション
Manager
Admin API
Vitals
Dev Portal
Enterpriseプラグイン

ライセンスファイルのデプロイ

ハイブリッドモードの展開： ライセンスファイルを各コントロールプレーン（CP）とデータプレーン（DP）にデプロイする必要があります。Kong Admin APIを通じてコントロールプレーン（CP）にライセンスを適用します。コントロールプレーン（CP）はライセンスをデータプレーン（DP）ノードに配布します。これは、ライセンスをデータプレーン（DP）に自動的に適用する唯一の方法です。
独立したコントロールプレーンがない従来のデプロイメント: ライセンスファイルは、Kong Gatewayを実行している各ノードにデプロイされる必要があります。

ライセンスファイルのチェックは、Kongの処理が開始するとともに、各ノードによって個別に実行されます。ライセンス検証プロセスを実行するのにネットワーク接続性は必要ありません。

Kong Gatewayノードでライセンスファイルを構成する方法は複数あります。これらは、Kongによってチェックされる順序で以下のように定義されます。

存在する場合は、環境変数KONG_LICENSE_DATAの内容が使用されます。
Kongは、デフォルトの場所 /etc/kong/license.jsonで検索します。
存在する場合、環境変数KONG_LICENSE_PATHで定義されたファイルの内容が使用されます。
/licenses Admin API エンドポイントを使用してライセンスを直接デプロイします。

この方法では、ライセンスファイルは、ノードファイルシステム上のファイルとして、環境変数として、または/licenses Admin APIエンドポイントを介して、デプロイできます。最も簡単な方法は、Admin APIを使用することです。

他のほとんどのKONG_*環境変数とは異なり、KONG_LICENSE_DATAとKONG_LICENSE_PATH は、kong CLI コマンドの一部としてインラインで定義できません。ライセンスファイルの環境変数は、kongCLIツールの前に、Nginxプロセスが実行されるシェルにエクスポートする必要があります。

詳細については、ライセンスをデプロイするを参照してください。

Kong Gateway ノード上のライセンスデータの確認

Admin APIの/licensesエンドポイント、またはKong Manager のAdmin GUIを使用してライセンスデータを取得します。

ライセンスの有効期限

ライセンスは、マシンが稼働しているタイムゾーンに応じて、有効期限日の00:00に期限切れになります。

Kong Managerは、ライセンス有効期限の15日前からライセンス有効期限の警告を示すバナーを表示します。有効期限の警告はKong Gatewayログにも表示されます。

ライセンスの有効期限が切れると、Kong Gatewayは次のように動作します。

Kong Manager とその構成にはアクセスでき、変更も可能ですが、Enterprise固有の機能は読み取り専用になります。
Admin API を使用すると、OSS 機能は引き続き動作し、構成された Kong Gateway Enterprise 機能は読み取り専用モードで継続して動作することができます。
Enterpriseプラグインを使用するトラフィックを含むプロキシトラフィックは、ライセンスの有効期限が失効していないものとして引き続き処理されます。
その他の Enterprise 機能にはアクセスできません。
まだ書き込み可能な Enterprise 機能があるかもしれませんが、後で変更される可能性もあるため、この動作を前提にしないでください。

各デプロイメントモードの動作は、以下のとおりです。

従来型: ノードは必要に応じて再起動/スケーリングできます。
ハイブリッド: 既存のデータプレーンまたは新しいデータプレーンは、ライセンスの有効期限が切れたコントロールプレーンからの構成を 受け入れることができます 。
DB-lessとKIC: 新しいノードを立ち上げることが できず 、再起動が中断されます。

新しいライセンスをアップロードするには、Enterprise ライセンスのデプロイを参照してください。

ライセンスの有効期限ログ

Kong Gatewayは、次のスケジュールでライセンスの有効期限日を記録します。

90日前：WARNログエントリを1日1回
30 日前: ERR ログエントリを 1 日 1 回
期限切れ時および期限切れ後: CRIT ログエントリを 1 日 1 回

トラブルシューティング

有効なライセンスファイルが適切にデプロイされている場合、ライセンスファイルの検証は透過的な操作であり、追加の出力やログデータは書き込まれず、提供されません。ライセンスの検証中にエラーが発生した場合、またはライセンスデータが有効でない場合は、エラーメッセージがコンソールに書き込まれ、Kong エラーログに記録され、その後プロセスが終了します。以下に、発生する可能性のあるエラーメッセージとトラブルシューティング手順を示します。

license path environment variable not set ：KONG_LICENSE_DATAまたはKONG_LICENSE_PATHの関数変数が定義されておらず、ライセンスファイルがデフォルトのライセンスロケーション（/etc/kong/license.json）で開くことができません。

internal error ：ライセンスの検証中に内部エラーが発生しました。このようなケースが発生する可能性は非常に低いため、さらにトラブルシューティングを行うには、Kongサポートにお問い合わせください。

error opening license file ：デフォルトの場所で、またはKONG_LICENSE_PATH環境変数を使用して定義されたライセンスファイルを開くことができない。Nginxプロセスを実行しているユーザー（Kong CLIユーティリティを実行しているユーザーなど）にこのファイルを読み取る権限があることを確認します。

error reading license file ：デフォルトの場所で、またはKONG_LICENSE_PATH環境変数を使用して、定義されたライセンスファイルを開くことができましたが、読み取り中にエラーが発生しました。ファイルが破損していないこと、カーネルエラーメッセージ（メモリ不足の状態など）が報告されていないことを確認してください。これは一般的なエラーであり、ファイルを開くことができれば、発生する可能性は極めて低いです。

could not decode license json: ライセンスファイルデータが有効なJSONとして復号できません。ファイルが破損しておらず、Kong Inc.から受信したあとに変更されていないことを確認します。Kong Inc.からライセンスファイルを再ダウンロードしてインストールしてみてください。再インストール後もこのエラーが発生する場合は、Kongサポートにお問い合わせください。
invalid license format: ライセンスファイルデータに1つ以上のキー/値ペアが欠落しています。ファイルが破損しておらず、Kong Inc.から受信したあとに変更されていないことを確認します。Kong Inc.からライセンスファイルを再ダウンロードしてインストールしてみてください。再インストール後もこのエラーが発生する場合は、Kongサポートにお問い合わせください。
validation failed: ライセンスの署名を使ったライセンスのペイロードの検証に失敗しました。ファイルが破損しておらず、Kong Inc. から受信したあとに変更されていないことを確認します。Kong Inc. からライセンスファイルを再ダウンロードしてインストールしてみてください。再インストール後もこのエラーが発生する場合は、Kong サポートにお問い合わせください。
license expired: システム時刻がライセンスのlicense_expiration_dateを過ぎています。

invalid license expiration datelicense_expiration_date フィールドのデータの形式が正しくありません。Kong Inc. からライセンスファイルを再ダウンロードしてインストールしてみてください。再インストール後もこのエラーが発生する場合は、Kong サポートにお問い合わせください。