Edge Microgateway の CLI リファレンス

<ph type="x-smartling-placeholder"></ph> 現在、Apigee Edge のドキュメントが表示されています。
Apigee X のドキュメント。 詳細

Edge マネージャー v. 3.3.x

概要

Edge Appliance CLI を使用すると、Edge AppSheet のあらゆる側面を制御および管理できます。 作成します。

<ph type="x-smartling-placeholder">

証明書の管理

cert コマンドを使用すると、公開鍵/秘密鍵のペアをインストールして管理できます クライアントが Edge を介して安全な呼び出しを行うために使用する署名なしトークンの署名に使用されます。 接続できます。鍵は、Apigee Edge に暗号化された Key-Value マップ（KVM）で保存されます。Edge Appliance は、 署名付きの署名なしトークンを検証できます。これらの鍵は、Edgemicro の Configure コマンドを使用します。詳しくは、 Edge Appliance の構成をご覧ください。ここで説明する cert コマンドを使用できます。 鍵を再生成して管理できます。

証明書をインストールする

暗号化された Key-Value マップ（KVM）に鍵をインストールし、 できます。鍵ペアのスコープは、指定された組織に設定されます。

使用目的

edgemicro cert install -o [organization] -e [environment] -u [username] -p [password] --force

パラメータ

パラメータ 説明
-o, --org Edge Appliance を構成した Apigee 組織。
-e, --env Edge Appliance を構成した環境。
-u, --username Apigee のユーザー名。指定したサービスの組織管理者である必要があります。 できます。
-p, --password （省略可）パスワード。Google Cloud コンソールにこのパラメータを指定しない場合は、 実行します。
-f, --force （省略可）鍵が暗号化された KVM にすでに格納されている場合は、強制的に置き換えます。
-h, --help 使用方法に関する情報を出力します。

例

edgemicro cert install -o docs -e test -u jdoe@example.com -f

出力

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
password:
deleting vault
creating vault
adding private_key
adding public_key
installed cert

証明書を削除する

組織の鍵ペアを削除します。

使用目的

edgemicro cert delete -o [organization] -e [environment] -u [username] -p [password]

パラメータ

パラメータ 説明
-o, --org Edge Appliance を構成した Apigee 組織。
-e, --env Edge Appliance を構成した環境。
-u, --username Apigee のユーザー名。指定したサービスの組織管理者である必要があります。 できます。
-p, --password （省略可）パスワード。Google Cloud コンソールにこのパラメータを指定しない場合は、 実行します。
-h, --help 使用方法に関する情報を出力します。

例

edgemicro cert delete -o docs -e test -u jdoe@example.com

出力

deleting vault
Vault deleted!

証明書を確認する

組織に証明書がインストールされていることを確認します。

使用目的

edgemicro cert check -o [organization] -e [environment] -u [username] -p [password]

パラメータ

パラメータ 説明
-o, --org Edge Appliance を構成した Apigee 組織。
-e, --env Edge Appliance を構成した環境。
-u, --username Apigee のユーザー名。指定したサービスの組織管理者である必要があります。 できます。
-p, --password （省略可）パスワード。Google Cloud コンソールにこのパラメータを指定しない場合は、 実行します。
-h, --help 使用方法に関する情報を出力します。

例

edgemicro cert check -o docs -e test -u jdoe@example.com

出力 （成功）

checked cert successfully

出力 （失敗）

証明書が存在しない場合は、エラーが返されます。

公開鍵を取得する

指定した組織の公開鍵を返します。認証は必要ありません。

使用目的

edgemicro cert public-key -o [organization] -e [environment]

パラメータ

パラメータ 説明
-o, --org Edge Appliance を構成した Apigee 組織。
-e, --env Edge Appliance を構成した環境。
-h, --help 使用方法に関する情報を出力します。

例

edgemicro cert public-key -o docs -e test

出力 （サンプル）

-----BEGIN CERTIFICATE-----

