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.

Archivos de configuración YAML compatibles

Cloud Code también admite las CRD de Kubernetes populares, como Kubeflow, listas para usar.

Habilitar o inhabilitar la compatibilidad con YAML

Para habilitar o inhabilitar la compatibilidad con YAML, navega a File > Settings > Tools > Gemini + Google Cloud Code > Kubernetes (para Windows y Linux) o IntelliJ IDEA > Settings > Tools > Gemini + Google Cloud Code > Kubernetes (para macOS) y selecciona o borra la casilla de verificación Enable YAML support para habilitar o inhabilitar la función.

Usa un esquema personalizado

Con Cloud Code, puedes proporcionar tu propio esquema de CRD con IntelliJ ve a Archivo > Configuración > Herramientas > Gemini y Google Cloud Code > Kubernetes (para Windows y Linux) o IntelliJ IDEA > Configuración > Herramientas > Gemini y Google Cloud Code > Kubernetes (para macOS) y, luego, consulta el esquema de CRD de Google Workspace.

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+ 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 que impulsa Cloud Code, que te ayuda a compilar, enviar e implementar tu aplicación y ofrecer asistencia para crear canalizaciones de CI/CD.

Cloud Code incluye asistencia adicional para la administración de archivos de configuración de Skaffold. Cuando abres 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.

Notificación en el registro de acontecimientos que solicita al usuario que actualice su versión del esquema de Skaffold, ya que sus archivos YAML existentes de Skaffold no pertenecen a la versión más reciente.

Como alternativa, puedes navegar a Herramientas > Gemini + Cloud Code > Kubernetes > Check for Skaffold Schemas Upgrades para buscar actualizaciones de esquemas disponibles.

Configurar con fragmentos

Los fragmentos listos para usar del esquema YAML común (con Ctrl + Espacio para ver las opciones) te permiten iniciar un archivo YAML nuevo o agregar código a uno existente sin errores, sin dejar de seguir las prácticas recomendadas. Además, es más fácil trabajar con campos repetitivos; completen uno y Cloud Code completará las instancias restantes.

Usa fragmentos con campos repetitivos

Cloud Code ofrece 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 to Containers - Export
  • Migrate to Containers - PersistentVolumeClaim
  • Migrate to Containers - StatefulSet
  • Skaffold - Bazel
  • Skaffold - Getting-started
  • Skaffold - Helm deployment
  • Skaffold - Kaniko

Completa con contexto

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

Parámetros contextuales para el esquema de Kubernetes

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.

Valor del campo de nombre subrayado en rojo para destacar un valor no válido de 1234; coloca el cursor sobre los estados de texto: Tipo incorrecto. Cadena esperada.

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. Consulta esta guía sobre cómo usar una app existente con Cloud Code.

Plantillas YAML de Skaffold

Completa los archivos de configuración de Skaffold con contexto

Cloud Code te proporcionará finalizaciones contextuales y documentación relevante que te ayudarán a elegir la opción correcta según el esquema actual.

Parámetros de Skaffold

Descubre definiciones con la documentación rápida

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

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.

Analiza archivos YAML con lint

Aplica un archivo YAML

Para ejecutar kubectl apply -f y aplicar un cambio de configuración con el comando puedes usar el ícono de kubectl actions Ícono de acciones de kubectl: disponible en el margen de tu IDE y selecciona Apply. Esto genera una diferencia para revisar los cambios antes de hacer clic en Aplicar.

Opción Apply destacada en la lista de acciones de kubectl

Diferencias entre archivos YAML

Para ver las diferencias entre un archivo YAML en el control de código fuente y un archivo YAML implementado, puedes usar el ícono de acciones de kubectl Ícono de acciones de kubectl disponible en el margen del editor. Selecciona la opción Diff para ver una vista de diferencias que te permita comparar y contrastar dos archivos de esquemas.

Opción DIF destacada en la lista de acciones de kubectl

Realiza la prueba de validación de un archivo YAML

Para realizar una ejecución de prueba de tu archivo y comprobar su validez, puedes usar el Ícono de kubectl actions Ícono de acciones de kubectl, disponibles en el margen de tu IDE, para seleccionar Dry-run on Server o de prueba en el cliente. Ejecuta kubectl apply -f dry-run=server. (o kubectl apply -f dry-run=client, para la opción Cliente) y te notifica si tu archivo se puede crear correctamente en la ventana de tu terminal.

La opción de prueba sin conexión en el servidor destacada en la lista de acciones de kubectl

¿Qué sigue?

Obtenga 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.