Deployer

Deployer is the implementation of the feature described in OpenServerless Issue 156.

Specifically, the deployer can extend a default runtime with user-defined “requirements” by generating a new “extended” user runtime and pushing it to OpenServerless’ internal Docker registry.

Actually, the supported “requirements” are listed in the following table:

kind	requirement file
go	go.mod
java	pom.xml
nodejs	package.json
php	composer.json
python	requirements.txt
ruby	Gemfile
dotnet	project.json

NOTE: this list will be improved when new extendible runtimes will be ready.

The “requirement” can be passed as base64 encoded string inside the file attribute of the json body payload:

{
  "source": "apache/openserverless-runtime-python:v3.13-2506091954", 
  "target": "devel:python3.12-custom", 
  "kind": "python", 
  "file": "Z25ld3MKYmVhdXRpZnVsc291cDQ="
}

By default the deployer will push to OpenServerless internal docker registry. To detect the host, it will use the registry_host inside the Operator's config map. To authenticate, it will use the imagePullSecret named registry-pull-secret (these credentials are valid to push and pull from the internal registry).

The deployer supports also pushing to an external private docker registry, using ops env:

REGISTRY_HOST - put here the hostname:port of the external private registry.
REGISTRY_SECRET - put here the name of a kubernetes secret containing an imagePullSecret able to push to the registry specified by REGISTRY_HOST.

This project has also support tasks:

to test the build.
to interact with OpenServerless internal registry too.

See Examples section

Endpoints

POST /system/api/v1/build/start - Perform the build of a custom image and push it to repository.

POST /system/api/v1/build/cleanup - Perform cleanup of build jobs older than 24 hours (or different number of hours if otherwise specified)

Both endpoints requires the wsk token in an authorization header. The token will be used to check the user (the target image hash needs to be always in the format user:image-tag).

Available tasks

task: Available tasks for this project:

* builder:clean:               Cleanup old build jobs via api
* builder:cleanjobs:           Clean up old jobs
* builder:delete-image:        Delete an image from the registry
* builder:get-image:           Get an image from the registry
* builder:list-catalogs:       List catalogs in the registry
* builder:list-images:         List images in a specific catalog
* builder:logs:                Show logs of the last build job
* builder:send:                Send the build to the server
* builder:updatetoml:          Update the buildkitd.toml file config map

Examples

Build a custom runtime

task builder:send SOURCE=apache/openserverless-runtime-python:v3.13-2506091954 TARGET=devel:python3.13-custom KIND=python REQUIREMENTS=$(base64 -i deploy/samples/requirements.txt)

Clenaup of old jobs via API

task builder:clean MAX_AGE_HOURS=2

MAX_AGE_HOURS, if not specified, has a default value of 24.

List images for the user

task builder:list-images CATALOG=devel

Delete an image for the user

task builder:delete-image IMAGE=devel:alpine