Installing Dispatch using Dispatch Solo OVA

Dispatch can be installed as an all-in-one OVA. The OVA can be deployed on VMware ESXi™, VMware vCenter Server®, VMware Fusion®, VMware Workstation Player™, or VMware Workstation Pro™ and contains a single virtual machine that runs dispatch-server. Use this OVA to get to know Dispatch.

Download Dispatch OVA

Download the latest Dispatch Solo OVA in your web browser or using a command-line tool like curl:

$ curl -OL

Deploy the OVA

When you deploy the OVA to the environment of your choice, you will be prompted to provide some configuration options. Configure those that you need, but if you have DHCP enabled, only the password field should be required:

Importing Dispatch OVA. Only password is required.

Start the Virtual Appliance

Once the VM has started, log in as the root user using the password you configured during OVA deployment. (Note: this process will change in future versions.) You can use Dispatch right away — the CLI inside the VM is preconfigured and can be used to deploy functions!

Dispatch VM comes with CLI preinstalled

Download Dispatch CLI

You may run the Dispatch CLI locally and point it to your Dispatch VM.

Get the Latest Release Version

export LATEST=$(curl -s | jq -r .name)

Note: If you don’t have jq and don’t want to install it, you can just manually parse the JSON response and grab the version.

For macOS

$ curl -OL$LATEST/dispatch-darwin
$ chmod +x dispatch-darwin
$ mv dispatch-darwin /usr/local/bin/dispatch

For Linux

$ curl -OL$LATEST/dispatch-linux
$ chmod +x dispatch-linux
$ mv dispatch-linux /usr/local/bin/dispatch

Configure and install Dispatch CLI:

Fetch the IP address of your Dispatch VM that is reachable from your machine, as this will be used the host for Dispatch services. The simplest way of getting your IP address is simply running ifconfig eth0 from within the VM:

Get IP

export DISPATCH_HOST= # replace with your IP

Create a Dispatch config file $HOME/.dispatch/config.json like this:

cat << EOF > $HOME/.dispatch/config.json
    "current": "solo",
    "contexts": {
        "solo": {
            "host": "${DISPATCH_HOST}",
            "port": 8080,
            "scheme": "http",
            "organization": "dispatch",
            "cookie": "cookie",
            "insecure": true,
            "api-https-port": 443

Hello World

At this point, the environment is up and working. Seed the service with some images and build our first function:

$ dispatch create seed-images
Created BaseImage: nodejs-base
Created BaseImage: python3-base
Created BaseImage: powershell-base
Created BaseImage: java-base
Created Image: nodejs
Created Image: python3
Created Image: powershell
Created Image: java
$ dispatch get images
     NAME    |   URL                |    BASEIMAGE    | STATUS | CREATED DATE
  java       | dispatch/f23f029e... | java-base       | READY  | ...
  nodejs     | dispatch/6f04f67d... | nodejs-base     | READY  | ...
  powershell | dispatch/edcbdda8... | powershell-base | READY  | ...
  python3    | dispatch/1937b329... | python3-base    | READY  | ...

Create a function:

$ cat << EOF >
def handle(ctx, payload):
    name = "Noone"
    place = "Nowhere"
    if payload:
        name = payload.get("name", name)
        place = payload.get("place", place)
    return {"myField": "Hello, %s from %s" % (name, place)}
$ dispatch create function hello-world --image python3 ./
Created function: hello-world

Wait for the function to become READY:

$ dispatch get function
  hello-world | dispatch/func-ead7912d... | READY  | ...

Execute the function:

$ dispatch exec hello-world --input '{"name": "Jon", "place": "Winterfell"}' --wait
    "blocking": true,
    "executedTime": 1542240146,
    "faasId": "ead7912d-1f18-4577-91ee-de4415ee10d0",
    "finishedTime": 1542240146,
    "functionId": "7f37559d-a182-446f-bb6f-b41fbcff1368",
    "functionName": "hello-world",
    "input": {
        "name": "Jon",
        "place": "Winterfell"
    "logs": {
        "stderr": null,
        "stdout": null,
    "name": "09bc2e3b-bc7a-49b3-ac23-e11a3ade89a5",
    "output": {
        "myField": "Hello, Jon from Winterfell"
    "reason": null,
    "secrets": [],
    "services": null,
    "status": "READY",
    "tags": []

Check out the examples section for a full list of examples.

Now go build something!