Comienza a usar Skaffold en Cloud Deploy

En este documento, se describe cómo comenzar a usar Skaffold como parte de Cloud Deploy, lo que incluye lo siguiente:

Configurar Skaffold para usarlo con una canalización de entrega de Cloud Deploy
Usar Skaffold y Cloud Deploy con herramientas de renderización de terceros, como Helm y Kustomize
De manera opcional, usar Skaffold para el desarrollo local
De manera opcional, usar Skaffold para la integración y la implementación continuas (CI/CD)

¿Por qué Skaffold?

¿Quieres saber por qué Cloud Deploy usa Skaffold y por qué necesitas administrar una configuración de Skaffold? Sigue leyendo.

Tengo experiencia con CI/CD, pero no uso Skaffold actualmente

Skaffold es una herramienta de línea de comandos de código abierto para mejorar la productividad de los desarrolladores. Organiza el desarrollo continuo, la integración continua (CI) y la entrega continua (CD).

Skaffold proporciona una configuración declarativa y portátil con una arquitectura conectable, lo que te permite usar diferentes herramientas para la fase de renderización.

Cuando se crea una versión, Cloud Deploy llama a Skaffold para renderizar tus manifiestos. En el momento de la implementación, Cloud Deploy vuelve a llamar a Skaffold para aplicar esos manifiestos y, así, implementar tu aplicación en cada destino de tu progresión. Después de la implementación, Skaffold realiza verificaciones de estado para supervisar el tiempo de ejecución de destino para una implementación correcta.

Skaffold para el desarrollo continuo

Cuando usas Skaffold para el desarrollo continuo, las imágenes se compilan, se prueban y se implementan en un clúster (o Minikube) a medida que cambias el código. Las extensiones de IDE de Cloud Code para VS Code y Cloud Code para IntelliJ integran Skaffold en Visual Studio Code y los IDE de JetBrains para el desarrollo continuo.

Skaffold para la entrega continua

También puedes usar Skaffold para la entrega continua, con pasos de compilación, implementación, renderización y aplicación. Cloud Deploy usa las capacidades de renderización y aplicación de Skaffold. Para usar Cloud Deploy, necesitas al menos un archivo de configuración skaffold.yaml válido.

A través de Skaffold, también puedes realizar integraciones con herramientas de administración de manifiestos de terceros , como Helm y Kustomize. Si usas Skaffold de esta manera, puedes usar las funciones de esas herramientas para renderizar manifiestos. kubectl sigue siendo el implementador de estos manifiestos.

No tengo experiencia en la implementación en Kubernetes

Con Skaffold, puedes configurar un conjunto base de manifiestos para todas tus implementaciones. Luego, puedes usar el motor de renderización de Skaffold, a través de Cloud Deploy, para renderizar y, luego, implementar cada manifiesto específico de la implementación desde uno de esos manifiestos base.

Obtén más información para administrar manifiestos, incluidos ejemplos de uso de Skaffold y Cloud Deploy con herramientas comunes de creación de plantillas de manifiestos, como Helm y Kustomize.

¿Qué se necesita para que Cloud Deploy funcione?

Para usar una canalización de entrega básica de Cloud Deploy, el skaffold.yaml archivo de configuración necesita al menos la siguiente configuración:

La información del encabezado que necesitan todas las configuraciones de skaffold.yaml:
```
apiVersion: skaffold/v4beta7
kind: Config
```
Una sección manifests, para GKE, clústeres conectados de GKE o Cloud Run que enumeran todos los manifiestos de Kubernetes sin procesar (a menos que uses una herramienta de administración de manifiestos, como Helm o Kustomize).

A continuación, se muestra un ejemplo con un manifiesto de Kubernetes sin procesar:
```
manifests:
  rawYaml:
  - deployment.yaml
```
Si planeas usar un renderizador (como Helm o Kustomize) para renderizar manifiestos, consulta Agrega compatibilidad con Helm a tu skaffold.yaml y Agrega compatibilidad con Kustomize a tu skaffold.yaml para obtener orientación sobre cómo configurar Skaffold para usar estas herramientas.

Para ver ejemplos de Helm y Kustomize, consulta Administra manifiestos
Una sección deploy, con deploy.kubectl para implementar en GKE o en clústeres conectados de GKE, o deploy.cloudrun para implementar en Cloud Run.

Para GKE y clústeres conectados de GKE:
```
deploy:
  kubectl: {}
```
La sección de implementación implementa los manifiestos de la aplicación que se proporcionaron en la sección de manifiestos.

