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. 3.3.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 Cómo configurar 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 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

Parámetros Descripción
-o, --org La organización de Apigee para la que configuraste Edge Microgateway.
-e, --env Es un entorno para el que configuraste Edge Microgateway.
-u, --username Tu nombre de usuario de Apigee. Debes ser administrador de la organización especificada.
-p, --password Tu contraseña (opcional) Se te solicitará que lo proporciones si no lo haces en la línea de comandos.
-f, --force (Opcional) Si ya hay una clave almacenada en la KVM encriptada, fuerza su reemplazo.
-h, --help Proporciona información sobre el uso.

Ejemplo

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

Resultado

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

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

Parámetros Descripción
-o, --org La organización de Apigee para la que configuraste Edge Microgateway.
-e, --env Es un entorno para el que configuraste Edge Microgateway.
-u, --username Tu nombre de usuario de Apigee. Debes ser administrador de la organización especificada.
-p, --password Tu contraseña (opcional) Se te solicitará que lo proporciones si no lo haces en la línea de comandos.
-h, --help Proporciona información sobre el uso.

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

Parámetros Descripción
-o, --org La organización de Apigee para la que configuraste Edge Microgateway.
-e, --env Es un entorno para el que configuraste Edge Microgateway.
-u, --username Tu nombre de usuario de Apigee. Debes ser administrador de la organización especificada.
-p, --password Tu contraseña (opcional) Se te solicitará que lo proporciones si no lo haces en la línea de comandos.
-h, --help Proporciona información sobre el uso.

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

Parámetros Descripción
-o, --org La organización de Apigee para la que configuraste Edge Microgateway.
-e, --env Es un entorno para el que configuraste Edge Microgateway.
-h, --help Proporciona información sobre el uso.

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

Parámetros Descripción
-o, --org La organización de Apigee para la que configuraste Edge Microgateway.
-e, --env Es un entorno para el que configuraste Edge Microgateway.
-u, --username Tu nombre de usuario de Apigee. Debes ser administrador de la organización especificada.
-p, --password Tu contraseña (opcional) Se te solicitará que lo proporciones si no lo haces en la línea de comandos.
-r, --url (Opcional) Especifica el alias del host virtual para tu organización:entorno. Consulta la documentación de Edge para obtener información sobre los hosts virtuales. Valor predeterminado: org-env.apigee.net
-c, --configDir (Opcional) Especifica la ruta de acceso al archivo de configuración de Edge Microgateway. De forma predeterminada, el archivo de configuración se encuentra en ./config/config.yaml. (Se agregó en la versión 2.4.x)
-x, --proxyName (Opcional) Establece la ruta base para el proxy edgemicro-auth. Si el proxy edgemicro-auth se implementa en una ruta diferente de la predeterminada, /edgemicro-auth, esta función te permite establecer la nueva ruta en Edge Microgateway. De forma predeterminada, la ruta base es /edgemicro-auth. (Se agregó en la versión 2.4.x).
-t, --token (Opcional) Te permite usar un token de OAuth para la autenticación en lugar de un nombre de usuario y una contraseña. Consulta también Protege las llamadas a la API con un token de acceso de OAuth2. Por ejemplo:

edgemicro configure -o docs -e test -t <your token>
-v, --virtualHosts (Opcional) Anula los hosts virtuales predeterminados, que son "default,secure". Usa esta opción si tienes hosts virtuales especificados para tu organización:entorno de Edge distintos de estos valores predeterminados. Consulta la documentación de Edge para obtener información sobre los hosts virtuales.
-d, --debug (Opcional) Proporciona información de depuración.
-h, --help Proporciona información sobre el uso.

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 datos de estadísticas de forma asíncrona en Apigee Edge.

Uso

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

Parámetros

Parámetros Descripción
-o, --org La organización de Apigee para la que configuraste Edge Microgateway.
-e, --env Es un entorno para el que configuraste Edge Microgateway.
-u, --username Tu nombre de usuario de Apigee. Debes ser administrador de la organización especificada.
-p, --password Tu contraseña (opcional) Se te solicitará que lo proporciones si no lo haces en la línea de comandos.
-t, --token (Opcional) Te permite usar un token de OAuth para la autenticación en lugar de un nombre de usuario y una contraseña. Consulta también Protege las llamadas a la API con un token de acceso de OAuth2. Por ejemplo:

