Referencia de la CLI para Edge Microgateway

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

Edge Microgateway v. 2.4.x

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 de cert te permiten instalar y administrar el par de claves pública/privada que se usa para firmar los tokens de portador que usan los clientes para realizar llamadas seguras a través de Edge Microgateway. Las claves se almacenan en un mapa de clave-valor (KVM) encriptado en Apigee Edge. Edge Microgateway usa la clave pública para validar los tokens de portador firmados. Estas claves se generan cuando ejecutas el comando de configuración de edgemicro, como se explica en Configuración de Edge Microgateway. Puedes usar los comandos cert que se describen aquí para volver a generar y administrar estas claves si es necesario.

Instalar un certificado

Instala las claves en un mapa de clave-valor (KVM) encriptado con el servicio de almacenamiento seguro de Apigee Edge y devuelve la clave pública como resultado. Los pares de claves se limitan a 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

Cómo borrar 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

Verifica 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

Salida (Correcto)

checked cert successfully

Salida (falla)

Si el certificado no existe, se muestra un error.

Obtén la clave pública

Devuelve la clave pública de 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

Salida (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. Encapsula y ejecuta una secuencia de comandos para implementar un proxy de autenticación requerido en Edge, generar tokens de autenticación y actualizar archivos de configuración. Para ver un ejemplo completo, consulta Cómo configurar 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 ~/.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 devuelve un conjunto de claves que debes usar cuando inicies 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 Edge Microgateway usa para autenticarse cuando publica de forma asíncrona datos de estadísticas 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 devolverá tres elementos. La primera es una URL que debes colocar en el archivo de configuración. Los otros dos son un par de claves que se requieren cuando inicias una instancia de Edge Microgateway.

• URL de inicio: Esta URL apunta a un servicio de Apigee Edge que permite que una instancia de Edge Microgateway envíe datos de Analytics 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 son necesarios como entrada para el 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

Salida (muestra)

Si se ejecuta de forma correcta, el comando devuelve un conjunto de claves que debes usar cuando inicies 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 Apigee Edge Private Cloud

Configura Edge Microgateway para que funcione con una instalación de Apigee Edge Private Cloud.

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 ~/.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 devuelve un conjunto de claves que debes usar cuando inicies Edge Microgateway.

...

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

edgemicro configuration complete!

Cómo iniciar Edge Microgateway

Antes de iniciar Edge Microgateway, primero debes ejecutar edgemicro configure (nube pública) o edgemicro private configure (nube privada). El comando configure devuelve los valores de clave y secreto que se requieren para iniciar Edge Microgateway.

Uso

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

Parámetros

Cómo configurar el puerto

El comando start te permite especificar un número de puerto para anular el puerto 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 devuelve un error.

Acerca del agrupamiento

Edge Microgateway emplea el módulo de clúster de Node.js para habilitar la agrupación en clústeres. El agrupamiento en clústeres permite que Edge Microgateway aproveche los sistemas multinúcleo. Para obtener más 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

Administración de tokens

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

Decodifica un token

Decodifica un token de portador firmado y codificado en su representación de texto simple de JWT (Java Web Token) en formato JSON. Un token transmite información sobre la app para desarrolladores de Apigee Edge que proporcionó las claves utilizadas para crear el token, incluido 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

Salida (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 de portador firmado. El token permite que las apps cliente realicen llamadas a la API autenticadas en 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 de cliente) de una app de desarrollador registrada en Apigee Edge. Consulta también Protege 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

Salida (muestra)

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

Cómo realizar una solicitud HTTP para obtener un token

También puedes realizar una solicitud HTTP sin procesar para obtener el token. Este es un ejemplo de curl. Solo sustituye los nombres de tu organización y entorno en la URL, y reemplaza los valores de ID de consumidor y 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 de 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

Ejemplo de resultado para un token válido

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

  client_id: 'O9ZQRZKnn1rdgcKQsAZUBkQSMdOsKS',

  scopes: [],

  api_product_list: [ 'MicroTest' ],

  iat: 1436396155,

  exp: 1436397954 }

Ejemplo de resultado para un token no válido

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

Ejemplo de resultado 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 de portador directamente

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

Este es un ejemplo de curl. Solo tienes que sustituir los nombres de tu organización y entorno en la URL, y reemplazar los valores de ID de consumidor y secreto del consumidor obtenidos de una app 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 nueva configuración 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

Salida (Correcto)

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

Verifica la configuración de Edge Microgateway

Verifica que Edge Microgateway esté configurado correctamente.

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

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

Se agregó: 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

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

Se agregó: v2.2.4-beta

Detiene el clúster de Edge Microgateway.

Uso

edgemicro stop

Parámetros

Ejemplo

edgemicro stop

Salida (Correcto)

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

Cómo volver a cargar el clúster de microgateway

Se agregó: v2.2.4-beta

Proporciona un reinicio sin tiempo de inactividad después de un cambio de configuración. Vuelve a cargar Edge Microgateway incorporando 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

Salida (Correcto)

...

Reload Completed Successfully