MIICpDCCAYwCCQCKpXWGum9uTjANBgkq9w0BAQsFADAUMRIwEAYDVQQDEwls
b2NhbGhvc3cNMTYxMTAyMjAxNTA2WhcNMTYxMTAzMjAxNTA2WjAUMRIwEAYD
VQQDEwlsb2Nvc3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDD
ETr/ne/gP47+9LgjLvBJjpbFVdaeUabZZ3wbA7sSIVnnNXWt3yPklrWSfIh+
L2+dq4k+YunsQE2+dwPdXA2x8DPGvqGcCdWPxnpZ7ix5Akbs8i/J+Ue0pXT4
jkpWbaDDftGL2tcxwP45yI+slpDYvmWRps07TFXkAPjGEHYPvCT9/v/35GkL
0h4v0S+XfpcjS5c47o7CIWlkgEM5GBosQUb17kuVR48392vGFPsnCP34iNe7
zguhiCXYg2zkOcj/N3AE4xKIhCz0QcewULy08GltWMmyjJ/30zs8P41JqoA4
RwfeEZ8RenN3rJQim1ppAAEwDQYJKoZIhvcNAQELBQADggEBAHcORIfc+ySe
2FMmqicNe6Wt5V/5zOaBMLsGQdqGOHB5cQc79sMBrk680KVhrwHXZ2nBIkVe
UEL+2qLY1VLfswBNAvcNwV9U4TwHq4eIANiD751oJK1tHmM/ujThQkwNf96o
6I7Ws+wfpGO3ppJCttRbtnATIxrwsCHN4i5lbW/tJSL7t/Zf6T1B+YSJU9AF
xuvLq22cCqyYJQdmKq2vVS55WRZdllm+mRtJrv7MLM9gfDPRxVlwrBz/eQHy
Fv+dwzxcvQjkz03RNhZUodzuD34DPJoYeK++rItsddwQ26KTahH80yYTAFzY
x9gfPf1/+qo=?

-----END CERTIFICATE-----

Apigee Edge Cloud 用の Edge Appliance の構成

Edge Gateway が Apigee Edge Cloud インスタンスと連携できるようにします。ラップして実行され 必要な認証プロキシを Edge にデプロイするための一連のコマンド、認証の生成 構成ファイルが更新されます。完全な動作例については、 Edge Appliance の構成をご覧ください。

<ph type="x-smartling-placeholder">

使用目的

edgemicro configure -o [organization] -e [environment] -u [username] -p [password]

パラメータ

パラメータ 説明
-o, --org Edge Appliance を構成した Apigee 組織。
-e, --env Edge Appliance を構成した環境。
-u, --username Apigee のユーザー名。指定したサービスの組織管理者である必要があります。 できます。
-p, --password （省略可）パスワード。Google Cloud コンソールにこのパラメータを指定しない場合は、 実行します。
-r, --url （省略可）organization:environment の仮想ホスト エイリアスを指定します。詳しくは、 Edge のドキュメントで仮想ホストの詳細をご覧ください。デフォルト: org-env.apigee.net
-c, --configDir （省略可）Edge AppSheet 構成ファイルのパスを指定します。デフォルトでは 構成ファイルは ./config/config.yaml にあります。（v2.4.x で追加）。
-x, --proxyName （省略可）edgemicro-auth プロキシのベースパスを設定します。もし edgemicro-auth プロキシは、デフォルトとは異なるパスにデプロイされます。 /edgemicro-auth を指定します。この機能を使用すると、Edge に新しいパスを設定できます。 接続できます。デフォルトでは、ベースパスは /edgemicro-auth です。（追加済み v2.4.x)
-t, --token （省略可）ユーザー名/パスワードの代わりに OAuth トークンを認証に使用できます。 OAuth2 アクセス トークンを使用した API 呼び出しの保護もご覧ください。 例:

edgemicro configure -o docs -e test -t <your token>
-v, --virtualHosts （省略可）デフォルトの仮想ホスト（ 「default,secure」このオプションは、サービス アカウントに仮想ホストが指定されている場合に これらのデフォルト以外のエッジ組織:環境。Edge のドキュメントをご覧ください。 詳しく学びます。
-d, --debug （省略可）デバッグ情報を提供します。
-h, --help 使用方法に関する情報を出力します。

使用上の注意

このコマンドは、構成情報を 約 /.edgemicro/org-env-config.yaml。

例

edgemicro configure -o docs -e test -u jdoe@example.com

出力

成功すると、Edge の起動時に使用する必要がある一連のキーが返されます。 接続できます。

...

The following credentials are required to start edge micro
  key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f
  secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372

edgemicro configuration complete!

キーの生成

genkeys コマンドは、Edge Datalab で使用される鍵とシークレットのペアを生成します。 Apigee Edge に分析データを非同期で送信する際に、自身を認証します。

使用目的

