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

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

Nota: Por motivos de compatibilidad, las funciones de edición de Kubernetes se inhabilitan automáticamente si se detecta el complemento Kubernetes de JetBrains. Para anular esta opción manualmente en el menú de configuración de Cloud Code, ve a Cloud Code > Kubernetes > Funciones de edición de Kubernetes y activa o desactiva el ajuste Habilitar funciones de edición de configuración de YAML de Kubernetes. Estas medidas de compatibilidad solo afectan a los archivos YAML de Kubernetes. Esto no afecta a la compatibilidad con otros tipos de archivos de configuración YAML, como Skaffold.

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

.

Archivos de configuración YAML admitidos

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

Cloud Code también admite CRDs de Kubernetes populares, como Kubeflow, de forma predeterminada.

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

Habilitar o inhabilitar la compatibilidad con YAML

Para habilitar o inhabilitar la compatibilidad con YAML, ve a Archivo > Configuración > Herramientas > Gemini + Google Cloud Code > Kubernetes (en Windows y Linux) o IntelliJ IDEA > Configuración > Herramientas > Gemini + Google Cloud Code > Kubernetes (en macOS) y marca o desmarca la casilla Habilitar compatibilidad con YAML para habilitar o inhabilitar la función.

Usar un esquema personalizado

Con Cloud Code, puedes proporcionar tu propio esquema de CRD con los ajustes de IntelliJ. Para ello, ve a File > Settings > Tools > Gemini + Google Cloud Code > Kubernetes (en Windows y Linux) o IntelliJ IDEA > Settings > Tools > Gemini + Google Cloud Code > Kubernetes (en macOS) y, a continuación, consulta la sección Ubicaciones del esquema de CRD.

Puedes indicar un archivo local o una URL. Las URLs que apuntan a github.com se convierten automáticamente en raw.githubusercontent.com.

Extraer 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 automáticamente el esquema de todos los CRDs instalados.

Compatibilidad adicional con Skaffold

Skaffold es el motor subyacente que impulsa Cloud Code y te ayuda a compilar, enviar e implementar tu aplicación, así como a crear flujos de procesamiento de CI/CD.

Cloud Code incluye asistencia adicional para gestionar archivos de configuración de Skaffold. Cuando abres un proyecto, Cloud Code detecta esquemas de Skaffold que no están actualizados y te avisa (a través del registro de eventos) cuando hay disponible una versión actualizada de un esquema de Skaffold para tus archivos de configuración YAML de Skaffold.

También puedes ir a Herramientas > Gemini + Cloud Code > Kubernetes > Buscar actualizaciones de esquemas de Skaffold para comprobar si hay actualizaciones de esquemas disponibles.

Configurar con fragmentos

Los fragmentos de código predefinidos para esquemas YAML comunes (usa Ctrl+Espacio para ver las opciones) te permiten iniciar un nuevo archivo YAML o añadir contenido a uno ya creado sin errores, al tiempo que sigues las prácticas recomendadas. Además, es más fácil trabajar con campos repetitivos: rellena uno y Cloud Code completará las instancias restantes.

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

Completar con contexto

Según el esquema actual, Cloud Code ofrece finalizaciones contextuales para ayudarte a elegir la opción adecuada.

Validar el esquema YAML

Cloud Code ofrece compatibilidad con la validación de esquemas. Para ello, marca las etiquetas y los valores no válidos de los archivos YAML y sugiere correcciones cuando es posible.

Validar archivos YAML de Skaffold

Cloud Code ofrece asistencia adicional para editar archivos de configuración de Skaffold y plantillas inteligentes que te permiten validar tus archivos skaffold.yaml. Consulta esta guía sobre cómo usar una aplicación con Cloud Code.

Completar archivos de configuración de Skaffold con contexto

En función del esquema actual, Cloud Code proporciona finalizaciones contextuales y documentación pertinente para ayudarte a elegir la opción adecuada.

Descubrir definiciones con la documentación rápida

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

Analiza el archivo YAML para detectar problemas estructurales y de validez

Cloud Code ofrece compatibilidad con linting para problemas de esquemas habituales y proporciona errores descriptivos.

Aplicar un archivo YAML

Para ejecutar kubectl apply -f y aplicar un cambio de configuración con el archivo actual, puedes usar el icono de acciones de kubectl , disponible en el margen de tu IDE, y seleccionar Aplicar. Se mostrará una vista de diferencias para que puedas revisar los cambios antes de hacer clic en Aplicar.

Diferencia entre archivos YAML

Para ver las diferencias entre un archivo YAML en el control de código fuente y un archivo YAML desplegado, puedes usar el icono de acciones de kubectl disponible en el margen de tu editor. Selecciona la opción Diff para ver una vista de diferencias que te permita comparar dos archivos de esquema.

Hacer una prueba de un archivo YAML

Para hacer una prueba de tu archivo y comprobar su validez, puedes usar el icono de acciones de kubectl , disponible en el margen de tu IDE, para seleccionar Prueba en el servidor o Prueba en el cliente. Se ejecuta kubectl apply -f dry-run=server (o kubectl apply -f dry-run=client, en el caso de la opción Cliente) y te avisa si el archivo se puede crear correctamente en la ventana Terminal.

Siguientes pasos

• Crea un archivo de configuración de ejecución de Kubernetes de Cloud Code skaffold.yaml.
• Crea manualmente una configuración de Skaffold para tu aplicación.
• Consulta la documentación de referencia de Skaffold.yaml.

Obtener asistencia

Para enviar comentarios o informar de un problema en tu IDE de IntelliJ, ve a Herramientas > Cloud Code > Ayuda o información > Enviar comentarios o informar de un problema para informar de un problema en GitHub.