Pular para o conteúdo principal

Módulos Personalizados

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

Desenvolvimento​

Use o modelo em 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 permanente.
  • Crie uma nova tag no git (com 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 registro 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.

  • Especifique o nome e a tag do módulo.

  • No campo URL da Imagem, forneça o caminho para a imagem docker construída anteriormente no formato host/user/repo:version.

    Onde host é o nome do host do registro docker, por exemplo, registry.gitlab.com,

    user é o ID do usuário ou da organização, por exemplo, oneentry,

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

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

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

  • No campo Host Docker, especifique o host do registro docker, que repete a parte host no caminho da imagem docker, por exemplo, registry.gitlab.com.

  • Nos campos ID do Token e Token, forneça o nome do token (conforme especificado durante a criação) e o token em si (geralmente começa com glpat), respectivamente.

  • Especifique as variáveis de ambiente necessárias (env) exigidas para o funcionamento do módulo (essas podem ser alteradas posteriormente).

Após criar o módulo, ele aparecerá na tabela. Você pode agora implantá-lo clicando Deploy (isso levará algum tempo).

Status dos Contêineres​

  • Não Implantado - O módulo foi criado, mas ainda não foi implantado.
  • Implantando - O módulo está em processo de implantação.
  • Em Execução - O módulo está operacional.
  • Suspenso - O módulo está implantado, mas não está em execução.

Ações do Módulo​

  • Suspender Suspender o módulo. Para o processo, mas os dados permanecem.
  • Retomar Retomar o módulo. Inicia o processo.
  • Excluir Excluir o módulo. Para o processo, exclui o contêiner e os dados associados.

Depuração de Erros​

Se o módulo falhar ao implantar ou o processo terminar consistentemente, você verá Warn.

Possíveis Problemas​

  • A imagem docker está configurada incorretamente.
  • O token é inválido ou incorreto.
  • O processo termina. O processo interno não deve terminar enquanto o módulo estiver ativo.

Registro​

Você pode depurar outros problemas com o módulo usando os logs exibidos nas configurações do módulo.

Atualizando/Editando o Módulo​

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

.