Esta página se ha traducido con Cloud Translation API.

Referencia

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

La apigee-remote-service-cli interfaz de línea de comandos (CLI) te ayuda a aprovisionar y gestionar Apigee Adapter for Envoy.

Comandos de enlace

Una vinculación asocia un servicio implementado en la malla de Istio con un producto de API de Apigee. La CLI te permite crear, quitar y enumerar vinculaciones.

Nota: En la interfaz de usuario de Crear producto, puede especificar uno o varios servicios con un producto. Hacerlo equivale a crear la vinculación mediante la CLI.

Añadir un enlace

Añade un enlace de destino remoto a un producto de API.

Uso

En Apigee Hybrid:

apigee-remote-service-cli bindings add [service_name] [product_name]  -o [organization] -e [environment] -t [token]

Parámetros

Parámetros	Tipo	Descripción
`-c, --config`	Cadena	Obligatorio. Ruta al archivo de configuración de Apigee Remote Service. Nota: Si especificas esta opción, puedes omitir la mayoría de los demás parámetros de comando. Consulta la sección Usar la opción `--config`.
`-e, --env`	Cadena	Obligatorio: un entorno de tu organización.
`-h, --help`		Muestra la ayuda de los parámetros del comando.
`--insecure`		Permitir conexiones de servidor no seguras al usar SSL
`--legacy`		Define esta marca si usas Apigee Cloud. Define las URLs de gestión y de tiempo de ejecución de Edge Cloud.
`--opdk`		Define esta marca si usas Apigee para nubes privadas.
`-o, --org`	Cadena	Obligatorio. Una organización de Apigee. Debes ser administrador de la organización.
`-p, --password`	Cadena	(Obligatorio solo para la autenticación básica) Tu contraseña de Apigee. También puedes especificar la contraseña en un archivo `.netrc`. Si lo haces, no tendrás que proporcionar tu contraseña en la línea de comandos. Consulta también Usar .netrc para las credenciales.
`-r, --runtime`	Cadena	URL base del tiempo de ejecución de Apigee (obligatoria para las instalaciones híbridas o locales).
`-t, --token`	Cadena	(Obligatorio solo para la autenticación con token de OAuth) Un token de OAuth o SAML que generas a partir de la información de tu cuenta de Apigee. Para obtener información sobre cómo generar tokens, consulta Obtener un token de acceso OAuth 2.0 y Información general sobre SAML.
`-u, --username`	Cadena	(Obligatorio solo para la autenticación básica) Tu nombre de usuario de Apigee (normalmente, una dirección de correo electrónico). También puedes especificar el nombre de usuario en un archivo `.netrc`. Si lo haces, no tendrás que proporcionar tu nombre de usuario en la línea de comandos. Consulta también Usar .netrc para las credenciales.
`-v, --verbose`		(Opcional) Genera una salida detallada.

Ejemplo

./apigee-remote-service-cli bindings add httpbin.org envoy-test -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
product envoy-test is now bound to: httpbin.org

Mostrar vínculos

Muestra todos los productos de API vinculados al servicio remoto.

Uso

Parámetros

Parámetros	Tipo	Descripción
`-c, --config`	Cadena	Obligatorio. Ruta al archivo de configuración de Apigee Remote Service. Nota: Si especificas esta opción, puedes omitir la mayoría de los demás parámetros de comando. Consulta la sección Usar la opción `--config`.
`-e, --env`	Cadena	Obligatorio: un entorno de tu organización.
`-h, --help`		Muestra la ayuda de los parámetros del comando.
`--insecure`		Permitir conexiones de servidor no seguras al usar SSL
`--legacy`		Define esta marca si usas Apigee Cloud. Define las URLs de gestión y de tiempo de ejecución de Edge Cloud.
`--opdk`		Define esta marca si usas Apigee para nubes privadas.
`-o, --org`	Cadena	Obligatorio. Una organización de Apigee. Debes ser administrador de la organización.
`-p, --password`	Cadena	(Obligatorio solo para la autenticación básica) Tu contraseña de Apigee. También puedes especificar la contraseña en un archivo `.netrc`. Si lo haces, no tendrás que proporcionar tu contraseña en la línea de comandos. Consulta también Usar .netrc para las credenciales.
`-r, --runtime`	Cadena	URL base del tiempo de ejecución de Apigee (obligatoria para las instalaciones híbridas o locales).
`-t, --token`	Cadena	(Obligatorio solo para la autenticación con token de OAuth) Un token de OAuth o SAML que generas a partir de la información de tu cuenta de Apigee. Para obtener información sobre cómo generar tokens, consulta Obtener un token de acceso OAuth 2.0 y Información general sobre SAML.
`-u, --username`	Cadena	(Obligatorio solo para la autenticación básica) Tu nombre de usuario de Apigee (normalmente, una dirección de correo electrónico). También puedes especificar el nombre de usuario en un archivo `.netrc`. Si lo haces, no tendrás que proporcionar tu nombre de usuario en la línea de comandos. Consulta también Usar .netrc para las credenciales.
`-v, --verbose`		(Opcional) Genera una salida detallada.