edgemicro genkeys -o [organization] -e [environment] -u [username] -p [password]

パラメータ

パラメータ 説明
-o, --org Edge Appliance を構成した Apigee 組織。
-e, --env Edge Appliance を構成した環境。
-u, --username Apigee のユーザー名。指定したサービスの組織管理者である必要があります。 できます。
-p, --password （省略可）パスワード。Google Cloud コンソールにこのパラメータを指定しない場合は、 実行します。
-t, --token （省略可）ユーザー名/パスワードの代わりに OAuth トークンを認証に使用できます。 OAuth2 アクセス トークンを使用した API 呼び出しの保護もご覧ください。 例:

edgemicro genkeys -o docs -e test -t <your token>
-h, --help 使用方法に関する情報を出力します。

使用上の注意

成功すると、このコマンドは 3 つのアイテムを返します。1 つ目の URL は 確認します。他の 2 つは、Edge の起動時に必要なキーペアです。 接続されます。

  • ブートストラップ URL: この URL は、 Apigee Edge に分析データを送信する Edge Appliance インスタンス。その URL をコピーして を Edge Appliance 構成ファイル ~/.edgemicro/org-env-config.yaml に配置します。
  • key: 鍵。このキーとシークレットは、CLI への入力として必要です。 コマンドを使用します。
  • secret: シークレット。

例

edgemicro genkeys -o docs -e test -u jdoe@example.com

出力 （サンプル）

成功すると、Edge の起動時に使用する必要がある一連のキーが返されます。 接続できます。

configuring host edgemicroservices-us-east-1.apigee.net for region us-east-1
Please copy the following property to the edge micro agent config
  bootstrap: https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/jdoe/environment/test

The following credentials are required to start edge micro
  key: db39324077989c75eac34c13d285772ea8e3b982b957b3f52916f3048511443f
  secret: 5bf8da39de0056f88fdd5f25a8602d22f312c1c8c870580a5fef55ac6637b7ae

finished

Apigee Edge Private Cloud 用の Edge Appliance の構成

Apigee Edge Private Cloud インストールと連携するように Edge Appliance を構成します。

使用目的

edgemicro private configure -o [organization] -e [environment] -u [username] -p [password]

パラメータ

パラメータ 説明
-o, --org Edge Appliance を構成した Apigee 組織。
-e, --env Edge Appliance を構成した環境。
-u, --username Apigee のユーザー名。指定したサービスの組織管理者である必要があります。 できます。
-p, --password （省略可）パスワード。Google Cloud コンソールにこのパラメータを指定しない場合は、 実行します。
-r, --runtime-url プライベート クラウド インスタンスのランタイム URL を指定します。
-m, --mgmt-url プライベート クラウド インスタンスの管理サーバーの URL。
-v, --virtualHosts 組織:環境の仮想ホストのカンマ区切りのリスト。デフォルト 「default,secure」
-c, --configDir （省略可）Edge AppSheet 構成ファイルのパスを指定します。デフォルトでは 構成ファイルは ./config/config.yaml にあります。（v2.4.x で追加）。
-t, --token （省略可）ユーザー名/パスワードの代わりに OAuth トークンを認証に使用できます。 OAuth2 アクセス トークンを使用した API 呼び出しの保護もご覧ください。 例:

edgemicro configure -o docs -e test -t <your token>
-d, --debug （省略可）デバッグ情報を提供します。
-h, --help 使用方法に関する情報を出力します。

使用上の注意

このコマンドは、構成情報を 約 /.edgemicro/org-env-config.yaml。

<ph type="x-smartling-placeholder">

例

edgemicro private configure -o docs -e test -u jdoe@example.com -r http://192.162.55.100:9002 -m http://192.162.55.100:8080

出力

成功すると、Edge の起動時に使用する必要がある一連のキーが返されます。 接続できます。

...

The following credentials are required to start edge micro
  key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f
  secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372

edgemicro configuration complete!

Edge Appliance の起動

Edge Appliance を起動する前に、まず edgemicro configure を実行する必要があります。 （パブリック クラウド）または edgemicro private Configure（プライベート クラウド）を選択します。構成 コマンドは、Edge AppSheet の起動に必要なキーとシークレットの値を返します。

使用目的

edgemicro start -o [organization] -e [environment] -k [public-key] -s [secret-key]

パラメータ

