Usa una aplicación existente en Cloud Code para IntelliJ

Si ya tienes un proyecto existente configurado con los manifiestos de Kubernetes, un Dockerfile o Jib para compilar tus imágenes, puedes abrirlo y usarlo con el complemento. La única configuración adicional necesaria es un archivo skaffold.yaml que se puede generar automáticamente o crear con la plantilla proporcionada.

Una vez que hayas terminado de configurar el archivo skaffold.yaml, asegúrate de especificar la ubicación en la que se almacenarán las imágenes de contenedor, donde se enviará la imagen del proyecto.

Arranca el proyecto de forma automática

Tu proyecto debe tener uno o más manifiestos de Kubernetes. Si Cloud Code detecta cualquier manifiesto de Kubernetes en el proyecto, intentará iniciarlo.

Si Cloud Code no detecta una configuración de skaffold.yaml existente, se te solicitará que la configures.

Requisitos previos

Tu proyecto debe cumplir con los siguientes requisitos previos para que se te solicite crear un archivo skaffold.yaml y ejecutar las configuraciones necesarias:

  • (Opción 1) Tu proyecto tiene un Dockerfile y está configurado para Jib, o

  • (Opcional 2) Tu proyecto se puede compilar mediante Buildpacks y tiene recursos de Kubernetes.

Configura la ejecución de Kubernetes

Si se cumplen los requisitos, Cloud Code te solicitará mediante una notificación que crees un archivo skaffold.yaml (si aún no existe) y cualquier parámetro de configuración de ejecución necesaria:

Notificación con un vínculo para crear los parámetros de configuración de ejecución de Kubernetes de Cloud Code

  1. Haz clic en la notificación. De esta forma, se crea automáticamente la configuración si es posible.

    Si no es posible crear de forma automática la configuración de skaffold.yaml debido a que se detectan varias imágenes o compiladores, Cloud Code mostrará un cuadro de diálogo que te pedirá proporcionar asignaciones entre las imágenes y los compiladores detectados.

    Especifica la configuración de compilación que se usará en tu archivo "skaffold.yaml"

    Como alternativa, también puedes configurar un archivo skaffold.yaml si navegas a Herramientas > Cloud Code > Kubernetes y seleccionas Agregar compatibilidad con Kubernetes.

    Esta opción analiza los recursos de Kubernetes de tu proyecto y genera un archivo skaffold.yaml (si aún no existe) y las opciones de configuración de ejecución necesarias. Las dos opciones de configuración de ejecución generadas incluyen una para ejecutar tu proyecto en Kubernetes y otra para desarrollo en un clúster de Kubernetes.

  2. Una vez que agregues la compatibilidad, podrás comenzar a ejecutar y depurar tu proyecto en Kubernetes mediante las opciones de configuración de ejecución recién agregadas.

Crea manualmente una configuración de skaffold.yaml de Cloud Code

Puedes crear un archivo skaffold.yaml nuevo de forma manual o agregar uno existente a tu proyecto.

Para crear un archivo skaffold.yaml de forma manual con plantillas activas, sigue estos pasos:

  1. Crea un archivo nuevo llamado skaffold.yaml en el directorio raíz de tu proyecto (clic derecho > New > File).

  2. Con el cursor en el archivo nuevo, presiona Ctrl+Space para que se muestren las sugerencias de plantillas en vivo y elige una plantilla de skaffold.yaml.

    Usa la plantilla `skaffold.yaml`

  3. Propaga el campo de la imagen con el nombre de la imagen de tu proyecto y el campo manifiestos con una lista de los recursos de Kubernetes que deseas implementar desde el IDE.

  4. Una vez que Cloud Code determine que tu archivo skaffold.yaml es válido, haz clic en el mensaje para crear las opciones de configuración de ejecución de Kubernetes.

    Notificación sobre crear un objetivo de ejecución de Kubernetes

Ejemplos de opciones de configuración de skaffold.yaml de Cloud Code

  • Compilaciones basadas en Dockerfile:

    build:
      artifacts:
        - image: image_name
    deploy:
      kubectl:
        manifests:
          - k8s/web.yaml
          - k8s/backend.yaml
    
  • La sección de compilación para los proyectos de Maven o Gradle en Java con el complemento Jib (la sección de implementación se mantiene igual que en el ejemplo anterior):

    build:
    artifacts:
    - image: image_name
      jib: {}
    
  • Si deseas definir opciones de configuración de compilación, de prueba y de implementación para diferentes contextos, puedes tener diferentes perfiles. A continuación, se muestra un ejemplo de un perfil de Cloud Build a fin de configurar Cloud Code para compilar imágenes mediante Cloud Build:

    profiles:
    # use the cloudbuild profile to build images using Google Cloud Build
    - name: cloudbuild
      build:
        googleCloudBuild: {}
    
  • Si deseas implementar tu proyecto con Helm, consulta la documentación de Helm.

Especifica dónde se almacenan las imágenes de contenedor

Almacenamiento de imágenes de contenedor

Antes de implementar tu aplicación, deberás definir un repositorio de imágenes predeterminado para usar con tu proyecto.

De forma predeterminada, el proyecto está configurado para usar el nombre de la imagen especificado en tus manifiestos de Kubernetes. También puedes personalizar esta especificación de imagen. Cuando hayas configurado tu repositorio preferido (Artifact Registry, DockerHub o un repositorio privado), edita las configuraciones de ejecución y especifícalo como un repositorio de imágenes predeterminado en la configuración de ejecución.

Puedes acceder a estas opciones desde el cuadro de diálogo Run/Debug configurations (configuración de ejecución y depuración) en la barra de tareas superior en Edit Configurations (Editar configuración) > Develop on Kubernetes (Desarrollar en Kubernetes) > Image repository (Repositorio de imágenes).

El repositorio de imágenes predeterminado en la configuración de ejecución se establece con el formato “gcr.io/” y se presentan opciones de autocompletado según el proyecto actual y el clúster activo

Si deseas obtener más información para especificar tus preferencias de imagen del contenedor, consulta la Guía de configuración de la imagen de contenedor.

Parámetros de configuración de compilación

Una vez que configuras tu imagen de contenedor, puedes establecer la configuración de compilación. Cloud Code es compatible con los tipos de artefactos Docker, Jib y Buildpacks.

En la pestaña Build / Deploy de la configuración de Run (Editar configuración > Desarrollar en Kubernetes), puedes configurar configuración de tu perfil predeterminado.

Configuración de compilación que se muestra en la pestaña Build/Deploy

Si deseas obtener más información para especificar la configuración de compilación de tu imagen, consulta la guía de configuración de las preferencias de compilación de la imagen del contenedor.

¿Qué sigue?

Obtén asistencia

Para enviar comentarios o informar un problema en tu IDE de IntelliJ, ve a Tools > Cloud Code > Help / About > Enviar comentarios o informar un problema para informar un problema en GitHub.