Ejemplo

apigee-remote-service-cli bindings list -o myorg -e test -u user@example.com -c config.yaml -p abc123
PI Products
============
Bound
-----
envoy-test:
  Quota: 5 requests every 1 minute
  Target bindings:
    httpbin.org
  Paths:
httpbin:
  Quota: 5 requests every 1 minute
  Target bindings:
    httpbin.org
  Paths:
    /httpbin
    /

Unbound
-------
product-1:
  Quota: 100 requests every 1 hour
product-2:
  Quota: 1000 requests every 1 month
product-3:
product-4:

Quitar un enlace

Elimina la vinculación de Remote Service for Envoy de un producto de API.

Nota: También puedes quitar un enlace de servicio remoto de Envoy eliminando el nombre del servicio del producto en la interfaz de usuario.

Uso

En Apigee Hybrid:

apigee-remote-service-cli bindings remove [service_name] [product_name]  -o [organization] -e [environment] -t [token]

Parámetros

Parámetros	Tipo	Descripción
`-c, --config`	Cadena	Obligatorio. Ruta al archivo de configuración de Apigee Remote Service. Nota: Si especificas esta opción, puedes omitir la mayoría de los demás parámetros de comando. Consulta la sección Usar la opción `--config`.
`-e, --env`	Cadena	Obligatorio: un entorno de tu organización.
`-h, --help`		Muestra la ayuda de los parámetros del comando.
`--insecure`		Permitir conexiones de servidor no seguras al usar SSL
`--legacy`		Define esta marca si usas Apigee Cloud. Define las URLs de gestión y de tiempo de ejecución de Edge Cloud.
`--opdk`		Define esta marca si usas Apigee para nubes privadas.
`-o, --org`	Cadena	Obligatorio. Una organización de Apigee. Debes ser administrador de la organización.
`-p, --password`	Cadena	(Obligatorio solo para la autenticación básica) Tu contraseña de Apigee. También puedes especificar la contraseña en un archivo `.netrc`. Si lo haces, no tendrás que proporcionar tu contraseña en la línea de comandos. Consulta también Usar .netrc para las credenciales.
`-r, --runtime`	Cadena	URL base del tiempo de ejecución de Apigee (obligatoria para las instalaciones híbridas o locales).
`-t, --token`	Cadena	(Obligatorio solo para la autenticación con token de OAuth) Un token de OAuth o SAML que generas a partir de la información de tu cuenta de Apigee. Para obtener información sobre cómo generar tokens, consulta Obtener un token de acceso OAuth 2.0 y Información general sobre SAML.
`-u, --username`	Cadena	(Obligatorio solo para la autenticación básica) Tu nombre de usuario de Apigee (normalmente, una dirección de correo electrónico). También puedes especificar el nombre de usuario en un archivo `.netrc`. Si lo haces, no tendrás que proporcionar tu nombre de usuario en la línea de comandos. Consulta también Usar .netrc para las credenciales.
`-v, --verbose`		(Opcional) Genera una salida detallada.

Ejemplo

./apigee-remote-service-cli bindings remove httpbin.org envoy-test -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
product envoy-test is no longer bound to: httpbin.org

Comando de ayuda

Se ofrece ayuda online para todos los comandos de apigee-remote-service-cli. Solo tienes que escribir:

apigee-remote-service-cli help

Para obtener ayuda sobre cualquier comando, escribe lo siguiente:

apigee-remote-service-cli [command] help

Por ejemplo:

apigee-remote-service-cli provision help

Comando de aprovisionamiento

El comando apigee-remote-service-cli provision instala un proxy en tu organización de Apigee, configura un certificado y genera las credenciales que necesitarás para configurar el adaptador de Apigee para Envoy.

Uso

Parámetros

Parámetros	Tipo	Descripción
`-c, --config`	Cadena	Ruta al archivo de configuración del servicio remoto de Apigee. Nota: Si especificas esta opción, puedes omitir la mayoría de los demás parámetros de comando. Consulta la sección Usar la opción `--config`.
`-e, --environment`	Cadena	Obligatorio: un entorno de tu organización.
`-f, --force-proxy-install`		(Opcional) Fuerza la reinstalación del proxy `remote-service` si ya está instalado en tu organización. NOTA SOBRE LA ACTUALIZACIÓN: Si vas a actualizar a la versión 1.0-beta.4 o a una versión posterior, debes incluir la marca `--force-proxy-install` para sustituir el proxy de servicio remoto que se haya implementado en Apigee.
`-h, --help`		Muestra la ayuda de los parámetros del comando.
`-k, --key`	Cadena	Especifica la clave devuelta por el comando `apigee-remote-service-cli provision`.
`--legacy`		Apigee Edge (define la URL de gestión y de tiempo de ejecución)
`-m, --management`	Cadena	Obligatorio si usas Apigee Private Cloud. Es la URL base de gestión de Apigee. Predeterminado: `https://api.enterprise.apigee.com`
`-n, --namespace`	Cadena	emite la configuración como un ConfigMap de Envoy en el espacio de nombres especificado.
`--opdk`	Cadena	Apigee OPDK.
`-o, --organization`	Cadena	Obligatorio: tu organización de Apigee. Debes ser administrador de la organización.
`-p, --password`	Cadena	(Obligatorio solo para la autenticación básica) Tu contraseña de Apigee. También puedes especificar la contraseña en un archivo `.netrc`. Si lo haces, no tendrás que proporcionar tu contraseña en la línea de comandos. Consulta también Usar .netrc para las credenciales.
`--rotate-int`	int	Si n > 0, genera una clave privada y conserva n claves públicas (solo híbrido)
`-r, --runtime`	Cadena	URL base del tiempo de ejecución de Apigee (obligatoria para las instalaciones híbridas o OPDK)
`-s, --secret`	Cadena	Especifica el secreto devuelto por el comando `apigee-remote-service-cli provision`.
`--strength`	int	(Opcional) Especifica la seguridad del cifrado de los certificados SSL que se utilizan para aprovisionar el adaptador. Predeterminado 2048
`-t, --token`	Cadena	(Solo Hybrid) Token de OAuth o SAML de Apigee.
`-u, --username`	Cadena	(Obligatorio solo para la autenticación básica) Tu nombre de usuario de Apigee (normalmente, una dirección de correo electrónico). También puedes especificar el nombre de usuario en un archivo `.netrc`. Consulta también Usar .netrc para las credenciales.
`-v, --verbose`		(Opcional) Genera una salida detallada.
`--virtual-hosts`	Cadena	Anula los hosts virtuales predeterminados.
`--years`	int	(Opcional) Número de años que faltan para que caduque el certificado SSL usado en el aprovisionamiento. Valor predeterminado: 1

Ejemplo

Asegúrate de capturar la salida del comando provision en un archivo, que se usa como entrada para otras operaciones de Apigee Adapter for Envoy.

Ejemplo de Apigee Hybrid:

apigee-remote-service-cli provision --organization $ORG --environment $ENV --runtime $RUNTIME --namespace $NAMESPACE --token $TOKEN > config.yaml

Comandos de token

Puedes usar un token JWT para hacer llamadas autenticadas a proxies de API en lugar de usar una clave de API. Los comandos de token te permiten crear, inspeccionar y rotar tokens JWT con este fin.

Crear un token JWT

Puedes usar un token JWT para hacer llamadas de proxy de API autenticadas a un servicio remoto de destino. Consulta también Usar la autenticación basada en JWT.

Uso

En Apigee Hybrid:

apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -r [runtime] -o [org] -e [env]

Parámetros

Parámetros	Tipo	Descripción
`-c, --config`	Cadena	Obligatorio. Ruta al archivo de configuración de Apigee Remote Service. Nota: Si especificas esta opción, puedes omitir la mayoría de los demás parámetros de comando. Consulta la sección Usar la opción `--config`.
`-e, --env`	Cadena	Obligatorio: un entorno de tu organización.
`-h, --help`		Muestra la ayuda de los parámetros del comando.
`--insecure`		Permite conexiones de servidor no seguras al usar SSL.
`-o, --org`	Cadena	Obligatorio. Una organización de Apigee. Debes ser administrador de la organización.
`-r, --runtime`	Cadena	URL base del tiempo de ejecución de Apigee (solo es obligatoria para las instalaciones híbridas o de OPDK).
`-v, --verbose`		(Opcional) Genera una salida detallada.

Ejemplo

apigee-remote-service-cli token create -o myorg -e test -i YUmlZAcBKNsTAelJqPZFl3sh58ObATX9 -s icTARgaKHqvUH1dq -c config.yaml