edgemicro genkeys -o docs -e test -t <your token>
-h, --help Proporciona información sobre el uso.

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

Parámetros Descripción
-o, --org La organización de Apigee para la que configuraste Edge Microgateway.
-e, --env Es un entorno para el que configuraste Edge Microgateway.
-u, --username Tu nombre de usuario de Apigee. Debes ser administrador de la organización especificada.
-p, --password Tu contraseña (opcional) Se te solicitará que lo proporciones si no lo haces en la línea de comandos.
-r, --runtime-url Especifica la URL del entorno de ejecución para tu instancia de nube privada.
-m, --mgmt-url Es la URL del servidor de administración de tu instancia de nube privada.
-v, --virtualHosts Lista separada por comas de los hosts virtuales de tu organización:entorno. El valor predeterminado es "default,secure".
-c, --configDir (Opcional) Especifica la ruta de acceso al archivo de configuración de Edge Microgateway. De forma predeterminada, el archivo de configuración se encuentra en ./config/config.yaml. (Se agregó en la versión 2.4.x)
-t, --token (Opcional) Te permite usar un token de OAuth para la autenticación en lugar de un nombre de usuario y una contraseña. Consulta también Protege las llamadas a la API con un token de acceso de OAuth2. Por ejemplo:

edgemicro configure -o docs -e test -t <your token>
-d, --debug (Opcional) Proporciona información de depuración.
-h, --help Proporciona información sobre el uso.

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

Parámetros Descripción
-o, --org La organización de Apigee para la que configuraste Edge Microgateway.
-e, --env Es un entorno para el que configuraste Edge Microgateway.
-k, --key Es el valor de la clave que se devuelve cuando ejecutas el comando "edgemicro configure".
-s, --secret Es el valor secreto que se muestra cuando ejecutas el comando "edgemicro configure".
-p, --processes Cantidad de procesos que se iniciarán (opcional). Valor predeterminado: La cantidad de núcleos de tu sistema.
-d, --pluginDir Ruta de acceso absoluta (opcional) al directorio del complemento.
-r, --port (Opcional) Anula el número de puerto especificado en el archivo ~/.edgemicro/org-env-config.yaml. Valor predeterminado: 8000
-c, --cluster

(Opcional) Inicia Edge Microgateway en modo de clúster.

Nota: A partir de la versión 2.3.1, se quitó esta opción. En la versión 2.3.1 y versiones posteriores, Edge Micro siempre se inicia en modo de clúster.
-c, --configDir (Opcional) Especifica la ruta de acceso al archivo de configuración de Edge Microgateway. De forma predeterminada, el archivo de configuración se encuentra en ./config/config.yaml. (Se agregó en la versión 2.4.x)
-u, --configUrl (Opcional) Especifica un extremo desde el que Edge Microgateway descargará su archivo de configuración. (Se agregó en la versión 2.5.x)
-d, --debug (Opcional) Proporciona información de depuración.
-h, --help Proporciona información sobre el uso.

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:

...

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

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

Parámetros Descripción
-f, --file Nombre de un archivo que contiene el token de JWT que se decodificará.
-h, --help Proporciona información sobre el uso.

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

Parámetros Descripción
-o, --org La organización de Apigee para la que configuraste Edge Microgateway.
-e, --env Es un entorno para el que configuraste Edge Microgateway.
-1, --key Es el ID de cliente de la app para desarrolladores asociada con tu proxy compatible con Microgateway.
-s, --secret El secreto del cliente de la app para desarrolladores asociada con tu proxy compatible con Microgateway.
-h, --help Proporciona información sobre el uso.

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

También puedes generar un JWT con la API de Management:

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

Donde:

  • $ORG es el nombre de tu organización de Edge (debes ser administrador de la organización).
  • $ENV es un entorno de tu organización (como "test" o "prod").
  • $CLIENT_ID es el ID del consumidor en la app para desarrolladores que creaste anteriormente.
  • $CLIENT_SECRET es el secreto del consumidor de la app para desarrolladores que creaste anteriormente.

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