パラメータ 説明
-o, --org Edge Appliance を構成した Apigee 組織。
-e, --env Edge Appliance を構成した環境。
-k, --key 「edgemicro configure」の実行時に返される Key-Value使用できます。
-s, --secret 「edgemicro configure」の実行時に返されるシークレットの値使用できます。
-p, --processes （省略可）開始するプロセスの数。デフォルト: デバイスのコア数 ありません
-d, --pluginDir （省略可）プラグイン ディレクトリの絶対パス。
-r, --port （省略可） 約 /.edgemicro/org-env-config.yaml ファイル。デフォルト: 8000
-c, --cluster

（省略可）Edge AppSheet をクラスタモードで起動します。

注: v2.3.1 から、このオプションは削除されました。バージョン 2.3.1 の場合 以降のバージョンでは、Edge Micro は常にクラスタモードで起動します。
-c, --configDir （省略可）Edge AppSheet 構成ファイルのパスを指定します。デフォルトでは 構成ファイルは ./config/config.yaml にあります。（v2.4.x で追加）。
-u, --configUrl （省略可）Edge Gateway が構成ファイルをダウンロードするエンドポイントを指定します 表示されます。（v2.5.x で追加）。
-d, --debug （省略可）デバッグ情報を提供します。
-h, --help 使用方法に関する情報を出力します。

ポートの設定

start コマンドを使用すると、ポート番号を指定して、指定したポートをオーバーライドできます。 値を指定します。PORT を使用してポート番号を指定することもできます。 使用します。例:

edgemicro start -o docs -e test -k abc123 -s xyz456 -p 2 --port 8002

または

export PORT=8002
edgemicro start -o org -e test -k key -s secret -p 2

ポートが使用中の場合、Edge Gateway はエラーを返します。

クラスタリングについて

Edge Appliance は、Node.js クラスタ モジュールを使用して、クラスタリングを有効にします。クラスタリングを使用すると、Edge マルチコア システムの長所を兼ね備えています。詳細については、こちらの Node.js ドキュメントをご覧ください。

<ph type="x-smartling-placeholder">

例

edgemicro start -o docs -e test -k abc123 -s xyz456

出力例:

...

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
info: jwk_public_keys download from null returned 200 undefined
info: jwt_public_key download from https://docs-test.apigee.net/edgemicro-auth/publicKey returned 200 OK
info: products download from https://docs-test.apigee.net/edgemicro-auth/products returned 200 OK
info: config download from https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/docs/environment/test returned 200 OK
PROCESS PID : 17991

トークンの管理

token コマンドを使用すると、署名付き OAuth2 アクセスの取得、デコード、検証を行うことができます。 使用します。関連項目 OAuth2 アクセス トークンを使用して API 呼び出しを保護する。

トークンをデコードする

署名付きのエンコードされた署名なしトークンを、書式なしテキストの JSON JWT（Java Web Token）にデコードします。 必要があります。トークンは、Apigee Edge デベロッパー アプリに関する情報を アプリケーション名、client_id、商品リストなど、トークンの作成に使用されるキー。

使用目的

edgemicro token decode -f [filename]

パラメータ

パラメータ 説明
-f, --file デコードする JWT トークンを含むファイルの名前。
-h, --help 使用方法に関する情報を出力します。

例

edgemicro token decode -f token.jwt

出力（サンプル）

{ header: { typ: 'JWT', alg: 'RS256' },

  payload:
   { application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217',
     client_id: 'O9ZQRZKnn1rdgcKQgsABSMdOsKS',
     scopes: [],
     api_product_list: [ 'MicroTest' ],
     iat: 1436280566,
     exp: 1436282365 },
  signature: '' }

トークンを生成する

署名付きの署名なしトークンを生成します。このトークンにより、クライアント アプリは認証済みの API 呼び出しを行うことができます 接続しますこのトークンは、OAuth 2.0 準拠の JSON Web Token（JWT）です。要件は次のとおりです。 登録済みのネットワークからコンシューマ キー（クライアント ID）とコンシューマ シークレット（クライアント シークレット）の値を入力 Apigee Edge 上のデベロッパー アプリです。関連項目 OAuth2 アクセス トークンを使用して API 呼び出しを保護する。

使用目的

edgemicro token get -o [org] -e [env] -i [client_id] -s [client_secret]

パラメータ

