Referência da CLI para o Edge Microgateway

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. informações

Edge Microgateway v. 3.3.x

Visão geral

A CLI do Edge Microgateway permite controlar e gerenciar todos os aspectos de uma instância do Edge Microgateway.

Como gerenciar certificados

Os comandos cert permitem instalar e gerenciar o par de chaves pública/privada que é usado para assinar tokens do portador usados pelos clientes para fazer chamadas seguras pelo Edge Microgateway. As chaves são armazenadas no Apigee Edge em um mapa de chave-valor (KVM) criptografado. O Edge Microgateway usa a chave pública para validar tokens do portador assinados. Essas chaves são geradas quando você executa o comando "configure" do Edgemicro, conforme explicado em Como instalar e configurar o Edge Microgateway. Use os comandos cert descritos aqui para gerar e gerenciar essas chaves novamente, se necessário.

Instalar um certificado

Instala as chaves em um mapa de chave-valor (KVM) criptografado e retorna a chave pública como saída. O escopo dos pares de chaves é definido para uma organização especificada.

Uso

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

Parâmetros

Exemplo

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

Saída

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

Excluir um certificado

Exclui o par de chaves de uma organização.

Uso

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

Parâmetros

Exemplo

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

Saída

deleting vault
Vault deleted!

Verificar um certificado

Verifica se a organização tem um certificado instalado.

Uso

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

Parâmetros

Exemplo

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

Saída (êxito)

checked cert successfully

Saída (falha)

Se o certificado não existir, será retornado um erro.

Receber a chave pública

Retorna a chave pública da organização especificada. Não requer autenticação.

Uso

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

Parâmetros

Exemplo

edgemicro cert public-key -o docs -e test

Saída (exemplo)

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

Como configurar o Edge Microgateway para o Apigee Edge Cloud

Permite que o Edge Microgateway opere com uma instância do Apigee Edge Cloud. Ele encapsula e executa uma sequência de comandos para implantar um proxy de autenticação necessário no Edge, gerar tokens de autenticação e atualizar arquivos de configuração. Para um exemplo completo de trabalho, consulte Como instalar e configurar o Edge Microgateway.

Uso

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

Parâmetros

Observações sobre o uso

Esse comando armazena informações de configuração em ~/.edgemicro/org-env-config.yaml.

Exemplo

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

Saída

Após a conclusão, o comando retorna um conjunto de chaves que você precisa usar ao iniciar o Edge Microgateway.

...

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

edgemicro configuration complete!

Como gerar chaves

O comando genkeys gera um par de chaves e secrets usado pelo Edge Microgateway para se autenticar ao postar dados de análise de maneira assíncrona no Apigee Edge.

Uso

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

Parâmetros

Observações sobre o uso

Após a conclusão, o comando retorna três itens. O primeiro é um URL que você precisa colocar no arquivo de configuração. Os outros dois são um par de chaves necessário ao iniciar uma instância do Edge Microgateway.

• URL de inicialização: esse URL aponta para um serviço do Apigee Edge que permite que uma instância do Edge Microgateway envie dados de análise para o Apigee Edge. É necessário copiar esse URL para o arquivo de configuração do Edge Microgateway: ~/.edgemicro/org-env-config.yaml.
• key: a chave. Essa chave e o secret são necessários como entrada para o comando da CLI usado para iniciar uma instância do Edge Microgateway.
• secret: o secret.

Exemplo

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

Saída (exemplo)

Após a conclusão, o comando retorna um conjunto de chaves que você precisa usar ao iniciar o 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

Como configurar o Edge Microgateway para a nuvem privada do Apigee Edge

Configura o Edge Microgateway para trabalhar com uma instalação de nuvem privada do Apigee Edge.

Uso

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

Parâmetros

Observações sobre o uso

Esse comando armazena informações de configuração em ~/.edgemicro/org-env-config.yaml.

Exemplo

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

Saída

Após a conclusão, o comando retorna um conjunto de chaves que você precisa usar ao iniciar o Edge Microgateway.

...

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

edgemicro configuration complete!

Como iniciar o Edge Microgateway

Antes de iniciar o Edge Microgateway, é preciso executar primeiro a configuração do Edgemicro (nuvem pública) ou a configuração particular do Edgemicro (nuvem privada). O comando "configure" retorna os valores de chave e secret necessários para iniciar o Edge Microgateway.

Uso

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

Parâmetros

Como configurar a porta

O comando start permite especificar um número de porta para substituir a porta especificada no arquivo de configuração. Também é possível especificar um número de porta usando a variável de ambiente PORT. Exemplo:

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

ou

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

Se a porta estiver em uso, o Edge Microgateway retornará um erro.

Sobre o clustering

O Edge Microgateway usa o módulo de cluster do Node.js para ativar o clustering. O clustering permite que o Edge Microgateway aproveite os sistemas de vários núcleos. Para mais detalhes, consulte a documentação do Node.js.

Exemplo

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

Exemplo de resposta:

...

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

Como gerenciar tokens

Os comandos token permitem receber, decodificar e verificar tokens de acesso OAuth2 assinados. Consulte também Proteger chamadas de API com um token de acesso OAuth2.

Decodificar um token

Decodifica um token do portador assinado e codificado em sua representação JSON de texto simples (Java Web Token). Um token transmite informações sobre o aplicativo de desenvolvedor do Apigee Edge que forneceu as chaves usadas para criar o token, incluindo o nome do aplicativo, client_id, lista de produtos e muito mais.