Parámetros Descripción
-o, --org La organización de Apigee para la que configuraste Edge Microgateway.
-e, --env Es un entorno para el que configuraste Edge Microgateway.
-f, --file Nombre de un archivo que contiene el JWT que se verificará.
-h, --help Proporciona información sobre el uso.

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

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

Parámetros Descripción
-c, --configDir (Opcional) Especifica la ruta de acceso al archivo de configuración de Edge Microgateway. De forma predeterminada, el archivo de configuración se encuentra en ./config/config.yaml. (Se agregó en la versión 2.4.x)
-h, --help Proporciona información sobre el uso.

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

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

Parámetros Descripción
-h, --help Proporciona información sobre el uso.

Ejemplo

edgemicro status

Salida (Correcto)

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

Detén el clúster de microgateway

Detiene el clúster de Edge Microgateway.

Uso

edgemicro stop

Parámetros

Parámetros Descripción
-h, --help Proporciona información sobre el uso.

Ejemplo

edgemicro stop

Salida (Correcto)

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

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

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

Parámetros Descripción
-o, --org La organización de Apigee para la que configuraste Edge Microgateway.
-e, --env Es un entorno para el que configuraste Edge Microgateway.
-k, --key Es el valor de la clave que se devuelve cuando ejecutas el comando "edgemicro configure".
-s, --secret Es el valor secreto que se muestra cuando ejecutas el comando "edgemicro configure".
-h, --help Proporciona información sobre el uso.

Ejemplo

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

Salida (Correcto)

...

Reload Completed Successfully

Actualiza el proxy de edgemicro-auth

Para usar la rotación de claves, debes tener un proxy de edgemicro-auth actualizado implementado en tu organización de Apigee Edge. (Se agregó en la versión 2.5.x)

Nota: Si configuraste tu instancia actual de Edge Micro antes de la versión 2.5.2, debes actualizar este proxy si quieres usar la rotación de claves. Solo tendrás que realizar esta actualización una vez.

Uso

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

Parámetros

Parámetros Descripción
-o, --org La organización de Apigee para la que configuraste Edge Microgateway.
-e, --env Es un entorno para el que configuraste Edge Microgateway.
-u, --username Tu nombre de usuario de Apigee. Debes ser administrador de la organización especificada.
-p, --password Tu contraseña (opcional) Se te solicitará que lo proporciones si no lo haces en la línea de comandos.
-v, --virtualhost (Opcional) Es el host virtual del proxy.
-b, --baseuri URI base de tu organización en Apigee Edge (opcional). La configuración predeterminada es que el URI base para las implementaciones en la nube de Apigee es api.enterprise.apigee.com. Para las implementaciones locales, la URL base puede ser diferente.

Ejemplo

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

Salida (Correcto)

Si se ejecuta de forma correcta, el comando devuelve un resultado similar al siguiente:

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

Actualización del mapa de clave-valor (KVM)

Usa el comando edgemicro upgradekvm para actualizar el KVM en tu organización de Apigee. Se requiere la actualización de KVM si deseas usar la rotación de claves.

Uso

Edge para la nube pública: 

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

Edge para la nube privada: 

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

Parámetros

Parámetros Descripción
-o, --org La organización de Apigee para la que configuraste Edge Microgateway.
-e, --env Es un entorno para el que configuraste Edge Microgateway.
-k, --key Es el valor de la clave que se devuelve cuando ejecutas el comando "edgemicro configure".
-s, --secret Es el valor secreto que se muestra cuando ejecutas el comando "edgemicro configure".
-p, --proxyuri URI del proxy edgemicro_auth

Nube pública de Edge: Opcional.
Nube privada de Edge: Obligatorio.

Ejemplo de nube pública de Edge: 

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

Ejemplo de nube privada de Edge: 

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

Ejemplo

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

Salida (Correcto)

Si se ejecuta de forma correcta, el comando devuelve un resultado similar al siguiente:

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

