Edge Microgateway의 CLI 참조

현재 Apigee Edge 문서가 표시되고 있습니다.
Apigee X 문서로 이동
정보

Edge Micro Gateway v. 3.3.x

개요

Edge Micro Gateway CLI를 사용하면 Edge Micro Gateway 인스턴스의 모든 측면을 제어하고 관리할 수 있습니다.

인증서 관리

cert 명령어를 사용하면 클라이언트가 Edge Micro게이트를 통해 보안 호출을 수행하는 데 사용하는 Bearer 토큰에 서명하는 데 사용되는 공개 키/비공개 키 쌍을 설치하고 관리할 수 있습니다. 키는 Apigee Edge의 암호화된 키-값 맵 (KVM)으로 저장됩니다. Edge Micro Gateway는 공개 키를 사용하여 서명된 Bearer 토큰을 검증합니다. 이러한 키는 Edge Micro Gateway 설정 및 구성에 설명된 대로 Edgemicro 구성 명령어를 실행할 때 생성됩니다. 필요한 경우 여기에 설명된 cert 명령어를 사용하여 이러한 키를 다시 생성하고 관리할 수 있습니다.

인증서 설치

암호화된 키-값 맵 (KVM)에 키를 설치하고 공개 키를 출력으로 반환합니다. 키 쌍의 범위는 지정된 조직으로 지정됩니다.

사용 정보

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

매개변수

매개변수 설명
-o, --org Edge Micro Gateway를 구성한 Apigee 조직입니다.
-e, --env Edge Micro Gateway를 구성한 환경입니다.
-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 Micro Gateway를 구성한 Apigee 조직입니다.
-e, --env Edge Micro Gateway를 구성한 환경입니다.
-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 Micro Gateway를 구성한 Apigee 조직입니다.
-e, --env Edge Micro Gateway를 구성한 환경입니다.
-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 Micro Gateway를 구성한 Apigee 조직입니다.
-e, --env Edge Micro Gateway를 구성한 환경입니다.
-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 Micro Gateway 구성

Edge Micro Gateway가 Apigee Edge Cloud 인스턴스로 작동할 수 있습니다. 일련의 명령어를 래핑하고 수행하여 필요한 인증 프록시를 Edge에 배포하고 인증 토큰을 생성하고 구성 파일을 업데이트합니다. 실제로 작동하는 전체 예시를 보려면 Edge Micro Gateway 설정 및 구성을 참조하세요.

사용 정보

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

매개변수

매개변수 설명
-o, --org Edge Micro Gateway를 구성한 Apigee 조직입니다.
-e, --env Edge Micro Gateway를 구성한 환경입니다.
-u, --username Apigee 사용자 이름입니다. 지정된 조직의 조직 관리자여야 합니다.
-p, --password (선택사항) 비밀번호 명령줄에서 이 매개변수를 제공하지 않으면 메시지가 표시됩니다.
-r, --url (선택사항) 조직 환경의 가상 호스트 별칭을 지정합니다. 가상 호스트에 대한 자세한 내용은 Edge 문서를 참조하세요. 기본값: org-env.apigee.net
-c, --configDir (선택사항) Edge Micro Gateway 구성 파일의 경로를 지정합니다. 기본적으로 구성 파일은 ./config/config.yaml에 있습니다. (v2.4.x 추가됨)
-x, --proxyName (선택사항) edgemicro-auth 프록시의 기본 경로를 설정합니다. edgemicro-auth 프록시가 기본값인 /edgemicro-auth와 다른 경로에 배포된 경우 이 기능을 사용하여 Edge Micro Gateway에 새 경로를 설정할 수 있습니다. 기본적으로 기본 경로는 /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 Micro Gateway를 시작할 때 사용해야 하는 키 집합을 반환합니다.

...

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

edgemicro configuration complete!

키 생성

genkeys 명령어는 분석 데이터를 Apigee Edge에 비동기식으로 게시할 때 Edge Micro Gateway가 자체 인증하는 데 사용하는 키 및 보안 비밀 쌍을 생성합니다.

사용 정보

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

매개변수

매개변수 설명
-o, --org Edge Micro Gateway를 구성한 Apigee 조직입니다.
-e, --env Edge Micro Gateway를 구성한 환경입니다.
-u, --username Apigee 사용자 이름입니다. 지정된 조직의 조직 관리자여야 합니다.
-p, --password (선택사항) 비밀번호 명령줄에서 이 매개변수를 제공하지 않으면 메시지가 표시됩니다.
-t, --token (선택사항) 인증에 사용자 이름/비밀번호 대신 OAuth 토큰을 사용할 수 있습니다. OAuth2 액세스 토큰으로 API 호출 보호도 참고하세요. 예를 들면 다음과 같습니다.

