現在、Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください。 情報
Edge Microgateway バージョン 3.2.x
概要
Edge Microgateway CLI を使用すると、Edge Microgateway インスタンスのすべての側面を制御および管理できます。
証明書の管理
cert
コマンドを使用すると、クライアントが Edge Microgateway を介して安全な呼び出しを行うために使用する署名なしトークンに署名するために使用される公開鍵/秘密鍵のペアをインストールして管理できます。鍵は、暗号化された Key-Value マップ(KVM)で Apigee Edge に保存されます。Edge Microgateway は公開鍵を使用して、署名付き署名なしトークンを検証します。これらの鍵は、Edge Microgateway の設定と構成で説明されているように、edgemicro Configure コマンドを実行すると生成されます。ここで説明する cert コマンドを使用して、これらの鍵を再生成し、必要に応じて管理できます。
証明書をインストールする
暗号化された Key-Value マップ(KVM)に鍵をインストールし、公開鍵を出力として返します。鍵ペアのスコープは指定された組織に設定されます。
使用目的
edgemicro cert install -o [organization] -e [environment] -u [username] -p [password] --force
パラメータ
パラメータ | 説明 |
---|---|
-o, --org |
Edge Microgateway を構成した Apigee 組織。 |
-e, --env |
Edge Microgateway を構成した環境。 |
-u, --username |
Apigee のユーザー名。指定した組織の組織管理者である必要があります。 |
-p, --password |
(省略可)パスワード。コマンドラインでこのパラメータを指定しない場合、プロンプトが表示されます。 |
-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 Microgateway を構成した Apigee 組織。 |
-e, --env |
Edge Microgateway を構成した環境。 |
-u, --username |
Apigee のユーザー名。指定した組織の組織管理者である必要があります。 |
-p, --password |
(省略可)パスワード。コマンドラインでこのパラメータを指定しない場合、プロンプトが表示されます。 |
-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 Microgateway を構成した Apigee 組織。 |
-e, --env |
Edge Microgateway を構成した環境。 |
-u, --username |
Apigee のユーザー名。指定した組織の組織管理者である必要があります。 |
-p, --password |
(省略可)パスワード。コマンドラインでこのパラメータを指定しない場合、プロンプトが表示されます。 |
-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 Microgateway を構成した Apigee 組織。 |
-e, --env |
Edge Microgateway を構成した環境。 |
-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 Microgateway を構成する
Edge Microgateway が Apigee Edge Cloud インスタンスと連携できるようにします。必要な認証プロキシの Edge へのデプロイ、認証トークンの生成、構成ファイルの更新を行う一連のコマンドをラップして実行します。実際の例については、Edge Microgateway の設定と構成をご覧ください。
使用目的
edgemicro configure -o [organization] -e [environment] -u [username] -p [password]
パラメータ
パラメータ | 説明 |
---|---|
-o, --org |
Edge Microgateway を構成した Apigee 組織。 |
-e, --env |
Edge Microgateway を構成した環境。 |
-u, --username |
Apigee のユーザー名。指定した組織の組織管理者である必要があります。 |
-p, --password |
(省略可)パスワード。コマンドラインでこのパラメータを指定しない場合、プロンプトが表示されます。 |
-r, --url |
(省略可)組織:環境の仮想ホスト エイリアスを指定します。仮想ホストについては、Edge のドキュメントをご覧ください。デフォルト: org-env.apigee.net |
-c, --configDir |
(省略可)Edge Microgateway 構成ファイルのパスを指定します。デフォルトでは、構成ファイルは ./config/config.yaml にあります。(v2.4.x で追加) |
-x, --proxyName |
(省略可)edgemicro-auth プロキシのベースパスを設定します。edgemicro-auth プロキシがデフォルトの /edgemicro-auth とは異なるパスにデプロイされている場合、この機能を使用すると、Edge Microgateway に新しいパスを設定できます。デフォルトのベースパスは /edgemicro-auth です。(v2.4.x で追加) |
-t, --token |
(省略可)ユーザー名とパスワードの代わりに OAuth トークンを認証に使用できます。OAuth2 アクセス トークンを使用した API 呼び出しの保護もご覧ください。次に例を示します。edgemicro configure -o docs -e test -t <your token> |
-v, --virtualHosts |
(省略可)デフォルトの仮想ホスト(default,secure )をオーバーライドします。Edge 組織 / 環境にこれらのデフォルト以外の仮想ホストが指定されている場合は、このオプションを使用します。仮想ホストについては、Edge のドキュメントをご覧ください。 |
-d, --debug |
(省略可)デバッグ情報を提供します。 |
-h, --help |
使用方法に関する情報を出力します。 |
使用上の注意
このコマンドにより、~/.edgemicro/org-env-config.yaml
に構成情報が保存されます。
例
edgemicro configure -o docs -e test -u jdoe@example.com
出力
このコマンドが成功すると、Edge Microgateway の起動時に使用する必要のある鍵のセットが返されます。
... The following credentials are required to start edge micro key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372 edgemicro configuration complete!
キーの生成
genkeys
コマンドは、分析データを Apigee Edge に非同期的に送信するときに、Edge Microgateway が自身の認証に使用する鍵とシークレットのペアを生成します。
使用目的
edgemicro genkeys -o [organization] -e [environment] -u [username] -p [password]
パラメータ
パラメータ | 説明 |
---|---|
-o, --org |
Edge Microgateway を構成した Apigee 組織。 |
-e, --env |
Edge Microgateway を構成した環境。 |
-u, --username |
Apigee のユーザー名。指定した組織の組織管理者である必要があります。 |
-p, --password |
(省略可)パスワード。コマンドラインでこのパラメータを指定しない場合、プロンプトが表示されます。 |
-t, --token |
(省略可)ユーザー名とパスワードの代わりに OAuth トークンを認証に使用できます。OAuth2 アクセス トークンを使用した API 呼び出しの保護もご覧ください。次に例を示します。edgemicro genkeys -o docs -e test -t <your token> |
-h, --help |
使用方法に関する情報を出力します。 |
使用上の注意
成功すると、コマンドは 3 つの項目を返します。1 つ目は、構成ファイルに含める必要がある URL です。他の 2 つは、Edge Microgateway インスタンスを起動するときに必要な鍵ペアです。
- ブートストラップ URL: この URL は、Edge Microgateway インスタンスが分析データを Apigee Edge に送信できるようにする Apigee Edge サービスを指します。その URL を Edge Microgateway 構成ファイル(~
/.edgemicro/org-env-config.yaml
)にコピーする必要があります。 - key: キー。この鍵とシークレットは、Edge Microgateway のインスタンスの起動に使用する CLI コマンドへの入力として必要です。
- secret: シークレット。
例
edgemicro genkeys -o docs -e test -u jdoe@example.com
出力 (サンプル)
このコマンドが成功すると、Edge Microgateway の起動時に使用する必要のある鍵のセットが返されます。
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 Microgateway を構成する
Apigee Edge Private Cloud インストールで動作するように Edge Microgateway を構成します。
使用目的
edgemicro private configure -o [organization] -e [environment] -u [username] -p [password]
パラメータ
パラメータ | 説明 |
---|---|
-o, --org |
Edge Microgateway を構成した Apigee 組織。 |
-e, --env |
Edge Microgateway を構成した環境。 |
-u, --username |
Apigee のユーザー名。指定した組織の組織管理者である必要があります。 |
-p, --password |
(省略可)パスワード。コマンドラインでこのパラメータを指定しない場合、プロンプトが表示されます。 |
-r, --runtime-url |
プライベート クラウド インスタンスのランタイム URL を指定します。 |
-m, --mgmt-url |
プライベート クラウド インスタンスの管理サーバーの URL。 |
-v, --virtualHosts |
組織と環境の仮想ホストのカンマ区切りリスト。デフォルトは「default,secure 」です。 |
-c, --configDir |
(省略可)Edge Microgateway 構成ファイルのパスを指定します。デフォルトでは、構成ファイルは ./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
に構成情報が保存されます。
例
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 Microgateway の起動時に使用する必要のある鍵のセットが返されます。
... The following credentials are required to start edge micro key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372 edgemicro configuration complete!
Edge Microgateway の起動
Edge Microgateway を起動する前に、まず edgemicroconfigure(Public Cloud)または edgemicro private configuration(Private Cloud)を実行する必要があります。Configure コマンドは、Edge Microgateway の起動に必要な鍵とシークレットの値を返します。
使用目的
edgemicro start -o [organization] -e [environment] -k [public-key] -s [secret-key]
パラメータ
パラメータ | 説明 |
---|---|
-o, --org |
Edge Microgateway を構成した Apigee 組織。 |
-e, --env |
Edge Microgateway を構成した環境。 |
-k, --key |
「edgemicro
configure 」コマンドを実行すると返される Key-Value。 |
-s, --secret |
「edgemicro
configure 」コマンドを実行すると返されるシークレット値。 |
-p, --processes |
(省略可)開始するプロセスの数。デフォルト: システム上のコア数。 |
-d, --pluginDir |
(省略可)プラグイン ディレクトリへの絶対パス。 |
-r, --port |
(省略可)~/.edgemicro/org-env-config.yaml ファイルで指定されたポート番号をオーバーライドします。デフォルト: 8,000 |
-c, --cluster |
(省略可)Edge Microgateway をクラスタモードで起動します。 注: v2.3.1 以降、このオプションは削除されました。v2.3.1 以降のバージョンでは、Edge micro は常にクラスタモードで起動します。 |
-c, --configDir |
(省略可)Edge Microgateway 構成ファイルのパスを指定します。デフォルトでは、構成ファイルは ./config/config.yaml にあります。(v2.4.x で追加) |
-u, --configUrl |
(省略可)Edge Microgateway が構成ファイルをダウンロードするエンドポイントを指定します。(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 Microgateway はエラーを返します。
クラスタリングについて
Edge Microgateway は、Node.js クラスタ モジュールを使用してクラスタリングを有効にします。クラスタリングにより、Edge Microgateway はマルチコア システムを利用できます。詳細については、こちらの 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 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: '' }
トークンを生成する
署名付きの署名なしトークンを生成します。このトークンを使用すると、クライアント アプリは Edge Microgateway に対して認証された 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]
パラメータ
パラメータ | 説明 |
---|---|
-o, --org |
Edge Microgateway を構成した Apigee 組織。 |
-e, --env |
Edge Microgateway を構成した環境。 |
-1, --key |
Microgateway 対応プロキシに関連付けられているデベロッパー アプリのクライアント ID。 |
-s, --secret |
Microgateway 対応プロキシに関連付けられているデベロッパー アプリのクライアント シークレット。 |
-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 Microgateway を構成した Apigee 組織。 |
-e, --env |
Edge Microgateway を構成した環境。 |
-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 Microgateway 構成の初期化
最初に Edge Microgateway をインストールした後、このコマンドを 1 回実行します。新しいデフォルト構成ファイル(~/.edgemicro/default.yaml
)が作成されます。
使用目的
edgemicro init
パラメータ
パラメータ | 説明 |
---|---|
-c, --configDir |
(省略可)Edge Microgateway 構成ファイルのパスを指定します。デフォルトでは、構成ファイルは ./config/config.yaml にあります。(v2.4.x で追加) |
-h, --help |
使用方法に関する情報を出力します。 |
例
edgemicro init
出力 (成功)
config initialized to /MyHome/.edgemicro/default.yaml
Edge Microgateway 構成の確認
Edge Microgateway が正しく構成されていることを確認します。
使用目的
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 Microgateway はクラスタモードで起動します。このコマンドを使用して、クラスタのステータスを確認できます。
使用目的
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
microgateway クラスタの停止
Edge Microgateway クラスタを停止します。
使用目的
edgemicro stop
パラメータ
パラメータ | 説明 |
---|---|
-h, --help |
使用方法に関する情報を出力します。 |
例
edgemicro stop
出力 (成功)
current nodejs version is v12.5.0 current edgemicro version is 3.0.2 Stop Completed Successfully
microgateway クラスタの再読み込み
構成の変更後にダウンタイムなしで再起動します。新しい構成を pull して、Edge Microgateway を再読み込みします。
使用目的
edgemicro reload -o [organization] -e [environment] -k [public-key] -s [secret-key]
パラメータ
パラメータ | 説明 |
---|---|
-o, --org |
Edge Microgateway を構成した Apigee 組織。 |
-e, --env |
Edge Microgateway を構成した環境。 |
-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 プロキシのアップグレード
鍵のローテーションを使用するには、アップグレードされた edgemicro-auth プロキシを Apigee Edge 組織にデプロイする必要があります。(v2.5.x で追加)
注: 現在の Edge micro インスタンスをバージョン 2.5.2 より前に構成した場合、鍵のローテーションを使用するには、このプロキシをアップグレードする必要があります。このアップグレードが必要なのは 1 回だけです。
使用目的
edgemicro upgradeauth -o [organization] -e [environment] -u [username]
パラメータ
パラメータ | 説明 |
---|---|
-o, --org |
Edge Microgateway を構成した Apigee 組織。 |
-e, --env |
Edge Microgateway を構成した環境。 |
-u, --username |
Apigee のユーザー名。指定した組織の組織管理者である必要があります。 |
-p, --password |
(省略可)パスワード。コマンドラインでこのパラメータを指定しない場合、プロンプトが表示されます。 |
-v, --virtualhost |
(省略可)プロキシの仮想ホスト。 |
-b, --baseuri |
(省略可)Apigee Edge 上の組織のベース URI。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 Microgateway を構成した Apigee 組織。 |
-e, --env |
Edge Microgateway を構成した環境。 |
-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
コマンドを使用して、Edge Microgateway で 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'
パラメータ
パラメータ | 説明 |
---|---|
-o, --org |
(必須)Edge Microgateway を構成した Apigee 組織。 |
-e, --env |
(必須)Edge Microgateway を構成した環境。 |
-k, --key |
「edgemicro
configure 」コマンドを実行すると返される Key-Value。 |
-s, --secret |
「edgemicro
configure 」コマンドを実行すると返されるシークレット値。 |
-p |
Apigee Edge が使用するカスタム秘密鍵へのパス。(3.1.6 で追加) |
-c |
Apigee Edge で使用されるカスタム証明書へのパス。(3.1.6 で追加) |
-n, --nbf |
新しい秘密鍵が有効になるまでの遅延を分単位で構成します。この遅延により、Microgateway インスタンスが新しい公開鍵で更新される時間がわかります。遅延は、
注: Edge Microgateway 3.1.6 で配布されているバージョンより古いバージョンの |
-i, --kid |
(省略可)特定のキーを照合するために使用される ID。Edge Microgateway は、この値を使用して、鍵のローテーション中に鍵のセットから選択します。このパラメータを省略した場合(推奨)、Edge Microgateway はタイムスタンプ ベースの鍵を生成します。詳しくは、JSON ウェブキー仕様のセクション 4.5 をご覧ください。 |
-r, --rotatekeyuri |
鍵の URI をローテーションします。 Edge Public Cloud: 省略可。 Edge Private Cloud: 必須。 Public 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!
ローテーション後、新しい鍵が 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 forever
コマンドを使用して Forever プロセスを管理します。これは、アプリがダウンした場合やエラーが発生した場合に Node.js アプリを自動的に再起動する Node.js ツールです。
Forever モニタリングもご覧ください。
使用目的
edgemicro forever
コマンドを実行する前に、次の環境変数を設定する必要があります。
EDGEMICRO_ORG
- Edge Microgateway を構成した Apigee 組織。EDGEMICRO_ENV
- Edge Microgateway を構成した環境。EDGEMICRO_KEY
- 「edgemicro Configure」コマンドを実行すると返された、返された Key-Value。EDGEMICRO_SECRET
- 「edgemicro Configure」コマンドを実行すると返された、返されたシークレットの値。
edgemicro forever -f [forever_file] -a [start|stop]
パラメータ
パラメータ | 説明 |
---|---|
-f, --file | forever.json ファイルの場所を指定します。 |
-a, --action | start または stop 。デフォルトは start です。 |
例:
Forever を開始するには:
edgemicro forever -f ~/mydir/forever.json -a start
Forever を停止するには:
edgemicro forever -a stop
キーを取り消す
edgemicro revokekeys
コマンドを使用して、Edge Microgateway 構成の鍵とシークレットの認証情報を取り消します。
使用目的
edgemicro revokekeys -o [organization] -e [environment] -u [username] -k [key] -s [secret]
パラメータ
パラメータ | 説明 |
---|---|
-o, --org |
(必須)Edge Microgateway を構成した Apigee 組織。 |
-e, --env |
(必須)Edge Microgateway を構成した環境。 |
-u, --username |
(必須)Apigee のユーザー名。指定した組織の組織管理者である必要があります。 |
-p, --password |
(省略可)パスワード。コマンドラインでこのパラメータを指定しない場合、プロンプトが表示されます。 |
-k, --key |
(必須)取り消すキー。 |
-s, --secret |
(必須)取り消すシークレット。 |
例
edgemicro revokekeys -o myorg -e test -u jdoe@apigee.com -k 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f -s 4b5d6355b874f7c46838893823e8d929dcb2e42fb9aebcb535089c9b98513
成功すると、次のメッセージが表示されます。
key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully