Administra los componentes del plano del entorno de ejecución

En este tema, se explica cómo configurar y administrar los componentes del plano del entorno de ejecución de Apigee Hybrid.

Acerca del archivo de anulación

La primera vez que instalas el entorno de ejecución híbrido en un clúster, debes crear un archivo de anulaciones de configuración. Este archivo te permite proporcionar los valores de propiedad necesarios para instalar hybrid, como el nombre de tu proyecto de Google, el nombre de la organización, los detalles del entorno, los archivos de certificado, etcétera. También puedes anular ciertos valores predeterminados para la mayoría de los componentes híbridos en el archivo de anulación. Para obtener una lista completa de las propiedades que se pueden configurar, consulta Referencia de las propiedades de configuración.

Los pasos de la instalación híbrida explican el proceso de creación de un archivo de anulaciones y cómo aplicar la configuración a un clúster. Si deseas cambiar la configuración más adelante, modifica el archivo de anulaciones que creaste y vuelve a aplicarlo. Consulta Realiza un cambio de configuración.

Realiza un cambio de configuración

Para realizar un cambio de configuración en un componente del plano del entorno de ejecución híbrido, edita tu archivo de anulaciones y aplica los cambios con apigeectl. Para obtener una lista completa de las propiedades que se pueden configurar, consulta Referencia de las propiedades de configuración.

Por ejemplo, para habilitar el componente logger, actualiza el archivo de anulación y vuelve a aplicarlo:

Abre el archivo de anulaciones. Asegúrate de usar el mismo archivo de anulaciones que se usó para instalar el entorno de ejecución híbrido en el clúster.
Ubica el elemento logger en el archivo. Por ejemplo:
```
...
logger:
  enabled: false
...
```
Cambia el valor de la propiedad a true.
```
...
  logger:
  enabled: true
...
```
Usa apigeectl para aplicar el cambio en el clúster:
```
$APIGEECTL_HOME/apigeectl apply -f $HYBRID_FILES/overrides/OVERRIDES.yaml --telemetry
```
La marca --telemetry le indica a apigeectl que solo actualice el componente del registrador. Si deseas obtener información sobre los parámetros de permisos, como --telemetry, consulta Permisos para aplicar apigeectl.

¿Qué propiedades de configuración puedes modificar?

Puedes encontrar la lista completa de propiedades configurables en la referencia de las propiedades de configuración. La referencia solo enumera las propiedades que puedes modificar. Si intentas modificar una propiedad que no está en la referencia, el cambio se ignora.

Cómo usar la referencia de configuración

La referencia de las propiedades de configuración usa la notación de puntos para describir elementos de configuración. El primer elemento es el nombre del elemento de nivel superior seguido de propiedades y propiedades secundarias. Por ejemplo:

authz.image.pullPolicy

En el archivo de anulación, las propiedades tienen el formato YAML adecuado. En el ejemplo anterior, el elemento authz de nivel superior tiene sangrías izquierdas y las propiedades de subelemento tienen sangría debajo de este. Además, YAML requiere dos puntos al final de cada elemento y subelemento.

Por ejemplo, para configurar la propiedad authz.image.pullPolicy como Always, ubica esta estrofa YAML en el archivo de anulación y configúrala de la siguiente manera:

authz:
  image:
    pullPolicy: Always

Para otro ejemplo, la propiedad cassandra.auth.admin.password (como aparece en la referencia de las propiedades de configuración) se usa para establecer la contraseña de administrador de Cassandra. Para cambiarlo, ubica el siguiente YAML en el archivo de anulación y configúralo de la siguiente manera:

cassandra:
  auth:
    admin:
      password: abc123

Recuerda que, en la referencia de las propiedades de configuración se describen todas las propiedades que puedes establecer en los componentes del plano de ejecución híbrido. Sigue el patrón que se explicó antes para modificar estos elementos en tu archivo de anulaciones antes de aplicar los cambios a tu clúster.

Información sobre la configuración predeterminada

Apigee mantiene la configuración de sus componentes predeterminados en el archivo $HYBRID_FILES/config/values.yaml. En este archivo, se especifica la configuración predeterminada, cuando sea posible, para cada componente híbrido.

Los archivos de anulación siguen la misma estructura YAML que values.yaml; sin embargo, un archivo de anulación incluye solo un subconjunto de las propiedades de configuración que se encuentran en values.yaml. Ten en cuenta que no todas las propiedades se pueden editar. Cuando aplicas una configuración a un clúster, las anulaciones se combinan con los valores predeterminados para crear la configuración completa del clúster de Kubernetes.