edgemicro genkeys -o docs -e test -t <your token>
-h, --help 사용량 정보를 출력합니다.

사용법 참고사항

성공하면 명령어가 항목 3개를 반환합니다. 첫 번째는 구성 파일에 배치해야 하는 URL입니다. 다른 두 개는 Edge Micro Gateway 인스턴스를 시작할 때 필요한 키 쌍입니다.

  • 부트스트랩 URL: 이 URL은 Edge Micro Gateway 인스턴스가 Apigee Edge로 분석 데이터를 전송할 수 있게 하는 Apigee Edge 서비스를 가리킵니다. 해당 URL을 Edge Microgateway 구성 파일(~/.edgemicro/org-env-config.yaml)에 복사해야 합니다.
  • key: 키입니다. 이 키와 보안 비밀은 Edge Micro Gateway 인스턴스를 시작하는 데 사용되는 CLI 명령어에 입력으로 필요합니다.
  • secret: 보안 비밀

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

출력 (샘플)

성공 시 명령어는 Edge Micro Gateway를 시작할 때 사용해야 하는 키 집합을 반환합니다.

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 프라이빗 클라우드용 Edge Micro Gateway 구성

Apigee Edge 프라이빗 클라우드 설치와 연동하도록 Edge Micro Gateway를 구성합니다.

사용 정보

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

매개변수

매개변수 설명
-o, --org Edge Micro Gateway를 구성한 Apigee 조직입니다.
-e, --env Edge Micro Gateway를 구성한 환경입니다.
-u, --username Apigee 사용자 이름입니다. 지정된 조직의 조직 관리자여야 합니다.
-p, --password (선택사항) 비밀번호 명령줄에서 이 매개변수를 제공하지 않으면 메시지가 표시됩니다.
-r, --runtime-url 프라이빗 클라우드 인스턴스의 런타임 URL을 지정합니다.
-m, --mgmt-url 프라이빗 클라우드 인스턴스의 관리 서버 URL입니다.
-v, --virtualHosts 조직:환경에 대한 가상 호스트의 쉼표로 구분된 목록입니다. 기본값은 'default,secure'입니다.
-c, --configDir (선택사항) Edge Micro Gateway 구성 파일의 경로를 지정합니다. 기본적으로 구성 파일은 ./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 Micro Gateway를 시작할 때 사용해야 하는 키 집합을 반환합니다.

...

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

edgemicro configuration complete!

Edge Micro Gateway 시작

Edge Micro Gateway를 시작하기 전에 먼저 edgemicroconfigure(퍼블릭 클라우드) 또는 edgemicro privateconfigure (Private Cloud)를 실행해야 합니다. 구성 명령어는 Edge Micro Gateway를 시작하는 데 필요한 키와 보안 비밀 값을 반환합니다.

사용 정보

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

매개변수

매개변수 설명
-o, --org Edge Micro Gateway를 구성한 Apigee 조직입니다.
-e, --env Edge Micro Gateway를 구성한 환경입니다.
-k, --key 'edgemicro configure' 명령어를 실행할 때 반환되는 키 값입니다.
-s, --secret 'edgemicro configure' 명령어를 실행할 때 반환되는 보안 비밀 값입니다.
-p, --processes (선택사항) 시작할 프로세스 수입니다. 기본값: 시스템의 코어 수입니다.
-d, --pluginDir (선택사항) 플러그인 디렉터리의 절대 경로입니다.
-r, --port (선택사항) ~/.edgemicro/org-env-config.yaml 파일에 지정된 포트 번호를 재정의합니다. 기본값: 8000
-c, --cluster

(선택사항) 클러스터 모드에서 Edge Micro Gateway를 시작합니다.

참고: v2.3.1부터 이 옵션은 삭제되었습니다. v2.3.1 이상 버전에서는 Edge Micro가 항상 클러스터 모드로 시작됩니다.

-c, --configDir (선택사항) Edge Micro Gateway 구성 파일의 경로를 지정합니다. 기본적으로 구성 파일은 ./config/config.yaml에 있습니다. (v2.4.x 추가됨)
-u, --configUrl (선택사항) Edge Micro 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 Micro Gateway가 오류를 반환합니다.

클러스터링 정보

Edge Micro Gateway는 Node.js 클러스터 모듈을 사용하여 클러스터링을 사용 설정합니다. 클러스터링을 통해 Edge Micro Gateway는 멀티 코어 시스템을 활용할 수 있습니다. 자세한 내용은 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 호출 보호도 참고하세요.

토큰 디코딩

