apigeectl

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.

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 del entorno de ejecución de Apigee hybrid a tu clúster de Kubernetes. Usa la marca -c para especificar uno o varios componentes (separados por comas).

Si no especificas la marca -c, el comando apply aplica todos los componentes al clúster.
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.

Si no especifica la marca -c, el comando check-ready se aplica a todos los componentes del clúster.
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.

Si no especifica la marca -c, el comando delete se aplica a todos los componentes implementados en el clúster.
help Ayuda para imprimir online.
init

Aplica configuraciones a los componentes necesarios, como Istio y Apigee Deployment, al clúster. Usa la marca -c para especificar uno o varios componentes (separados por comas).
version Muestra la información de la versión de la CLI.

Marcas de apigeectl

En la tabla siguiente se enumeran las marcas apigeectl:

Bandera Descripción
-c, --components

Especifica un único componente al que se aplica el comando.

Si no especifica esta marca, el comando se aplicará a todos los componentes (toda la implementación) del clúster. Estos son algunos de los posibles valores:

  • cassandra
  • logger
  • mart
  • metrics
  • runtime
  • synchronizer
  • udca

Por ejemplo, -c cassandra

También puede especificar varios componentes añadiendo valores separados por comas: -c cassandra, runtime

--dry-run Ejecuta el comando especificado sin cambiar el clúster. Úselo con ‑‑print-yaml para generar la especificación del objeto renderizado en 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 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.
--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.
-s, --settings

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 cambias la propiedad virtualhosts y nada más. (Añadido en la versión 1.2.0)

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 -c runtime

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 -c para aplicar solo un componente 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 la marca -c, tal como se describe en Marcas de apigeectl.

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

apigeectl apply -c synchronizer -f my_overrides.yaml

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

apigeectl apply -c cassandra,runtime -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 --print-yaml > apigee-hybrid.yaml

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
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.

apigeectl delete -f my_overrides.yaml