Referência da CLI para o Edge Microgateway

Esta é a documentação do Apigee Edge.
Acesse 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 um Edge Microgateway instância.

Como gerenciar certificados

Os comandos cert permitem instalar e gerenciar o par de chaves públicas/privadas 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 o chave pública para validar tokens do portador assinados. Essas chaves são geradas quando você executa o parâmetro configure, conforme explicado em Como configurar e como configurar o Edge Microgateway. É possível usar os comandos cert descritos aqui para gerar e gerenciar novamente essas chaves, se necessário.

Instalar um certificado

Instala as chaves em um mapa de chave-valor (KVM) criptografado e retorna o chave pública como saída. Os pares de chaves têm o escopo de uma organização especificada.

Uso

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

Parâmetros

Parâmetros Descrição
-o, --org A organização da Apigee em que você configurou o Edge Microgateway.
-e, --env Um ambiente em que você configurou o Edge Microgateway.
-u, --username Seu nome de usuário da Apigee. Você precisa ser um administrador da organização organização.
-p, --password (Opcional) Sua senha. Se você não fornecer esse parâmetro no na linha de comando.
-f, --force (Opcional) Se uma chave já estiver armazenada na KVM criptografada, force a substituição dela.
-h, --help Gerar informações de uso.

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

Parâmetros Descrição
-o, --org A organização da Apigee em que você configurou o Edge Microgateway.
-e, --env Um ambiente em que você configurou o Edge Microgateway.
-u, --username Seu nome de usuário da Apigee. Você precisa ser um administrador da organização organização.
-p, --password (Opcional) Sua senha. Se você não fornecer esse parâmetro no na linha de comando.
-h, --help Gerar informações de uso.

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

Parâmetros Descrição
-o, --org A organização da Apigee em que você configurou o Edge Microgateway.
-e, --env Um ambiente em que você configurou o Edge Microgateway.
-u, --username Seu nome de usuário da Apigee. Você precisa ser um administrador da organização organização.
-p, --password (Opcional) Sua senha. Se você não fornecer esse parâmetro no na linha de comando.
-h, --help Gerar informações de uso.

Exemplo

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

Saída (sucesso)

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

Parâmetros Descrição
-o, --org A organização da Apigee em que você configurou o Edge Microgateway.
-e, --env Um ambiente em que você configurou o Edge Microgateway.
-h, --help Gerar informações de uso.

Exemplo

edgemicro cert public-key -o docs -e test

Saída (amostra)

-----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 a 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 autenticação e atualizar arquivos de configuração. Para um exemplo completo, consulte a página Como configurar e como configurar o Edge Microgateway.

Uso

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

Parâmetros

Parâmetros Descrição
-o, --org A organização da Apigee em que você configurou o Edge Microgateway.
-e, --env Um ambiente em que você configurou o Edge Microgateway.
-u, --username Seu nome de usuário da Apigee. Você precisa ser um administrador da organização organização.
-p, --password (Opcional) Sua senha. Se você não fornecer esse parâmetro no na linha de comando.
-r, --url (Opcional) Especifica o alias do host virtual da sua organização:ambiente. Consulte a Documentação do Edge para saber mais sobre hosts virtuais. Padrão: org-env.apigee.net
-c, --configDir (Opcional) Especifica o caminho para o arquivo de configuração do Edge Microgateway. Por padrão, O arquivo de configuração está em ./config/config.yaml. (Adicionado na v2.4.x)
-x, --proxyName (Opcional) Define o caminho de base para o proxy edgemicro-auth. Se o proxy edgemicro-auth é implantado em um caminho diferente do padrão, /edgemicro-auth, este recurso permite definir o novo caminho no Edge. Microgateway Por padrão, o caminho base é /edgemicro-auth. (Adicionado v2.4.x)
-t, --token (Opcional) Permite usar um token OAuth para autenticação, em vez do nome de usuário/senha. Consulte também Proteger chamadas de API com um token de acesso OAuth2. Por exemplo:

edgemicro configure -o docs -e test -t <your token>
-v, --virtualHosts (Opcional) Substitui os hosts virtuais padrão, que são "default,secure". Use esta opção se você tiver hosts virtuais especificados para seu Organização de borda:ambiente diferente dos padrões. Consulte a documentação do Edge para para aprender sobre hosts virtuais.
-d, --debug (Opcional) Fornece informações de depuração.
-h, --help Gerar informações de uso.

Observações sobre o uso

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

Exemplo

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

Saída

Se o comando for bem-sucedido, o comando retornará um conjunto de chaves que você precisará 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 chave e secret usado pelo Edge Microgateway para autenticar-se ao publicar dados de análise de forma assíncrona no Apigee Edge.

