Skip to main content

Custom Modules

You can deploy your module with your functionality using the developer API.

Development​

Use the template https://github.com/OneEntry/module-example and follow the instructions at https://github.com/OneEntry/custom-module-deployment-guide during development.

Build​

  • Create a new project token with read-registry permissions. It is recommended to create a permanent token.
  • Create a new tag in git (with each release of a new version of the module)
  • Wait for the pipeline to complete, after which the docker image of the module will be uploaded to the registry and available for deployment.

Deployment​

Go to settings, the "Modules" section, and scroll down to the module addition form.

  • Specify the name and tag of the module.

  • In the Image URL field, specify the path to the previously built docker image in the format host/user/repo:version.

    Where host is the name of the docker registry host, for example registry.gitlab.com,

    user is the user or organization id, for example oneentry,

    repo is the name of the repository, for example my-module

    version is the tag name (module version)

    Full example: registry.gitlab.com/oneentry-skd-js/test-module:prod-v1.0.10

  • In the Docker host field, specify the docker registry host, which repeats the host part in the docker image path, for example registry.gitlab.com

  • In the Token Id and Token fields, specify the name of the token (as specified during creation) and the token itself (usually starts with glpat), respectively.

  • Specify the necessary environment variables (env) required for the module to work (can be changed later).

After creating the module, it will appear in the table. Now you can deploy it by clicking Deploy (this will take some time).

Container Statuses​

  • Not Deployed - The module is created but has not been deployed yet.
  • Deploying - The module is in the process of being deployed.
  • Running - The module is operational.
  • Suspended - The module is deployed but not running.

Module Actions​

  • Suspend Suspend the module. Stops the process, but the data remains.
  • Resume Resume the module. Starts the process.
  • Delete Delete the module. Stops the process, deletes the container, and associated data.

Debugging Errors​

If the module failed to deploy or the process consistently terminates, you will see Warn.

Possible Issues​

  • Incorrectly configured docker image.
  • Invalid or incorrect token.
  • The process terminates. The internal process should not terminate while the module is active.

Logging​

You can debug other issues with the module using the logs displayed in the module settings.

Updating/Editing the Module​

If you need to deploy a new version of the module or change environment variables, you must update the tag and/or variables in the settings. The process will be restarted.

.