Publish Your Pod Image to Jina Hub

You can contribute your executor into this repository and it will be automatically built into an image and published to the Jina Hub via our CI/CD pipeline.

What Files Need to be Uploaded?

Typically, the following files are required:

File Descriptions
Dockerfile describes the dependency setup and expose the entry point;
manifest.yml metadata of the image, author, tags, etc. help the Hub to index and classify your image
README.md a instruction for guiding users to use your image
*.py describes the executor logic written in Python, if applicable;
*.yml a YAML file describes the executor arguments and configs, if you want users to use your config;

Note, large binary files (such as pretrained model, auxiliary data) are not recommended to upload to this repository. You can use RUN wget ... or RUN curl inside the Dockerfile to download it from the web during the build.

Your file bundle awesomeness should be uploaded to:

hub/
  |
   - executors/
       |
        - encoders/
            |
            - awesomeness/
                |
                |- Dockerfile
                |- manifest.yml
                |- README.md
                |- awesome_ai.py

Your image will be published as jinaai/hub.executors.encoders.awesomeness.

Schema of manifest.yml

manifest.yml must exist if you want to publish your Pod image to Jina Hub.

manifest.yml annotates your image so that it can be managed by Jina Hub. To get better appealing on Jina Hub, you should carefully set manifest.yml to the correct values.

Key Description Default
name Human-readable title of the image (must match with ^[a-zA-Z_$][a-zA-Z_\s\-$0-9]{3,20}$) Required
description Human-readable description of the software packaged in the image Required
author contact details of the people or organization responsible for the image (string) Jina AI Dev-Team ([email protected])
url URL to find more information on the image (string) https://jina.ai
documentation URL to get documentation on the image (string) https://docs.jina.ai
version version of the image, it should be Semantic versioning-compatible 0.0.0
vendor the name of the distributing entity, organization or individual (string) Jina AI Limited
license license under which contained software is distributed, it should be in this list apache-2.0
avatar a picture that personalizes and distinguishes your image None
platform a list of CPU architectures that your image is built on, each item should be in this list [linux/amd64]

Please refer to hub/examples/mwu_encoder/manifest.yml for the example.

Steps to Publish Your Image

All you need is to publish your bundle into this repo, the Docker image building, uploading and tagging are all handled automatically by our CICD pipeline.

  1. Let’s say your organize all files mentioned in here in a folder called awesomeness. Depending on what you are contributing, you can put it into hub/executors/indexers/awesomeness.

  2. Make a Pull Request and commit your changes into this repository, remember to follow the commit lint style.

  3. Wait until the CICD finish and you get at least one reviewer’s approval.

  4. Merge it!

The CICD pipeline will work on building, uploading and tagging the image on the Jina Hub.

The image will be available at jinaai/hub.executors.indexers.awesomeness:0.0.0 assuming your version number is defined as 0.0.0 in manifest.yml.

You can use the image as the ways we described here.

Why My Upload Fails on the CICD?

Here is the checklist to help you locate the problem.

  • [ ] Required file Dockerfile, manifest.yml, README.md is missing.

  • [ ] The required field in manifest.yml is missing.

  • [ ] Some field value is not in the correct format, not passing the sanity check.

  • [ ] The pod bundle is badly placed.

  • [ ] The build is success but it fails on three basic usage tests.

Click “Details” and check out the log of the CICD pipeline:

../../_images/5f4181e9.png