bootstrap

README

faas-provider

This faas-provider can be used to write your own back-end for OpenFaaS. The Golang SDK can be vendored into your project so that you can provide a provider which is compliant and compatible with the OpenFaaS gateway.

The faas-provider provides CRUD for functions and an invoke capability. If you complete the required endpoints then you will be able to use your container orchestrator or back-end system with the existing OpenFaaS ecosystem and tooling.

See also: backends guide

Recommendations

The following is used in OpenFaaS and recommended for those seeking to build their own back-ends:

• License: MIT
• Language: Golang

How to use this project

All the required HTTP routes are configured automatically including a HTTP server on port 8080. Your task is to implement the supplied HTTP handler functions.

For an example see the server.go file in the faas-netes Kubernetes backend.

I.e.:

	timeout := 8 * time.Second
	bootstrapHandlers := bootTypes.FaaSHandlers{
		FunctionProxy:  handlers.MakeProxy(),
		DeleteHandler:  handlers.MakeDeleteHandler(clientset),
		DeployHandler:  handlers.MakeDeployHandler(clientset),
		FunctionReader: handlers.MakeFunctionReader(clientset),
		ReplicaReader:  handlers.MakeReplicaReader(clientset),
		ReplicaUpdater: handlers.MakeReplicaUpdater(clientset),
		InfoHandler:    handlers.MakeInfoHandler(),
		LogHandler: logs.NewLogHandlerFunc(requestor,timeout),
	}

	var port int
	port = 8080
	bootstrapConfig := bootTypes.FaaSConfig{
		ReadTimeout:  timeout,
		WriteTimeout: timeout,
		TCPPort:      &port,
	}

	bootstrap.Serve(&bootstrapHandlers, &bootstrapConfig)

Need help?

Join #faas-provider on OpenFaaS Slack

Documentation

Index

• Constants
• func Router() *mux.Router
• func Serve(handlers *types.FaaSHandlers, config *types.FaaSConfig)

Constants

const NameExpression = "-a-zA-Z_0-9."

NameExpression for a function / service

Functions

func Router

func Router() *mux.Router

Router gives access to the underlying router for when new routes need to be added.

func Serve

func Serve(handlers *types.FaaSHandlers, config *types.FaaSConfig)

Serve load your handlers into the correct OpenFaaS route spec. This function is blocking.