Saltar al contenido principal

Módulos personalizados

Puedes desplegar tu módulo con tu funcionalidad utilizando la API del desarrollador.

Desarrollo​

Utiliza la plantilla https://github.com/OneEntry/module-example y sigue las instrucciones en https://github.com/OneEntry/custom-module-deployment-guide durante el desarrollo.

Construcción​

  • Crea un nuevo token de proyecto con permisos read-registry. Se recomienda crear un token de duración indefinida.
  • Crea una nueva etiqueta en git (con cada lanzamiento de una nueva versión del módulo)
  • Espera a que finalice el pipeline, después de lo cual la imagen docker del módulo se cargará en el registro y estará disponible para el despliegue.

Despliegue​

Ve a la configuración, sección "Módulos" y desplázate hacia abajo para acceder al formulario de adición de módulo.

  • Indica el nombre y el marcador del módulo.

  • En el campo Url de la imagen indica la ruta a la imagen docker previamente construida en el formato host/user/repo:version.

    Donde host es el nombre del host del registro docker, por ejemplo registry.gitlab.com,

    user es el id del usuario o de la organización, por ejemplo oneentry,

    repo es el nombre del repositorio, por ejemplo my-module

    version es el nombre de la etiqueta (versión del módulo)

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

  • En el campo Host de Docker indica el host del registro docker, que repite la parte host de la ruta a la imagen docker, por ejemplo registry.gitlab.com

  • En los campos Id del token y Token indica el nombre del token (indicado al crearlo) y el propio token (que generalmente comienza con glpat) respectivamente.

  • Indica las variables de entorno necesarias (env) requeridas para el funcionamiento del módulo (se pueden modificar más tarde).

Después de crear el módulo, aparecerá en la tabla. Ahora puedes desplegarlo haciendo clic en Deploy (esto tomará un tiempo).

Estados del contenedor​

  • No desplegado - El módulo ha sido creado, pero aún no ha sido desplegado.
  • Desplegando - El módulo está en proceso de despliegue.
  • En ejecución - El módulo está funcionando.
  • Suspendido - El módulo está desplegado, pero no está en ejecución.

Acciones con el módulo​

  • Suspend Suspender el módulo. Detiene el proceso, pero los datos permanecen.
  • Resume Reanudar el funcionamiento del módulo. Inicia el proceso.
  • Delete Eliminar el módulo. Detendrá el proceso, eliminará el contenedor y los datos asociados.

Depuración de errores​

Si no se pudo desplegar el módulo o el proceso finaliza sistemáticamente, verás Warn.

Problemas posibles​

  • Imagen docker mal configurada.
  • Token inválido o incorrecto.
  • El proceso finaliza. El proceso interno no debe finalizar mientras el módulo esté activo.

Registro​

Otros problemas con el módulo se pueden depurar utilizando los registros que se muestran en la configuración del módulo.

Actualización/edición del módulo​

Si es necesario desplegar una nueva versión del módulo o cambiar las variables de entorno, debes actualizar la etiqueta y/o las variables en la configuración. El proceso se reiniciará.