Configuración de un devfile para un entorno de desarrollo

Un devfile es un estándar abierto que le ayuda a personalizar los entornos de desarrollo de su equipo. Un devfile es un archivo YAML que codifica las herramientas de desarrollo necesarias. Al configurar un devfile, puede predeterminar las herramientas de proyecto y las bibliotecas de aplicaciones que necesita y Amazon las CodeCatalyst instala en su entorno de desarrollo por usted. El archivo de desarrollo es específico del repositorio para el que se creó y puede crear un archivo de desarrollo independiente para cada repositorio. Su entorno de desarrollo admite comandos y eventos, y proporciona una imagen de archivo de desarrollo universal predeterminada.

Si crea un proyecto con el plano vacío, puede crear un devfile manualmente. Si crea un proyecto con un esquema diferente, CodeCatalyst crea un devfile automáticamente. El /projects directorio de un entorno de desarrollo almacena los archivos que se extraen del repositorio fuente y del devfile. El /home directorio, que está vacío al crear un entorno de desarrollo por primera vez, almacena los archivos que se crean mientras se utiliza el entorno de desarrollo. Todo el contenido de los /home directorios /projects y de un entorno de desarrollo se almacena de forma persistente.

nota

La /home carpeta solo cambia si cambias el nombre del devfile o del componente devfile. Si cambia el nombre del componente devfile o devfile, se sustituirá el contenido del /home directorio y no se podrán recuperar los datos del /home directorio anterior.

Si crea un entorno de desarrollo con un repositorio de código fuente que no contiene un archivo de desarrollo en su raíz, o si crea un entorno de desarrollo sin un repositorio de código fuente, se aplicará automáticamente un archivo de desarrollo universal predeterminado al repositorio de origen. Se utiliza la misma imagen de archivo de desarrollo universal predeterminada para todos los IDE. CodeCatalyst actualmente es compatible con la versión 2.0.0 de devfile. Para obtener más información sobre el archivo de desarrollo, consulte el esquema de archivo de desarrollo: versión 2.0.0.

nota

Solo puede incluir imágenes de contenedor público en su archivo de desarrollo.

Tenga en cuenta que los entornos de desarrollo conectados a VPC solo admiten las siguientes imágenes de devfile:

• Imagen universal

• Imágenes privadas de Amazon ECR, si el repositorio está en la misma región que la VPC

Temas

• Edición de un archivo de desarrollo de repositorio para un entorno de desarrollo
• Características de Devfile compatibles con CodeCatalyst
• Ejemplo de un archivo de desarrollo para un entorno de desarrollo
• Solución de problemas de un archivo de desarrollo del repositorio mediante el modo de recuperación
• Especificación de imágenes de archivos de desarrollo universales para un entorno de desarrollo
• Comandos de Devfile
• Eventos de Devfile
• Componentes de Devfile

Características de Devfile compatibles con CodeCatalyst

CodeCatalyst admite las siguientes funciones de devfile en la versión 2.0.0. Para obtener más información sobre el archivo de desarrollo, consulte el esquema de archivo de desarrollo: versión 2.0.0.

Característica	Tipo
exec	Comando
postStart	Evento
container	Componente
args	Propiedades de los componentes
env	Propiedades de los componentes
mountSources	Propiedades de los componentes
volumeMounts	Propiedades de los componentes

Ejemplo de un archivo de desarrollo para un entorno de desarrollo

El siguiente es un ejemplo de un archivo de desarrollo simple.

schemaVersion: 2.0.0
metadata:
  name: al2
components:
  - name: test
    container:
      image: public.ecr.aws/amazonlinux/amazonlinux:2
      mountSources: true
      command: ['sleep', 'infinity']
  - name: dockerstore
commands:
  - id: setupscript
    exec:
      component: test
      commandLine: "chmod +x script.sh"
      workingDir: /projects/devfiles
  - id: executescript
    exec:
      component: test
      commandLine: "/projects/devfiles/script.sh"
  - id: yumupdate
    exec:
      component: test
      commandLine: "yum -y update --security"
events:
  postStart:
    - setupscript
    - executescript
    - yumupdate

Los registros de inicio, comandos y eventos de Devfile se capturan y almacenan en. /aws/mde/logs Para depurar el comportamiento de los archivos de desarrollo, inicie su entorno de desarrollo con un archivo de desarrollo que funcione y acceda a los registros.

Solución de problemas de un archivo de desarrollo del repositorio mediante el modo de recuperación

Si hay algún problema al iniciar el archivo de desarrollo, pasará al modo de recuperación para que pueda seguir conectándose a su entorno y corregir su archivo de desarrollo. Mientras esté en modo de recuperación, al ejecutar /aws/mde/mde status no se incluirá la ubicación del archivo de desarrollo.

{
            "status": "STABLE"
        }

Puedes comprobar el error en los registros de abajo/aws/mde/logs, corregir el devfile e intentar volver a /aws/mde/mde start ejecutarlo.