Saltar al contenido principal

Módulos Personalizados

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

Desarrollo​

Utiliza la plantilla en 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 de read-registry. Se recomienda crear un token permanente.
  • Crea una nueva etiqueta en git (con cada lanzamiento de una nueva versión del módulo).
  • Espera a que se complete la canalización, después de lo cual la imagen de docker del módulo se subirá al registro y estará disponible para su 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ódulos.

  • Especifica el nombre y la etiqueta del módulo.

  • En el campo URL de la Imagen, proporciona la ruta a la imagen de docker previamente construida en el formato host/user/repo:version.

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

    user es el ID del usuario u 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).

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

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

  • En los campos ID de Token y Token, proporciona el nombre del token (como se especificó durante la creación) y el token en sí (que generalmente comienza con glpat), respectivamente.

  • Especifica las variables de entorno necesarias (env) requeridas para que el módulo funcione (estas se pueden cambiar más tarde).

Después de crear el módulo, aparecerá en la tabla. Ahora puedes desplegarlo haciendo clic en Desplegar (esto tomará algún 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 ser desplegado.
  • Ejecutándose - El módulo está operativo.
  • Suspendido - El módulo está desplegado pero no está en ejecución.

Acciones del Módulo​

  • Suspender Suspender el módulo. Detiene el proceso, pero los datos permanecen.
  • Reanudar Reanudar el módulo. Inicia el proceso.
  • Eliminar Eliminar el módulo. Detiene el proceso, elimina el contenedor y los datos asociados.

Depuración de Errores​

Si el módulo no se despliega o el proceso termina de manera consistente, verás Advertencia.

Problemas Posibles​

  • La imagen de docker está configurada incorrectamente.
  • El token es inválido o incorrecto.
  • El proceso termina. El proceso interno no debería terminar mientras el módulo esté activo.

Registro​

Puedes depurar otros problemas con el módulo utilizando los registros mostrados en la configuración del módulo.

Actualización/Edición del Módulo​

Si necesitas 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á.

.