How-tos

Running Go Programs as IBM Cloud Functions

Share this post:

IBM Cloud Functions is a functions-as-a-service platform that is powered by Apache OpenWhisk. It is a readily extensible serverless platform that supports functions authored in various programing languages including Node.js,PythonSwiftJava, and PHP.

A feature of IBM Cloud Functions that has been around for some time but not well documented is support for native binaries: any executable that is binary compatible with a standard OpenWhisk container may run as a serverless function. 

This approach affords you an even greater choice of languages for your serverless applications. You can develop using GoRust, and even C and C++. Moreover, functions may be composed irrespective of their implementation language, empowering you to use the right language for the task at hand while building complex serverless applications.

The native executable must conform to the following conventions:

  • The program shall accept a single command line argument as input. The argument is a JSON object that is encoded as a string. The object represents the input argument to the function.
  • The program must return a JSON object as a JSON formatted string, emitted to stdout as the final log line before the program terminates.
  • The program may log to stdout and stderr otherwise as desired.
  • The executable program must be called exec and should be self-contained (e.g., statically linked). Otherwise, make sure to package all dependencies.

Showing not telling

I’ll illustrate the capability by writing a program in Go and running it using IBM Cloud Functions. The source below is a variant of an example I’ve used before to explain Docker actions.

package main

import "encoding/json"
import "fmt"
import "os"

func main() {
    // program receives one argument: the JSON object as a string
    arg := os.Args[1]

    // unmarshal the string to a JSON object
    var obj map[string]interface{}
    json.Unmarshal([]byte(arg), &obj)

    // can optionally log to stdout (or stderr) 
    fmt.Println("hello Go action")

    name, ok := obj["name"].(string)
    if !ok { name = "Stranger" }

    // last line of stdout is the result JSON object as a string
    msg := map[string]string{"msg": ("Hello, " + name + "!")}
    res, _ := json.Marshal(msg)
    fmt.Println(string(res))
}

Save the code above to a file sample.go and build it. You must set the GOOS and GOARCH properties to cross-compile the binary if you build the binary on another platform. The executable must be called exec.

GOOS=linux GOARCH=amd64 go build -o exec

The rest is standard OpenWhisk workflow to create an action. The executable must be Zip compressed. And the action is created using the --native parameter to indicate this is a native executable using the wsk command line interface.

zip exec.zip exec
wsk action create helloGo --native exec.zip

The action is invoked as any other action.

$ wsk action invoke helloGo -r -p name Gopher 
{
    "msg": "Hello, Gopher!"
}

Logs may be fetched using wsk as well.

$ wsk activation logs --last --strip
my first Go action.

The Go action may be turned into a web action, to make it accessible via a browser or curl.

$ wsk action update helloGo --web true
$ curl `wsk action get helloGo --url | tail -1`.json?name=GoWeb
{
  "msg": "Hello, GoWeb!"
}

Beyond Golang

You run a Rust action in a similar way using the steps described in another blog. In general, any binary that you statically compile may run as a native action. This makes IBM Cloud Functions, or your own deployment of OpenWhisk, a flexible platform for serverless computing. Try it and join the growing OpenWhisk community on Slack. You can also contribute on GitHub.

More How-tos stories
January 11, 2019

Deploying to IBM Cloud Environments with IBM Cloud Developer Tools CLI

Learn how to deploy applications to IBM Cloud and IBM Cloud Private environments using IBM Cloud Developer Tools CLI version 2.1.12.

Continue reading

January 11, 2019

How-To: Running HA IBM DB2 on Kubernetes

You can easily run an HA IBM Db2 container on Kubernetes using Portworx for replication, snapshots, backups, volume resizing, and even encryption.

Continue reading

January 8, 2019

Getting Started with pgRouting on IBM Cloud Databases for PostgreSQL Using Esri Shapefiles

We are going to look at how to upload an Esri shapefile of Seattle streets, layer on a set of locations throughout Seattle, and then find the shortest paths to those points using the street network.

Continue reading