On-Boarding docker image model or docker URI model user guide

1: How to onboard a docker image model ?

Acumos allows users to onboard their docker image models. Each model dockerised outside acumos by modelers can be onboarded in Acumos. You just have to use the “Onboard dockerised model” panel in the “on-boarding model” page of the Acumos portal. In this panel just type the name of the model and you will received the Acumos image reference to be used to push your docker image model in Acumos. This Acumos image reference looks like :

<acumos_domain>:<docker_proxy_port>/modelname_soultion_id:tag

Then users have to follow the three steps depicted here :

1 : Authenticate in the Acumos docker registry

docker login https://<acumos_domain>:<docker_proxy_port> -u <acumos_userid> -p <acumos_password>

2 : Tag the docker image model with the Acumos image reference

docker tag my_image_model <acumos_domain>:<docker_proxy_port>/modelname_solution_id:tag

3 : Push the model in Acumos

docker push <acumos_domain>:<docker_proxy_port>/modelname_solution_id:tag

The process of on-boarding a docker image model in Acumos is reduced to create a solution Id and upload the model. There are no micro-service, nor tosca file, nor metadata file, nor protobuf file created. Acumos doesn’t request a license file during the on-boarding, if needed modelers can add a license file in their docker image model before the on-boarding.

2 : How to onboard a docker URI model ?

Acumos allows users to save all their docker image model URI. For each dockerised models, that have been previously stored by modelers in docker repo like Docker Hub for example, modelers have just to use the “Onboard dockerised model URI” panel in the “on-boarding model” page of the Acumos portal. In this panel, type the name of the model and the Host, optionally you can fill the port an the tag.

It is also possible to on-board a licence file associated with your docker URI model. Just drag and drop or browse your licence file to on-board it. The license profile file name must be “license.json”, if the license profile file extension is not ‘json’ the license profile on-boarding will not be possible and if the name is not ‘license’ Acumos will rename your license profile file as license.json and you will see your license profile file named as license.json in the artifacts table. If you upload a new version of your license profile after on-boarding, a number revision will be added to the name of your license profile file like : “license-2.json”. To help user create the license profile file expected by Acumos a license profile editor user guide is available here : License profile editor user guide

The process of on-boarding a docker URI model in Acumos is reduced to create a solution Id, save the URI and if needed associate a license profile file with this URI. There are no micro-service, nor tosca file , nor metadata file, nor protobuf file created.

3 : Common to Dockerized Model URI and Dockerized Model

Whatever the case you can on-board a protobuf file and/or a license file associated with your model by browsing or drag and drop (These two files are optional). The protobuf file will allow you to use your model in Design Studio.