Para destinos de Cloud Run:
```
deploy:
  cloudrun: {}
```
La sección de implementación implementa los manifiestos de la aplicación que se proporcionaron en la sección de manifiestos.

Si usas destinos personalizados, tu skaffold.yaml debe tener el encabezado (apiVersion y kind:) y las acciones personalizadas que usará el destino personalizado si el tipo de destino personalizado aún no hace referencia a una configuración remota de Skaffold.

Crea un archivo `skaffold.yaml`

Cloud Deploy usa Skaffold para renderizar e implementar tus aplicaciones.

Para cada versión, debes proporcionar al menos un archivo skaffold.yaml que identifique los manifiestos que se usarán. Consulta la sección anterior para obtener orientación sobre lo que debe incluir este archivo.

Haz que Cloud Deploy genere tu `skaffold.yaml`

Si no tienes un archivo skaffold.yaml, pero tienes un manifiesto de Kubernetes único o un archivo de definición de servicio de Cloud Run, Cloud Deploy puede generar un archivo skaffold.yaml por ti.

El archivo de Skaffold generado estará disponible en el directorio de preparación de origen de Cloud Storage una vez que se complete la versión.

El siguiente comando incluye la marca --from-k8s-manifest, que pasa el manifiesto de Kubernetes. Cloud Deploy usa la información del manifiesto para generar el skaffold.yaml, que luego se usa para la versión.

gcloud deploy releases create  RELEASE_NAME --delivery-pipeline=PIPELINE_NAME --from-k8s-manifest=MANIFEST --region=REGION

Para generar el skaffold.yaml desde un YAML de servicio de Cloud Run, usa el mismo comando, pero con --from-run-manifest en lugar de --from-k8s-manifest.

Si usas cualquiera de estas marcas con la marca --skaffold-file o la marca --source, se genera un error.

Usa el archivo `skaffold.yaml` generado

El skaffold.yaml generado es adecuado para la incorporación, el aprendizaje y la demostración de Cloud Deploy. Después de que te familiarices con Cloud Deploy, y para las cargas de trabajo de producción, es posible que desees una configuración de Skaffold que diferencie entre tus destinos (con perfiles de Skaffold).

Cuando uses el archivo skaffold.yaml generado como punto de partida para crear tu propia configuración diferenciada de Skaffold, asegúrate de usar el archivo en el archivo de origen de renderización, no el archivo renderizado. La fuente de renderización está disponible para descargar desde la pestaña Artifacts en la página Release details.

Este skaffold.yaml generado se incluye en la fuente de renderización almacenada en un bucket de Cloud Storage.

Para ver este archivo, descarga el archivo .tar.gz y extráelo.
El skaffold.yaml renderizado está disponible en Target artifacts.

En la sección Target artifacts, haz clic en View artifacts.

Usa Skaffold para el desarrollo local

Una de las ventajas de Skaffold es que puedes usarlo para el desarrollo local y para CI/CD. En el modo dev, Skaffold observa tus archivos de origen y, cuando detecta un cambio, Skaffold vuelve a compilar las imágenes, vuelve a realizar pruebas y vuelve a implementar los contenedores en un clúster de minikube (por ejemplo) en tu máquina local.

Cuando usas Skaffold de esta manera, puedes usar los mismos comandos de forma local que para la implementación remota.

Si usas Skaffold para el desarrollo local, puedes definir perfiles de Skaffold separados para tus destinos y una sección de implementación predeterminada para el desarrollo local.

Cuando detienes el modo dev, Skaffold limpia los artefactos implementados del clúster.

Usa Skaffold para CI/CD

Además de usar Skaffold para la compilación y la implementación locales continuas, puedes usar Skaffold para CI/CD. Cloud Deploy usa las funciones de CI/CD en Skaffold para renderizar y aplicar tus manifiestos, y para implementar tu aplicación en los destinos definidos , dadas las imágenes de contenedor compiladas con una herramienta de CI como Cloud Build y un registro de imágenes como Artifact Registry.

Renderizar, implementar y aplicar

Skaffold separa el proceso de renderización de manifiestos de la implementación. Cloud Deploy llama a skaffold render, para renderizar los manifiestos y a skaffold apply para aplicarlos al destino.

Esta separación entre renderización y aplicación te permite capturar el estado declarativo completo de tu aplicación en la configuración, de modo que se pueda aplicar de forma segura y repetible (por ejemplo, para reversiones). Esta técnica también facilita las aprobaciones. Debido a que los manifiestos se renderizan para todos los destinos antes del primer lanzamiento, puedes ver el YAML renderizado que se aplicará a cada destino.

