Repository files navigation

ATTENTION: This is the Solo branch of Dispatch. Read theDispatchSolo section to understand what that means.

Dispatch is a framework for deploying and managing serverless style applications. The intent is a frameworkwhich enables developers to build applications which are defined by functions which handle business logic and serviceswhich provide all other functionality:

• State (Databases)
• Messaging/Eventing (Queues)
• Ingress (Api-Gateways)
• Etc.

Our goal is to provide a substrate which can be built upon and extended to serve as a framework for serverlessapplications. Additionally, the framework must provide tools and features which aid the developer in building,debugging and maintaining their serverless application.

Dispatch Solo is a simplified branch of Dispatch. The objective is to remove as many dependencies as possiblewhile maintaining functionlity. Dispatch Solo is a single binary which only relies on Docker as dependency,distributed as an OVA. The trade-off of this simplification is scale and persistence. However, it is the perfectplatform for evaluation and learning.

Checkout the detaileddocumentation including aquickstart guide.

The diagram below illustrates the different components which make up the Dispatch project:

The quickest way to deploy Dispatch Solo is using the OVA, following the documentation in thequickstart guide. Alternatively, Dispatch Solo can be built from source by following the instructions below.

• Golang
• Docker

Clone the repository and update your GOPATH:

mkdir -p$HOME/dispatch/go/src/github.com/vmwarecd$HOME/dispatch/go/src/github.com/vmwaregit clone git@github.com:vmware/dispatch.gitcd dispatchgit checkout origin/soloexport GOPATH=$HOME/dispatch/go

Build and run Dispatch CLI and server (Mac):

make darwincp ./bin/dispatch-darwin /usr/local/bin/dispatch./bin/dispatch-server-darwin

Build and run Dispatch CLI and server (Linux):

make linuxcp ./bin/dispatch-linux /usr/local/bin/dispatch./bin/dispatch-server-linux

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

mkdir$HOME/.dispatchcat<<EOF >$HOME/.dispatch/config.json{    "current": "solo",    "contexts": {        "solo": {            "port": 8080,            "scheme": "http",            "organization": "dispatch-server",            "cookie": "cookie",            "insecure": true        }    }}EOF

To run the end to end tests:

API_GATEWAY_HTTP_HOST=http://localhost:8081 ./e2e/scripts/run-e2e.sh e2e/tests

You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pullrequests, and do our best to process them as fast as we can. If you wish to contribute code and you have not signed ourcontributor license agreement (CLA), our bot will update the issue when you open aPullRequest. For any questions about the CLA process, pleaserefer to ourFAQ.

Before you start to code, we recommend discussing your plans through aGitHubissue or discuss it first with the official projectmaintainers via the#Dispatch Slack Channel, especiallyfor more ambitious contributions. This gives other contributors a chance to point you in the right direction, give youfeedback on your design, and help you find out if someone else is working on the same thing.

Dispatch is available under theApache 2 license.