apigeectl

En este momento, estás viendo la versión 1.1 de la documentación de Apigee Hybrid. Esta versión está al final del ciclo de vida. Debes actualizarla a una versión más reciente. Para obtener más información, consulta las versiones compatibles.

apigeectl es una interfaz de línea de comandos (CLI) para instalar y administrar Apigee Hybrid en un clúster de Kubernetes.

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

Sintaxis de apigeectl

apigeectl [command] [flags]

Aquí:

• 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 de Apigee Hybrid a tu clúster de Kubenetes. Usa la marca -c para especificar uno o más componentes (separados por comas). Si no especificas la marca -c, el comando apply aplica todos los componentes al clúster. NOTA: 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. Si no especificas la marca -c, el comando check-ready se aplica a todos los componentes en el clúster.
delete	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. Si no especificas la marca -c, el comando delete se aplica a todos los componentes implementados en el clúster.
help	Imprime la ayuda en línea.
init	Aplica opciones de configuración a los componentes de los requisitos, como la implementación de Istio y Apigee al clúster. Usa la marca -c para especificar uno o más componentes (separados por comas).
version	Imprime la información de la versión de la CLI.

Marcas de apigeectl

En la siguiente tabla, se enumeran las marcas apigeectl:

Flag	Descripción
-c, --components	Especifica un solo componente al que se aplica el comando. Si no especificas esta marca, el comando se aplicará a todos los componentes (la implementación completa) en el clúster. Estos son algunos de los valores posibles: cassandra logger mart metrics runtime synchronizer udca Por ejemplo, -c cassandra O bien, para especificar varios componentes, agrega valores separados por comas: -c cassandra, runtime
--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.
‑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.
--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.
-h, --help	Muestra ayuda para el comando.

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 para aplicar solo los cambios o usa -c para aplicar solo un componente específico.

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 la marca -c, como se describe en marcas de apigeectl.

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

apigeectl apply -c synchronizer -f my_overrides.yaml

En el siguiente ejemplo, solo se aplica la configuración para los componentes de Cassandra y del entorno de ejecución:

apigeectl apply -c cassandra,runtime -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 --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
All containers ready in namespace 'my-namespace'

Borra los componentes híbridos del clúster

El siguiente ejemplo borra solo los componentes del entorno de ejecución híbrido para tu clúster de Kubernetes. Para borrar todo, usa la marca --all.

NOTA: Para desinstalarlos de forma correcta, debes tener instalada la versión 1.11.x o posterior de kubectl.

apigeectl delete -f my_overrides.yaml