Uso

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

Parâmetros

Parâmetros Descrição
-o, --org A organização da Apigee em que você configurou o Edge Microgateway.
-e, --env Um ambiente em que você configurou o Edge Microgateway.
-u, --username Seu nome de usuário da Apigee. Você precisa ser um administrador da organização organização.
-p, --password (Opcional) Sua senha. Se você não fornecer esse parâmetro no na linha de comando.
-t, --token (Opcional) Permite usar um token OAuth para autenticação, em vez do nome de usuário/senha. Consulte também Proteger chamadas de API com um token de acesso OAuth2. Por exemplo:

edgemicro genkeys -o docs -e test -t <your token>
-h, --help Gerar informações de uso.

Observações sobre o uso

Se for bem-sucedido, o comando retornará três itens. O primeiro é um URL que você precisa colocar o arquivo de configuração. Os outros dois são um par de chaves necessário ao iniciar um Edge. Instância do Microgateway.

  • URL de inicialização: esse URL aponta para um serviço do Apigee Edge que ativa uma Instância do Edge Microgateway para enviar dados de análise ao Apigee Edge. Você precisa copiar esse URL no arquivo de configuração do Edge Microgateway: aproximadamente /.edgemicro/org-env-config.yaml.
  • key: a chave. Essa chave e o secret são necessários como entrada para a 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 (amostra)

Se o comando for bem-sucedido, o comando retornará um conjunto de chaves que você precisará 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

Parâmetros Descrição
-o, --org A organização da Apigee em que você configurou o Edge Microgateway.
-e, --env Um ambiente em que você configurou o Edge Microgateway.
-u, --username Seu nome de usuário da Apigee. Você precisa ser um administrador da organização organização.
-p, --password (Opcional) Sua senha. Se você não fornecer esse parâmetro no na linha de comando.
-r, --runtime-url Especifica o URL do ambiente de execução para sua instância de nuvem privada.
-m, --mgmt-url O URL do servidor de gerenciamento da instância de nuvem privada.
-v, --virtualHosts Lista separada por vírgulas de hosts virtuais da sua organização:organization. Padrão "default,secure".
-c, --configDir (Opcional) Especifica o caminho para o arquivo de configuração do Edge Microgateway. Por padrão, O arquivo de configuração está em ./config/config.yaml. (Adicionado na v2.4.x)
-t, --token (Opcional) Permite usar um token OAuth para autenticação, em vez do nome de usuário/senha. Consulte também Proteger chamadas de API com um token de acesso OAuth2. Por exemplo:

edgemicro configure -o docs -e test -t <your token>
-d, --debug (Opcional) Fornece informações de depuração.
-h, --help Gerar informações de uso.

Observações sobre o uso

Esse comando armazena informações de configuração em aprox. /.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

Se o comando for bem-sucedido, o comando retornará um conjunto de chaves que você precisará 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, execute o comando edgemicro configure. (nuvem pública) ou edgemicro private configure (nuvem privada). Configuração 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

Parâmetros Descrição
-o, --org A organização da Apigee em que você configurou o Edge Microgateway.
-e, --env Um ambiente em que você configurou o Edge Microgateway.
-k, --key O valor da chave retornado quando você executa "edgemicro configure" kubectl.
-s, --secret O valor do secret retornado que é retornado quando você executa "edgemicro configure" kubectl.
-p, --processes (Opcional) O número de processos a serem iniciados. Padrão: o número de núcleos no sistema.
-d, --pluginDir (Opcional) Caminho absoluto para o diretório do plug-in.
-r, --port (Opcional) Substitui o número da porta especificado no ~/.edgemicro/org-env-config.yaml arquivo. Padrão: 8000.
-c, --cluster

(Opcional) Inicia o Edge Microgateway no modo de cluster.

Observação: a partir da v2.3.1, essa opção foi removida. Na v2.3.1 e versões mais recentes, o Edge Micro sempre será iniciado no modo de cluster.
-c, --configDir (Opcional) Especifica o caminho para o arquivo de configuração do Edge Microgateway. Por padrão, O arquivo de configuração está em ./config/config.yaml. (Adicionado na v2.4.x)
-u, --configUrl (Opcional) Especifica um endpoint do qual o Edge Microgateway fará o download da configuração . (Adicionado na v2.5.x)
-d, --debug (Opcional) Fornece informações de depuração.
-h, --help Gerar informações de uso.

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 o método PORT variável de ambiente. 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 a biblioteca Node.js módulo cluster para ativar o clustering. Com o clustering, o Edge Microgateway usa e aproveitar os benefícios dos sistemas multinúcleo. Para mais detalhes, consulte esta 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 que você receba, decodifique e verifique o acesso do OAuth2 assinado tokens. Consulte também Chamadas de API seguras com um token de acesso OAuth2

