Notes on building modules with Kube BISQUE.

[ivanfarevalo]

• Read the documentation on module development first.
• Read documentation on running Kube BISQUE in the discussions of this repo.

bisque.yaml

• Make sure that container port 8080 is set under ports:
• Mount your local directory that contains your module by specifying its path under volumeMounts and volumes.
• Make sure correct image is being pulled by specifying it under containers. At the time of writing, amilworks/bisque-module-dev:git is the correct image to use.

bisque-svc.yaml

• Make sure the port and target port match ports in bisque.yaml. The default port is 8080.

Custom Module

• It is strongly encouraged to format your source code in a way that reads data from an input folder and outputs data to an output folder. This will make communication with Bisque much easier.
• First step to build your custom module should be to dockerize your application.
• Create a folder with the name of your application and put your source code in a src folder.
• If your application is written in python3, you will need to include the python3 bqapi folder which is will be uploaded soon. For now you can copy it from nphprediction module.
• A base template image is being written that will include any dependencies needed by the bqapi for python3.
• Write the dockerfile for your module based on this template image and add any other dependencies needed for your application.
• Once your module runs successfully in the container you created, follow the module development documentation to write the PythonScriptWrapper, PythonScriptWrapper.py, xml file, and config file.
• IMPORTANT: make sure that the xml file has the same name as your module and folder name. If not, your module will not show up at time of registering the module.
• IMPORTANT: make sure to rebuild your module image including the bqapi folder, your source folder, and all the files necessary to run on bisque (pythonscriptwrapper, xml, etc).
• .....