Uso

edgemicro token decode -f [filename]

Parâmetros

Exemplo

edgemicro token decode -f token.jwt

Saída (exemplo)

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

Gerar um token

Gera um token do portador assinado. O token permite que os apps clientes façam chamadas de API autenticadas para o Edge Microgateway. O token é um JSON Web Token (JWT) compatível com OAuth 2.0. Como entrada, são necessários os valores da chave do cliente (ID do cliente) e da chave secreta do cliente (chave secreta do cliente) de um app de desenvolvedor registrado no Apigee Edge. Consulte também Proteger chamadas de API com um token de acesso OAuth2.

Uso

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

Parâmetros

Exemplo

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

Saída (exemplo)

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

Também é possível gerar um JWT usando a API de gerenciamento:

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

Em que:

• $ORG é o nome da sua organização de Edge (você precisa ser um administrador da organização).
• $ENV é um ambiente na sua organização, como "test" ou "prod".
• $CLIENT_ID é o ID do consumidor no app do desenvolvedor criado anteriormente.
• $CLIENT_SECRET é a chave secreta do consumidor no app do desenvolvedor criado anteriormente.

Verificar um token

Verifica um token do portador assinado em relação à chave pública armazenada no Apigee Edge para a organização e o ambiente especificados.

Uso

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

Parâmetros

Exemplo

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

Exemplo de saída para um token válido

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

  client_id: 'O9ZQRZKnn1rdgcKQsAZUBkQSMdOsKS',

  scopes: [],

  api_product_list: [ 'MicroTest' ],

  iat: 1436396155,

  exp: 1436397954 }

Exemplo de saída de token inválido

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

Exemplo de saída de token expirado

{ [TokenExpiredError: jwt expired]

  name: 'TokenExpiredError',

  message: 'jwt expired',

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

Inicializando uma nova configuração do Edge Microgateway

Execute esse comando uma vez depois de instalar o Edge Microgateway. Cria um novo arquivo de configuração padrão: ~/.edgemicro/default.yaml.

Uso

edgemicro init

Parâmetros

Exemplo

edgemicro init

Saída (êxito)

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

Como verificar a configuração do Edge Microgateway

Verifica se o Edge Microgateway está configurado corretamente.

Uso

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

Parâmetros

Exemplo

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

Saída (êxito)

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

Verificar o status do cluster de microgateway

Por padrão, o Edge Microgateway é iniciado no modo de cluster. É possível usar esse comando para verificar o status do cluster.

Uso

edgemicro status

Parâmetros

Exemplo

edgemicro status

Saída (êxito)

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

Como interromper o cluster do microgateway

Interrompe o cluster do Edge Microgateway.

Uso

edgemicro stop

Parâmetros

Exemplo

edgemicro stop

Saída (êxito)

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

Como recarregar o cluster de microgateway

Fornece reinicialização com tempo de inatividade zero após uma mudança de configuração. Recarrega o Edge Microgateway extraindo uma nova configuração.

Uso

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

Parâmetros

Exemplo

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

Saída (êxito)

...

Reload Completed Successfully

Como fazer upgrade do proxy Edgemicro-auth

Para usar a rotação de chaves, você precisa ter um proxy Edgemicro-auth atualizado na organização do Apigee Edge. (Adicionada v2.5.x)

Observação:se você configurou a instância atual do Edge Micro antes da versão 2.5.2, faça upgrade deste proxy para usar a rotação de chaves. Você só precisará fazer esse upgrade uma vez.

Uso

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

Parâmetros

Exemplo

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

Saída (êxito)

Após a conclusão, o comando retorna uma resposta semelhante a esta:

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

Upgrade do mapa de chave-valor (KVM)

Use o comando edgemicro upgradekvm para fazer upgrade da KVM na sua organização da Apigee. É necessário fazer upgrade da KVM se você quiser usar a rotação de chaves.

Uso

Edge para nuvem pública:

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

Edge para nuvem privada:

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

Parâmetros

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

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

Exemplo

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

Saída (êxito)

Após a conclusão, o comando retorna uma resposta semelhante a esta:

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

Rotação de chaves

Use o comando edgemicro rotatekey para alternar os pares de chaves públicas/privadas usados para gerar os tokens JWT usados para a segurança OAuth no Edge Microgateway.

Para saber mais, consulte Como fazer a rotação de chaves JWT.

Uso

Edge para nuvem pública:

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

Edge para nuvem privada:

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

Parâmetros

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

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

Exemplo

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

Saída (êxito)

Após a conclusão, o comando retorna uma resposta semelhante a esta:

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!

Após a rotação, é possível ver na interface do Edge que novas chaves foram adicionadas à KVM do microgateway.

Exemplo

Este exemplo usa as sinalizações -p e -c para especificar o caminho para um par de chave privada/certificado. Essas opções permitem transmitir uma chave privada personalizada e um par de certificados.

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

Monitoramento permanente

Revogar chaves

Use o comando edgemicro revokekeys para revogar as credenciais de chave e secret de uma configuração do Edge Microgateway.

Uso

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

Parâmetros

edgemicro revokekeys -o ORG-NAME -e ENV-NAME -k KEY-TO-REVOKE \
    -s KEY-SECRET -t TOKEN

Exemplos

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

Se tudo der certo, você verá a seguinte mensagem: