apigeectl

Estás viendo la versión 1.11 de la documentación de Apigee Hybrid. Para obtener más información, consulta las Versiones compatibles.

Version 1.11 

   Versiones compatibles:

• v1.13 (la más reciente)                        
• v1.12                         
• v1.11                         
• Lista de versiones compatibles

   Versiones no compatibles

• v1.10                                      
• v1.9                                         
• v1.8                                         
• v1.7                                         
• v1.6                                         
• v1.5                                         
• v1.4                                         
• v1.3                                         
• v1.2                                         
• v1.1                                         

apigeectl es una interfaz de línea de comandos (CLI) para instalar y administrar Apigee Hybrid en un clúster de Kubernetes. Para obtener más información sobre cómo descargar e instalar apigeectl, consulta Descarga e instala apigeectl.

Nota: Debes tener kubectl instalado y configurado en tu máquina de administración de Kubernetes para usar el comando apigeectl.

Alcances para aplicar apigeectl

Mediante el uso de las marcas apigeectl, puedes controlar a qué alcances aplica el comando los cambios de configuración. Para obtener una descripción general de los alcances dentro del entorno de ejecución de Apigee Hybrid, consulta Descripción general de la configuración del servicio del entorno de ejecución.

Alcance	Componentes	Marca apigeectl
Almacenamiento	Cassandra	‑‑datastore
Almacenamiento en memoria	Redis	‑‑redis
Entorno	Entorno de ejecución Synchronizer UDCA	‑‑all‑envs ‑‑env
Organization	Agente de Apigee Connect MART Agente de observación	‑‑org
Informes	Registrador Métricas	‑‑telemetry

Sintaxis de apigeectl

apigeectl [command] [flags]

Donde:

• command: especifica la operación que deseas realizar. Para obtener una lista completa de comandos, consulta comandos de Apigeectl.

• flags: especifica los parámetros del comando. Para obtener una lista completa de marcas, consulta marcas de apigeectl.

Comandos de apigeectl

En la siguiente tabla, se enumeran los comandos de apigeectl:

Comando	Descripción
apply	Aplica opciones de configuración para los componentes del entorno de ejecución híbrido de Apigee en tu clúster de Kubernetes. apigeectl apply sin marcas aplicará los cambios a todos los componentes del clúster. marcas de apigeectl: ‑‑all‑envs, ‑‑datastore, ‑‑dry‑run, ‑‑env, ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑org, ‑‑print‑yaml, ‑‑redis, ‑‑settings virtualhosts, ‑‑telemetry, ‑‑v Nota: Después de una instalación nueva o una actualización, debes llamar a apigeectl init antes de llamar a apigeectl apply.
check‑ready	Verifica el estado de los Pods de los componentes híbridos. Cuando todos los Pods componentes están listos, se muestra el mensaje “Todos los contenedores listos”. Para la secuencia de comandos automatizada, ten en cuenta que el comando sale con un estado de 0 cuando los contenedores están listos. Cuando hay al menos un pod no listo, el comando sale con un estado de 1. Marcas de apigeectl: ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑v
delete	Advertencia: El uso del comando apigeectl delete con la marca ‑‑all (por ejemplo, apigeectl delete ‑‑all -f overrides.yaml) también borrará los datos de copia de seguridad de todas las instantáneas de volumen de CSI. Borra componentes híbridos del clúster. Usa la marca ‑‑all para quitar TODOS los componentes. Si omites ‑‑all, solo se quitan los componentes específicos de Apigee (no se borran los componentes instalados con apigeectl init). Los componentes específicos de Apigee son los componentes que se instalan con el comando apply. apigeectl delete sin marcas opcionales aplica el comando delete que se aplica a todos los componentes implementados en el clúster. apigeectl diagnostic delete ‑f OVERRIDES_FILE borra el espacio de nombres apigee‑diagnostic creado por apigeectl diagnostic. La marca ‑f/‑‑file‑override‑config es obligatoria con apigeectl diagnostic delete. Marcas de apigeectl: ‑‑all, ‑‑all‑envs, ‑‑datastore, ‑‑env, ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑org, ‑‑redis, ‑‑telemetry, ‑‑v Para obtener más información, consulta Desinstala el entorno de ejecución híbrido.
diagnostic	Invoca el colector de diagnóstico, que captura datos de diagnóstico en los componentes de Kubernetes de una instancia de Apigee Hybrid a pedido y los almacena en buckets de almacenamiento de Google Cloud. El colector de diagnóstico requiere un bucket de Google Cloud Storage con nombre, una cuenta de servicio con la función de Administrador de almacenamiento y una estrofa diagnostic: agregada a tu archivo overrides. Consulta los siguientes vínculos: Usa el colector de diagnóstico Referencia de propiedad de configuración; diagnostic Cuando invocas el colector de diagnóstico, se crea un espacio de nombres de Kubernetes “apigee‑diagnostic”. Debes borrar esto con apigeectl diagnostic delete antes de invocar de nuevo el colector de diagnóstico. Invoca el colector de diagnóstico: apigeectl diagnostic ‑f OVERRIDES_FILE Borra el colector de diagnóstico: apigeectl diagnostic delete ‑f OVERRIDES_FILE Marcas de apigeectl: ‑‑file‑override‑config
encode	Muestra una lista de nombres codificados de todas las ApigeeDeployments para la organización o el entorno especificado dentro de la organización especificada. Los nombres codificados incluyen el nombre del componente con un nombre con hash de la organización y, si se usa la marca ‑‑env, un nombre con hash del entorno. Apigee Hybrid crea nombres con hash de organizaciones y entornos para poder evitar colisiones de espacios de nombres. Debes usar ‑‑org org‑name o ‑‑org org‑name con las marcas ‑‑env env‑name con encode. Por ejemplo: ./apigeectl encode ‑‑org hybrid‑example List of ApigeeDeployments are: apigee‑connect‑agent‑hybrid‑example‑6a82f8a apigee‑mart‑hybrid‑example‑6a82f8a apigee‑watcher‑hybrid‑example‑6a82f8a ./apigeectl encode ‑‑org hybrid‑example ‑‑env example‑env List of ApigeeDeployments are: apigee‑runtime‑hybrid‑example‑example‑env‑9e87e2d apigee‑synchronizer‑hybrid‑example‑example‑env‑9e87e2d apigee‑udca‑hybrid‑example‑example‑env‑9e87e2d Marcas de apigeectl: ‑‑env, ‑‑org
help	Imprime la ayuda en línea.
init	Instala operadores y CRD de Apigee en el espacio de nombres apigee-system. Ejecuta apigeectl init después de una instalación o actualización nueva antes de ejecutar apigeectl apply. Marcas de apigeectl: ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑v
version	Imprime la información de la versión de la CLI. Marca de Apigeectl: ‑‑help