パラメータ 説明
-o, --org Edge Appliance を構成した Apigee 組織。
-e, --env Edge Appliance を構成した環境。
-1, --key Dataproc 対応に関連付けられたデベロッパー アプリのクライアント ID あります。
-s, --secret Dataproc 対応に関連付けられているデベロッパー アプリのクライアント シークレット あります。
-h, --help 使用方法に関する情報を出力します。

例

edgemicro token get -o docs -e test -i 5UzOwAXGoOeo60aew94PPG5MAZE3aJp -s 6vahKFGS9a3qMLwz

出力（サンプル）

{ token: 'eyJ0eXAiOiJKV1JhbGciOiJSUzI1NiJ9Glvbl9uYW1lIjoiNWNiMGY0NTV6TV3
EtOWMzOC00YmJjLWIzNzEtZGMxZTQzOGMxIiwiY2xpZW50X2lkIjoiNVV6T3dBWEdvSU9lbz
YwYWV3OTRQN0c1TUFaRTNhSnAiLCJzY2MiOltdLCJhcGlfcHJvZHVjdF9saXN0IjpbIkVkZ2
VNaWNyb1Rlc3RQcm9kdWN0Il0sImlhdCI3ODEyMzQ2MSwiZXhwIjoxNDc4MTI1MjYwfQ.Dx5
f5U7PXm8koNGmFX4N6VrxKMJnpndKgoJ5zWSJvBZ6Ccvhlpd85ipIIA5S2A5nx4obYWp_rpY
RJpIGYwyxP6Oq2j0rxnVjdCC4qyYMgthZjhKgEBVBe3s1ndP72GP2vV6PsSA9RQ2-yzsy9r0
TzhAZ3NJTxT1tS0XKqKngE-OhR3fJHVLAzdMDT0AmS9H0Z2NAJtQOuK6RTpCjG9B6Bc48AEM
sj7QSM-1LWiQ8LdY8k_BoC06qsTI7bCQGWwTuqL-ismbcx2bxovUxSemZIaoROfuF-dCZHG3
2aTP75WxBvvNgBBvPvQtPzbeSOtEaww' }

管理 API を使用して JWT を生成することもできます。

curl -i -X POST "http://$ORG-$ENV.apigee.net/edgemicro-auth/token" \
  -H "Content-Type: application/json" \
  -d '{
    "$CLIENT_ID": "your consumer key",
    "$CLIENT_SECRET": "your consumer secret",
    "grant_type": "client_credentials"
  }'

ここで

  • $ORG は Edge 組織名です（組織管理者である必要があります）。
  • $ENV は組織の環境です（「test」や「prod」など）。
  • $CLIENT_ID は、以前に作成したデベロッパー アプリのコンシューマ ID です。
  • $CLIENT_SECRET は、作成したデベロッパー アプリのコンシューマ シークレットです。 使用します。

トークンを検証する

Apigee Edge に保存されている、指定された公開鍵に対する署名なしトークンを検証します。 組織と環境の両方が含まれます。

使用目的

edgemicro token verify -o [org] -e [env] -f [filename]

パラメータ

パラメータ 説明
-o, --org Edge Appliance を構成した Apigee 組織。
-e, --env Edge Appliance を構成した環境。
-f, --file 検証する JWT を含むファイルの名前。
-h, --help 使用方法に関する情報を出力します。

例

edgemicro token get -o docs -e test -f token.jwt

有効なトークンの出力例

{ application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217',

  client_id: 'O9ZQRZKnn1rdgcKQsAZUBkQSMdOsKS',

  scopes: [],

  api_product_list: [ 'MicroTest' ],

  iat: 1436396155,

  exp: 1436397954 }

無効なトークンの出力例

{ [JsonWebTokenError: invalid token] name: 'JsonWebTokenError', message: 'invalid token' }

期限切れのトークンの出力例

{ [TokenExpiredError: jwt expired]

  name: 'TokenExpiredError',

  message: 'jwt expired',

  expiredAt: Tue Jul 07 2015 09:19:25 GMT-0600 (MDT) }

新しい Edge Scanner 構成を初期化する

このコマンドを 1 回実行してから、Edge API を最初にインストールしてください。新しいデフォルトを作成します 構成ファイル（~/.edgemicro/default.yaml）。

使用目的

edgemicro init

パラメータ

パラメータ 説明
-c, --configDir （省略可）Edge AppSheet 構成ファイルのパスを指定します。デフォルトでは 構成ファイルは ./config/config.yaml にあります。（v2.4.x で追加）。
-h, --help 使用方法に関する情報を出力します。

