Instructions

Publishing an image in the registry

Prerequisites

info

You can use npx and pipx tools to run gvmkit-build without installation.

Introduction

Once your image is built and tested you can push it to a remote repository so that it becomes available to providers within the Golem Network. Golem manages a freely-accessible repository that everybody can push into without any special requirements. You can identify your image by a hash or by a tag.

If you intend to use your image just for testing, it is enough to upload it anonymously and use its hash to identify it. On the other hand, if you plan to work on a more complex project where you would like to use several different versions of your image or collaborate with other users - you should consider creating an account in the registry and using tags to describe your images. Both cases are illustrated below.

Publishing a custom Golem image to the registry (hash-based)

If you have your gvmi image built from a Docker image you can push it to the repository with the following command:

gvmkit-build --direct-file-upload <my-image-filename>.gvmi --push --nologin
info

After conversion, the resultant GVMI file is placed in the current working directory. By default, the image name is a Docker image name followed by a part of its hash. When you push the GVMI image using this method you need to provide the name of the .gvmi file.

You can convert your Docker image and push the Golem image to the repository with one command:

gvmkit-build docker-image-name --push --nologin

Publishing a custom Golem image to the registry (tag-based)

Golem image tags have a format of username/repository_name:tag, where:

  • username is your login to the registry portal,
  • repository_name is the name of your repository,
  • and tag is the text that you chose to describe the content/version of the image. The tag can be latest to constantly keep the latest version, or you can use a versioning system and e.g. make it v0.0.1 and so on.

Let's assume for this example your username is golem, your Docker image is tagged golem-example, your repository name is my_example and the version is latest.

  1. Create an account on the registry portal.
  2. Create a repository on the registry portal.
  3. Create and copy a personal access token from the registry portal.
  4. Run the following command (you will be asked for your login and personal access token)
gvmkit-build golem-example --push-to golem/my_example:latest

or if you do not have gvmkit-build installed:

npx gvmkit-build golem-example --push-to golem/my_example:latest

Your tag golem/my_example:latest is ready to use in one of Golem Network APIs

Next steps
See also