Referencia de la CLI para Edge Microgateway

Estás viendo la documentación de Apigee Edge.
Ve a la Documentación de Apigee X. información

Descripción general

La CLI de Edge Microgateway te permite controlar y administrar todos los aspectos de una instancia de Edge Microgateway.

Administrar certificados

Los comandos cert te permiten instalar y administrar el par de claves pública/privada que se usa para firmar los tokens del portador que usan los clientes para hacer llamadas seguras a través de Edge Microgateway. Las claves se almacenan en Apigee Edge en una bóveda segura. Edge Microgateway usa la clave pública para validar los tokens del portador firmados. Estas claves se generan cuando ejecutas el comando de configuración de Edgemicro, como se explica en Configura y configura Edge Microgateway. Puedes usar los comandos cert que se describen aquí para regenerar y administrar estas claves si es necesario.

Instalar un certificado

Instala las claves en una bóveda con el servicio de almacenamiento seguro de Apigee Edge y muestra la clave pública como resultado. Los pares de claves tienen alcance en una organización especificada.

Uso

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

Parámetros

Ejemplo

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

Resultado

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
password:
deleting vault
creating vault
adding private_key
adding public_key
installed cert

Borra un certificado

Borra el par de claves de una organización.

Uso

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

Parámetros

Ejemplo

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

Resultado

deleting vault
Vault deleted!

Cómo verificar un certificado

Comprueba que tu organización tenga un certificado instalado.

Uso

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

Parámetros

Ejemplo

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

Resultado (Correcto)

checked cert successfully

Resultado (Error)

Si el certificado no existe, se muestra un error.

Obtén la clave pública

Devuelve la clave pública para la organización especificada. No requiere autenticación.

Uso

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

Parámetros

Ejemplo

edgemicro cert public-key -o docs -e test

Resultado (Muestra)

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

Configura Edge Microgateway para Apigee Edge Cloud

Permite que Edge Microgateway opere con una instancia de Apigee Edge Cloud. Une y ejecuta una secuencia de comandos para implementar un proxy de autenticación necesario en Edge, generar tokens de autenticación y actualizar archivos de configuración. Para ver un ejemplo funcional completo, consulta Configura y configura Edge Microgateway.

Uso

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

Parámetros

Notas de uso

Este comando almacena la información de configuración en aproximadamente /.edgemicro/org-env-config.yaml.

Ejemplo

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

Resultado

Si se ejecuta de forma correcta, el comando muestra un conjunto de claves que debes usar cuando inicias Edge Microgateway.

...

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

edgemicro configuration complete!

Genera claves

El comando genkeys genera un par de clave y secreto que usa Edge Microgateway para autenticarse cuando se publican datos de estadísticas de forma asíncrona en Apigee Edge.

Uso

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

Parámetros

Notas de uso

Si se ejecuta de forma correcta, el comando muestra tres elementos. La primera es una URL que debes colocar en el archivo de configuración. Las otras dos son un par de claves que se requieren cuando inicias una instancia de Edge Microgateway.

• URL de arranque: Esta URL dirige a un servicio de Apigee Edge que permite que una instancia de Edge Microgateway envíe datos de estadísticas a Apigee Edge. Debes copiar esa URL en el archivo de configuración de Edge Microgateway: ~/.edgemicro/org-env-config.yaml.
• key: Es la clave. Esta clave y el secreto se requieren como entrada al comando de la CLI que se usa para iniciar una instancia de Edge Microgateway.
• secret: Es el secreto.

Ejemplo

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

Resultado (Muestra)

Si se ejecuta de forma correcta, el comando muestra un conjunto de claves que debes usar cuando inicias 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

Configura Edge Microgateway para la nube privada de Apigee Edge

Configura Edge Microgateway para que funcione con una instalación de nube privada de Apigee Edge.

Uso

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

Parámetros

Notas de uso

Este comando almacena la información de configuración en aproximadamente /.edgemicro/org-env-config.yaml.

Ejemplo

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

Resultado

Si se ejecuta de forma correcta, el comando muestra un conjunto de claves que debes usar cuando inicias Edge Microgateway.

...

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

edgemicro configuration complete!

Inicia Edge Microgateway

Antes de iniciar Edge Microgateway, primero debes ejecutar edgemicro private configure (nube pública) o edgemicro private configure (nube privada). El comando de configuración muestra los valores de clave y secreto necesarios para iniciar Edge Microgateway.

Uso

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

Parámetros

Configura el puerto

El comando start te permite especificar un número de puerto para anular el que está especificado en el archivo de configuración. También puedes especificar un número de puerto con la variable de entorno PORT. Por ejemplo:

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

o

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

Si el puerto está en uso, Edge Microgateway muestra un error.

Acerca del agrupamiento en clústeres

Edge Microgateway usa el módulo de clúster de Node.js para habilitar el agrupamiento en clústeres. El agrupamiento en clústeres permite que Edge Microgateway aproveche los sistemas de varios núcleos. Para conocer los detalles, consulta esta documentación de Node.js.

Ejemplo

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

Resultado de muestra:

...

PROCESS PID : 54709
installed plugin from analytics
installed plugin from analytics
installed plugin from oauth
installed plugin from oauth
installed plugin from analytics
installed plugin from oauth
5a86b570-a142-11e6-aa1f-6730e9065d6c edge micro listening on port 8000
5a86dc80-a142-11e6-962c-43d9cc723190 edge micro listening on port 8000
5a8751b0-a142-11e6-8241-cf1c517c91eb edge micro listening on port 8000
installed plugin from analytics
installed plugin from oauth
5a924e30-a142-11e6-8740-2944162ce275 edge micro listening on port 8000

