Edge のインストールの概要

Edge for Private Cloud バージョン 4.17.05

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

インストール プロセス

ノードへの Edge のインストールは、複数のステップからなるプロセスです。

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

      詳細については、Edge apigee-setup ユーティリティのインストールをご覧ください。
  • apigee-setup ユーティリティを使用して、選択したトポロジに基づいて各ノードに 1 つ以上の Edge コンポーネントをインストールします。
    ノード上のノードに Edge コンポーネントをインストールするをご覧ください。
  • Management Server ノードで、apigee-setup ユーティリティを使用して apigee-provision をインストールします。apigee-provision は、Edge 組織の作成と管理に使用するユーティリティです。
    詳細については、組織のオンボーディングをご覧ください。

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

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 スクリプト(apigee-service install を使用して必要な RPM をインストールしている場合を除く)。root 権限または sudo フルアクセス権限(不要な場合)。)
  • Edge コンポーネントを更新する update.sh スクリプト

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

上記以外のコマンドを実行するユーザーは、「apigee」ユーザーに対する sudo フルアクセス権を持つユーザーである必要があります。次のようなコマンドがあります。

  • apigee-service ユーティリティ コマンド(以下を含む):
    • start、stop、reboot、configure などの apigee-service コマンド
    • apigee-all コマンド(start、停止、再起動、構成など)。

「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.17.05.sh ファイルをダウンロードして実行します。
      > curl https://software.apigee.com/bootstrap_4.17.05.sh -o /tmp/bootstrap_4.17.05.sh
      > sudo Word user /tmp/bootstrap_apigee. ユーティリティをユーザーとしてインストールします。uName
    2. 前述のように、「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-ui、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 をノードにインストールするには、そのノードが Apigee リポジトリにアクセスできる必要があります。

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

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

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

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

ローカルの Edge リポジトリを使用して Edge のバージョンを維持する

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

ただし、外部インターネット接続があるノードであっても、ローカル リポジトリを使用する利点は他にもあります。Apigee 公開リポジトリから Edge をインストールする場合は、常に最新の Edge RPM をインストールします。したがって、特定のバージョンの Edge 用の Edge RPM をダウンロードして保存する場合は、その Edge バージョンのローカル リポジトリを作成する必要があります。そのローカル リポジトリを使用して、任意のバージョンの Edge のインストールを実行できます。

たとえば、最初にローカル リポジトリを使用して Edge 開発環境をインストールします。その後、本番環境に移行する準備ができたら、再びローカル リポジトリから Edge をインストールします。ローカル リポジトリからインストールすることで、開発環境と本番環境が一致していることが保証されます。

ミラーリングされたリポジトリは非常に柔軟性があります。たとえば、最新の Edge RPM や特定のバージョンの Edge からミラーリングされたリポジトリを作成できます。リポジトリを作成した後、それを更新して、異なる Edge バージョンから RPM を追加することもできます。詳細については、Edge apigee-setup ユーティリティのインストールをご覧ください。

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

Apigee Edge 配布ファイルは、RPM ファイルのセットとしてインストールされます。各 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-setupsetup.sh スクリプトのログファイルは、/tmp/setup-root.log に書き込まれます。

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

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

次の表に、ログファイルの場所を示します。

コンポーネント

場所

管理サーバー

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

ルーター

/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 サーバー

/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

データ

コンポーネント

場所

管理サーバー

/opt/apigee/data/edge-management-server

ルーター

/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 コンポーネントの構成

インストール後に 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 では、Edge のインストールを管理するために使用できる管理ユーティリティが /opt/apigee/apigee-service/bin にインストールされます。たとえば、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 action

たとえば、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
  • baas - API BaaS コンポーネント。例: baas-usergrid

各コンポーネントの動作はコンポーネントによって異なりますが、以下のアクションはすべてのコンポーネントでサポートされています。

  • 起動、停止、再起動
  • status、version
  • バックアップ、復元
  • install、uninstall