Usa el Sincronizador de configuración con Kustomize y Helm

Aprende a usar el Sincronizador de configuración a fin de instalar un componente de Helm listo para usar.

En este instructivo, agregarás a tu repositorio opciones de configuración de Kustomize que hacen referencia a los gráficos de Helm y, luego, usarás el Sincronizador de configuración para sincronizar tu clúster con el repositorio.

Cuando usas el Sincronizador de configuración, las opciones de configuración de Kustomize y los gráficos de Helm que colocas en el repositorio de Git se renderizar de forma automática. La renderización automatizada te brinda los siguientes beneficios:

  • Ya no necesitas una canalización de hidratación externa. Sin el procesamiento automatizado, debes procesar de forma manual las opciones de configuración mediante Kustomize y Helm en tu estación de trabajo o configurar un paso para activar el proceso de hidratación en tus sistemas de CI. Con la renderización automatizada, el Sincronizador de configuración controla la ejecución.

  • Se reducen los costos de mantenimiento. Sin la renderización automatizada, debes mantener un repositorio de Git con la configuración original de Kustomize y los gráficos de Helm, y otro repositorio de Git con el resultado que genera la hidratación externa. Luego, debes configurar el Sincronizador de configuración para que se sincronice desde el repositorio de Git con el resultado renderizado. Con la renderización automatizada, solo necesitas mantener un repositorio con los archivos de configuración originales.

  • Tu flujo de trabajo de desarrollo está simplificado. Sin el procesamiento automático, los cambios realizados en la configuración original deben revisarse dos veces antes de combinarse: una en el repositorio original y otra en el renderizado. Con el procesamiento automatizado, los archivos de configuración renderizados se generan mediante el Sincronizador de configuración y solo necesitas revisar los cambios en los archivos de configuración originales.

Objetivos

  • Configura tu repositorio con las configuraciones de Kustomize que hacen referencia a un gráfico de Helm listo para usar para cert-manager. cert-manager es una herramienta para Kubernetes que te ayuda a administrar tu certificados.
  • Obtén una vista previa y valida los archivos de configuración que creas.
  • Usa el Sincronizador de configuración para procesar el gráfico de forma automática y sincronizar el clúster con el repositorio.
  • Verifica que la instalación se haya realizado correctamente.

Costos

En este documento, usarás los siguientes componentes facturables de Google Cloud:

Para generar una estimación de costos en función del uso previsto, usa la calculadora de precios. Es posible que los usuarios nuevos de Google Cloud califiquen para obtener una prueba gratuita.

Cuando finalices las tareas que se describen en este documento, puedes borrar los recursos que creaste para evitar que continúe la facturación. Para obtener más información, consulta Cómo realizar una limpieza.

Antes de comenzar

  1. En la página del selector de proyectos de la consola de Google Cloud, selecciona o crea un proyecto de Google Cloud.

    Ir al selector de proyectos

  2. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

  3. Crea o asegúrate de tener acceso a un clúster que cumpla con los requisitos del Sincronizador de configuración y use la siguiente configuración del Sincronizador de configuración:
  4. Registra tu clúster en una flota.
  5. Instala la herramienta de línea de comandos de nomos. Si ya instalaste la herramienta de nomos, asegúrate de actualizarla a la versión 1.9.0 o una posterior.
  6. Instalar Helm.

También es útil tener conocimientos de Git, Kustomize y Helm.

Configura tu repositorio