例

edgemicro init

出力 （成功）

config initialized to /MyHome/.edgemicro/default.yaml

Edge Appliance の構成の確認

Edge AppSheet が正しく構成されていることを確認します。

使用目的

edgemicro verify -o [organization] -e [environment] -k [public-key] -s [secret-key]

パラメータ

例

edgemicro verify -o docs -e test -k abc123 -s xyz456

出力 （成功）

logging to /var/tmp/edgemicro-My-Machine.local-a0c48610-a148-11e6-8466-93f081b05988
installed plugin from analytics
installed plugin from oauth
a0c48610-a148-11e6-8466-93f081b05988 edge micro listening on port 8000
verifying analytics negative case: OK
verifying bootstrap url availability:OK
verifying jwt_public_key availability: OK
verifying products availability: OK
verifying quota with configured products: OK
verifying analytics with payload: OK
verification complete

マイクロサービス クラスタのステータスを確認する

デフォルトでは、Edge Gateway はクラスタモードで起動します。このコマンドを使用して ステータスが表示されます。

<ph type="x-smartling-placeholder">

使用目的

edgemicro status

パラメータ

パラメータ 説明
-h, --help 使用方法に関する情報を出力します。

例

edgemicro status

出力 （成功）

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
edgemicro is running with 8 workers

Apigee クラスタを停止する

Edge Scanner クラスタを停止します。

<ph type="x-smartling-placeholder">

使用目的

edgemicro stop

パラメータ

パラメータ 説明
-h, --help 使用方法に関する情報を出力します。

例

edgemicro stop

出力 （成功）

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
Stop Completed Successfully

Microgateway クラスタの再読み込み

構成の変更後にダウンタイムなしで再起動できます。次の時間までに Edge Appliance を再読み込みします。 使用します。

<ph type="x-smartling-placeholder">

使用目的

edgemicro reload -o [organization] -e [environment] -k [public-key] -s [secret-key]

パラメータ

パラメータ 説明
-o, --org Edge Appliance を構成した Apigee 組織。
-e, --env Edge Appliance を構成した環境。
-k, --key 「edgemicro configure」の実行時に返される Key-Value使用できます。
-s, --secret 「edgemicro configure」の実行時に返されるシークレットの値使用できます。
-h, --help 使用方法に関する情報を出力します。

例

edgemicro reload -o docs -e test -k abc123 -s xyz456

出力 （成功）

...

Reload Completed Successfully

Edgemicro-auth プロキシのアップグレード

鍵のローテーションを使用するには、 Apigee Edge 組織にデプロイされている Edgemicro-auth プロキシ。（v2.5.x で追加）。

注: 現在の Edge Micro インスタンスを以前に構成した場合 鍵のローテーションを使用するには、このプロキシをアップグレードする必要があります。必要なのは、 このアップグレードは 1 回だけ行います。

使用目的

edgemicro upgradeauth -o [organization] -e [environment] -u [username]

パラメータ

パラメータ 説明
-o, --org Edge Appliance を構成した Apigee 組織。
-e, --env Edge Appliance を構成した環境。
-u, --username Apigee のユーザー名。指定したサービスの組織管理者である必要があります。 できます。
-p, --password （省略可）パスワード。Google Cloud コンソールにこのパラメータを指定しない場合は、 実行します。
-v, --virtualhost （省略可）プロキシの仮想ホスト。
-b, --baseuri （省略可）Apigee Edge 上の組織のベース URI。デフォルトは「base」 Apigee クラウド デプロイの URI は api.enterprise.apigee.com です。オンプレミスデプロイの場合 ベース URL は異なる場合があります。

例

edgemicro upgradeauth -o docs -e test -u jdoe@example.com

出力 （成功）

成功すると、コマンドは次のような出力を返します。

