Trabaja con archivos YAML de Google Cloud y Kubernetes en Cloud Code para IntelliJ

Cloud Code está diseñado para ayudar a editar archivos de configuración relacionados con Google Cloud y Kubernetes, incluidos los diagnósticos, la validación basada en esquemas y la documentación rápida.

Nota: Por razones de compatibilidad, las funciones de edición de Kubernetes se inhabilitan de forma automática si se detecta el complemento de Kubernetes para JetBrains. Anula esto de forma manual en el menú de configuración de Cloud Code. Para ello, navega a Cloud Code > Kubernetes > Funciones de edición de Kubernetes y activa o desactiva la configuración Habilitar las funciones de edición de configuración YAML de Kubernetes. Estas medidas de compatibilidad solo afectan a los archivos YAML de Kubernetes. La compatibilidad con otros tipos de archivos de configuración YAML, como Skaffold, no se ve afectada.

Nota: La compatibilidad con la edición de YAML de Cloud Build solo está disponible para los archivos llamados cloudbuild.yaml

Archivos de configuración YAML compatibles

• Anthos Config Management
• Cloud Build
• Config Connector
• Knative
• Kubernetes
• Kustomize
• Migrate for Anthos
• Skaffold

Además, Cloud Code también admite las CRD de Kubernetes conocidas, como Kubeflow, listas para usar.

Nota: Para usar la agregación de recursos más actualizada, necesitarás la versión más reciente de Cloud Code.

Usa el esquema personalizado

Además, con Cloud Code, puedes proporcionar tu propio esquema CRD con la configuración de IntelliJ (Archivo > Parámetros de configuración > Herramientas> Cloud Code > Kubernetes o Mac OS X, IntelliJ IDEA > Preferencias > Herramientas > Cloud Code > Kubernetes y navega a la sección Ubicaciones de esquemas de CRD).

Puedes apuntar a un archivo local o a una URL. Las URL que apuntan a github.com se convierten de forma automática en raw.githubusercontent.com.

Extrae el esquema de un clúster

Cuando cambias a un clúster que ejecuta Kubernetes v1.16 y posterior en el Explorador de Kubernetes, Cloud Code extrae de forma automática el esquema de todas las CRD instaladas.

Asistencia adicional con Skaffold

Skaffold es el motor subyacente con el que funciona Cloud Code y te ayuda a compilar, enviar y, también, implementar tu aplicación. Además, proporciona asistencia para crear canalizaciones de CI/CD.

Cloud Code incluye asistencia adicional para la administración de archivos de configuración de Skaffold. Al abrir un proyecto, Cloud Code detecta esquemas de Skaffold que no están actualizados y te notifica (a través del registro de acontecimientos) cuando hay una actualización de la versión del esquema de Skaffold disponible para tus archivos de configuración YAML de Skaffold existentes.

Como alternativa, puedes navegar a Herramientas > Cloud Code > Kubernetes y seleccionar Check for Skaffold Schemas Upgrades para buscar actualizaciones de esquema disponibles.

Configura con fragmentos

Los fragmentos listos para usar del esquema YAML común (con Ctrl+Space a fin de ver las opciones) facilitan el inicio de un archivo YAML nuevo o lo agregan a uno existente sin errores, sin dejar de seguir las prácticas recomendadas. Además, es más fácil trabajar con campos repetitivos, ya que, si completas uno, Cloud Code llenará las instancias restantes.

En la actualidad, se ofrecen los siguientes fragmentos:

• Cloud Build - Cloud Run deployment
• Cloud Build - Docker container build
• Cloud Build - GKE deployment
• Cloud Build - GKE Skaffold deployment
• Cloud Build - Go build
• Cloud Build - Terraform plan + apply
• Config Connector - BigQueryDataset
• Config Connector - BigQueryTable
• Config Connector - BigtableCluster
• Config Connector - BigtableInstance
• Config Connector - PubSubSubscription
• Config Connector - PubSubTopic
• Config Connector - RedisInstance
• Config Connector - SpannerInstance
• Kubernetes - ConfigMap
• Kubernetes - Deployment
• Kubernetes - Ingress
• Kubernetes - Pod
• Kubernetes - Service
• Migrate for Anthos - Export
• Migrate for Anthos - PersistentVolumeClaim
• Migrate for Anthos - StatefulSet
• Skaffold - Bazel
• Skaffold - Getting-started
• Skaffold - Helm deployment
• Skaffold - Kaniko

Completa con contexto

Cloud Code te proporcionará parámetros contextuales que te ayudarán a elegir la opción correcta según el esquema actual.

Valida el esquema YAML

