Implementação de código

Editar online

A ferramenta de implantação de código é usada para implantar o código-fonte do aplicativo em IBM® Code Engine, o que simplifica o processo de implantação e reduz o esforço manual.

A ferramenta de implantação de código oferece um processo de implantação simplificado e automatizado. Ele oferece suporte a dois tipos de implementações, IBM - gerenciada e gerenciada pelo usuário, e oferece recursos como a recuperação do status do processo de implementação, a recuperação de registros do aplicativo implementado e a exclusão do aplicativo especificado.

Serviços suportados e tipos de implementação

IBM -implantação gerenciada
Implanta o código do aplicativo em um ambiente Code Engine gerenciado pelo IBM, que fornece uma configuração temporária e autolimpante. Os principais recursos de chave a seguir estão incluídos:
Recursos temporários
O aplicativo e os recursos relacionados são limpos automaticamente após um período definido e direcionado à persona do desenvolvedor.
Teste
Os usuários da persona do desenvolvedor recebem o endpoint do aplicativo URL e o nome do aplicativo para testes convenientes.
API Connect SaaS exclusivo
Esse recurso foi desenvolvido para API Connect SaaS,, simplificando os processos de implantação e teste.
Implementação gerenciada pelo usuário
Implemente facilmente o código do aplicativo que usa a interface do Agent em um serviço IBM Code Engine especificado pelo usuário, o que oferece flexibilidade e controle. Os principais recursos de chave a seguir estão incluídos:
Recursos controlados pelo usuário
Você pode manter controle total sobre o ciclo de vida e a configuração dos recursos implementados.
Detalhes da implementação
A ferramenta fornece o endpoint do aplicativo URL e o nome do aplicativo após a implementação bem-sucedida.

Recursos

Implementação do código do aplicativo
Implantar um .zip arquivo que contém código de aplicativo para um ambiente Code Engine gerenciado pela IBM ou pelo usuário.
  • A implantação do código do aplicativo é uma operação assíncrona.
  • Consulte o status da implantação separadamente para obter resultados.
Nota:
  • Somente os arquivos .zip são compatíveis com a implementação. Outros formatos não são aceitos.
  • O tamanho do arquivo deve ser inferior a 1 MB.
  • Para obter informações sobre verificações básicas de validação de pré-implantação, consulte Verificações de pré-implantação para Code Engine gerenciado IBM.
  • A ferramenta determina a alocação de recursos para o aplicativo implantado da seguinte forma:
    • 0.125 CPU
    • 0.5 GB de memória
Verificar o status de implementação
Recupere o status de uma implementação com base no nome do arquivo .zip fornecido pelo usuário.
  • Após a conclusão da implementação, a ferramenta exibe o status da implementação, o nome do aplicativo e o ponto de extremidade URL.
  • Para obter mais informações sobre os status da implantação, consulte Status da implantação.
Obter registros do aplicativo
Recupere os registros do aplicativo que está implantado em Code Engine.
  • Os registros obtidos são empacotados como um arquivo .log e fornecidos para download e depuração.
Excluir aplicativo
Exclua o aplicativo e seus recursos relacionados.

Verificações de pré-implantação para IBM -managed Code Engine

IBM -o mecanismo de código gerenciado faz as verificações que são realizadas antes da implementação do aplicativo e dos recursos associados.
Gerenciado pela IBM
Para ambientes gerenciados pelo IBM, todas as condições a seguir devem ser atendidas antes de iniciar uma implementação.
Tabela 1. Requisitos
Verificação Requisitos
Limite do projeto
  • Se o projeto para a organização do provedor existir no site IBM Code Engine, a ferramenta de implementação do código usará o projeto existente.
  • Se o projeto não existir para a organização do provedor, a ferramenta de implementação de código criará um novo projeto em IBM Code Engine se o número de projetos disponíveis for menor que 20.
Estado do projeto O projeto não deve estar no estado de criação.
Aplicativo existente O sistema impede que um usuário diferente implemente um aplicativo com o mesmo arquivo de código-fonte .zip
Vários aplicativos É permitida apenas uma inscrição por projeto.
Segredo do registro Não deve existir um segredo de registro com o mesmo nome.

Convenções de nomenclatura para implementação de recursos

Para garantir a consistência e a rastreabilidade, a ferramenta de implantação de código segue padrões de nomenclatura padronizados ao criar recursos.
IBM Code Engine
Use as seguintes convenções de nomenclatura ao criar recursos de implementação nos serviços IBM Code Engine :

A tabela a seguir mostra como os recursos são criados para um aplicativo com o nome de arquivo de código app-code, que é implantado pelo usuário 123 na organização do provedor abc.

Tabela 2. Convenções de nomenclatura
Tipo de recurso Formato Convenção de nomenclatura
Projeto aa-<provider_organization>-project
Observação: Os projetos em IBM Code Engine têm como escopo a organização do provedor em API Connect.
 aa-abc-project
Segredo do registro <project_name>-registry-secret aa-abc-project-registry-secret
Construção de imagem <project_name>-<application_code_file_name>-<user_id>-<resource_name> aa-abc-project-app-code-123-image-build
Execução de compilações de imagens <project_name>-<application_code_file_name>-<user_id>-<resource_name> aa-abc-project-app-code-123-image-build-run
Configmap <project_name>-<application_code_file_name>-<user_id>-<resource_name> aa-abc-project-app-code-123-cm
Segredo <project_name>-<application_code_file_name>-<user_id>-<resource_name> aa-abc-project-app-code-123-secret
Aplicativo <project_name>-<application_code_file_name>-<user_id>-<resource_name> aa-abc-project-app-code-123-app

Status de implementação

Quando você inicia a operação de status da implantação, diferentes status são retornados pela ferramenta de implantação de código para identificar o progresso ou o resultado da implantação.
IBM Code Engine status da implantação
Os status a seguir representam os estágios da implementação em IBM Code Engine :
Tabela 3. Status
Estágio Descrição Status
Criação de projeto Configuração de projetos e segredos PENDING, IN_PROGRESS, COMPLETED, FAILED
Construção de imagens Criação e envio de imagens PENDING, IN_PROGRESS, COMPLETED, FAILED
Implementação do aplicativo Criação de aplicativos, mapas de configuração e segredos PENDING, IN_PROGRESS, COMPLETED, FAILED
Nota:
  • Todos os três estágios são exibidos para indicar quais estágios foram concluídos, quais estão em andamento e quais ainda estão pendentes.
  • Se alguma parte do processo falhar, o estágio com falha exibirá o status FAILED e um motivo para a falha.
  • Se todos os estágios exibirem o status COMPLETED (concluído ), a ferramenta fornecerá o aplicativo URL e o nome do aplicativo.
  • Certifique-se de que o documento de origem OpenAPI, a partir do qual o aplicativo implantado foi gerado, esteja atualizado para usar o aplicativo IBM Code Engine URL como o valor do servers[0].url. Isso é essencial se a próxima ação planejada for criar um rascunho de API e publicá-lo em API Connect usando a ferramenta API Connect Task.