Gestionar componentes del plano del entorno de ejecución

En este tema se explica cómo configurar y gestionar los componentes del plano de tiempo de ejecución de Apigee hybrid.

Acerca del archivo de anulaciones

La primera vez que instales el entorno de ejecución híbrido en un clúster, debes crear un archivo de anulaciones de configuración. Este archivo le permite proporcionar los valores de propiedad necesarios para instalar la solución híbrida, como el nombre de su proyecto de Google, el nombre de la organización, los detalles del entorno, los archivos de certificado, etc. También puede anular determinados valores predeterminados de la mayoría de los componentes híbridos en el archivo de anulaciones. Para ver una lista completa de las propiedades configurables, consulta la referencia de la propiedad de configuración.

En los pasos de instalación de la versión híbrida se explica cómo crear un archivo de anulaciones y aplicar la configuración a un clúster. Si quieres cambiar la configuración más adelante, modifica el archivo de anulaciones que has creado y vuelve a aplicarlo. Consulta Cambiar la configuración.

Hacer un cambio de configuración

Para cambiar la configuración de un componente del plano de tiempo de ejecución híbrido, edita el archivo de anulaciones y aplica los cambios con apigeectl. Para ver una lista completa de las propiedades configurables, consulta la referencia de la propiedad de configuración.

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

  1. Abre el archivo de anulaciones. Asegúrate de usar el mismo archivo de anulaciones que se usó para instalar el tiempo de ejecución híbrido en el clúster.
  2. Busca el elemento logger en el archivo. Por ejemplo: 
    ...
logger:
  enabled: false
...
  3. Cambia el valor de la propiedad a true: 
    ...
  logger:
  enabled: true
...
  4. Usa apigeectl para aplicar el cambio al clúster: 
    $APIGEECTL_HOME/apigeectl apply -f $HYBRID_FILES/overrides/OVERRIDES.yaml --telemetry

    La marca --telemetry indica a apigeectl que solo actualice el componente de registro. Para obtener información sobre los parámetros de ámbito, como --telemetry, consulta Ámbitos para aplicar apigeectl.

¿Qué propiedades de configuración puede modificar?

Puede consultar la lista completa de propiedades configurables en la referencia de propiedades de configuración. En la referencia solo se indican las propiedades que puede modificar. Si intenta modificar una propiedad que no aparece en la referencia, el cambio se ignorará.

Cómo usar la referencia de configuración

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

authz.image.pullPolicy

En el archivo de anulaciones, las propiedades tienen el formato YAML adecuado. En el ejemplo anterior, el elemento authz de nivel superior tiene una sangría a la izquierda y las propiedades de los subelementos tienen una sangría debajo. Además, YAML requiere dos puntos al final de cada elemento y subelemento.

Por ejemplo, para definir la propiedad authz.image.pullPolicy como Always, busca esta estrofa YAML en el archivo de anulaciones y configúrala de la siguiente manera:

authz:
  image:
    pullPolicy: Always

Otro ejemplo es la propiedad cassandra.auth.admin.password (que se indica en la referencia de la propiedad de configuración), que se usa para definir la contraseña de administrador de Cassandra. Para cambiarlo, busca el siguiente YAML en el archivo de anulaciones y configúralo de la siguiente manera:

cassandra:
  auth:
    admin:
      password: abc123

Recuerde que en la referencia de la propiedad de configuración se describen todas las propiedades que puede definir en los componentes del plano de tiempo de ejecución híbrido. Sigue el patrón explicado anteriormente para modificar estos elementos en tu archivo de anulaciones antes de aplicar los cambios al clúster.

Acerca de los valores predeterminados de configuración

Apigee mantiene la configuración predeterminada de sus componentes en el archivo $HYBRID_FILES/config/values.yaml. Este archivo especifica los valores predeterminados, cuando es posible, de cada componente híbrido.