서명되고 인코딩된 Bearer 토큰을 일반 텍스트 JSON JWT (Java Web Token) 표현으로 디코딩합니다. 토큰은 애플리케이션 이름, client_id, 제품 목록 등 토큰을 생성하는 데 사용된 키를 제공한 Apigee Edge 개발자 앱에 대한 정보를 전달합니다.

사용 정보

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

토큰 생성

서명된 Bearer 토큰을 생성합니다. 이 토큰을 사용하면 클라이언트 앱이 Edge Micro Gateway에 인증된 API 호출을 수행할 수 있습니다. 토큰은 OAuth 2.0 준수 JSON 웹 토큰 (JWT)입니다. Apigee Edge에 등록된 개발자 앱의 고객 키 (클라이언트 ID) 및 고객 보안 비밀번호 (클라이언트 보안 비밀번호) 값이 입력으로 필요합니다. OAuth2 액세스 토큰으로 API 호출 보호도 참고하세요.

사용 정보

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

매개변수

매개변수 설명
-o, --org Edge Micro Gateway를 구성한 Apigee 조직입니다.
-e, --env Edge Micro Gateway를 구성한 환경입니다.
-1, --key Micro Gateway 인식 프록시와 연결된 개발자 앱의 클라이언트 ID입니다.
-s, --secret Micro Gateway 인식 프록시와 연결된 개발자 앱의 클라이언트 보안 비밀번호입니다.
-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에 저장된 공개 키와 비교하여 서명된 Bearer 토큰을 확인합니다.

사용 정보

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

매개변수

매개변수 설명
-o, --org Edge Micro Gateway를 구성한 Apigee 조직입니다.
-e, --env Edge Micro Gateway를 구성한 환경입니다.
-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 Micro Gateway 구성 초기화

Edge Micro Gateway를 처음 설치한 후 이 명령어를 한 번 실행합니다. 새로운 기본 구성 파일(~/.edgemicro/default.yaml)이 생성됩니다.

사용 정보

edgemicro init

매개변수

매개변수 설명
-c, --configDir (선택사항) Edge Micro Gateway 구성 파일의 경로를 지정합니다. 기본적으로 구성 파일은 ./config/config.yaml에 있습니다. (v2.4.x 추가됨)
-h, --help 사용량 정보를 출력합니다.

edgemicro init

출력 (성공)

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

Edge Micro Gateway 구성 확인

Edge Micro Gateway가 올바르게 구성되었는지 확인합니다.

사용 정보

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 Micro게이트는 클러스터 모드로 시작됩니다. 이 명령어를 사용하여 클러스터의 상태를 확인할 수 있습니다.

사용 정보

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

마이크로 게이트웨이 클러스터 중지

Edge Micro Gateway 클러스터를 중지합니다.

사용 정보

edgemicro stop

매개변수

매개변수 설명
-h, --help 사용량 정보를 출력합니다.

edgemicro stop

출력 (성공)

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

마이크로 게이트웨이 클러스터 새로고침

구성 변경 후 다운타임 없이 다시 시작할 수 있습니다. 새 구성을 가져와 Edge Micro Gateway를 새로고침합니다.

사용 정보

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

매개변수

매개변수 설명
-o, --org Edge Micro Gateway를 구성한 Apigee 조직입니다.
-e, --env Edge Micro Gateway를 구성한 환경입니다.
-k, --key 'edgemicro configure' 명령어를 실행할 때 반환되는 키 값입니다.
-s, --secret 'edgemicro configure' 명령어를 실행할 때 반환되는 보안 비밀 값입니다.
-h, --help 사용량 정보를 출력합니다.

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

출력 (성공)

...

Reload Completed Successfully

Edgemicro 인증 프록시 업그레이드

키 순환을 사용하려면 Apigee Edge 조직에 업그레이드된 Edgemicro 인증 프록시가 배포되어 있어야 합니다. (v2.5.x 추가됨)

참고: 버전 2.5.2 이전에 현재 Edge Micro 인스턴스를 구성한 경우 키 순환을 사용하려면 이 프록시를 업그레이드해야 합니다. 이 업그레이드는 한 번만 수행하면 됩니다.

사용 정보

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

매개변수

매개변수 설명
-o, --org Edge Micro Gateway를 구성한 Apigee 조직입니다.
-e, --env Edge Micro Gateway를 구성한 환경입니다.
-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

키-값 맵 (KVM) 업그레이드

edgemicro upgradekvm 명령어를 사용하여 Apigee 조직의 KVM을 업그레이드합니다. 키 순환을 사용하려면 KVM 업그레이드가 필요합니다.

사용 정보

퍼블릭 클라우드용 에지:

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

프라이빗 클라우드용 에지:

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

