Skip to main content

Build e atualização

O build constrói uma imagem Docker a partir do código do repositório. O procedimento é compartilhado pelos formatos batch e online.

O código deve estar disponível na branch remota indicada pelo manifesto. Os campos gitRepoUrl, gitBranch e gitPath devem corresponder ao repositório, à branch e ao diretório da aplicação. Imagens construídas localmente não são enviadas automaticamente à Carol.

Acesso ao repositório​

A configuração Git do Carol App oferece conexões com GitHub, Bitbucket e Azure DevOps. Para construir a imagem, a Carol precisa acessar o repositório informado no manifesto e ler o Dockerfile e os arquivos da aplicação na branch indicada.

Em repositórios privados, informe na tela de build um token com permissão de leitura. A Carol utiliza esse token para autenticar o acesso ao repositório e obter os arquivos necessários à construção da imagem. O build utiliza a URL, a branch, o diretório e o nome do Dockerfile definidos em docker[] no manifesto.

Preparação do manifesto para o primeiro build

Os manifestos de exemplo contêm uma URL de repositório que deve ser substituída antes do envio à Carol. Em cada definição de docker[], confira:

CampoValor a informar
gitRepoUrlURL real do repositório que contém o código e o Dockerfile.
gitBranchBranch em que esses arquivos estão disponíveis remotamente.
gitPathDiretório dos arquivos dentro do repositório. Nos exemplos, /static/examples/carol-apps/batch ou /static/examples/carol-apps/online.
gitDockerfileNameNome do arquivo de instruções de build, como Dockerfile.
dockerTagVersão da imagem a construir, como 1.0.0.

O campo dockerName deve ter o mesmo valor na definição de build e no processo que utiliza a imagem. Os exemplos de cada formato já incluem essa associação.

Build na Carol​

  1. Na tenant de desenvolvimento, abra Carol Apps, clique em Create new App e preencha os dados do app.
  2. Abra o app em Developed Apps. Em Files, use Upload file para enviar o manifest.json ajustado.
  3. Clique em Build e selecione a definição Docker do processo: carol-demo-batch ou carol-demo-online nos exemplos.
  4. Confira o repositório e a branch. Se o repositório for privado, informe o token com permissão de leitura no campo de autenticação da tela de build.
  5. Em Next, confira Image name, Tag e Instance type to build docker image. Escolha uma instância disponível e adequada ao build.
  6. Clique em Build image, acompanhe a tarefa de build e confirme sua conclusão com sucesso. Em caso de falha, consulte o log da tarefa antes de prosseguir.

Ao concluir o build, a imagem está pronta para uso pelo processo. A execução da aplicação é iniciada na aba Process, conforme as instruções de batch ou online. Cada imagem declarada no manifesto requer um build próprio.

Campos de build do manifesto
CampoUso e exemplo
dockerNameNome da imagem referenciada pelo processo. Deve corresponder exatamente ao seu properties.dockerName.
dockerTagVersão da imagem, como 1.0.0. Use uma nova tag ao publicar uma alteração para facilitar rastreabilidade e retorno à versão anterior.
gitRepoUrlURL da raiz do repositório, sem /tree/main ou caminhos de arquivos. Não inclua tokens nessa URL.
gitBranchBranch existente que contém o código a construir, como main.
gitPathDiretório do código e Dockerfile, a partir da raiz do repositório: /static/examples/carol-apps/batch neste exemplo.
gitDockerfileNameNome do Dockerfile dentro de gitPath: Dockerfile.

Os campos gitRepoUrl, gitBranch, gitPath e gitDockerfileName ficam no bloco docker[] neste formato. O tipo de instância escolhido na tela de build fornece recursos para construir a imagem; properties.instanceType fornece recursos para executar o processo.

Tela de build

Seleção de imagem no build de um Carol App

Atualização de versões​

Alterações no código, nas dependências ou no Dockerfile exigem um novo build. Após a validação local, disponibilize o código na branch remota, atualize dockerTag e envie o manifesto. Construa as imagens alteradas e execute novamente a tarefa batch ou reinicie o serviço online.

Alterações apenas nas variáveis de ambiente exigem o envio do manifesto atualizado e uma nova execução batch ou o reinício do serviço online. A imagem pode ser reutilizada.

Distribuição e retorno à versão anterior

Após a validação na tenant de desenvolvimento, a distribuição segue o fluxo de revisão e aprovação da organização. Os estados de publicação estão descritos em Antes de começar, e o procedimento de instalação está disponível na seção de instalação de Carol Apps.

Após instalar ou atualizar, confira os Settings da tenant de destino e repita a validação dos processos. Use tags de versão identificáveis e guarde a imagem e o manifesto anteriores para permitir retorno se a atualização falhar.

Diagnóstico de erros de build e versão
SintomaVerificação
Falha ao acessar o GitURL da raiz do repositório, branch e permissão da credencial.
Dockerfile ou código não encontradogitPath, gitDockerfileName e os arquivos usados por COPY no contexto de build.
Processo não encontra a imagemCorrespondência de dockerName, tag e conclusão do build. Para dockerImage, confira a referência e o acesso ao registry.
Alteração local não aparece na CarolConteúdo da branch remota, tag construída e manifesto enviado.

Não salve tokens na URL do repositório nem no manifesto. Use a credencial solicitada pela integração na tela de build.

Para acompanhar a execução depois do build, consulte Carol App Logs.