faas/guide

OpenFaaS guides & documentation

This page is a collection of our key blog posts, tutorials and guides while we prepare a dedicated site for documentation. For other queries please get in touch for a Slack invite or ping @openfaas on Twitter.

There is a PR underway for the new documentation site

Suggestions for new topics are welcome. Please also check the Issue tracker.

Deployment guides (start here)

A foreword on security

These instructions are for a development environment. If you plan to expose OpenFaaS on the public Internet you need to enable basic authentication with a proxy such as Kong or Traefik at a minimum. TLS is also highly recomended and freely available with LetsEncrypt.org. Kong guide Traefik guide.

Note: We are also looking to automate authentication "out the box" to cover edge cases.

• Kubernetes deployment

• Docker Swarm deployment

• DigitalOcean deployment (with Swarm)

Intermediate

• Workflows / Chaining functions

• Interacting with other containers/services

• Troubleshooting

• Asynchronous functions with NATS Streaming

• Submit a function to the OpenFaaS Function Store

• Secrets with OpenFaaS and Docker Swarm

• Hardening OpenFaaS with Kong & TLS

• Reference documentation for Function Watchdog

• An Introduction to Serverless DevOps with OpenFaaS

• WIP Debugging Functions

Blog posts and tutorials

Hands-on with Node.js / Go / Python

• Morning coffee with the OpenFaaS CLI

• Build a Serverless Golang Function with OpenFaaS

• Your first serverless Python function with OpenFaaS

Project background, design decisions and architecture:

• Introducing Functions as a Service (OpenFaaS)

• OpenFaaS presents to CNCF Serverless workgroup

• An Introduction to Serverless DevOps with OpenFaaS

Hands-on with containers as functions

• Serverless sorcery with ImageMagick

High-throughput

• Next-generation Watchdog (of-watchdog)

Raspberry Pi & ARM

Your Serverless Raspberry Pi cluster with Docker

Extend OpenFaaS

• Build a third-party provider

Deprecated

Afterburn is replaced by the of-watchdog listed above.

• OpenFaaS accelerates serverless Java with AfterBurn