Administra tokens

Los comandos token te permiten obtener, decodificar y verificar tokens de acceso OAuth2 firmados. Consulta también Cómo proteger las llamadas a la API con un token de acceso de OAuth2.

Cómo decodificar un token

Decodifica un token del portador codificado y firmado en su representación JSON JWT (token web Java) de texto sin formato. Un token transmite información sobre la app del desarrollador de Apigee Edge que proporcionó las claves usadas para crear el token, incluidos el nombre de la aplicación, el client_id, la lista de productos y mucho más.

Uso

edgemicro token decode -f [filename]

Parámetros

Ejemplo

edgemicro token decode -f token.jwt

Resultado (muestra)

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

Genera un token

Genera un token del portador firmado. El token permite que las apps cliente realicen llamadas autenticadas a la API a Edge Microgateway. El token es un token web JSON (JWT) compatible con OAuth 2.0. Requiere como entrada los valores de la clave de consumidor (ID de cliente) y el secreto de consumidor (secreto del cliente) de una aplicación de desarrollador registrada en Apigee Edge. Consulta también Cómo proteger las llamadas a la API con un token de acceso de OAuth2.

Uso

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

Parámetros

Ejemplo

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

Resultado (muestra)

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

Realiza una solicitud HTTP para obtener un token

También puedes realizar una solicitud HTTP sin procesar para obtener el token. Aquí hay un ejemplo de curl. Simplemente, sustituye los nombres de tu organización y entorno en la URL, y los valores del ID de consumidor y el secreto del consumidor por los parámetros client_id y client_secret:

curl -i -X POST "http://<org>-<test>.apigee.net/edgemicro-auth/token" -d '{"grant_type": "client_credentials", "client_id": "4t8X137pOUUtMR7wag3M1yZTcRxeK", "client_secret": "RAcOFVOvO0jns"}' -H "Content-Type: application/json"

Verifica un token

Verifica un token del portador firmado con la clave pública almacenada en Apigee Edge para la organización y el entorno especificados.

Uso

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

Parámetros

Ejemplo

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

Resultado de muestra para un token válido

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

  client_id: 'O9ZQRZKnn1rdgcKQsAZUBkQSMdOsKS',

  scopes: [],

  api_product_list: [ 'MicroTest' ],

  iat: 1436396155,

  exp: 1436397954 }

Resultado de muestra para un token no válido

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

Resultado de muestra para un token vencido

{ [TokenExpiredError: jwt expired]

  name: 'TokenExpiredError',

  message: 'jwt expired',

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

Cómo obtener tokens del portador directamente

Es posible que prefieras obtener tokens del portador de forma directa mediante una solicitud HTTP al extremo del token en Apigee Edge. El extremo real del token se implementa en el proxy que se implementa con el comando de la CLI deploy-edge-service.

Aquí hay un ejemplo de curl. Simplemente reemplaza los nombres de tu organización y entorno en la URL, y los valores de ID de consumidor y del secreto de consumidor obtenidos de una aplicación de desarrollador en Apigee Edge por los parámetros client_id y client_secret:

curl -i -X POST "http://<org>-<test>.apigee.net/edgemicro-auth/token" -d '{"grant_type": "client_credentials", "client_id": "4t8X137pOUUtMR7wag3M1yZTcRxeK", "client_secret": "RAcOFVOvO0jns"}' -H "Content-Type: application/json"

Resultado de muestra:

HTTP/1.1 200 OK

X-Powered-By: Express

Cache-Control: no-store

Pragma: no-cache

Content-Type: application/json; charset=utf-8

Content-Length: 640

ETag: W/"280-ze/g/k+c9taqp110vjYQ"

Date: Fri, 17 07 2015 15:49:24 GMT

Connection: keep-alive

"<long string of numbers and letters>"

Inicializa una configuración nueva de Edge Microgateway

Ejecuta este comando una vez después de instalar Edge Microgateway por primera vez. Crea un nuevo archivo de configuración predeterminado: ~/.edgemicro/default.yaml.

Uso

edgemicro init 

Parámetros

Ejemplo

edgemicro init

Resultado (Correcto)

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

Verifica la configuración de Edge Microgateway

Verifica que Edge Microgateway esté configurado de forma correcta.

Uso

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

Parámetros

Ejemplo

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

Resultado (Correcto)

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

Verifica el estado del clúster de microgateway

Agregada: v2.2.4-beta

De forma predeterminada, Edge Microgateway se inicia en modo de clúster. Puedes usar este comando para verificar el estado del clúster.

Uso

edgemicro status

Parámetros

Ejemplo

edgemicro status

Resultado (Correcto)

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
edgemicro is running with 4 workers

Detén el clúster de microgateway

Agregada: v2.2.4-beta

Detén el clúster de Edge Microgateway.

Uso

edgemicro stop

Parámetros

Ejemplo

edgemicro stop

Resultado (Correcto)

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
Stop Completed Successfully

Vuelve a cargar el clúster de microgateway

Agregada: v2.2.4-beta

Proporciona reinicios sin tiempo de inactividad después de un cambio de configuración. Vuelve a cargar Edge Microgateway. Para ello, extrae una configuración nueva.

Uso

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

Parámetros

Ejemplo

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

Resultado (Correcto)

...

Reload Completed Successfully