Los archivos de anulaciones siguen la misma estructura YAML que values.yaml, pero solo incluyen un subconjunto de las propiedades de configuración que se encuentran en values.yaml. Recuerde que no todas las propiedades se pueden editar. Cuando aplicas una configuración a un clúster, tus anulaciones se combinan con los valores predeterminados para crear la configuración completa del clúster de Kubernetes.

Usar archivos de anulaciones de muestra predefinidos

Apigee proporciona un conjunto de archivos de anulaciones de ejemplo para ayudarte a configurar tu implementación híbrida. Te recomendamos que copies y modifiques el archivo de anulaciones que mejor se adapte a los requisitos de tu instalación.

Los siguientes ejemplos se incluyen en el directorio $APIGEECTL_HOME/examples:

Archivos de anulaciones de ejemplo Descripción
overrides-small.yaml Esta muestra es ideal para empezar rápidamente. Usa el espacio mínimo recomendado para iniciar los componentes del tiempo de ejecución híbrido. Esta configuración de ejemplo se basa en la medida de lo posible en los ajustes y valores predeterminados. Todas las réplicas mínimas se han definido como 1.
overrides-medium.yaml Esta muestra es un buen punto de partida para entornos de prueba y control de calidad. Se ha asignado un nivel superior de recursos a los componentes individuales para gestionar el tráfico adicional. Cassandra usa discos SSD para mejorar el rendimiento. En este entorno, se recomienda que los usuarios instalen componentes con y sin estado en nodos independientes. Consulta Configurar nodos dedicados.
overrides-large.yaml Esta muestra es un buen punto de partida para entornos de alto rendimiento, como los de preproducción y producción. La muestra incluye propiedades para definir claves de cifrado, contraseñas y otros elementos. Los componentes individuales tienen un mínimo de dos réplicas.
private-overrides.yaml En este ejemplo se muestra cómo usar imágenes de un repositorio de imágenes privado. Consulta Usar un repositorio de imágenes privado.

Anotaciones personalizadas

Las anotaciones son mapas de pares clave-valor que se usan para adjuntar metadatos a los pods de Kubernetes. Puede crear anotaciones personalizadas para las siguientes propiedades de componentes híbridos que se indican en la referencia de propiedades de configuración:

Para añadir una anotación personalizada de par nombre-valor, abre el archivo de anulaciones y añade una estrofa annotations para el componente correspondiente. A continuación, aplica el cambio con apigeectl. Por ejemplo:

runtime:
  annotations:
    businessunit: "bu1"

Usar pruebas de funcionamiento para probar los cambios en la configuración

Puedes usar la marca --dry-run con apigeectl para probar el archivo de configuración de anulaciones sin aplicarlo realmente al clúster. Esta opción es útil para depurar un problema de instalación, ya que 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 estés usando. Consulta la versión de kubectl con el siguiente comando:

kubectl version

kubectl versión 1.17 y anteriores:

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

kubectl versión 1.18 y posteriores:

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

Crear varios archivos de anulaciones según sea necesario

Puedes crear varios archivos de anulaciones, cada uno de los cuales cumple un requisito específico. Por ejemplo, puedes tener un archivo de anulaciones que ajuste tu clúster para la producción y otro para crear un clúster de pruebas. Después, puedes mantener estos archivos en tu sistema de control de versiones.

Usa el comando apigeectl apply para aplicar un archivo overrides al clúster. Por ejemplo:

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

Eliminar componentes del entorno de ejecución

El comando apigeectl delete proporciona marcas que te permiten eliminar todos los componentes del tiempo de ejecución híbrido instalado o un subconjunto de ellos. Para obtener información sobre el uso de los comandos, consulta la página de referencia de apigeectl. Consulta también Desinstalar entornos de ejecución híbridos.

Eliminar entorno

Para eliminar por completo un entorno, debes quitar los planos de tiempo de ejecución (local) y de gestión (en la nube). Para obtener más información, consulta Eliminar entornos.