デプロイの概要

このトピックでは、プロキシのデプロイの概要について簡単に説明します。管理 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 プロキシの以前のリビジョンをオーバーライドできます。

リビジョンの詳細については、Management API を使用した API プロキシのデプロイUI でのプロキシのデプロイをご覧ください。

動画: API リビジョンについて詳しく解説する動画をご覧ください。