Going to create revision 2 of API edgemicro-auth
Using /Users/jdoe/npm/lib/node_modules/edgemicro/node_modules/microgateway-edgeauth/apiproxy/edgemicro-auth.xml as the root file
Creating revision 2 of API edgemicro-auth
Uploading java resource micro-gateway-products-javacallout-2.0.0.jar
Uploading jsc resource generate-verify-jwt.js
Uploading jsc resource send-public-key.js
Uploading jsc resource set-jwt-variables.js
Uploading jsc resource set-response.js
Uploading node resource index.js
Uploading node resource node_modules_apigee-access.zip
Uploading node resource node_modules_base64url.zip
Uploading node resource node_modules_buffer-equal-constant-time.zip
Uploading node resource node_modules_ecdsa-sig-formatter.zip
Uploading node resource node_modules_jsrsasign.zip
Uploading node resource node_modules_jwa.zip
Uploading node resource node_modules_jws.zip
Uploading node resource node_modules_safe-buffer.zip
Uploading node resource package.json
Uploading policy Access-App-Info-2.xml
Uploading policy Access-App-Info.xml
Uploading policy AccessTokenRequest.xml
Uploading policy Add-Custom-Claims.xml
Uploading policy Create-OAuth-Request.xml
Uploading policy Create-Refresh-Request.xml
Uploading policy Extract-API-Key.xml
Uploading policy Extract-OAuth-Params.xml
Uploading policy Extract-Refresh-Params.xml
Uploading policy Get-Private-Key.xml
Uploading policy Get-Public-Key.xml
Uploading policy Get-Public-Keys.xml
Uploading policy JavaCallout.xml
Uploading policy Products-to-JSON-2.xml
Uploading policy Products-to-JSON.xml
Uploading policy Raise-Fault-Unknown-Request.xml
Uploading policy RefreshAccessToken.xml
Uploading policy Send-Public-Key.xml
Uploading policy Set-JWT-Variables.xml
Uploading policy Set-Response.xml
Uploading policy Verify-API-Key.xml
Uploading target TargetEndpoint-1
Uploading proxy default
Deploying revision 2 of edgemicro-auth to test
Deployment on test successful
edgemicro-auth proxy upgraded

Key-Value マップ（KVM）のアップグレード

edgemicro upgradekvm コマンドを使用して、Apigee で KVM をアップグレードします。 できます。鍵のローテーションを使用する場合は、KVM のアップグレードが必要です。

使用目的

Edge for Public Cloud: 

edgemicro upgradekvm -o [organization] -e [environment] -k [key] -s [secret]

Edge for Private Cloud: 

edgemicro private upgradekvm -o [organization] -e [environment] -k [key] -s [secret] -p 'https://[hostname]/edgemicro-auth'

パラメータ

パラメータ 説明
-o, --org Edge Appliance を構成した Apigee 組織。
-e, --env Edge Appliance を構成した環境。
-k, --key 「edgemicro configure」の実行時に返される Key-Value使用できます。
-s, --secret 「edgemicro configure」の実行時に返されるシークレットの値使用できます。
-p, --proxyuri edgemicro_auth プロキシの URI。

Edge Public Cloud: 省略可。
Edge Private Cloud: 必須。

Edge Public Cloud の例: 

 -p 'https://[org]-[env].apigee.net/edgemicro-auth'

Edge Private Cloud の例: 

-p 'https://[hostname]/edgemicro-auth'

例

edgemicro upgradekvm -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47

出力 （成功）

成功すると、コマンドは次のような出力を返します。

current nodejs version is v12.5.0
current edgemicro version is 3.1.5
password:
Checking for certificate...
Certificate found!
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT6yVoT/h6pvkPlkUUtv
Hgs7MbDPcWxto7dZqJBwQ4oOQ0IJ2P4XGigc3kYUyPp5lFHg1ssP9+0onRpqn6Lq
z7N5iaTSv5YXb26bU2kSOl4hbwcljIzauAnBzQ13VaQ5SoflRxMGSZmTqZeu5jkQ
3JZ7F6k2bCar5sk1k84vd4WXcCVyngFlrMtlux5z0vOU56QYZFvvKYl/wOHNPLLB
Js54531CV1ZfhV3nDDq9Lh5D1C/oQVlm1Lc7BJoEUmKeFATmSsi50c14ScsmdtJ1
HqC/brSXCd185P6ifu2RH7IHKzNfcD4NlfAVmDScng4w5RxBan2avbmAJrokQ4b5
WQIDAQAB
-----END PUBLIC KEY-----
KVM update complete

鍵のローテーション

edgemicro rotatekey コマンドを使用して公開鍵/秘密鍵のペアをローテーションする JWT トークンの生成に使用されたトークン（JWT トークン）です。

詳細については、<ph type="x-smartling-placeholder"></ph>をご覧ください。 JWT 鍵のローテーションをご覧ください。

使用目的

