組織のオンボーディング

Edge for Private Cloud v4.19.01

組織をオンボーディングするには、オンボーディング構成ファイルを作成して、setup-org コマンドに渡す必要があります。それぞれの手順については、以降のセクションで説明します。

Management API を使用して組織をオンボーディングする方法については、組織、環境、仮想ホストの作成をご覧ください。

オンボーディング構成ファイルを作成する

このセクションでは、setup-org を使用して組織をオンボーディングするためのサンプル構成ファイルについて説明します。

次の例をコピーし、組織に応じて編集します。

IP1=192.168.1.1

# Specify the IP or DNS name of the Management Server.
MSIP="$IP1"

# Specify the Edge sys admin credentials.
ADMIN_EMAIL="admin@email.com"
APIGEE_ADMINPW=admin_password  # If omitted, you are prompted for it.

# Specify organization name.
ORG_NAME=myorg  # lowercase only, no spaces, underscores, or periods.

# Specify the organization administrator user.
# Either specify an existing user, or specify the information
# necessary to create a new user.
# Do not use the sys admin as the organization administrator.
#
# Create a new user for the organization administrator.
NEW_USER="y"
# New user information if NEW_USER="y".
USER_NAME=new@user.com
FIRST_NAME=new
LAST_NAME=user
# Org admin password must be at least 8 characters long and contain one uppercase
# letter, one lowercase letter, and one digit or special character
USER_PWD="newUserPword"
ORG_ADMIN=new@user.com
#
# Or, specify an existing user as the organization admin,
# omit USER_NAME, FIRST_NAME, LAST_NAME, USER_PWD.
# NEW_USER="n"
# ORG_ADMIN=existing@user.com

# Specify environment name.
ENV_NAME=prod  # lowercase only

# Specify virtual host information.
VHOST_PORT=9001
VHOST_NAME=default

# If you have a DNS entry for the virtual host.
VHOST_ALIAS=myorg-test.apigee.net

# If you do not have a DNS entry for the virtual host,
# specify the IP and port of each router as a space-separated list:
# VHOST_ALIAS="firstRouterIP:9001 secondRouterIP:9001"

# Optionally configure TLS/SSL for virtual host.
# VHOST_SSL=y     # Set to "y" to enable TLS/SSL on the virtual host.
# KEYSTORE_JAR=   # JAR file containing the cert and private key.
# KEYSTORE_NAME=  # Name of the keystore.
# KEYSTORE_ALIAS= # The key alias.
# KEY_PASSWORD=   # The key password, if it has one.

# Specify the analytics group.
# AXGROUP=axgroup-001 # Default name is axgroup-001.

:

  • VHOST_ALIAS に、仮想ホストへのアクセスに使用する DNS レコードがすでにある場合は、ホスト エイリアスを指定します。必要に応じてポートを指定します(「myapi.example.com」など)。DNS レコードがない場合は、Router の IP アドレスを使用できます。

    仮想ホストの構成方法については、仮想ホストの設定をご覧ください。

  • TLS / SSL 構成の JAR ファイルの作成とその他の側面について詳しくは、キーストアとトラストストアPrivate Cloud 用 API への TLS アクセスの構成をご覧ください。
  • 仮想ホストの構成の詳細については、Private Cloud 用 API への TLS アクセスの構成をご覧ください。
  • 同じ名前の組織を 2 つ作成することはできません。その場合、2 回目の作成は失敗します。

setup-org を実行する

オンボーディング構成ファイルを作成したら、それを setup-org スクリプトに渡してオンボーディング プロセスを実行します。このスクリプトは Management Server ノードで実行する必要があります。

組織をオンボーディングするとき、setup-org スクリプトは次の処理を行います。

  • 新しい組織を作成します。
  • 環境を作成する。
  • 環境の仮想ホストを作成します。
  • 指定したユーザーを組織管理者として設定します。以下の点にご注意ください。
    • 既存のユーザーを使用することも、組織管理者に新しいユーザーを作成することもできます。
    • 組織管理者をシステム管理者と同じにすることはできません
  • 組織を "gateway" ポッドに関連付けます。(これはデフォルトであり、変更できません)。
  • 環境をすべての Message Processor に関連付けます。
  • 分析を可能にする。

setup-org を実行するには:

  1. Management Server ノードに apigee-provision をインストールします。
    /opt/apigee/apigee-service/bin/apigee-service apigee-provision install
  2. Management Server ノードで setup-org スクリプトを実行し、オンボーディング構成ファイルを作成するで作成した構成ファイルを指定します。
    /opt/apigee/apigee-service/bin/apigee-service apigee-provision setup-org -f configFile

    構成ファイルは「apigee」ユーザーによって読み取り可能である必要があります。

  3. 組織のオンボーディングが正常に完了したことを確認します。これを行う方法の 1 つは、ブラウザで次の URL をリクエストして UI にログインする方法です。
    http://IP_address:9000/login

    ここで、IP_address は Edge UI をインストールしたサーバーの IP アドレスです。

    その他の確認手順については、オンボーディングを確認するをご覧ください。

  4. 最初のプロキシを作成します。

オンボーディングを確認する

オンボーディングが完了したら、Management Server ノードで次の curl コマンドを実行して、システムのステータスを確認します。

  1. 次のコマンドを実行して、Management Server でユーザーと組織のステータスを確認します。
    curl -u adminEmail:admin_passwd http://localhost:8080/v1/users
    curl -u adminEmail:admin_passwd http://localhost:8080/v1/organizations
    curl -u adminEmail:admin_passwd http://localhost:8080/v1/organizations/org_name/deployments
  2. curl -u adminEmail:admin_password http://localhost:8080/v1/organizations/org_name/environments/env_name/provisioning/axstatus
    コマンドを実行してアナリティクスを確認します。
  3. ノード 2 で次のコマンドを実行して、PostgreSQL データベースのステータスを確認します(インストール トポロジを参照)。
    psql -h /opt/apigee/var/run/apigee-postgresql -U apigee apigee

    コマンド プロンプトで次のコマンドを入力して、組織の分析テーブルを表示します。

    \d analytics."org_name.env_name.fact"

    次のコマンドを使用して、psql を終了します。

    \q
  4. ウェブブラウザを使用して Apigee Edge UI にアクセスします。インストールの最後に管理コンソールの URL をメモしました。
    1. 任意のブラウザを起動し、Edge UI の URL を入力します。次のようになります。ここで IP アドレスは、インストール トポロジに示されているノード 1、または代替構成用の UI をインストールしたノードの IP アドレスです。
      http://192.168.56.111:9000/login

      9000 は UI で使用されるポート番号です。

      Edge UI をホストするサーバーでブラウザを直接起動する場合は、次の形式の URL を使用できます。

      http://localhost:9000/login

    2. コンソールのログインページで、Apigee システム管理者のユーザー名とパスワードを指定します。
  5. 新しい Apigee ユーザー アカウントに登録し、新しいユーザー認証情報を使用してログインします。コンソールのログインページで [ログイン] ボタンをクリックします。

    ブラウザが http://192.168.56.111:9000/platform/#/org_name/ にリダイレクトされ、作成した組織を構成できるダッシュボードが開きます(Apigee 管理者の認証情報を使用してログインした場合)。

最初のプロキシを作成する

新しい組織をオンボーディングし、オンボーディング プロセスが正常に完了したことを確認したら、最初のプロキシを作成できます。詳細については、初めての API プロキシの構築をご覧ください。

その他の便利なリソース: