Skip to content
This repository has been archived by the owner on Dec 15, 2020. It is now read-only.

Latest commit

 

History

History
56 lines (36 loc) · 2.63 KB

faas.md

File metadata and controls

56 lines (36 loc) · 2.63 KB
Raw

Go 'Serverless'

This is a guide to help you build and deploy OpenFaaS functions with Golang server

Requirements

  1. Golang server. CLI installed.
  2. Docker running on host.
  3. OpenFaaS CLI.
  4. OpenFaaS Gateway (Link to setup-guide) . Running & accessible OpenFaaS gateway.

Step 0

Create a new repository on github. I used the Desktop client and later switched to terminal.

Step 1 - Setup

Change your working directory to your github repository folder. Initialize a Golang server project within the repository with following command :

gos --make

Step 2 - Setup

Set FaaS gateway of project. Open the gos.gxml within your repository folder and update the second line of the file. Add the attribute gateway to specify the location of your OpenFaaS gateway. The example below is set to the default setting of OpenFaaS :

<gos gateway="http://localhost:8080">

Step 3 - Setup

Update your gos.gxml deploy tag content from webapp to faas.

Step 4 - Add

Serverless <end> tag

Add a new <end> tag within <endpoints> and voila you have a serverless function with full access to http.Request to retrieve body data. <end> tags with type attribute set to f or left blank will not be processed.

Templates

Templates are also processed into OpenFaas functions. More information about adding new templates with Golang server.

Step 5 - Build

Build and deploy functions with command

gos --run

Step 6 - Access

<end> tags :

Your <end>'s path attribute will be stripped of / (forward slashes) and the letter following it will be converted to uppercase. This will become the name of your function on OpenFaaS. The Stdin of this function will be converted into a request body.

<template> tags :

Your <template>'s name attribute will be the name of your OpenFaaS function. The Stdin of this function is a JSON string which will be converted to the tag's specified struct attribute.

Notes

With end tags write your response as usual with *http.ResponseWriter's Write func. Return JSON of your interfaces with this guide. I used this Go server repository for this guide. Template functions compile their linked .tmpl (with internal package html/template) file then write the output to Stdout. The session variable availble by default to <end> tags, only spans the scope of the request.