Edge for Public Cloud: 

edgemicro rotatekey -o [organization] -e [environment] -k [key] -s [secret]

Edge for Private Cloud: 

edgemicro private rotatekey -o [organization] -e [environment] -k [key] -s [secret] -r '[hostname]/edgemicro-auth/rotateKey'

パラメータ

パラメータ 説明
-o, --org （必須）Edge AppSheet を構成した Apigee 組織。
-e, --env （必須）Edge Gateway を構成した環境。
-k, --key 「edgemicro configure」の実行時に返される Key-Value使用できます。
-s, --secret 「edgemicro configure」の実行時に返されるシークレットの値使用できます。
-p Apigee Edge で使用されるカスタム秘密鍵のパス。（3.1.6 で追加）。
-c Apigee Edge で使用されるカスタム証明書のパス。（3.1.6 で追加）。
-n, --nbf

新しい秘密鍵が有効になるまでの遅延を分単位で構成します。この これにより、マイクロサービス インスタンスが新しいパブリック IP アドレスで更新されて ] キーを押します。遅延は config_change_poll_internal 構成の設定よりも大きくすることをおすすめします。 デフォルトは 10 分です詳細については、「以前にない」タグを構成する発生します。（3.1.6 で追加）。

注: このオプションを edgemicro-auth より古いバージョンで使用すると、 バージョン 3.1.6 で配布されている場合、このフラグは無視されます。

-i, --kid （省略可）特定の鍵との照合に使用される ID。Edge Appliance は、この値を使用して次のことを行います。 鍵のセットから選択できます。このパラメータを省略すると（推奨）、 Edge Appliance は、タイムスタンプ ベースの鍵を生成します。詳しくは、 JSON Web Key 仕様をご覧ください
-r, --rotatekeyuri 鍵の URI をローテーションします。

Edge Public Cloud: 省略可。
Edge Private Cloud: 必須。

パブリック クラウドの例: 

-r 'https://[org]-[env].apigee.net/edgemicro-auth/rotateKey'

Edge Private Cloud の例: 

-r '[hostname]/edgemicro-auth/rotateKey'

例

edgemicro rotatekey -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47

出力 （成功）

成功すると、コマンドは次のような出力を返します。

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
password:
Checking if private key exists in the KVM...
Checking for certificate...
Found Certificate
Generating New key/cert pair...
Extract new public key
Key Rotation successfully completed!

ローテーション後、新しい鍵が Apigee に追加されていることを Edge UI で確認できます。 KVM。

例

この例では、-p フラグと -c フラグを使用してパスを指定しています。 秘密鍵と証明書のペアにマッピングされます。これらのオプションを使用すると、カスタムの秘密鍵と証明書を ペア設定します。 

edgemicro rotatekey -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47 \
-p /users/home/keys.pem -c /users/home/cert.cert

Forever モニタリング

キーを取り消す

edgemicro revokekeys コマンドを使用して、プロジェクトの鍵とシークレットの認証情報を取り消します。 。

使用目的

edgemicro revokekeys -o [organization] -e [environment] -u [username]
-k [key] -s [secret]

パラメータ

パラメータ 説明
-o, --org （必須）Edge AppSheet を構成した Apigee 組織。
-e, --env （必須）Edge Gateway を構成した環境。
-u, --username （-u または -t のいずれかが必須）Apigee のユーザー名。指定したサービスの組織管理者である必要があります。 できます。代わりに -t パラメータを指定する場合、このパラメータは必要ありません。
-p, --password （省略可）パスワード。Google Cloud コンソールにこのパラメータを指定しない場合は、 実行します。
-k, --key （必須）取り消すキー。
-s, --secret （必須）取り消すシークレット。
-t, --token （-u または -t のいずれかが必須）認証に代わりに OAuth トークンを使用可能 構成します。-t が指定されている場合、-u パラメータは必要ありません。OAuth2 アクセス トークンを使用した API 呼び出しの保護もご覧ください。次に例を示します。 
edgemicro revokekeys -o ORG-NAME -e ENV-NAME -k KEY-TO-REVOKE \
    -s KEY-SECRET -t TOKEN

例

edgemicro revokekeys -o myorg -e test -u jdoe@apigee.com
-k 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f -s 4b5d6355b874f7c46838893823e8d929dcb2e42fb9aebcb535089c9b98513

成功すると、次のメッセージが表示されます。

key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully