Pular para o conteúdo principal

Módulos Personalizados

Você pode implantar seu módulo com sua funcionalidade usando a API do desenvolvedor.

Desenvolvimento​

Use o template https://github.com/OneEntry/module-example e siga as instruções em https://github.com/OneEntry/custom-module-deployment-guide durante o desenvolvimento.

Construção​

  • Crie um novo token de projeto com permissões read-registry. É recomendável criar um token sem expiração.
  • Crie uma nova tag no git (a cada lançamento de uma nova versão do módulo)
  • Aguarde a conclusão do pipeline, após o qual a imagem docker do módulo será carregada no registry e estará disponível para implantação.

Implantação​

Vá para as configurações, seção "Módulos" e role para baixo para acessar o formulário de adição de módulo.

  • Informe o nome e o marcador do módulo

  • No campo Url da imagem informe o caminho para a imagem docker previamente construída no formato host/user/repo:version.

    Onde host - nome do host do docker registry, por exemplo registry.gitlab.com,

    user - id do usuário ou organização, por exemplo oneentry,

    repo - nome do repositório, por exemplo my-module

    version - nome da tag (versão do módulo)

    Exemplo completo: registry.gitlab.com/oneentry-skd-js/test-module:prod-v1.0.10

  • No campo Host Docker informe o host do docker registry, que repete a parte host do caminho para a imagem docker, por exemplo registry.gitlab.com

  • Nos campos Id do token e Token informe o nome do token (indicado na criação) e o próprio token (geralmente começa com glpat), respectivamente

  • Informe as variáveis de ambiente (env) necessárias para o funcionamento do módulo (pode ser alterado posteriormente)

Após a criação do módulo, ele aparecerá na tabela. Agora você pode implantá-lo clicando em Deploy (isso levará algum tempo).

Status do Contêiner​

  • Não implantado - Módulo criado, mas ainda não foi implantado
  • Implantando - Módulo está em processo de implantação
  • Em execução - Módulo está funcionando
  • Suspenso - Módulo implantado, mas não está em execução

Ações com o Módulo​

  • Suspend Suspender módulo. Para o processo, mas os dados permanecem
  • Resume Retomar o funcionamento do módulo. Inicia o processo
  • Delete Excluir módulo. Parará o processo, excluirá o contêiner e os dados relacionados

Depuração de Erros​

Se o módulo não puder ser implantado ou o processo falhar sistematicamente, você verá Warn.

Possíveis Problemas​

  • Imagem docker configurada incorretamente
  • Token inválido ou incorreto
  • O processo falha. O processo interno não deve falhar enquanto o módulo estiver ativo

Registro​

Outros problemas com o módulo podem ser depurados usando os logs exibidos nas configurações do módulo.

Atualização/Edição do Módulo​

Se for necessário implantar uma nova versão do módulo ou alterar as variáveis de ambiente, você deve atualizar a tag e/ou as variáveis nas configurações. O processo será reiniciado.

.