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.
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 Si no especificas la marca |
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 |
delete |
Borra componentes híbridos del clúster. Usa la marca Si no especificas la marca |
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 |
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:
Por ejemplo,
O bien, para especificar varios componentes, agrega valores separados por comas: |
--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. |
-h, --help |
Muestra ayuda para el comando. |
--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. |
-s, --settings |
Especifica una configuración a la que se aplica el comando. Actualmente, esta marca solo es compatible con la configuración Por ejemplo, si realizas un cambio en la configuración de apigeectl apply -f my-overrides.yaml --settings virtualhosts -c runtime |
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
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.
apigeectl delete -f my_overrides.yaml