How to share apps/components as Docker images

Software (apps/components) from frameworks and technologies other than UIMA and GATE must be registered in OpenMinTeD as Docker images.

Don't forget! Check that your software complies with at least the minimal level of the OpenMinTeD interoperability requirements and recommendations.

Step 1 - Preparing and packaging

To build an OpenMinTeD-compatible Docker image of apps/components, in addition to the Docker guidelines, you must follow the relevant OpenMinTeD specifications for dockerized components and upload it to the Docker hub.

Step 2 - Adding in the OpenMinTeD platform

You can then visit the OpenMinTeD registry where you can register your app/component in one of the following ways:

  • edit from scratch the OMTD-SHARE metadata record1 using the OpenMinTeD editor or

  • upload an XML file with the OMTD-SHARE metadata record.

In both cases, as long as the metadata record is private (i.e. the metadata element "public" has the value "no"), it can be viewed and edited at the end of the process.

Important: the following elements must be in the metadata record as described below, otherwise the app/component will not run!

  • OpenMinTeD looks into the Central Docker hub to locate the docker images; so, please provide in the element distributionLocation (a) the docker image name and (b) the version; i.e. OpenMinTeD will use the command "docker pull image_name:version" to retrieve the image, so in the distributionLocation you must add image_name:version

    <distributionLocation>bibliome/alvisengine:1.0.0</distributionLocation>

  • Please add the command for invoking the app/component in the metadata element command, e.g.

    <command>alvisnlp org.bibliome.alvisnlp.modules.ccg.CCGParser</command>

The command element must (a) only contain your executor i.e. the part required to run your command by excluding the parameters and their respective values, and (b) be available to run from everywhere in the docker image (i.e. add your executor in the /usr/bin/ or use absolute paths).


1. You can find examples of OMTD-SHARE metadata records here.

results matching ""

    No results matching ""