API ゲートウェイのリリースノート

OpenLM Platform をリリースするたびに、API ゲートウェイの最新リリースをインストールしてください。アップグレードの手順は、API ゲートウェイ を参照してください。

1.0.0-rc.2

リリース候補です。--version 1.0.0-rc.2 を指定してインストールします。このリリースの変更点は次のとおりです。

• ゲートウェイのルートが 80 個 になりました（以前は 75 個）。新しいルート: /api/assistantservice、/api/automation、/api/flowengine、/api/resourcetracking、/api/usersdirectory。
• すべてのルートが短いサービス名でサービスに到達するようになり、ゲートウェイはどの namespace でも動作します。以前は、4 つのルート（/api/agents-hub/announce、/api/integration-orchestrator、/api/marketplacemanager、/api/servicenow-alerts）が namespace openlm でしか動作しませんでした。以前のアップグレード後にこれらのルートを手動で修正していた場合、その作業は不要になりました。
• /api/atlassianintegration は、サービスのポート 3080 を使用します。
• ストレージクラスが指定されていない場合のエラーメッセージのスペルが修正されました。

1.0.0-rc.1 からのアップグレード: values ファイルを指定してアップグレードを実行します。ルートを読み込むジョブが再実行され、すべてのルートが置き換わります。ゲートウェイの Pod は再起動しません。

0.2.x からのアップグレード: 先に、1.0.0-rc.1 の アップグレードの前に を読んでください。

1.0.0-rc.1

リリース候補です。--version 1.0.0-rc.1 を指定してインストールします。指定しないと、Helm はプレリリースバージョンを無視します。

一部のインストールでは対応が必要です。 アップグレードの前に を読んでください。

このリリースの変更点は次のとおりです。

• チャートの名前が openlm-apigateway になり、OpenLM の Helm リポジトリ（https://openlm-helm.github.io/helmcharts）から入手できるようになりました。0.2.x までのバージョンの名前は openlm-gateway でした。バージョン番号は 1.0.0 から始まり直します。
• チャートに既定の APISecret がなくなりました。独自のシークレットを、できれば useSecretName でシークレットとして設定してください。設定しない場合、helm install と helm upgrade はメッセージを表示して停止します。
• API のルートとゲートウェイのバージョンは、0.2.12 から変わりません（Tyk Gateway 5.9.1）。

アップグレードの前に

0.2.x からアップグレードする前に、次の手順に従います。

1. リリース名は openlm-gateway のままにし、新しいチャートでアップグレードします。OpenLM Platform は /api を既存のゲートウェイに送るため、openlm-apigateway を新しいリリース名でインストールしないでください。
2. お使いのインストールに独自のシークレットがあるかを確認します。

   helm -n "$NS" get values openlm-gateway | grep -E "useSecretName|APISecret"

   • 名前付きの useSecretName、または自分で選んだ値の APISecret が表示される場合は、何もする必要はありません。アップグレードによってオブジェクトは変更されず、ゲートウェイも再起動しません。
   • 何も表示されない場合、または自分で選んでいない APISecret が表示される場合は、先にシークレットを作成してから、useSecretName を指定してアップグレードします（openlm-gateway 0.2.x からのアップグレード を参照）。ゲートウェイが 1 回再起動するため、/api は数秒間使用できなくなります。古いシークレットでゲートウェイのコントロール API を呼び出す独自のスクリプトがあれば更新してください。

アップグレードが "The gateway needs its own APISecret" で停止した場合、クラスターには何も変更されていません。シークレットを作成して、アップグレードを再実行してください。

0.2.12

このリリースの変更点は次のとおりです。

• OpenShift では、/api のルートが、インストール先の namespace（helm -n）に作成されるようになりました。以前は常に openlm に作成されていました。
• ルートの名前を選ぶための新しい設定 openShiftRoute.name（既定値は openlm-gateway）を追加しました。手動で作成したルートを引き継ぐ場合などに使用します。
• namespace openlm にインストールしている場合は変更ありません。

0.2.11

このリリースの変更点は次のとおりです。

• OpenShift では、/api のルートが OpenLM Platform のルートと同じセキュリティヘッダーを設定するようになりました: HSTS（1 年、サブドメインを含む）、X-Frame-Options: SAMEORIGIN、X-Content-Type-Options: nosniff、Referrer-Policy: strict-origin-when-cross-origin、Content-Security-Policy: frame-ancestors 'self'。(80929)
• openShiftRoute.routeSecurity の下に新しい設定を追加しました: enabled（既定値は true）、hstsMaxAge、hstsIncludeSubDomains。これらのヘッダーには OpenShift 4.14 以降が必要です。それより古いバージョンでは enabled: false を設定してください。
• これらのヘッダーを /api のルートに手動で追加していた場合、アップグレードによって同じ値が設定されます。Helm がルートのフィールドの競合を報告した場合は、手動の変更を削除してから、もう一度アップグレードしてください。