En las siguientes tareas, se muestra cómo preparar un repositorio de Git con archivos de configuración que combinan configuraciones de Kustomize con gráficos de Helm:

  1. Crea un repositorio Git o asegúrate de tener acceso a él. Debido a que en tu repositorio se usa Kustomize y Helm, este debería ser un repositorio no estructurado.

  2. En la raíz de tu repositorio de Git, crea un archivo llamado kustomization.yaml y pega el siguiente código en él:

    # ./kustomization.yaml
    resources:
    - base
    
    patches:
    - path: ignore-deployment-mutation-patch.yaml
      target:
        kind: Deployment
    

    Este archivo es una superposición de Kustomize que apunta a la base de Kustomize. Esta superposición incluye un parche para la base del gráfico de Helm que agrega la anotación client.lifecycle.config.k8s.io/mutation: ignore a todos los objetos Deployment. La anotación hace que el Sincronizador de configuración ignore cualquier cambio conflictivo en este objeto en el clúster después de crearlo.

  3. En tu repositorio de Git, crea un directorio llamado base:

    mkdir base
    
  4. En el directorio base, crea otro archivo llamado kustomization.yaml y pega el siguiente código en él:

    # ./base/kustomization.yaml
    helmCharts:
    - name: cert-manager
      repo: https://charts.jetstack.io
      version: v1.5.3
      releaseName: my-cert-manager
      namespace: cert-manager
    

    Este archivo es la base de Kustomize, que renderiza el gráfico remoto de Helm.

  5. Navega a la raíz de tu repositorio de Git, crea un archivo llamado ignore-deployment-mutation-patch.yaml y pega el siguiente código en él:

    # ./ignore-deployment-mutation-patch.yaml
    apiVersion: apps/v1
    kind: Deployment
    metadata:
     name: any
     annotations:
       client.lifecycle.config.k8s.io/mutation: ignore
    

    Este archivo es un parche que se aplica al gráfico base de Helm. Agrega la anotación client.lifecycle.config.k8s.io/mutation: ignore a todos los objetos Deployment en el directorio base.

  6. Confirma los cambios en tu repositorio:

    git add .
    git commit -m 'Set up manifests.'
    git push
    

El repositorio de muestras tiene un ejemplo de cómo se vería ese repositorio.

Obtén una vista previa y valida los archivos de configuración renderizados

Antes de que el Sincronizador de configuración renderice los archivos de configuración y los sincronice con el clúster, asegúrate de que los archivos de configuración sean precisos mediante la ejecución de nomos hydrate para obtener una vista previa de la configuración renderizada y ejecuta nomos vet a fin de validar que el formato sea correcto.

  1. Ejecuta el siguiente nomos hydrate con los siguientes marcadores:

    nomos hydrate \
        --source-format=unstructured \
        --output=OUTPUT_DIRECTORY
    

    En el ejemplo anterior, se ilustra lo siguiente:

    • --source-format=unstructured permite que nomos hydrate funcione en un repositorio no estructurado. Dado que usas archivos de configuración de Kustomize y gráficos de Helm, debes usar un repositorio no estructurado y agregar esta marca.
    • --output=OUTPUT_DIRECTORY te permite definir una ruta de acceso a los archivos de configuración renderizados. Reemplaza OUTPUT_DIRECTORY por la ubicación en la que deseas que se guarde el resultado.
  2. Para verificar la sintaxis y la validez de tus archivos de configuración, ejecuta nomos vet con las siguientes marcas:

    nomos vet \
        --source-format=unstructured \
        --keep-output=true \
        --output=OUTPUT_DIRECTORY
    

    En el ejemplo anterior, se ilustra lo siguiente:

    • --source-format=unstructured permite que nomos vet funcione en un repositorio no estructurado.
    • --keep-output=true guarda los archivos de configuración renderizados.
    • --output=OUTPUT_DIRECTORY es la ruta de acceso a los archivos de configuración renderizados.

Configura la sincronización desde el repositorio de Git

Ahora que creaste un repositorio con los archivos de configuración que deseas usar, puedes configurar la sincronización del clúster al repositorio. Si ya instalaste el Sincronizador de configuración, ve a Verifica el estado de la sincronización.

  1. En la consola de Google Cloud, habilita la API de GKE Hub.

    Ir a la API de GKE Hub

  2. En la consola de Google Cloud, ve al panel del Sincronizador de configuración.

    Ir al panel del Sincronizador de configuración

  3. En el cuadro Configuración del Sincronizador de configuración, haz clic en Instalar el Sincronizador de configuración.

  4. En la tabla Clústeres disponibles, selecciona cs-cluster y haz clic en Instalar el Sincronizador de configuración.

    Después de unos minutos, ve a la pestaña Configuración. Deberías ver Instalada en la columna Estado del Sincronizador de configuración de cs-cluster.

  5. En el panel del Sincronizador de configuración, haz clic en Implementar paquete.

  6. En la tabla Selecciona clústeres para la implementación de paquetes, selecciona cs-cluster y, luego, haz clic en Continuar.

  7. Deja seleccionada la opción Paquete alojado en Git y haz clic en Continuar.

  8. En el campo Package name, ingresa sample-repository.

  9. En el campo URL del repositorio, ingresa https://github.com/GoogleCloudPlatform/anthos-config-management-samples.

  10. En el campo Ruta de acceso, ingresa config-sync-quickstart/multirepo/root.

  11. Deje todos los otros campos con sus valores predeterminados.

  12. Haz clic en Implementar paquete.

    Después de unos minutos, deberías ver Sincronizado en la columna Estado de sincronización de cs-cluster.

Verifique la instalación

Después de instalar y configurar el Sincronizador de configuración, puedes verificar que la instalación se haya completado correctamente.

  1. Verifica que no haya otros errores mediante nomos status:

    nomos status
    

    Resultado de ejemplo:

    *CLUSTER_NAME
    --------------------
    <root>   https:/github.com/GoogleCloudPlatform/anthos-config-management-samples.git/helm-component/manifests@init
    SYNCED   fd17dd5a
    
  2. Verifica si el componente de Helm se instaló correctamente:

    kubectl get all -n cert-manager
    

    Resultado de ejemplo:

    NAME                                              READY   STATUS    RESTARTS   AGE
    pod/my-cert-manager-54f5ccf74-wfzs4               1/1     Running   0          10m
    pod/my-cert-manager-cainjector-574bc8678c-rh7mq   1/1     Running   0          10m
    pod/my-cert-manager-webhook-7454f4c77d-rkct8      1/1     Running   0          10m
    
    NAME                              TYPE        CLUSTER-IP     EXTERNAL-IP   PORT(S)    AGE
    service/my-cert-manager           ClusterIP   10.76.9.35     <none>        9402/TCP   10m
    service/my-cert-manager-webhook   ClusterIP   10.76.11.205   <none>        443/TCP    10m
    
    NAME                                         READY   UP-TO-DATE   AVAILABLE   AGE
    deployment.apps/my-cert-manager              1/1     1            1           10m
    deployment.apps/my-cert-manager-cainjector   1/1     1            1           10m
    deployment.apps/my-cert-manager-webhook      1/1     1            1           10m
    
    NAME                                                    DESIRED   CURRENT   READY   AGE
    replicaset.apps/my-cert-manager-54f5ccf74               1         1         1       10m
    replicaset.apps/my-cert-manager-cainjector-574bc8678c   1         1         1       10m
    replicaset.apps/my-cert-manager-webhook-7454f4c77d      1         1         1       10m
    

Limpia

Para evitar que se apliquen cargos a tu cuenta de Google Cloud por los recursos usados en este instructivo, borra el proyecto que contiene los recursos o conserva el proyecto y borra los recursos individuales.

Borra el proyecto

  1. En la consola de Google Cloud, ve a la página Administrar recursos.

    Ir a Administrar recursos

  2. En la lista de proyectos, elige el proyecto que quieres borrar y haz clic en Borrar.
  3. En el diálogo, escribe el ID del proyecto y, luego, haz clic en Cerrar para borrar el proyecto.

Borra los recursos individuales

Borra los manifiestos de tu repositorio

Para evitar la eliminación accidental, el Sincronizador de configuración no te permite quitar todos los espacios de nombres o recursos con permiso de clúster en una sola confirmación. Sigue estas instrucciones a fin de desinstalar el componente de forma correcta y quitar el espacio de nombres en confirmaciones separadas:

  1. Quita el componente de cert-manager del repositorio:

    git rm -rf manifests/cert-manager \
        && git commit -m "uninstall cert-manager" \
        && git push origin BRANCH
    

    Reemplaza BRANCH por la rama en la que creaste el repositorio.

  2. Borra el espacio de nombres de cert-manager:

    git rm manifests/namespace-cert-manager.yaml \
        && git commit -m "remove the cert-manager namespace" \
        && git push origin BRANCH
    
  3. Verifica que el espacio de nombres de cert-manager no exista:

    kubectl get namespace cert-namespace
    

    Resultado de ejemplo:

    Error from server (NotFound): namespaces "cert-namespace" not found
    

Borra el clúster

Para borrar el clúster, completa los siguientes comandos:

Consola

Para borrar un clúster mediante la consola de Google Cloud, completa las siguientes tareas:

  1. En la consola de Google Cloud, ve a la página de GKE.

    Ir a GKE

  2. Junto al clúster que deseas borrar, haz clic en Acciones y, luego, en Borrar.

  3. Cuando se te solicite confirmación, haz clic en Borrar de nuevo.

gcloud

Para borrar un clúster con la CLI de Google Cloud, ejecuta el siguiente comando:

gcloud container clusters delete CLUSTER_NAME

Para obtener más información, consulta la documentación de gcloud container clusters delete.

¿Qué sigue?