Decodificar um token

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

Uso

edgemicro token decode -f [filename]

Parâmetros

Parâmetros Descrição
-f, --file O nome de um arquivo que contém o token JWT a ser decodificado.
-h, --help Gerar informações de uso.

Exemplo

edgemicro token decode -f token.jwt

Saída (amostra)

{ 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 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. Ele exige como insira os valores da chave do cliente (ID do cliente) e do código do cliente (chave secreta do cliente) de um para desenvolvedores na Apigee Edge. Consulte também Chamadas de API seguras com um token de acesso OAuth2

Uso

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

Parâmetros

Parâmetros Descrição
-o, --org A organização da Apigee em que você configurou o Edge Microgateway.
-e, --env Um ambiente em que você configurou o Edge Microgateway.
-1, --key O ID do cliente do app para desenvolvedores associado ao seu ambiente com reconhecimento de Microgateway proxy.
-s, --secret A chave secreta do cliente do app do desenvolvedor associado à conta com reconhecimento de microgateway proxy.
-h, --help Gerar informações de uso.

Exemplo

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

Saída (amostra)

{ 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 "teste" ou "produção").
  • $CLIENT_ID é o ID do consumidor no app do desenvolvedor criado anteriormente.
  • $CLIENT_SECRET é o secret do cliente no app do desenvolvedor que você criou. antes.

Verificar um token

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

Uso

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

Parâmetros

Parâmetros Descrição
-o, --org A organização da Apigee em que você configurou o Edge Microgateway.
-e, --env Um ambiente em que você configurou o Edge Microgateway.
-f, --file O nome de um arquivo que contém o JWT a ser verificado.
-h, --help Gerar informações de uso.

Exemplo

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

Exemplo de saída para 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 para token inválido

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

Exemplo de saída para token expirado

{ [TokenExpiredError: jwt expired]

  name: 'TokenExpiredError',

  message: 'jwt expired',

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

Como inicializar uma nova configuração do Edge Microgateway

Execute este comando uma vez após instalar o Edge Microgateway pela primeira vez. Cria um novo padrão arquivo de configuração: ~/.edgemicro/default.yaml.

Uso

edgemicro init

Parâmetros

Parâmetros Descrição
-c, --configDir (Opcional) Especifica o caminho para o arquivo de configuração do Edge Microgateway. Por padrão, O arquivo de configuração está em ./config/config.yaml. (Adicionado na v2.4.x)
-h, --help Gerar informações de uso.

Exemplo

edgemicro init

Saída (sucesso)

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 (sucesso)

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. Use esse comando para verificar status do cluster.

Uso

edgemicro status

Parâmetros

Parâmetros Descrição
-h, --help Gerar informações de uso.

Exemplo

edgemicro status

Saída (sucesso)

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

Como interromper o cluster de microgateway

Interrompe o cluster do Edge Microgateway.

Uso

edgemicro stop

Parâmetros

Parâmetros Descrição
-h, --help Gerar informações de uso.

Exemplo

edgemicro stop

Saída (sucesso)

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

Como atualizar o cluster de microgateway

Oferece reinicialização sem inatividade após uma mudança de configuração. Recarrega o Edge Microgateway extrair uma nova configuração.

Uso

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

Parâmetros

Parâmetros Descrição
-o, --org A organização da Apigee em que você configurou o Edge Microgateway.
-e, --env Um ambiente em que você configurou o Edge Microgateway.
-k, --key O valor da chave retornado quando você executa "edgemicro configure" kubectl.
-s, --secret O valor do secret retornado que é retornado quando você executa "edgemicro configure" kubectl.
-h, --help Gerar informações de uso.

Exemplo

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

Saída (sucesso)

...

Reload Completed Successfully

Como fazer upgrade do proxy Edgemicro-auth

Para usar a rotação de chaves, é preciso ter um proxy Edgemicro-auth implantado na sua organização do Apigee Edge. (Adicionado na v2.5.x)

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

Uso

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

Parâmetros

Parâmetros Descrição
-o, --org A organização da Apigee em que você configurou o Edge Microgateway.
-e, --env Um ambiente em que você configurou o Edge Microgateway.
-u, --username Seu nome de usuário da Apigee. Você precisa ser um administrador da organização organização.
-p, --password (Opcional) Sua senha. Se você não fornecer esse parâmetro no na linha de comando.
-v, --virtualhost (Opcional) O host virtual do proxy.
-b, --baseuri (Opcional) O URI base da sua organização no Apigee Edge. O padrão é a base O URI para implantações da Apigee na nuvem é api.enterprise.apigee.com. Para implantações no local, o URL base pode ser diferente.

Exemplo

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

Saída (sucesso)

Após a conclusão, o comando vai retornar uma saída 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 Apigee organização. O upgrade da KVM será necessário se você quiser usar a rotação de chaves.

Uso

Borda para nuvem pública: 

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

Borda para nuvem privada: 

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

Parâmetros

Parâmetros Descrição
-o, --org A organização da Apigee em que você configurou o Edge Microgateway.
-e, --env Um ambiente em que você configurou o Edge Microgateway.
-k, --key O valor da chave retornado quando você executa "edgemicro configure" kubectl.
-s, --secret O valor do secret retornado que é retornado quando você executa "edgemicro configure" kubectl.
-p, --proxyuri URI do proxyedgemicro_auth

Nuvem pública de borda: opcional.
Nuvem privada de borda: obrigatório.

Exemplo da nuvem pública do Edge: 

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

Exemplo de nuvem privada de borda: 

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

Exemplo

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

Saída (sucesso)

Após a conclusão, o comando vai retornar uma saída 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. que foram 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

Borda para nuvem pública: 

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

Borda para nuvem privada: 

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

Parâmetros

Parâmetros Descrição
-o, --org (Obrigatório) A organização da Apigee em que você configurou o Edge Microgateway.
-e, --env (Obrigatório) Um ambiente em que você configurou o Edge Microgateway.
-k, --key O valor da chave retornado quando você executa "edgemicro configure" kubectl.
-s, --secret O valor do secret retornado que é retornado quando você executa "edgemicro configure" kubectl.
-p Caminho para uma chave privada personalizada que será usada pelo Apigee Edge. (Adicionado na versão 3.1.6)
-c Caminho para um certificado personalizado que será usado pelo Apigee Edge. (Adicionado na versão 3.1.6)
-n, --nbf

Configure o tempo, em minutos, para que uma nova chave privada entre em vigor. Isso o atraso permite que as instâncias de microgateway sejam atualizadas com as novas de dados. Uma prática recomendada é definir o atraso para um valor maior do que a configuração do config_change_poll_internal. que é 10 minutos por padrão. Para mais informações, consulte Configurar um parâmetro "não antes" atraso. (Adicionado na versão 3.1.6)

Observação : se você usar essa opção com versões do edgemicro-auth anteriores a a versão distribuída com o Edge Microgateway 3.1.6, a sinalização será ignorada.

-i, --kid (Opcional) Um ID usado para fazer a correspondência com uma chave específica. O Edge Microgateway usa esse valor para escolher entre um conjunto de chaves durante a rotação. Se esse parâmetro for omitido (recomendado), O Edge Microgateway gera uma chave com base em carimbo de data/hora. Para mais informações, consulte a Seção 4.5 dos a especificação da chave da Web JSON.
-r, --rotatekeyuri Alternar URI da chave.

Nuvem pública de borda: opcional.
Nuvem privada de borda: obrigatório.

Exemplo de nuvem pública: 

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

Exemplo de nuvem privada de borda: 

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

Exemplo

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

Saída (sucesso)

Após a conclusão, o comando vai retornar uma saída 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 ao microgateway KVM.

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 que você transmita uma chave privada personalizada e um certificado par. 

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

Monitoramento contínuo

Revogar chaves

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

Uso

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

Parâmetros

Parâmetros Descrição
-o, --org (Obrigatório) A organização da Apigee em que você configurou o Edge Microgateway.
-e, --env (Obrigatório) Um ambiente em que você configurou o Edge Microgateway.
-u, --username (-u ou -t são obrigatórios) seu nome de usuário da Apigee. Você precisa ser um administrador da organização organização. Esse parâmetro não será obrigatório se você especificar o parâmetro -t.
-p, --password (Opcional) Sua senha. Se você não fornecer esse parâmetro no na linha de comando.
-k, --key (Obrigatório) A chave a ser revogada.
-s, --secret (Obrigatório) O segredo a ser revogado.
-t, --token (-u ou -t são obrigatórios) Permite usar um token OAuth para autenticação em vez de nome de usuário/senha. Se -t for especificado, o parâmetro -u não será obrigatório. Consulte também Proteger chamadas de API com um token de acesso OAuth2. Exemplo: 
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ê vai receber a seguinte mensagem:

key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully