Skip to content

aidun/openfaas-cloud

 
 

Repository files navigation

OpenFaaS Cloud

Managed OpenFaaS for teams

Conceptual diagram

The high-level workflow for the OpenFaaS Cloud CI/CD pipeline.

Introduction

Build Status

OpenFaaS Cloud introduces an automated build and management system for your Serverless functions with native integrations into your source-control management system whether that is GitHub or GitLab.

With OpenFaaS Cloud functions are managed through typing git push which reduces the tooling and learning curve required to operate functions for your team. As soon as OpenFaaS Cloud receives a push event from git it will run through a build-workflow which clones your repo, builds a Docker image, pushes it to a registry and then deploys your functions to your cluster. Each user can access and monitor their functions through their personal dashboard.

Features:

  • Portable - self-host or use the hosted Community Cluster (SaaS)
  • Multi-user - use your GitHub/GitLab identity to log into your personal dashboard
  • Automates CI/CD triggered by git push (also known as GitOps)
  • Onboard new git repos with a single click by adding the GitHub App or a repository tag in GitLab
  • Immediate feedback on your personal dashboard and through GitHub Checks or GitLab Statuses
  • Sub-domain per user or organization with HTTPS
  • Runtime-logs for your functions
  • Fast, non-root image builds using buildkit from Docker

Non-goals:

  • Raspberry Pi support - this is out of scope, since OpenFaaS Cloud is for professional use

The dashboard page for a user:

Dashboard

The details page for a function:

Details page

Overview

KubeCon video

KubeCon: OpenFaaS Cloud + Linkerd: A Secure, Multi-Tenant Serverless Platform - Charles Pretzer & Alex Ellis

Blog posts

Documentation

Roadmap & Features

See the Roadmap & Features

Get started

You can set up and host your own OpenFaaS Cloud or apply for access to the hosted Community Cluster.

Option 1: Automated deployment (self-hosted)

You can set up your own OpenFaaS Cloud with authentication and wildcard certificates using ofc-bootstrap in around 100 seconds.

Get started: ofc-bootstrap

This method assumes you are using Kubernetes and have a public IP available. Some basic knowledge of how to setup a GitHub App and GitHub OAuth App along with a DNS service account on Google Cloud DNS or AWS Route53.

Option 2: Community Cluster (SaaS)

The OpenFaaS Community Cluster is a hosted version of OpenFaaS Cloud for community use and for evaluation.

Option 3: Manual deployment (self-hosted)

The manual deployment takes longer, but covers all the requirements in detail and is the most flexible option. You may follow this guide if you are contributing to the project, or if you want to use Swarm.

Read the developer's guide to find out more about the functions and to start hacking on OpenFaaS Cloud.

Getting help

For help join #openfaas-cloud on the OpenFaaS Slack workspace. If you need commercial support, contact [email protected]

Packages

 
 
 

Languages

  • Go 75.6%
  • JavaScript 20.5%
  • HTML 1.2%
  • Dockerfile 0.9%
  • CSS 0.7%
  • Smarty 0.6%
  • Other 0.5%