Edge のインストールの概要

Edge for Private Cloud v4.18.05

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

インストール プロセス

ノードに Edge をインストールする手順は次のとおりです。

  1. ノードで SELinux を無効にするか、permissive モードに設定します。詳細については、Edge apigee-setup ユーティリティをインストールするをご覧ください。
  2. Cassandra 認証を有効にするかどうかを決定します。
  3. Postgres のマスター / スタンバイ レプリケーションを設定するかどうかを決定します。
  4. 推奨トポロジのリストから Edge 構成を選択します。たとえば、テスト用に 1 つのノードに 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. ファイルの所有者を「apigee:apigee」に変更します。Edge サービスを実行しているユーザーを「apigee」ユーザーから変更した場合は、Edge サービスを実行しているユーザーにファイルを chown します。chown

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 UI コンポーネントを再起動してください。

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

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

  • 外部インターネット接続を使用するノード

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

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

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

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

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

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

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-setup と setup.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 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

データ

コンポーネント ロケーション
管理サーバー /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 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.properties や management-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_name action

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

  • apigee-cassandra（Cassandra）
  • apigee-openldap（OpenLDAP）
  • apigee-postgresql（PostgreSQL データベース）
  • apigee-qpidd（Qpidd）
  • apigee-sso（Edge SSO）
  • apigee-zookeeper（ZooKeeper）
  • edge-management-server（Management Server）
  • edge-management-ui（新しい Edge UI）
  • edge-message-processor（Message Processor）
  • edge-postgres-server（Postgres Server）
  • edge-qpid-server（Qpid Server）
  • edge-router（Edge Router）
  • edge-ui（Classic 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: 収益化コンポーネント。（例: edge-mint-management-server）。

コンポーネントのアクションの完全なリストはコンポーネント自体によって異なりますが、すべてのコンポーネントが次のアクションをサポートしています。

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

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

Edge インストール構成ファイルは、次のプロパティをサポートしています。

ENABLE_SYSTEM_CHECK=y

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