Marcas de apigeectl

En la siguiente tabla, se enumeran las marcas apigeectl:

Marcar	Descripción
‑‑all	Advertencia: El uso del comando apigeectl delete con la marca ‑‑all (por ejemplo, apigeectl delete ‑‑all -f overrides.yaml) también borrará los datos de copia de seguridad de todas las instantáneas de volumen de CSI. delete únicamente: Borra toda la instalación de Apigee Hybrid, excepto ASM (Istio) y cert-manager, del clúster.
‑‑all‑envs	Aplica el comando apigeectl a todos los entornos en la organización especificada en tu archivo de configuración de anulación.
‑‑datastore	Aplica la configuración al alcance del almacén de datos (Cassandra).
‑‑dry‑run	Ejecuta el comando especificado sin cambiar el clúster. Úsalo con ‑‑print‑yaml para enviar la especificación del objeto renderizado a un archivo. ‑‑dry‑run se debe usar con uno de los dos valores siguientes, según la versión de kubectl que ejecutes. Usa gcloud version para verificar tu versión de kubectl: Versión de kubectl 1.17.x o anterior: ‑‑dry‑run=true Versión de kubectl 1.18.x o posterior: ‑‑dry‑run=client
‑‑env env‑name	Aplica la configuración a la organización especificada. Esta marca aplicará la configuración a los componentes de alcance del entorno de apigee-runtime, apigee-synchronizer y apigee-udca. ‑‑env se debe usar con la marca ‑‑org. Por ejemplo: apigeectl apply ‑‑org hybrid‑example ‑‑env example‑env \ ‑f overrides/overrides.yaml
‑f ‑‑file‑override‑config	Especifica un archivo YAML que contiene propiedades de configuración personalizadas para la implementación híbrida. El valor predeterminado es ./overrides.yaml. Se requiere un archivo de anulación para los comandos apply, check‑ready, delete y init. Debes especificar la ruta de acceso completa con esta marca. Para obtener más información, consulta Administra componentes del plano de entorno de ejecución.
‑h ‑‑help	Muestra ayuda para el comando.
‑‑org	Aplica la configuración a la organización especificada. Esta marca aplicará la configuración a los componentes de alcance de la organización apigee-connect-agent, apigee-mart y apigee-watcher. Nota: Cuando uses ‑‑org con encode, debes incluir el ID de la organización. Por ejemplo: apigeectl encode ‑‑org example‑org
‑‑print‑yaml	Imprime el resultado de la plantilla de configuración en stdout. Para ver un ejemplo en el que se use esta marca, consulta Imprime la configuración en un archivo.
‑‑redis	Aplica la configuración al permiso de almacenamiento de datos en la memoria (Redis).
‑‑restore	Restablece Cassandra a una instantánea guardada antes especificada por la propiedad snapshotTimestamp en la configuración restore del archivo overrides.yaml. La copia de seguridad se restablece desde el bucket de Cloud Storage o desde un servidor remoto según la configuración de backup en el archivo overrides.yaml. Para obtener más información, consulta Restablece una región a partir de una copia de seguridad.
‑s ‑‑settings virtualhosts	Especifica una configuración a la que se aplica el comando. Actualmente, esta marca solo es compatible con la configuración virtualhosts, que forma parte del componente runtime. Usa esta marca si solo realizas cambios en la propiedad virtualhosts. Por ejemplo, si realizas un cambio en la configuración de virtualhosts en tu archivo de anulación, aplícala al clúster con este comando: apigeectl apply ‑f my‑overrides.yaml ‑‑settings virtualhosts \ ‑‑org example‑org ‑‑env example‑env
‑‑telemetry	Aplica la configuración de componentes de telemetría como apigee-logger y apigee-metrics.
‑‑v int	Imprime registros detallados en std err. int es un número entero que establece el nivel de verbosidad. int es obligatorio con ‑‑v. Esta opción se comporta de la misma manera que la opción kubectl ‑‑v. Nota: Con esta opción, se reemplaza la opción ‑‑verbose obsoleta.

El comando apigeectl usa kubectl en segundo plano para realizar su trabajo. Las opciones del comando apigeectl (apply y delete, y el uso de archivos de configuración YAML, son similares a sus contrapartes de kubectl. Si deseas obtener más información sobre cómo se administran los objetos en un clúster de Kubernetes, consulta los siguientes temas:

• Administración imperativa de objetos de Kubernetes con archivos de configuración
• Descripción general de kubectl

Ejemplos

Inicializa la configuración del clúster

Aplica configuraciones de componentes de requisitos previos a tu clúster con init. Debes ejecutar el comando init antes de apply.

apigeectl init ‑f my_overrides.yaml

Aplica la configuración del clúster

Para aplicar configuraciones híbridas a tu clúster de Kubernetes, usa el comando apply. La primera vez que ejecutas apply, se crean todos los componentes del entorno de ejecución híbrido en tu clúster. Si realizas cambios en la configuración, vuelve a ejecutar apply fin de aplicar solo los cambios o usa marcas para aplicar los cambios a un permiso específico únicamente.

En el siguiente ejemplo, se aplica la configuración de los componentes del plano del entorno de ejecución híbrido a tu clúster:

apigeectl apply ‑f my_overrides.yaml

Aplica la configuración para un solo componente

Para restringir el comando apply a un componente en particular, usa las marcas descritas en marcas de apigeectl.

En el siguiente ejemplo, solo se aplica la configuración del componente de Cassandra:

apigeectl apply ‑‑datastore ‑f my_overrides.yaml

Imprime la configuración en un archivo

Si depuras un problema de instalación, es útil imprimir toda la configuración del clúster en un archivo para poder inspeccionar la configuración. La marca ‑‑print‑yaml imprime la configuración híbrida en stdout, y la marca ‑‑dry‑run permite que el comando se ejecute sin realizar cambios en el clúster.

apigeectl apply ‑f my_overrides.yaml ‑‑dry‑run=client ‑‑print‑yaml > apigee‑hybrid.yaml

NOTA: Se recomienda guardar una copia del resultado en formato YAML en el control de la fuente para referencia futura. Sin embargo, debes tener en cuenta que el archivo de salida contiene contraseñas y secretos que quizás no quieras almacenar.

El estado del pod

En el siguiente ejemplo, se verifica el estado de los pods implementados en tu clúster:

apigeectl check‑ready ‑f overrides/overrides.yaml
All containers ready in namespace 'my-namespace'

Borra los componentes híbridos del clúster

Para obtener más información, consulta Desinstala el entorno de ejecución híbrido.