Administra manifiestos en Cloud Deploy

En esta página, se describe cómo configurar Cloud Deploy para procesar la configuración de cada destino en una canalización de entrega.

Cloud Deploy usa Skaffold para renderizar tus manifiestos de Kubernetes. El servicio admite la renderización de manifiestos sin procesar y herramientas de administración de manifiestos más avanzadas, como Helm, Kustomize y kpt.

El proceso de renderización tiene dos etapas:

  1. La herramienta de administración de manifiestos genera el manifiesto.

  2. Skaffold sustituye las referencias de imagen en el manifiesto por las imágenes que deseas implementar en la versión.

En esta página, se incluyen ejemplos de configuración mediante Helm y Kustomize.

Usar Skaffold para generar tu configuración

Si aún no tienes un archivo de configuración de Skaffold (skaffold.yaml), puedes usar Skaffold a fin de generar uno, según lo que haya en tu repositorio.

  1. Instala Skaffold con Google Cloud CLI:

    gcloud components install skaffold

  2. Ejecuta skaffold init en el repositorio que contiene tus manifiestos:

    skaffold init --skip-build

Con este comando, se crea un archivo skaffold.yaml en tu repositorio. Ese archivo hace referencia a los manifiestos de ese repositorio. El contenido se verá de la siguiente manera:

apiVersion: skaffold/v4beta6
kind: Config
metadata:
  name: sample-app
manifests:
  rawYaml:
    - k8s-manifests/deployment.yaml
    - k8s-manifests/rbac.yaml
    - k8s-manifests/redis.yaml
    - k8s-manifests/service.yaml

Renderiza los manifiestos sin procesar

Los manifiestos sin renderizar son manifiestos que no se administran mediante una herramienta como Helm o Kustomize, y, por lo tanto, no necesitan ningún procesamiento previo antes de hidratarse e implementarse en un clúster.

De forma predeterminada, Cloud Deploy usa skaffold render para renderizar tus manifiestos de Kubernetes, y reemplaza los nombres de imágenes sin etiquetar por los nombres de las imágenes de contenedor que implementas. Luego, cuando promociones la versión, Cloud Deploy usa skaffold apply para aplicar los manifiestos y, luego, implementar las imágenes en el clúster de Google Kubernetes Engine.

Una estrofa manifests de una configuración básica se ve de la siguiente manera:

manifests:
  rawYaml:
    - PATH_TO_MANIFEST

Consulta la documentación de Skaffold para obtener más información sobre los valores que se pueden pasar aquí.

Renderiza mediante Helm

Puedes usar Cloud Deploy para renderizar tus gráficos de Helm. Para hacerlo, incluye los detalles del gráfico de Helm en una estrofa deploy en un perfil de Skaffold.

Cada una de estas definiciones se ve de la siguiente manera:

apiVersion: skaffold/v4beta6
kind: Config
manifests:
  helm:
    releases:
      - name: RELEASE_NAME
        chartPath: PATH_TO_HELM_CHART
        artifactOverrides:
          image: IMAGE_NAME

Donde:

RELEASE_NAME es el nombre de la instancia de gráfico de Helm para esta versión.

PATH_TO_HELM_CHART es la ruta de acceso local a un gráfico de Helm empaquetado o a un directorio de gráficos de Helm sin empaquetar.

IMAGE_NAME es el nombre de la imagen de contenedor que estás implementando.

El gráfico de Helm debe tener un parámetro de valor image que defina la imagen que se implementará en el gráfico.

Puedes usar opciones de configuración adicionales de Helm, como se describe en la documentación de Skaffold.

Renderiza mediante Kustomize

Puedes usar Kustomize con Cloud Deploy. Para hacerlo, apunta a los archivos de Kustomization desde la estrofa deploy en la configuración de tu perfil skaffold.yaml.

Debes incluir una configuración de Kustomize independiente para cada destino para el que uses Kustomize, en cada profile correspondiente de tu skaffold.yaml.

Cada una de estas definiciones se ve de la siguiente manera:

apiVersion: skaffold/v4beta6
kind: Config
manifests:
  kustomize:
    paths:
      - PATH_TO_KUSTOMIZE

Donde:

PATH_TO_KUSTOMIZE apunta a tus archivos de Kustomization. El valor predeterminado es ["."].

Puedes usar opciones de configuración adicionales de Kustomize, como se describe en la documentación de Skaffold.

Configuración de manifiestos diferentes por destino

Con frecuencia, cada destino necesita una configuración un poco diferente. Por ejemplo, es posible que tengas más réplicas en las implementaciones de producción que en las de etapa de pruebas.

Puedes renderizar un conjunto diferente de manifiestos para cada destino si proporcionas cada variación como un perfil de Skaffold diferente.

Perfiles con manifiestos sin procesar

Cuando trabajas con manifiestos sin procesar, puedes apuntar Cloud Deploy a un archivo diferente, según el destino. Puedes configurar eso de la siguiente manera:

apiVersion: skaffold/v4beta6
kind: Config
profiles:
  - name: prod
    manifests:
      rawYaml:
        - prod.yaml
  - name: staging
    manifests:
      rawYaml:
        - staging.yaml

Perfiles con Kustomize

A continuación, se muestra un ejemplo de skaffold.yaml que tiene diferentes perfiles para la etapa de pruebas y la producción mediante Kustomize, en el que cada perfil apunta a una Kustomization diferente:

apiVersion: skaffold/v4beta6
kind: Config
profiles:
  - name: prod
    manifests:
      kustomize:
        paths:
          - environments/prod
  - name: staging
    manifests:
      kustomize:
        paths:
          - environments/staging

Perfiles a los que se hace referencia en la canalización de entrega

Se hace referencia a estos perfiles, definidos en skaffold.yaml, en la configuración de la canalización de entrega, por destino:

serialPipeline:
  stages:
  - targetId: staging-target
    profiles:
    - staging
  - targetId: prod-target
    profiles:
    - prod

¿Qué sigue?