Salida

Si la operación se realiza correctamente, verá un token JST similar al siguiente:

eyJraWQiOiIxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhY2Nlc3NfdG9rZW4iOiJ0a2tlVzVKQTY2a0pZYTB4bFV1cVBsUW1BMU43IiwiYXVkIjoiaXN0aW8iLCJuYmYiOjE1MzAxMzg1OTEsImFwaV9wcm9kdWN0X2xpc3QiOlsiaXN0aW8tcHJvZHVjdCJdLCJhcHBsaWNhdGlvbl9uYW1lIjoiaXN0aW8tYXBwIiwiZGV2ZWxvcGVyX2VtYWlsIjoicFluZ2Zsb3lkQGdvb2dsZS5jb20iLCJpc3MiOiJodHRwczovL2FwaWdlZXNlYXJjaC10ZXN0LmFwaWdlZS5uZXQvaXN0aW8tYXV0aC90b2tlbiIsImV4cCI6MTUzMDEzOTQ5MSwiaWF0IjoxNTMwMTM4NTkxLCJqdGkiOiIxODgzMzViZi0wMmE4LTRjZGUsOGFkOS0yMWJmNDZjNmRjZDkiLCJjbGllbnRfaWQiOiJZVW1sWkFjQktOc1RBZWxKcVBZRmwzc2g1OE9iQVRYOSJ9.AL7pKSTmond-NSPRNNHVbIzTdAnZjOXcjQ-BbOJ_8lsQvF7PuiOUrGIhY5XTcJusisKgbCdtIxBl8Wq1EiQ_fKnUc3JYYOqzpTB5bGoFy0Yqbfu96dneuWyzgZnoQBkqwZkbQTIg7WNTGx1TJX-UTePvBPxAefiAbaEUcigX9tTsXPoRJZOTrm7IOeKpxpB_gQYkxQtV1_NbERxjTPyMbHdMWal9_xRVzSt7mpTGudMN9OR-VtQ1uXA67GOqhZWcOzq57qImOiCMbaoKnKUADevyWjX_VscN5ZZUtzQUQhTrmv8aR69-uVhMIPKp9juMyYKaYn2IsYZEeCWfhfV45Q

Inspeccionar un token JWT

Puedes inspeccionar un token JWT con este comando. Consulta también Inspeccionar un token.

Uso

En Apigee Hybrid:

apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file] --runtime [host_alias]

Parámetros

Parámetros	Tipo	Descripción
`-c, --config`	Cadena	Obligatorio. Ruta al archivo de configuración de Apigee Remote Service. Nota: Si especificas esta opción, puedes omitir la mayoría de los demás parámetros de comando. Consulta la sección Usar la opción `--config`.
`-e, --env`	Cadena	Obligatorio: un entorno de tu organización.
`-h, --help`		Muestra la ayuda de los parámetros del comando.
`--insecure`		Permite conexiones de servidor no seguras al usar SSL.
`-o, --org`	Cadena	Obligatorio. Una organización de Apigee. Debes ser administrador de la organización.
`-r, --runtime`	Cadena	URL base del tiempo de ejecución de Apigee (solo es obligatoria para las instalaciones híbridas o de OPDK).
`-v, --verbose`		(Opcional) Genera una salida detallada.

Ejemplo

apigee-remote-service-cli token inspect -c config.yaml <<< $TOKEN

Salida

Si la operación se realiza correctamente, verás un resultado similar al siguiente:

{
	"aud": [
		"remote-service-client"
	],
	"exp": 1591741549,
	"iat": 1591740649,
	"iss": "https://apigee-docs-test.apigee.net/remote-service/token",
	"jti": "99325d2e-6440-4278-9f7f-b252a1a79e53",
	"nbf": 1591740649,
	"access_token": "VfzpXzBGAQ07po0bPMKY4JgQjus",
	"api_product_list": [
		"httpbin"
	],
	"application_name": "httpbin",
	"client_id": "GYDGHy5TRpV8AejXCOlreP7dPVepA8H",
	"developer_email": "user@example.com",
	"scope": ""
}
verifying...
token ok.

Rotar un token JWT

En algún momento después de generar un JWT por primera vez, es posible que tengas que cambiar el par de claves pública y privada que Apigee almacena en su mapa de valores clave (KVM) cifrado. Este proceso de generación de un nuevo par de claves se denomina "rotación de claves". Cuando rotas las claves, se genera un nuevo par de claves privada/pública y se almacena en el KVM "istio" de tu organización o entorno de Apigee. Además, la clave pública antigua se conserva junto con su valor de ID de clave original.

