このトピックでは、プロキシのデプロイの概要について簡単に説明します。管理 UI、コマンドライン スクリプト、API を使用してプロキシをデプロイできます。
動画: API プロキシのデプロイ中のダウンタイムをゼロにするためのベスト プラクティスについての短い動画をご覧ください。
プロキシをデプロイするタイミング
プロキシを呼び出すには、その前にプロキシをデプロイする必要があります。一般に、デプロイのタイミングは自由に決めることができます。テスト環境で作業を行っている場合、何回でも繰り返しデプロイできます。一方、テスト環境から本番環境にプロキシをデプロイするかどうかの判断は、通常、開発チームが定めたライフサイクル ルールによって決まります。
プロキシのデプロイや再デプロイは、次のようなときに行われます。
- 新しいプロキシの作成時(デプロイは自動的に実行されます)
- 既存のプロキシの変更時
- プロキシの新しいリビジョンの作成時
- プロキシの新バージョン作成時
- テスト環境から本番環境への移行など、環境間でプロキシを移行するとき
- キーストアを削除して再作成するとき
プロキシをデプロイする場所
プロキシは 1 つの環境にデプロイされます。デフォルトで Apigee Edge のどの組織にも、少なくとも test と prod の 2 つの環境があります。これらの環境は単に、API を変更してそれをテストするための領域、および API をアプリに公開するための領域を提供するためのものです。次の図では、test
環境に展開されるプロキシを緑色の丸で示します。
プロキシをデプロイする方法
プロキシのデプロイ方法は、プロキシを開発している場所によって異なります。UI で作業している場合、数回のマウスクリックで簡単にプロキシをデプロイできます。新しいプロキシは、作成時に自動的にデプロイされるので、特別な操作は不要です。既存のプロキシを再デプロイする手順はシンプルです。デプロイ先の環境を選択するだけで、それ以降の操作は管理 UI によって実行されます。詳細については、UI でのプロキシのデプロイをご覧ください。
プロキシと関連コンポーネントをオフラインで開発している場合(プロキシ XML ファイルとその他のコードをファイル システムで直接操作する場合)、Apigee Edge では、便利なコマンドライン デプロイツールを使用できます。また、サンプル シェル スクリプトを入手して、プロキシ ファイルのアップロードとデプロイのためにそれを構成して実行することもできます。詳細については、コマンドラインからのプロキシのデプロイをご覧ください。
最後に、Edge 管理 API を使用してプロキシをデプロイできます。デプロイメント API は、開発チームが API 開発ライフサイクルの自動化と最適化のために調整できる最小単位の機能を公開しています。管理 API を使用して API プロキシをデプロイするをご覧ください。
API プロキシのリビジョンとは
API プロキシを作成して環境にデプロイするときに、リビジョンを使って API プロキシの更新を管理できます。リビジョンには順番に番号が付けられるので、API プロキシの旧リビジョンをデプロイすることで、変更を元に戻すことができます。複数のリビジョンが同じ API プロキシ ベースパスを共有している場合、一度に 1 つの環境にデプロイできる API プロキシのリビジョンは 1 つだけです。ただし、ベースパスを変更することで、API プロキシの複数のバージョンを同じ環境にデプロイできます。詳細については、UI でのプロキシのデプロイをご覧ください。
通常、新しいリビジョンをデプロイする前に、既存のリビジョンをデプロイ解除する必要があります。その他の高度なオプションには、デプロイされるリビジョンをオーバーライドするオプション、リビジョンの増分をまったく行わないオプションなどがあります。たとえば、小さな変更を行ったときに、リビジョンの増分が不必要な場合もあります。こうした高度なオプションは、Edge 管理 API の直接呼び出しで実行できます。管理 API を使用して API プロキシをデプロイするをご覧ください。
API プロキシのあるリビジョンを prod
環境に展開する一方で、その API プロキシの新たなリビジョンの作成を test
環境で継続できます。用意が整ったら、リビジョンの高い API プロキシを test
環境から「昇格」させて、prod
環境にある以前のリビジョンを上書きできます。
リビジョンの詳細については、管理 API を使用した API プロキシのデプロイと UI でのプロキシのデプロイをご覧ください。
動画: API リビジョンについて詳しく解説する動画をご覧ください。