Si deseas modificar los valores predeterminados de un componente, y el componente aún no está en el archivo de anulaciones, puedes copiar su YAML de values.yaml en tu archivo de anulaciones y modificarlo allí.

No edites values.yaml directamente; usa un archivo de anulaciones para especificar las propiedades de configuración.

Usa la muestra predefinida de archivo de anulaciones

Apigee proporciona un conjunto de archivos anulados de muestra para ayudarte a configurar tu implementación híbrida. Se recomienda copiar y modificar el archivo de anulaciones que más coincide con los requisitos de tu instalación.

En el directorio $APIGEECTL_HOME/examples, se incluyen los siguientes ejemplos:

Archivos de anulaciones de muestra	Descripción
`overrides-small.yaml`	Esta muestra es ideal para comenzar rápidamente. Usa la huella mínima recomendada para iniciar los componentes del entorno de ejecución híbrido. Esta configuración de muestra depende, en la medida de lo posible, de la configuración y los valores predeterminados. Todas las réplicas mínimas se configuran como `1`.
`overrides-medium.yaml`	Este ejemplo es un buen punto de partida para los entornos de prueba y QA. Los componentes individuales tienen un nivel más alto de recursos para manejar el tráfico adicional. Cassandra usa discos SSD para lograr un buen rendimiento. En este entorno, se recomienda que los usuarios instalen componentes con estado y sin estado en nodos separados. Consulta Configura nodos dedicados.
`overrides-large.yaml`	Esta muestra es un buen punto de partida para entornos de alto rendimiento, como la preproducción y la producción. En esta muestra, se incluyen propiedades para configurar claves de encriptación, contraseñas y otras opciones. Los componentes individuales tienen un mínimo de dos réplicas.
`private-overrides.yaml`	En esta muestra, se indica cómo usar imágenes de un repositorio de imágenes privado. Consulta Usa un repositorio de imágenes privado.

Anotaciones personalizadas

Las anotaciones son mapas de par clave-valor que se usan para adjuntar metadatos a los pods de Kubernetes. Puedes crear anotaciones personalizadas para las siguientes propiedades de componentes híbridos que se enumeran en Referencia de las propiedades de configuración:

Si deseas agregar una anotación de par nombre/valor personalizado, abre el archivo de anulaciones y agrega una estrofa annotations para el componente correspondiente y, luego, aplica el cambio con apigeectl. Por ejemplo:

runtime:
  annotations:
    businessunit: "bu1"

Usa pruebas de validación para probar cambios de configuración

Puedes usar la marca --dry-run con apigeectl para probar el archivo de configuración de anulación sin aplicarlo, de hecho, a tu clúster. Esta opción es útil para depurar un problema de instalación, ya que te muestra exactamente lo que se aplicará al clúster.

En Apigee hybrid, la sintaxis de la marca --dry-run depende de la versión de kubectl que ejecutas. Verifica la versión de kubectl con el siguiente comando:

kubectl version

Versión 1.17 de kubectl y versiones anteriores:

$APIGEECTL_HOME/apigeectl init -f $HYBRID_FILES/overrides/OVERRIDES.yaml --dry-run=true

Versión 1.18 de kubectl y versiones posteriores:

  $APIGEECTL_HOME/apigeectl init -f $HYBRID_FILES/overrides/OVERRIDES.yaml --dry-run=client

Crea varios archivos de anulaciones según sea necesario

Puedes crear varios archivos de anulación, en el que cada uno cumpla un requisito específico. Por ejemplo, puedes tener un archivo de anulación que ajuste tu clúster para la producción y otro para crear un clúster a fin de realizar pruebas. Puedes mantener estos archivos en tu sistema de control de código fuente.

Usa el comando apigeectl apply para aplicar un archivo de anulación al clúster. Por ejemplo:

$APIGEECTL_HOME/apigeectl apply  -f $HYBRID_FILES/overrides/test_env_override.yaml

Borra componentes del entorno de ejecución

El comando apigeectl delete proporciona marcas que te permiten borrar todos los componentes del entorno de ejecución híbrido instalados, o un subconjunto de ellos. Para obtener detalles sobre el uso de comandos, consulta la página de referencia de apigeectl. Consulta también Desinstala el entorno de ejecución híbrido.

Borra un entorno

Para borrar por completo un entorno, debes quitar los planos del entorno de ejecución (local) y de administración (nube). Para obtener detalles, consulta Borra entornos.