Uso

Parámetros

Parámetros	Tipo	Descripción
`-c, --config`	Cadena	Obligatorio. Ruta al archivo de configuración de Apigee Remote Service. Nota: Si especificas esta opción, puedes omitir la mayoría de los demás parámetros de comando. Consulta la sección Usar la opción `--config`.
`-e, --env`	Cadena	Obligatorio: un entorno de tu organización.
`-h, --help`		Muestra la ayuda de los parámetros del comando.
`--insecure`		Permitir conexiones de servidor no seguras al usar SSL
`--truncate`	int	Número de certificados que se conservarán en jwks (el valor predeterminado es 2).
`-o, --org`	Cadena	Obligatorio. Una organización de Apigee. Debes ser administrador de la organización.
`-r, --runtime`	Cadena	URL base del tiempo de ejecución de Apigee (obligatoria para las instalaciones híbridas o locales).
`-v, --verbose`		(Opcional) Genera una salida detallada.

Ejemplo

apigee-remote-service-cli token rotate-cert -c config.yaml -o myorg -e test -k 2e238ffa15dc5ab6a1e97868e7581f6c60ddb8575478582c256d8b7e5b2677a8 -s 51058077223fa7b683c3bea845c5cca138340d1d5583922b6d465f9f918a4b08

Salida

certificate successfully rotated

Usar .netrc para las credenciales

apigee-remote-service-cli recoge automáticamente el username y el password (para la autenticación básica cuando sea necesario) de un archivo .netrc en tu directorio principal si usas Apigee y tienes una entrada para la máquina api.enterprise.apigee.com. Si usas Apigee Private Cloud, el valor de la máquina es el mismo que el de tu URL management (por ejemplo, http://192.162.55.100).

Comando de versión

Imprime la versión de la CLI.

apigee-remote-service-cli version

Usar la opción de comando `--config`

La opción --config especifica la ubicación del archivo de configuración generado por el comando provision. Una de las ventajas de esta opción es que te permite omitir la mayoría de los demás parámetros de comandos, que la CLI extrae del archivo de configuración. Entre estas opciones, se incluyen las siguientes:

organización
entorno
runtime
management
inseguro
espacio de nombres
antiguo
opdk

Por ejemplo, puedes ejecutar el comando provision de esta forma:

apigee-remote-service-cli provision --config='old-config.yaml' > new-config.yaml

Archivo de configuración

En esta sección se muestra un archivo de configuración de ejemplo con todas las opciones disponibles.

global:
  temp_dir: /tmp/apigee-istio
  keep_alive_max_connection_age: 10m
  api_address: :5000
  metrics_address: :5001
  tls:
    cert_file: tls.crt
    key_file: tls.key
tenant:
  internal_api: https://istioservices.apigee.net/edgemicro
  remote_service_api: https://org-test.apigee.net/remote-service
  org_name: org
  env_name: env
  key: mykey
  secret: mysecret
  client_timeout: 30s
  allow_unverified_ssl_cert: false
products:
  refresh_rate: 2m
analytics:
  legacy_endpoint: false
  file_limit: 1024
  send_channel_size: 10
  collection_interval: 10s
  fluentd_endpoint: apigee-udca-myorg-test.apigee.svc.cluster.local:20001
  tls:
    ca_file: /opt/apigee/tls/ca.crt
    cert_file: /opt/apigee/tls/tls.crt
    key_file: /opt/apigee/tls/tls.key
    allow_unverified_ssl_cert: false
auth:
  api_key_claim: claim
  api_key_cache_duration: 30m
  api_key_header: x-api-key
  api_target_header: :authority
  reject_unauthorized: true
  jwks_poll_interval: 0s

Referencia Organízate con las colecciones Guarda y clasifica el contenido según tus preferencias.

Comandos de enlace

Añadir un enlace

Uso

Parámetros

Ejemplo

Mostrar vínculos

Uso

Parámetros

Ejemplo

Quitar un enlace

Uso

Parámetros

Ejemplo

Comando de ayuda

Comando de aprovisionamiento

Uso

Parámetros

Ejemplo

Comandos de token

Crear un token JWT

Uso

Parámetros

Ejemplo

Salida

Inspeccionar un token JWT

Uso

Parámetros

Ejemplo

Salida

Rotar un token JWT

Uso

Parámetros

Ejemplo

Salida

Usar .netrc para las credenciales

Comando de versión

Usar la opción de comando --config

Archivo de configuración

Referencia

Usar la opción de comando `--config`