Edge のインストールの概要

Edge for Private Cloud v4.18.05

一般的な Edge のインストールは、複数のノードに分散された Edge コンポーネントで構成されます。Edge をノード上にインストールしてから、そのノードに 1 つ以上の Edge コンポーネントをインストールして構成します。

インストール プロセス

Edge のインストール プロセスは、次の複数のステップで構成されます。

  1. ノード上の SELinux を無効にするか、制限なしモードに設定します。詳細については、Edge apigee-setup ユーティリティをインストールするをご覧ください。
  2. Cassandra 認証を有効にするかどうかを決定します。
  3. Postgres 用のマスター / スタンバイ レプリケーションを設定するかどうかを決定します。
  4. 推奨されるトポロジのリストから、Edge 構成を選択します。たとえば、テスト用として単一のノードへの Edge をインストールしたり、本番用として 13 個のノードにインストールしたりできます。詳細については、インストール トポロジをご覧ください。
  5. 選択したトポロジの各ノード上に Edge apigee-setup ユーティリティをインストールします。
    • Edge の bootstrap_4.18.05.sh ファイルを /tmp/bootstrap_4.18.05.sh にダウンロードします。
    • Edge apigee-service ユーティリティと依存関係をインストールします。
    • Edge apigee-setup ユーティリティと依存関係をインストールします。

      詳細については、Edge apigee-setup ユーティリティをインストールするをご覧ください。

  6. 選択したトポロジに基づいて、apigee-setup ユーティリティを使用して各ノードに 1 つ以上の Edge コンポーネントをインストールします。

    ノードに Edge コンポーネントをインストールするをご覧ください。

  7. Management Server ノード上で、apigee-setup ユーティリティを使用して、Edge 組織の作成と管理に使用するユーティリティである apigee-provision をインストールします。

    詳細については、組織のオンボーディングを行うをご覧ください。

  8. インストールの完了後に Edge UI コンポーネントを再起動します。

インストールを実行できるユーザー

Apigee Edge 配布ファイルは、RPM と依存関係のセットとしてインストールされます。Edge RPM のインストール、アンインストール、更新を行うには、root ユーザー、または sudo フルアクセス権限を持つユーザーがコマンドを実行する必要があります。sudo フルアクセス権限があるということは、root と同じ操作を実行する sudo アクセス権がユーザーにあることを意味します。

以下のコマンドやスクリプトを実行するユーザーはすべて、root であるか、sudo フルアクセス権限が付与されている必要があります。

  • apigee-service ユーティリティ:
    • apigee-service コマンド: install, uninstall, update.
    • apigee-all コマンド: install, uninstall, update.
  • Edge コンポーネントをインストールする setup.sh スクリプト(必要な RPM のインストールにまだ「apigee-service install」を使用しておらず、root または sudo フルアクセス権限が必要とされていない場合。)
  • Edge コンポーネントを更新する update.sh スクリプト

また、Edge インストーラにより、システム上に「apigee」という名前の新しいユーザーが作成されます。Edge コマンドの多くは、sudo を呼び出して「apigee」ユーザーとして実行します。

上記以外のすべてのコマンドを実行するユーザーは、「apigee」ユーザーに対する sudo フルアクセス権限が付与されている必要があります。これらのコマンドには次のものがあります。

  • 以下を含む apigee-service ユーティリティ コマンド:
    • start, stop, restart, configure などの apigee-service コマンド
    • start, stop, restart, configure などの apigee-all コマンド

「apigee」ユーザーに対する sudo フルアクセス権限を持つユーザーの作成

「apigee」ユーザーに対する sudo フルアクセス権限をユーザーに構成するには、「visudo」コマンドを使用して sudoers ファイルを編集して以下を追記します。

installUser        ALL=(apigee)      NOPASSWD: ALL

installUser は、Edge を扱うユーザーのユーザー名です。

構成ファイルに対するアクセス許可の設定

Edge コマンドで使用されるファイルやリソースはすべて、「apigee」ユーザーからアクセスできる必要があります。これには、Edge ライセンス ファイルとすべての構成ファイルが含まれます。

構成ファイルの作成時に、次のようにオーナーを「apigee:apigee」に変更することで、Edge コマンドに確実にアクセスできるようにします。

  1. このファイルを任意のユーザーとしてエディタで作成します。
  2. chown を使用してファイルのオーナーを「apigee:apigee」に変更するか、また Edge サービスを実行するユーザーを「apigee」ユーザーから変更している場合は、chown を実行してファイルのオーナーを Edge サービスを実行しているユーザーに変更します。

root ユーザーと root 以外のユーザーの Edge インストール タスクの分離

Edge のインストール プロセス全体を root ユーザーか sudo フルアクセス権限のあるユーザーによって実行することが最も簡単な方法ですが、常にこのようにできるとは限りません。代替の方法として、プロセスを root ユーザーが実行するタスクと、「apigee」ユーザーに対する sudo フルアクセス権限を持つユーザーが実行するタスクとに分けることができます。

  1. root ユーザーが実行するタスク:
    1. bootstrap_4.18.05.sh ファイルをダウンロードして実行します。
      curl https://software.apigee.com/bootstrap_4.18.05.sh -o /tmp/bootstrap_4.18.05.sh
          sudo bash /tmp/bootstrap_4.18.05.sh apigeeuser=uName apigeepassword=pWord

      このステップで apigee-service ユーティリティがインストールされ、「apigee」ユーザーが作成されます。

    2. 「apigee」ユーザーに対する sudo フルアクセス権限を持つユーザーの作成の説明に沿って、「apigee」ユーザーに対する sudo フルアクセス権限を持つようにユーザーを構成します。
    3. apigee-setup ユーティリティをインストールします。
      /opt/apigee/apigee-service/bin/apigee-service apigee-setup install
    4. apigee-setup ユーティリティを使用して、ノードに Edge RPM をインストールします。
      /opt/apigee/apigee-service/bin/apigee-service compName install

      ノードにインストールする Edge RPM は、トポロジによって異なります。使用できるコンポーネントには以下が含まれます。 apigee-provision, apigee-validate, apigee-zookeeper, apigee-cassandra, apigee-openldap, edge-management-server, edge-ui, edge-router, edge-message-processor, apigee-postgresql, apigee-qpidd, edge-postgres-server, edge-qpid-server

  2. root ユーザーがノードに Edge RPM をインストールした後に、「apigee」ユーザーに対する sudo フルアクセス権限を持つユーザーが構成プロセスを完了させます。
    1. setup.sh ユーティリティを使用して、ノード上の Edge コンポーネントの構成を完了します。コマンドの形式は、ノードにインストールしたコンポーネントによって異なります。完全なリストについては、ノードに Edge コンポーネントをインストールするをご覧ください。

      たとえば、ZooKeeper と Cassandra のインストールを完了するには、次のコマンドを使用します。

      /opt/apigee/apigee-setup/bin/setup.sh -p ds -f configFile

      configFile は Edge 構成ファイルです。

      また、オールインワン インストールを実行するには、次のコマンドを使用します。

      /opt/apigee/apigee-setup/bin/setup.sh -p aio -f configFile

インストール構成ファイルの場所

Edge インストールに関する情報が含まれる構成ファイルを apigee-setup ユーティリティに渡す必要があります。サイレント インストールの唯一の要件は、「apigee」ユーザーから構成ファイルへのアクセスと読み取りが可能であることです。たとえば、ノードの /usr/local/var ディレクトリまたは /usr/local/share ディレクトリにファイルを配置して、chown を使用して「apigee:apigee」にオーナーを変更します。

Edge システム管理者のパスワードを除き、構成ファイル内のすべての情報が必要です。パスワードを省略した場合、コマンドラインで apigee-setup ユーティリティから入力を求められます。

詳細については、ノードに Edge コンポーネントをインストールするをご覧ください。

インストール エラーの処理

Edge コンポーネントのインストール中にエラーが発生した場合は、問題を修正してインストーラを再試行できます。インストーラは、エラーが検出された場合や、インストール後にコンポーネントの変更や更新が必要になった場合に繰り返し実行できるように設計されています。

インストールや更新の後は、Edge UI コンポーネントが実行される各ノードを必ず再起動してください。

インターネットまたはインターネット以外のインストール

Edge をノードにインストールするには、そのノードが Apigee リポジトリにアクセスできる必要があります。

  • 外部インターネット接続があるノード

    外部インターネット接続があるノードは、Apigee リポジトリにアクセスして Edge RPM と依存関係をインストールします。

  • 外部インターネット接続がないノード

    外部インターネット接続がないノードは、内部に設定されたミラー バージョンの Apigee リポジトリにアクセスできます。このリポジトリにはすべての Edge RPM が含まれますが、内部ネットワーク上のリポジトリから他のすべての依存関係を利用できることを保証する必要があります。

    Apigee の内部リポジトリを作成するには、ノードが外部とインターネット接続できるようにし、Edge RPM と依存関係をダウンロードできるようにする必要があります。内部リポジトリを作成したら、そのリポジトリを別のノードに移動したり、そのノードを Edge ノードからアクセスできるようしたりして、インストールに使用できます。

ローカル Edge リポジトリを使用した Edge バージョンの管理

ローカル リポジトリやミラーリングされたリポジトリを使用する理由の 1 つは、前のセクションで説明したように、外部インターネット接続がないノードに Edge をインストールするためです。

RPM インストールの依存関係の解決

Apigee Edge 配布ファイルは、RPM ファイルのセットとしてインストールされ、それぞれに独自のインストール依存関係チェーンがあります。このような依存関係の多くは、Apigee の管理外にあるサードパーティ コンポーネントによって定義され、随時変更される可能性があります。このため、このドキュメントには、各依存関係の明示的なバージョン番号は記載されていません。

インターネット アクセスのあるマシン上でインストールを実行する場合は、ノードで必要な RPM と依存関係をダウンロードできます。しかし、インターネット アクセスがないノードからインストールする場合は通常、必要な依存関係のすべてが含まれる内部リポジトリを設定します。ローカル リポジトリにすべての依存関係が含まれることを保証する唯一の方法は、インストールを試行し、不足している依存関係があるかどうかを確認して、インストールが正常に完了するまでそうした依存関係をローカル リポジトリにコピーすることです。

一般的な Yum コマンド

Linux 用 Edge インストール ツールは、コンポーネントのインストールと更新を Yum に依存しています。ノード上のインストールを管理するには、複数の Yum コマンドの使用が必要な場合があります。

  • すべての Yum キャッシュをクリーニングする。
    sudo yum clean all
  • Edge コンポーネントを更新する。
    sudo yum update componentName

    例:

    sudo yum update apigee-setup
        sudo yum update edge-management-server

ファイル システムの構造

Edge ではすべてのファイルが /opt/apigee ディレクトリにインストールされます。

このガイドと Edge のオペレーション ガイドでは、ルート インストール ディレクトリが次のように記載されています。

/opt/apigee

インストールでは、次のファイル構造を使用して Apigee Edge for Private Cloud がデプロイされます。

ログファイル

apigee-setup スクリプトと setup.sh スクリプトのログファイルは、/tmp/setup-root.log に書き込まれます。

各コンポーネントのログファイルは、/opt/apigee/var/log ディレクトリに保存されます。各コンポーネントには独自のサブディレクトリがあります。たとえば、Management Server のログは次のディレクトリにあります。

/opt/apigee/var/log/edge-management-server

次の表は、ログファイルの場所のリストです。

コンポーネント 場所

Management Server

/opt/apigee/var/log/edge-management-server

Router

/opt/apigee/var/log/edge-router

Edge Router は Nginx を使用して実装されます。追加のログについては、以下をご覧ください。

/opt/apigee/var/log/edge-router/nginx
/opt/nginx/logs

Message Processor

/opt/apigee/var/log/edge-message-processor

Apigee Qpid Server

/opt/apigee/var/log/edge-qpid-server
Apigee Postgres Server /opt/apigee/var/log/edge-postgres-server
Edge UI /opt/apigee/var/log/edge-ui
ZooKeeper /opt/apigee/var/log/apigee-zookeeper
OpenLDAP /opt/apigee/var/log/apigee-openldap
Cassandra /opt/apigee/var/log/apigee-cassandra
Qpidd /opt/apigee/var/log/apigee-qpidd
PostgreSQL データベース /opt/apigee/var/log/apigee-postgresql

データ

コンポーネント 場所
Management Server /opt/apigee/data/edge-management-server
Router /opt/apigee/data/edge-router
Message Processor /opt/apigee/data/edge-message-processor
Apigee Qpid エージェント /opt/apigee/data/edge-qpid-server
Apigee Postgres エージェント /opt/apigee/data/edge-postgres-server
ZooKeeper /opt/apigee/data/apigee-zookeeper
OpenLDAP /opt/apigee/data/apigee-openldap
Cassandra /opt/apigee/data/apigee-cassandra/data
Qpidd /opt/apigee/data/apigee-qpid/data
PostgreSQL データベース /opt/apigee/data/apigee-postgres/pgdata

インストール後のタスク

インストールの完了後は、Edge コンポーネントで追加のアクションを実行できます。

Edge UI コンポーネントを再起動する

インストールの完了後は、各ノードの Edge UI コンポーネントを再起動する必要があります。

/opt/apigee/apigee-service/bin/apigee-service edge-ui restart

インストール後の Edge コンポーネントの構成

Edge をインストール後に構成するには、.properties ファイルと Edge ユーティリティを組み合わせて使用します。たとえば、Edge UI で TLS / SSL を構成するには、.properties ファイルを編集して必要なプロパティを設定します。.properties ファイルの変更後は、影響が及ぶ Edge コンポーネントを再起動する必要があります。

.properties ファイルは /opt/apigee/customer/application ディレクトリにあります。各コンポーネントのディレクトリには独自の .properties ファイルがあります。たとえば、router.propertiesmanagement-server.properties などのファイルです。

コンポーネントのプロパティを設定するには、対応する .properties ファイルを編集してから、そのコンポーネントを再起動します。

/opt/apigee/apigee-service/bin/apigee-service component restart

例:

/opt/apigee/apigee-service/bin/apigee-service edge-router restart

Edge を更新すると /opt/apigee/customer/application ディレクトリの .properties ファイルが読み取られます。つまり、更新後も、そのコンポーネントで設定されたプロパティは保持されます。

Edge の構成の詳細については、Edge の構成方法をご覧ください。

Edge コンポーネントでのコマンドの呼び出し

Edge では /opt/apigee/apigee-service/bin に管理ユーティリティがインストールされ、Edge インストールの管理に使用できます。たとえば、apigee-all ユーティリティは、ノード上のすべての Edge コンポーネントの起動、停止、再起動、ステータスの決定に使用できます。

/opt/apigee/apigee-service/bin/apigee-all stop|start|restart|status|version

個々のコンポーネントを管理して構成するには、apigee-service ユーティリティを使用します。apigee-service ユーティリティの形式は次のとおりです。

/opt/apigee/apigee-service/bin/apigee-service component_name action

component_name はコンポーネントを表します。コンポーネントは、apigee-service を実行するノード上に存在する必要があります。構成に応じて、component_name の値には次の使用可能値があります。

  • apigee-cassandra(Cassandra)
  • apigee-openldap(OpenLDAP)
  • apigee-postgresql(PostgreSQL データベース)
  • apigee-qpidd(Qpidd)
  • apigee-zookeeper(ZooKeeper)
  • edge-management-server(Management Server)
  • edge-message-processor(Message Processor)
  • edge-postgres-server(Postgres Server)
  • edge-qpid-server(Qpid Server)
  • edge-router(Edge Router)
  • edge-ui(Edge UI)

これらのコンポーネントに加え、構成によっては apigee-provision コンポーネントと apigee-validate コンポーネントで apigee-service も呼び出すことができます。

たとえば、Edge Router を再起動するには、次のコマンドを実行します。

/opt/apigee/apigee-service/bin/apigee-service edge-router restart

ノードにインストールされているコンポーネントのリストは、/opt/apigee ディレクトリを調べることで判別できます。このディレクトリには、ノード上にインストールされているすべての Edge コンポーネントのサブディレクトリがあります。各サブディレクトリには次の接頭辞が付けられます。

  • apigee: Edge で使用されるサードパーティ コンポーネント。例: apigee-cassandra
  • edge: Apigee からの Edge コンポーネント。例: edge-management-server
  • edge-mint: Monetization コンポーネント。例: edge-mint-management-server

特定のコンポーネントのアクションの完全なリストは、各コンポーネントごとに異なりますが、次のアクションはすべてのコンポーネントでサポートされます。

  • start, stop, restart
  • status, version
  • backup, restore
  • install, uninstall

インストール時にシステム チェックを有効にする

Edge インストールの構成ファイルでは、次のプロパティがサポートされます。

ENABLE_SYSTEM_CHECK=y

このプロパティを「y」に設定すると、インストールするコンポーネントの CPU とメモリの要件をシステムが満たしているかどうかがチェックされます。デフォルト値は「n」で、チェックが無効になっています。