Edge Microgateway の CLI リファレンス

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントに移動。 情報

Edge CIDR v. 3.3.x

概要

Edge CIDR CLI を使用すると、Edge CIDR インスタンスのすべての側面を制御および管理できます。

証明書の管理

cert コマンドを使用すると、クライアントが Edge Dataprep を介して安全に呼び出しを行うために使用する署名なしトークンの署名に使用される公開鍵/秘密鍵のペアをインストールして管理できます。鍵は、暗号化された Key-Value マップ（KVM）で Apigee Edge に保存されます。Edge Dataprep は、公開鍵を使用して署名付きトークンを検証します。これらの鍵は、Edge CIDR の設定と構成で説明されているように、edgemicro configure コマンドを実行すると生成されます。必要に応じて、ここで説明する cert コマンドを使用して、これらの鍵を再生成し、管理できます。

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

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

使用目的

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

パラメータ

例

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]

パラメータ

例

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]

パラメータ

例

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

出力 （成功）

checked cert successfully

出力 （失敗）

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

公開鍵を取得する

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

使用目的

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

パラメータ

例

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 Dataprep を構成する

Edge Dataprep が Apigee Edge Cloud インスタンスと連携できるようにします。必要な認証プロキシの Edge へのデプロイ、認証トークンの生成、構成ファイルの更新を行う一連のコマンドをラップして実行します。実際の例については、Edge CIDR の設定と構成をご覧ください。

使用目的

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

パラメータ

使用上の注意

このコマンドにより、構成情報が ~/.edgemicro/org-env-config.yaml に保存されます。

例

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

出力

このコマンドが成功すると、Edge CIDR の起動時に使用する必要がある一連の鍵が返されます。

...

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

edgemicro configuration complete!

キーを生成する

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

使用目的

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

パラメータ

使用上の注意

成功すると、コマンドは 3 つの項目を返します。1 つ目は、構成ファイル内に配置する URL です。他の 2 つは鍵ペアで、Edge CIDR インスタンスを起動するときに必要です。

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

例

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

出力 （サンプル）

このコマンドが成功すると、Edge CIDR の起動時に使用する必要がある一連の鍵が返されます。

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 Dataprep を構成する

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

使用目的

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

パラメータ

使用上の注意

このコマンドにより、構成情報が ~/.edgemicro/org-env-config.yaml に保存されます。

例

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 CIDR の起動時に使用する必要がある一連の鍵が返されます。

...

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

edgemicro configuration complete!

Edge Dataprep の起動

Edge Dataprep を起動する前に、まず edgemicro configure（Public Cloud）または edgemicro private configure（Private Cloud）を実行する必要があります。configure コマンドは、Edge CIDR の起動に必要なキーとシークレットの値を返します。

使用目的

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

パラメータ

ポートの設定

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 CIDR はエラーを返します。

クラスタリングについて

Edge Dataprep は、Node.js クラスタ モジュールを使用してクラスタリングを有効にします。クラスタリングにより、Edge CIDR でマルチコア システムを利用できます。詳細については、こちらの Node.js ドキュメントをご覧ください。

例

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 ウェブトークン）表現にデコードします。トークンは、アプリケーション名、client_id、プロダクト リストなど、トークンの作成に使用されたキーを提供した Apigee Edge デベロッパー アプリに関する情報を伝えるものです。

使用目的

edgemicro token decode -f [filename]

パラメータ

例

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: '' }

トークンを生成する

署名付きトークンを生成する。このトークンにより、クライアント アプリは Edge CIDR に対して認証済みの API 呼び出しを行うことができます。トークンは OAuth 2.0 準拠の JSON Web Token（JWT）です。Apigee Edge に登録されているデベロッパー アプリからコンシューマ キー（クライアント ID）とコンシューマ シークレット（クライアント シークレット）の値を入力する必要があります。 OAuth2 アクセス トークンを使用した API 呼び出しの保護もご覧ください。

使用目的

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

パラメータ

例

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' }

Management 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]

パラメータ

例

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 CIDR 構成の初期化

このコマンドは、最初に Edge Dataprep をインストールした後に 1 回実行します。新しいデフォルト構成ファイル（~/.edgemicro/default.yaml）を作成します。

使用目的

edgemicro init

パラメータ

例

edgemicro init

出力 （成功）

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

Edge Dataprep の構成の確認

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

使用目的

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

microgateway クラスタのステータスを確認する

デフォルトでは、Edge CIDR はクラスタモードで起動します。このコマンドを使用すると、クラスタのステータスを確認できます。

使用目的

edgemicro status

パラメータ

例

edgemicro status

出力 （成功）

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

microgateway クラスタの停止

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

使用目的

edgemicro stop

パラメータ

例

edgemicro stop

出力 （成功）

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

microgateway クラスタの再読み込み

構成の変更後にダウンタイムなしで再起動します。新しい構成を pull して、Edge CIDR を再読み込みします。

使用目的

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

パラメータ

例

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

出力 （成功）

...

Reload Completed Successfully

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

鍵のローテーションを使用するには、アップグレードした Edgemicro-auth プロキシを Apigee Edge 組織にデプロイする必要があります。（v2.5.x で追加）。

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

使用目的

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

パラメータ

例

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）のアップグレード

Apigee 組織で KVM をアップグレードするには、edgemicro upgradekvm コマンドを使用します。鍵のローテーションを使用する場合は、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'

パラメータ

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

-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 コマンドを使用して、Edge CIDR で OAuth セキュリティに使用される JWT トークンの生成に使用された公開鍵/秘密鍵のペアをローテーションします。

詳細については、 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'

パラメータ

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

-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!

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

例

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

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

永久モニタリング

キーを取り消す

edgemicro revokekeys コマンドを使用して、Edge CIDR 構成の鍵とシークレットの認証情報を取り消します。

使用目的

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

パラメータ

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

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