Cloud Code ofrece asistencia para la validación de esquemas mediante la marcación con etiquetas no válidas y valores en tus archivos YAML, y sugiere correcciones cuando sea posible.

Valida archivos YAML de Skaffold

Cloud Code admite la edición de los archivos de configuración de Skaffold adicionales y proporciona plantillas inteligentes que te permiten validar los archivos skaffold.yaml con facilidad. Consulta esta guía sobre cómo usar una app existente con Cloud Code.

Completa los archivos de configuración de Skaffold con contexto

Cloud Code te proporcionará parámetros contextuales y documentos relevantes que te ayudarán a elegir la opción correcta según el esquema actual.

Habilita la sincronización de archivos de Skaffold y la recarga en caliente

Para mejorar la eficiencia de tu flujo de trabajo de desarrollo local y evitar tener que volver a compilar, implementar y reiniciar tus Pods, Skaffold admite la copia de archivos modificados en un contenedor implementado. Esto significa que, cuando realices cambios en archivos de código fuente estáticos y de código fuente, podrás ver que estos se implementan en cuestión de segundos, lo que genera un ciclo de reacción acelerado.

En el caso de los archivos estáticos (como archivos HTML y CSS), el comportamiento de copia de archivos se denomina sincronización de archivos.

En el caso de los archivos de código fuente, este comportamiento se denomina recarga en caliente y funciona para los siguientes tipos de archivos:

• Go: *.go
• Java: *.java, *.kt, *.scala, *.groovy, *.clj
• NodeJS: *.js, *.mjs, *.coffee, *.litcoffee, *.json

Con la recarga en caliente configurada, Skaffold detecta cambios en los archivos compatibles y los sincroniza con el contenedor en ejecución en tu clúster, lo que evita la necesidad de volver a compilar una imagen engorrosa y reiniciar el Pod. Sin embargo, los cambios en otros tipos de archivos activan una recompilación de imagen.

La sincronización automática de archivos y la recarga en caliente están habilitadas de forma predeterminada cuando trabajas con Buildpacks como tu compilador preferido. Para otros compiladores como Docker, puedes especificar una sección sync en tu skaffold.yaml para el artefacto que estás personalizando.

La configuración de sincronización puede ser una de las siguientes opciones (en orden de preferencia):

• auto (solo para artefactos de Jib y Buildpacks)
• infer
• manual

Si especificaras una sincronización de manual para sincronizar todos los archivos HTML /static-html en la carpeta static en el contenedor, el archivo skaffold.yaml contendrá esta sección sync:

build:
  artifacts:
    - image: gcr.io/k8s-skaffold/node-example
      context: node
      sync:
        manual:
          - src: 'static-html/*.html'
            dest: static

Para obtener una descripción detallada de la sincronización de archivos y especificar reglas de sincronización, consulta la guía de Skaffold sobre la sincronización de archivos.

Descubre definiciones con la documentación rápida

Cloud Code muestra documentación relevante para un recurso cuando destacas una línea en el archivo de configuración y accedes a Ver > Documentación rápida.

Analiza YAML con lint para detectar problemas de estructura y validez

Cloud Code proporciona asistencia de lint para problemas comunes del esquema y muestra errores descriptivos.

Aplica un archivo YAML

A fin de ejecutar kubectl apply -f para aplicar un cambio de configuración con el archivo actual, puedes usar el ícono de acciones de kubectl , disponible en el margen del IDE y seleccionar Apply. Aparecerá una vista de diferencias para revisar los cambios antes de hacer clic en Apply.

Diferencia entre archivos YAML

Si deseas ver las diferencias entre un archivo YAML en el control de código fuente y uno implementado, puedes usar el ícono de acciones de kubectl disponible en el margen del editor. Elige la opción Diff (Diferencia) para obtener una vista de diferencias a fin de comparar y contrastar dos archivos de esquema.

Realiza la prueba de validación de un archivo YAML

Para realizar una ejecución de prueba de tu archivo y verificar su validez, puedes usar el ícono de kubectl actions , disponible en el margen de tu IDE, para seleccionar Dry-run on Server o Dry-run on Client. Esto ejecutará kubectl apply -f dry-run=server (o kubectl apply -f dry-run=client, en la opción de cliente) y te notificará si el archivo se puede crear correctamente en la ventana de la terminal.

Obtener asistencia

Para enviar comentarios o informar un problema en tu IDE de IntelliJ, ve aTools >Cloud Code >Help / About >Envía comentarios o informa un problema para informar un problema en GitHub o hacer una pregunta en Stack Overflow.

También puedes unirte al canal #cloud-code, que forma parte de la comunidad de Slack en Google Cloud.