Cloud Deploy no admite el uso de otros implementadores para implementar tu aplicación. Sin embargo, puedes usar herramientas como Helm o Kustomize para la renderización.

Para obtener más información sobre cómo Cloud Deploy realiza implementaciones con kubectl como implementador, consulta Arquitectura del servicio de Cloud Deploy.

Acerca de los perfiles de Skaffold

Puedes crear perfiles de Skaffold separados, identificados en skaffold.yaml, en una profiles: sección.

Cuando usas perfiles de Skaffold con Cloud Deploy, puedes crear perfiles separados para todos o algunos de tus destinos. Por ejemplo, diferentes perfiles para dev, staging y prod.

Los perfiles no son necesarios para usar Skaffold en Cloud Deploy, pero son útiles para definir personalizaciones de manifiestos entre tus destinos, por ejemplo, con diferentes archivos kustomization.yaml de Kustomize por destino.

Agrega compatibilidad con Kustomize a tu `skaffold.yaml`

La integración de tu configuración de Kustomize con tu configuración de Cloud Deploy/Skaffold consta de lo siguiente:

Incluye un archivo kustomization.yaml entre tus archivos de configuración.

Puedes almacenar tus archivos de configuración en un directorio local o en un bucket de Cloud Storage.

En tu archivo skaffold.yaml, crea una sección deploy para cada perfil.

También puedes tener una sección deploy fuera de los perfiles definidos, si no usas perfiles o para una configuración de implementación predeterminada que no esté vinculada a un perfil.

El siguiente es un ejemplo de configuración de Skaffold que muestra secciones deploy por perfil y usa una app de muestra ficticia llamada my-app:

apiVersion: skaffold/v4beta7
kind: Config
build:
  artifacts:
    - image: my-app-web-profiles
      context: my-app-web-profiles
    - image: my-app-application-profiles
      context: my-app-application-profiles
  googleCloudBuild:
    projectId: ${PROJECT_ID}
profiles:
- name: local
  manifests:
    kustomize:
      paths:
        - my-app-application-profiles/kubernetes/local
- name: test
  manifests:
    kustomize:
      paths:
        - my-app-application-profiles/kubernetes/test
- name: staging
  manifests:
    kustomize:
      paths:
        - my-app-application-profiles/kubernetes/staging
- name: prod
  manifests:
    kustomize:
      paths:
        - my-app-application-profiles/kubernetes/prod
deploy:
  kubectl: {}

La configuración de Skaffold que se muestra aquí tiene perfiles separados para los destinos test, staging y prod. También muestra un perfil para el desarrollo local. En cada perfil, hay una sección deploy.kustomize con una ruta que apunta a la ubicación de la personalización que se usará para ese destino.

Agrega compatibilidad con Helm a tu `skaffold.yaml`

Puedes usar Helm para renderizar tus manifiestos. Cloud Deploy no usa Helm para implementar tus aplicaciones y solo admite kubectl como implementador.

Para usar Helm, necesitas tu gráfico o gráficos de Helm, almacenados en cualquier ubicación a la que puedas hacer referencia desde tu skaffold.yaml. Esta ubicación puede estar en un sistema de archivos, un repositorio, posiblemente junto con tu skaffold.yaml o un repositorio de Open Container Initiative (OCI).

Para usar un gráfico de Helm, agrega una sección helm a tu skaffold.yaml archivo.

apiVersion: skaffold/v4beta7
kind: Config
build:
  artifacts:
  - image: skaffold-helm-image
manifests:
  helm:
    releases:
    - name: skaffold-helm-image
      chartPath: charts
deploy:
  kubectl: {}

La skaffold.yaml referencia muestra lo que se requiere en esta helm sección.

Funciones no compatibles de Skaffold

Las siguientes funciones de Skaffold no se pueden usar en Cloud Deploy:

Hooks de ciclo de vida
Módulos dinámicos de Skaffold

No se admite el uso de --module= para seleccionar módulos específicos para build, render, apply, etcétera. Se admiten módulos estáticos.
En Helm, la capacidad de crear un espacio de nombres si no existe uno.

¿Qué sigue?

Visita el sitio de Skaffold para obtener información sobre cómo funciona y qué puede hacer por ti.
Practica el uso de Cloud Deploy con Kustomize y perfiles de Skaffold.
Descubre cómo Cloud Deploy selecciona las versiones de herramientas que se usarán y cómo determinar qué versiones están en uso.
Aprende a usar perfiles de Skaffold con herramientas avanzadas de administración de manifiestos, como Helm, Kustomize y kpt.