Configurando um devfile para um ambiente de desenvolvimento

Um devfile é um padrão aberto que ajuda você a personalizar seus ambientes de desenvolvimento em toda a sua equipe. Um devfile é um YAML arquivo que codifica as ferramentas de desenvolvimento necessárias. Ao configurar um devfile, você pode pré-determinar as ferramentas de projeto e as bibliotecas de aplicativos de que precisa e a Amazon as CodeCatalyst instala em seu ambiente de desenvolvimento para você. O devfile é específico para o repositório para o qual foi criado, e você pode criar um devfile separado para cada repositório. Seu ambiente de desenvolvimento oferece suporte a comandos e eventos e fornece uma imagem padrão de devfile universal.

Se você criar um projeto usando o blueprint vazio, poderá criar um devfile manualmente. Se você criar um projeto usando um blueprint diferente, CodeCatalyst cria um devfile automaticamente. O /projects diretório de um ambiente de desenvolvimento armazena os arquivos que são extraídos do repositório de origem e do devfile. O /home diretório, que está vazio quando você cria um ambiente de desenvolvimento pela primeira vez, armazena os arquivos que você cria enquanto usa seu ambiente de desenvolvimento. Tudo nos /home diretórios /projects e de um ambiente de desenvolvimento é armazenado de forma persistente.

nota

A /home pasta só será alterada se você alterar o nome do devfile ou do componente devfile. Se você alterar o nome do devfile ou do componente devfile, o conteúdo do /home diretório será substituído e os dados do /home diretório anterior não poderão ser recuperados.

Se você criar um ambiente de desenvolvimento com um repositório de origem que não contém um devfile em sua raiz, ou se você criar um ambiente de desenvolvimento sem um repositório de origem, um devfile universal padrão será aplicado automaticamente ao repositório de origem. A mesma imagem devfile universal padrão é usada para todosIDEs. CodeCatalyst atualmente suporta a versão 2.0.0 do devfile. Para obter mais informações sobre o devfile, consulte Esquema Devfile - Versão 2.0.0.

nota

Você só pode incluir imagens de contêiner público em seu devfile.

Observe que os ambientes VPC de desenvolvimento conectados suportam apenas as seguintes imagens de devfile:

• Imagem universal

• ECRImagens privadas da Amazon, se o repositório estiver na mesma região do VPC

Tópicos

• Editando um arquivo de desenvolvimento do repositório para um ambiente de desenvolvimento
• Recursos do Devfile suportados pelo CodeCatalyst
• Exemplo de um devfile para um ambiente de desenvolvimento
• Solução de problemas de um devfile do repositório usando o modo de recuperação
• Especificação de imagens de devfile universais para um ambiente de desenvolvimento
• Comandos Devfile
• Eventos Devfile
• Componentes do Devfile

Recursos do Devfile suportados pelo CodeCatalyst

CodeCatalyst suporta os seguintes recursos do devfile na versão 2.0.0. Para obter mais informações sobre o devfile, consulte Esquema Devfile - Versão 2.0.0.

Atributo	Tipo
exec	Comando
postStart	Evento
container	Componente
args	Propriedades do componente
env	Propriedades do componente
mountSources	Propriedades do componente
volumeMounts	Propriedades do componente

Exemplo de um devfile para um ambiente de desenvolvimento

Veja a seguir um exemplo de um devfile simples.

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

Os registros de inicialização, comandos e eventos do Devfile são capturados e armazenados em/aws/mde/logs. Para depurar o comportamento do devfile, inicie seu ambiente de desenvolvimento usando um devfile ativo e acesse os registros.

Solução de problemas de um devfile do repositório usando o modo de recuperação

Se houver algum problema ao iniciar seu devfile, ele entrará no modo de recuperação para que você ainda possa se conectar ao seu ambiente e corrigir seu devfile. No modo de recuperação, a execução /aws/mde/mde status não conterá a localização do seu devfile.

{
            "status": "STABLE"
        }

Você pode verificar o erro nos registros abaixo/aws/mde/logs, corrigir o devfile e tentar executar /aws/mde/mde start novamente.