Rotación de claves

Usa el comando edgemicro rotatekey para rotar los pares de claves pública/privada que se usaron para generar los tokens de JWT que se usan para la seguridad de OAuth en Edge Microgateway.

Para obtener más información, consulta Rotación de claves de JWT.

Uso

Edge para la nube pública: 

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

Edge para la nube privada: 

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

Parámetros

Parámetros Descripción
-o, --org Es la organización de Apigee para la que configuraste Edge Microgateway (obligatorio).
-e, --env Es un entorno para el que configuraste Edge Microgateway (obligatorio).
-k, --key Es el valor de la clave que se devuelve cuando ejecutas el comando "edgemicro configure".
-s, --secret Es el valor secreto que se muestra cuando ejecutas el comando "edgemicro configure".
-p Ruta de acceso a una clave privada personalizada que usará Apigee Edge. (Se agregó en la versión 3.1.6)
-c Ruta de acceso a un certificado personalizado que usará Apigee Edge. (Se agregó en la versión 3.1.6)
-n, --nbf

Configura la demora en minutos para que una nueva clave privada entre en vigencia. Esta demora permite que las instancias de microgateway se actualicen con la nueva clave pública. Una práctica recomendada es establecer la demora en un valor superior al parámetro de configuración config_change_poll_internal, que es de 10 minutos de forma predeterminada. Para obtener más información, consulta Cómo configurar un retraso de "no antes de". (Se agregó en la versión 3.1.6)

Nota: Si usas esta opción con versiones de edgemicro-auth anteriores a la versión distribuida con Edge Microgateway 3.1.6, se ignorará la marca.

-i, --kid (Opcional) Es un ID que se usa para hacer coincidir una clave específica. Edge Microgateway usa este valor para elegir entre un conjunto de claves durante la rotación de claves. Si se omite este parámetro (opción recomendada), Edge Microgateway genera una clave basada en la marca de tiempo. Para obtener más información, consulta la sección 4.5 de la especificación de claves web JSON.
-r, --rotatekeyuri Es el URI de la clave de rotación.

Nube pública de Edge: Opcional.
Nube privada de Edge: Obligatorio.

Ejemplo de nube pública: 

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

Ejemplo de nube privada de Edge: 

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

Ejemplo

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

Salida (Correcto)

Si se ejecuta de forma correcta, el comando devuelve un resultado similar al siguiente:

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!

Después de la rotación, puedes ver en la IU de Edge que se agregaron claves nuevas al KVM de microgateway.

Ejemplo

En este ejemplo, se usan las marcas -p y -c para especificar la ruta de acceso a un par de certificado y clave privada. Estas opciones te permiten pasar un par de certificado y clave privada personalizados. 

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

Supervisión permanente

Revoca claves

Usa el comando edgemicro revokekeys para revocar las credenciales de clave y secreto de una configuración de Edge Microgateway.

Uso

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

Parámetros

Parámetros Descripción
-o, --org Es la organización de Apigee para la que configuraste Edge Microgateway (obligatorio).
-e, --env Es un entorno para el que configuraste Edge Microgateway (obligatorio).
-u, --username Tu nombre de usuario de Apigee (se requiere -u o -t). Debes ser administrador de la organización especificada. Este parámetro no es obligatorio si, en cambio, especificas el parámetro -t.
-p, --password Tu contraseña (opcional) Se te solicitará que lo proporciones si no lo haces en la línea de comandos.
-k, --key (Obligatorio) Es la clave que se revocará.
-s, --secret (Obligatorio) Es el secreto que se revocará.
-t, --token (Se requiere -u o -t) Te permite usar un token de OAuth para la autenticación en lugar de un nombre de usuario y una contraseña. Si se especifica -t, no se requiere el parámetro -u. Consulta también Protege las llamadas a la API con un token de acceso de OAuth2. Por ejemplo: 
edgemicro revokekeys -o ORG-NAME -e ENV-NAME -k KEY-TO-REVOKE \
    -s KEY-SECRET -t TOKEN

Ejemplos

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

Si la operación se realiza correctamente, verás el siguiente mensaje:

key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully