apigeectl

Actualmente, está consultando la versión 1.5 de la documentación de Apigee Hybrid. This version is end of life. You should upgrade to a newer version. Para obtener más información, consulte las versiones admitidas.

Version 1.5 (unsupported)

   Versiones compatibles:

• v1.15 (última)                        
• v1.14                        
• v1.13                         
• Lista de versiones admitidas

   Versiones no compatibles:

• v1.12                         
• v1.11                         
• v1.10                                      
• v1.9                                         
• v1.8                                         
• v1.7                                         
• Versión 1.6                                         
• v1.5                                         
• Versión 1.4                                         
• Versión 1.3                                         
• v1.2                                         
• v1.1                                         

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

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

Permisos para aplicar apigeectl

Con las marcas apigeectl, puedes controlar a qué ámbitos aplica los cambios de configuración el comando. Para obtener una descripción general de los ámbitos del entorno de ejecución de Apigee hybrid, consulta el artículo Información general sobre la configuración del servicio del entorno de ejecución.

Ámbito	Componentes	Marca apigeectl
Almacenamiento	Cassandra	--datastore
Almacenamiento en memoria	Redis	--redis
Entorno	Runtime Synchronizer UDCA	--all-envs --env
Organization (Organización)	Agente de conexión de Apigee MART Watcher	--org
Informes	Logger Metrics	--telemetry

Sintaxis de apigeectl

apigeectl [command] [flags]

Donde:

• command: especifica la operación que quieres realizar. Para ver una lista completa de los comandos, consulta Comandos de apigeectl.

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

Comandos de apigeectl

En la siguiente tabla se enumeran los comandos de apigeectl:

Comando	Descripción
apply	Aplica configuraciones para los componentes de tiempo de ejecución de Apigee hybrid a tu clúster de Kubernetes. apigeectl apply sin indicadores aplicará los cambios a todos los componentes del clúster. Banderas de apigeectl: --all-envs, --datastore, --dry-run, --env, -f, --file-override-config, --help, --org, --print-yaml, --redis, --settings virtualhosts, --telemetry,--verbose 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	Comprueba el estado de los pods de componentes híbridos. Cuando todos los pods de componentes estén listos, se mostrará el mensaje "All containers ready" (Todos los contenedores listos). En el caso de las secuencias de comandos automatizadas, ten en cuenta que el comando se cierra con el estado 0 cuando todos los contenedores están listos. Cuando hay al menos un pod que no está listo, el comando sale con el estado 1. Banderas de apigeectl: -f, --file-override-config, --help, --verbose
delete	Elimina los componentes híbridos del clúster. Usa la marca --all para quitar TODOS los componentes. Si omite --all, solo se eliminarán los componentes específicos de Apigee (los componentes instalados con apigeectl init no se eliminarán). Los componentes específicos de Apigee son los que se instalan con el comando apply. apigeectl delete sin ninguna marca opcional aplica el comando delete a todos los componentes implementados en el clúster. Flags de apigeectl: --all, --all-envs, --datastore, --env, -f, --file-override-config, --help, --org, --redis, --telemetry, --verbose
encode	Devuelve una lista de nombres codificados de todos los ApigeeDeployments de la organización especificada o del entorno especificado de la organización especificada. Los nombres codificados incluyen el nombre del componente con un nombre cifrado de la organización y, si se usa la marca --env, un nombre cifrado del entorno. Apigee Hybrid crea nombres cifrados con hash de organizaciones y entornos para evitar colisiones de espacios de nombres. Debes usar --org org-name o --org org-name y --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 Banderas de apigeectl: --env, --org
help	Ayuda para imprimir online.
init	Instala los operadores y los CRDs 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. Banderas de apigeectl: -f, --file-override-config, --help, --verbose
version	Muestra la información de la versión de la CLI. Marca apigeectl: --help

Marcas de apigeectl

En la tabla siguiente se enumeran las marcas apigeectl:

Bandera	Descripción
--all	delete solo: elimina toda la instalación de Apigee hybrid, excepto ASM (Istio) y cert-manager, de tu clúster.
--all-envs	Aplica el comando apigeectl a todos los entornos de la organización especificada en el archivo de configuración de anulaciones.
--datastore	Aplica la configuración al ámbito del almacén de datos (Cassandra).
‑‑dry‑run	Ejecuta el comando especificado sin cambiar el clúster. Úsalo con ‑‑print-yaml para generar la especificación del objeto renderizado en un archivo. ‑‑dry‑run debe usarse con uno de los dos valores siguientes, en función de la versión de kubectl que estés usando. Usa gcloud version para comprobar tu versión de kubectl: kubectl versión 1.17.x o anterior: ‑‑dry‑run=true kubectl versión 1.18.x o posterior: ‑‑dry‑run=client
--env env-name	Aplica la configuración al entorno especificado. Esta marca aplicará la configuración a los componentes del ámbito del entorno apigee-runtime, apigee-synchronizer y apigee-udca. --env debe usarse 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 necesita un archivo de anulaciones para los comandos apply, check-ready, delete y init. Debes especificar la ruta completa con esta marca. Para obtener más información, consulta Gestionar componentes del plano de tiempo de ejecución.
-h --help	Muestra la ayuda del comando.
--org	Aplica la configuración a la organización especificada. Esta marca aplicará la configuración a los componentes apigee-connect-agent, apigee-mart y apigee-watcher del ámbito de la organización. Nota: Cuando uses --org con encode debes incluir el ID de la organización. Por ejemplo: apigeectl encode --org example-org
--print‑yaml	Imprime la salida de la plantilla de configuración en stdout. Para ver un ejemplo que usa esta marca, consulta Imprimir la configuración en un archivo.
--redis	Aplica la configuración al ámbito de almacenamiento de datos en memoria (Redis).
-s ‑‑settings virtualhosts	Especifica una configuración a la que se aplica el comando. Actualmente, esta marca solo se admite en la configuración virtualhosts, que forma parte del componente runtime. Usa esta marca si modificas la propiedad virtualhosts y nada más. Por ejemplo, si haces un cambio en la configuración de virtualhosts en tu archivo de anulaciones, aplícalo 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 los componentes de telemetría, como apigee-logger y apigee-metrics.
--verbose	Imprime registros detallados en el error estándar.

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

• Gestión imperativa de objetos de Kubernetes mediante archivos de configuración
• Descripción general de kubectl

Ejemplos

Inicializa la configuración del clúster.

Aplica las configuraciones de los componentes de los 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 ejecutes apply, se crearán todos los componentes del tiempo de ejecución híbrido en tu clúster. Si haces cambios en la configuración, vuelve a ejecutar apply para aplicar solo los cambios o usa marcas para aplicar los cambios solo a un ámbito específico.

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

apigeectl apply -f my_overrides.yaml

Aplicar la configuración a un solo componente

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

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

apigeectl apply --datastore -f my_overrides.yaml

Imprimir la configuración en un archivo

Si estás depurando un problema de instalación, es útil imprimir toda la configuración del clúster en un archivo para que puedas inspeccionar los ajustes de 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 hacer ningún cambio en el clúster.

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

NOTA: Te recomendamos que guardes una copia del resultado de YAML en el control de código fuente para consultarla en el futuro. Sin embargo, ten en cuenta que el archivo de salida contiene contraseñas y secretos que puede que no quieras almacenar.

Comprobar el estado de los pods

En el siguiente ejemplo se comprueba el estado de los pods implementados en el clúster:

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

Eliminar el clúster híbrido

En el siguiente ejemplo se eliminan solo los componentes del tiempo de ejecución híbrido del clúster de Kubernetes. Para eliminar todos los datos, usa la marca --all.

NOTA: Para desinstalar correctamente, debes tener instalada la versión 1.11.x o una posterior de kubectl.

apigeectl delete -f my_overrides.yaml