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.
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]
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 híbrido de Apigee en tu clúster de Kubernetes.
Marcas de apigeectl: |
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: |
delete |
Borra componentes híbridos del clúster. Usa la marca
Marcas de apigeectl: |
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 Debes usar ./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: |
help |
Imprime la ayuda en línea. |
init |
Instala operadores y CRD de Apigee en el espacio de nombres apigee-system. Ejecuta Marcas de apigeectl: |
version |
Imprime la información de la versión de la CLI.
Marca de Apigeectl: |
Marcas de apigeectl
En la siguiente tabla, se enumeran las marcas apigeectl
:
Flag | Descripción |
---|---|
--all |
delete únicamente: Borra toda la instalación de Apigee Hybrid, excepto ASM (Istio) y cert-manager, del clúster. |
--all-envs |
Aplica el comando |
--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.
|
--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.
apigeectl apply --org hybrid-example --env example-env \ -f overrides/overrides.yaml |
‑f |
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 |
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. |
--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). |
-s |
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 \ --org example-org --env example-env |
--telemetry |
Aplica la configuración de componentes de telemetría como apigee-logger y apigee-metrics. |
--verbose |
Imprime registros detallados en std err. |
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
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
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