out of date: please refer to https://github.com/vmware/dispatch/tree/master/examples/blog

Prerequisite

Dispatch

You will need a dispatch cluster deployed and configured, please follow the quick start instruction at dispatch repository.

You will need the url of your dispatch installation. e.g.

DISPATCH_HOST=dev.dispatch.vmware.com
DISPATCH_API_HOST=api.dev.dispatch.vmware.com

For minikube deployment, keep a note of the port of your dispatch host and dipatch api-gateway host.

Minio

Minio is a S3 compatible object store, we use it to store blog posts. You can deploy a minio server locally or use S3 instead.

Here we briefly provide a simple way to deploy minio in a kubernetes cluster with helm, if you have deployed dispatch, you should already have a kubernetes cluter and helm ready.

helm upgrade minio --install --namespace minio --set serviceType=NodePort stable/minio

You need to keep a note of minio credentials, including hostname, port, accessKey, secretKey.

For minio deployed in kubernetes:

hostname will be your kubernetes cluster hostname,

get port with kubectl get svc -n minio,

get accessKey and secretKey with

kubectl get secret minio-minio-user -n minio -o yaml

Build the image

export docker_user=<your-docker-username>
docker build -t ${docker_user}/dipatch-nodejs6-blog-webapp:0.0.1-dev1 ./base-image
docker push ${docker_user}/dipatch-nodejs6-blog-webapp:0.0.1-dev1

Register the image with Dispatch

dispatch delete base-image blog-webapp-base-image
dispatch delete image blog-webapp-image
dispatch create base-image blog-webapp-base-image ${docker_user}/dipatch-nodejs6-blog-webapp:0.0.1-dev1 --language=nodejs6
dispatch create image blog-webapp-image blog-webapp-base-image

Secret

NOTE:

currently as injecting secret from api-gateway is not supported, this secret is actually not used, you can safely skip this section, but you need to hardcode your minio credientials in the post.js code.

{
    "endPoint": "<minio-host>"
    "port": <minio-port>
    "accessKey": "<access-key>",
    "secretKey": "<secret-key>",
}

END of NOTE

TODO: add instructions on how to create secret.json and have a template of it

dispatch delete secret blog-webapp-secret
dispatch create secret blog-webapp-secret secret.json

Upload the post.js as a Dispatch function

dispatch delete function post
dispatch create function blog-webapp-image post post.js

Milestone I: Execute the uploaded function with dispatch cli

Use dispatch cli to test if your images, secrets and functions are deployed correctly and ready to be used.

dispatch exec post --secret blog-webapp-secret --input '{"op":"add", "post":{"id":"126", "title":"helloworld", "content":"this is a content"}}' --wait
dispatch exec post --secret blog-webapp-secret --input '{"op":"get", "post":{"id":"126"}}' --wait
dispatch exec post --secret blog-webapp-secret --input '{"op":"update", "post":{"id":"126", "title":"nihao", "content":"nihao"}}' --wait
dispatch exec post --secret blog-webapp-secret --input '{"op":"list"}' --wait
dispatch exec post --secret blog-webapp-secret --input '{"op":"delete", "post":{"id":"126"}}' --wait

Create APIs

APIs are used by the blog webapp client (an angular2.0 project)

dispatch delete api list-post-api
dispatch delete api get-post-api
dispatch delete api update-post-api
dispatch delete api add-post-api
dispatch delete api delete-post-api

dispatch create api list-post-api post --auth public -m GET --path /post/list --cors
dispatch create api get-post-api post --auth public -m GET  --path /post/get --cors
dispatch create api add-post-api post --auth public -m POST  --path /post/add --cors
dispatch create api update-post-api post --auth public -m PATCH --path /post/update --cors
dispatch create api delete-post-api post --auth public -m DELETE --path /post/delete --cors

Milestone II: Execute the function via API Gateway

In this milestone, you want to test if your function works well via dispatch api-gateway.

If your dispatch is locally deployed, in this step, you need the https port on which your dispatch api-gateway is hosted on.

export DISPATCH_API_PORT=31841
curl -X POST https://api.dev.dispatch.vmware.com:${DISPATCH_API_PORT}/post/add -k -d '{
    "op": "add",
    "post":{
        "id": "1234",
        "title": "foo",
        "content":"bar bar bar"
    }
}'

curl -X GET https://api.dev.dispatch.vmware.com:${DISPATCH_API_PORT}/post/get?op=get\&post=1234 -k
curl -X GET https://api.dev.dispatch.vmware.com:${DISPATCH_API_PORT}/post/list?op=list -k

curl -X PATCH https://api.dev.dispatch.vmware.com:${DISPATCH_API_PORT}/post/update -k -d '{
    "op": "update",
    "post":{
        "id": "1234",
        "title": "foo",
        "content":"foo foo foo"
    }
}'

curl -X DELETE https://api.dev.dispatch.vmware.com:${DISPATCH_API_PORT}/post/delete -k -d '{
    "op": "delete",
    "post": { "id": "1234"}
}'

After completing this milestone, it is a good time to deploy a front-end web-app(UI), which provides a friendly user interface for your blog.

Please go ahead and check dispatch-example-blog-web-client