매개변수

매개변수 설명
-o, --org Edge Micro Gateway를 구성한 Apigee 조직입니다.
-e, --env Edge Micro Gateway를 구성한 환경입니다.
-k, --key 'edgemicro configure' 명령어를 실행할 때 반환되는 키 값입니다.
-s, --secret 'edgemicro configure' 명령어를 실행할 때 반환되는 보안 비밀 값입니다.
-p, --proxyuri edgemicro_auth 프록시의 URI입니다.

Edge 퍼블릭 클라우드: 선택사항.
Edge Private Cloud: 필수 항목입니다.

Edge 퍼블릭 클라우드 예시:

 -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 키 순환을 참조하세요.

사용 정보

퍼블릭 클라우드용 에지:

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

프라이빗 클라우드용 에지:

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

매개변수

매개변수 설명
-o, --org (필수) Edge Micro Gateway를 구성한 Apigee 조직입니다.
-e, --env (필수) Edge Micro Gateway를 구성한 환경입니다.
-k, --key 'edgemicro configure' 명령어를 실행할 때 반환되는 키 값입니다.
-s, --secret 'edgemicro configure' 명령어를 실행할 때 반환되는 보안 비밀 값입니다.
-p Apigee Edge에서 사용할 커스텀 비공개 키의 경로입니다. (3.1.6 추가됨)
-c Apigee Edge에서 사용할 커스텀 인증서의 경로입니다. (3.1.6 추가됨)
-n, --nbf

새 비공개 키가 적용되려면 지연 시간(분)을 구성합니다. 이러한 지연으로 인해 마이크로 게이트웨이 인스턴스를 새 공개 키로 새로고침할 수 있습니다. 지연을 config_change_poll_internal 구성 설정(기본값 10분)보다 높게 설정하는 것이 좋습니다. 자세한 내용은 '이전' 지연 구성을 참고하세요. (3.1.6 추가됨)

참고: Edge Micro Gateway 3.1.6으로 배포된 버전보다 오래된 edgemicro-auth 버전에서 이 옵션을 사용하면 플래그가 무시됩니다.

-i, --kid (선택사항) 특정 키를 일치시키는 데 사용되는 ID입니다. Edge Micro Gateway는 이 값을 사용하여 키 순환 중에 키 집합 중에서 선택합니다. 이 매개변수를 생략하면 (권장) Edge Micro Gateway는 타임스탬프 기반 키를 생성합니다. 자세한 내용은 JSON 웹 키 사양의 섹션 4.5를 참조하세요.
-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!

순환 후 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

지속적인 모니터링

edgemicro forever 명령어를 사용하여 Forever 프로세스를 관리합니다. 이는 앱이 다운되거나 오류가 발생하는 경우 Node.js 앱을 자동으로 다시 시작하는 Node.js 도구입니다. 영구 모니터링도 참조하세요.

사용 정보

edgemicro forever 명령어를 실행하기 전에 다음 환경 변수를 설정해야 합니다.

  • EDGEMICRO_ORG - Edge Micro Gateway를 구성한 Apigee 조직입니다.
  • EDGEMICRO_ENV - Edge Micro Gateway를 구성한 환경입니다.
  • EDGEMICRO_KEY - 'edgemicroconfigure' 명령어를 실행할 때 반환된 키 값입니다.
  • EDGEMICRO_SECRET - 'edgemicroconfigure' 명령어를 실행할 때 반환된 보안 비밀 값입니다.
edgemicro forever -f [forever_file] -a [start|stop]

매개변수

매개변수설명
-f, --fileforever.json 파일의 위치를 지정합니다.
-a, --actionstart 또는 stop. 기본값은 start입니다.

예:

포에버를 시작하려면 다음 단계를 따르세요.

edgemicro forever -f ~/mydir/forever.json -a start

영구 중지하려면 다음 단계를 따르세요.

edgemicro forever -a stop

키 취소

edgemicro revokekeys 명령어를 사용하여 Edge Micro Gateway 구성의 키 및 보안 비밀 사용자 인증 정보를 취소합니다.

사용 정보

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

매개변수

매개변수 설명
-o, --org (필수) Edge Micro Gateway를 구성한 Apigee 조직입니다.
-e, --env (필수) Edge Micro Gateway를 구성한 환경입니다.
-u, --username (-u 또는 -t은 필수) Apigee 사용자 이름입니다. 지정된 조직의 조직 관리자여야 합니다. -t 매개변수를 대신 지정하는 경우에는 이 매개변수가 필요하지 않습니다.
-p, --password (선택사항) 비밀번호 명령줄에서 이 매개변수를 제공하지 않으면 메시지가 표시됩니다.
-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