Go Dockerfile Makefile Other
alexellis Fix tests broken by #249
The following commit did not update tests and it seems the
Dockerfile / CI was not running them either, found by Lucas.
Error in: aa04e3e

Tested with:

- go test ./test
- make

Signed-off-by: Alex Ellis (VMware) <alexellis2@gmail.com>
Latest commit a65b904 Aug 3, 2018
Permalink
Failed to load latest commit information.
.github Mention kubernetes version Apr 6, 2018
chart/openfaas Enable read-only file-system Aug 1, 2018
cloud Break out dep/svc/cfg files from YAML Jun 6, 2018
contrib clean up set_travis_experimental_mode Oct 7, 2017
docs Enable read-only file-system Aug 1, 2018
handlers Add annotation support Jul 31, 2018
test Fix tests broken by #249 Aug 3, 2018
types Reduce the readiness checks for functions Jul 21, 2018
vendor Add annotation support Jul 31, 2018
version Add /system/info endpoint to faas-netes Mar 29, 2018
yaml Enable read-only file-system Aug 1, 2018
yaml_arm64 Change mentions from faas-netesd to faas-netes for yaml Jul 23, 2018
yaml_armhf Change mentions from faas-netesd to faas-netes for yaml Jul 23, 2018
.DEREK.yml Redirect derek to faas repo May 17, 2018
.gitignore Disable Prometheus scraping for function services Nov 28, 2017
.travis.yml Run helm lint in TravisCI Jul 25, 2018
CONTRIBUTING.md Update faas-netes and queue-worker versions Mar 29, 2018
Dockerfile Fix tests broken by #249 Aug 3, 2018
Dockerfile.arm64 Update Golang build SDK to 1.9.4 Apr 23, 2018
Dockerfile.armhf Update Golang build SDK to 1.9.4 Apr 23, 2018
Gopkg.lock Add annotation support Jul 31, 2018
Gopkg.toml Add annotation support Jul 31, 2018
HELM.md Swap order of recommended namespaces for helm Feb 12, 2018
LICENSE Initial commit Jul 23, 2017
MAINTAINERS Update MAINTAINERS Sep 6, 2017
Makefile Change mentions from faas-netesd to faas-netes for yaml Jul 23, 2018
QuickStart.md Update namespace for org and revendor Sep 27, 2017
README.md Reduce the readiness checks for functions Jul 21, 2018
SECRETS.md Add label-schema to Dockerfile Jul 9, 2018
build.sh Add resource limits and requests via function parameters Nov 15, 2017
monitoring-config.yml Upgrade prometheu to v2.1 Feb 6, 2018
namespaces.yml Break out dep/svc/cfg files from YAML Jun 6, 2018
server.go Reduce the readiness checks for functions Jul 21, 2018

README.md

faas-netes

Go Report Card Build Status License: MIT OpenFaaS

This is a plugin to enable Kubernetes as an OpenFaaS backend. The existing CLI and UI are fully compatible. It also opens up the possibility for other plugins to be built for orchestration frameworks such as Nomad, Mesos/Marathon or even a cloud-managed back-end such as Hyper.sh or Azure ACI.

OpenFaaS also runs well on managed Kubernetes services like AKS and GKE. See our list of tutorials in the documentation site for more.

Watch a video demo from TechFieldDay Extra at Dockercon

OpenFaaS is an event-driven serverless framework for containers. Any container for Windows or Linux can be leveraged as a serverless function. OpenFaaS is quick and easy to deploy (less than 60 secs) and lets you avoid writing boiler-plate code.

Stack

In this README you'll find a technical overview and instructions for deploying FaaS on a Kubernetes cluster. (Docker Swarm is also supported in the main project)

  • Serverless framework for containers
  • Native Kubernetes integrations (API and ecosystem)
  • Built-in UI
  • YAML templates & helm chart
  • Over 11k GitHub stars
  • Independent open-source project with over 90 authors/contributors

Get started

Note: a CRD-based Kubernetes controller is also available for OpenFaaS in the incubator program - faas-o6s.

How is this project different from others?

Reference guide

Configuration via Environmental variables

FaaS-netes can be configured via environment variables.

Option Usage
httpProbe Boolean - use http probe type for function readiness and liveness. Default: false
write_timeout HTTP timeout for writing a response body from your function (in seconds). Default: 8
read_timeout HTTP timeout for reading the payload from the client caller (in seconds). Default: 8
image_pull_policy Image pull policy for deployed functions (Always, IfNotPresent, Never. Default: Always

Readiness checking

The readiness checking for functions assumes you are using our function watchdog which writes a .lock file in the default "tempdir" within a container. To see this in action you can delete the .lock file in a running Pod with kubectl exec and the function will be re-scheduled.

Namespaces

By default all OpenFaaS functions and services are deployed to the openfaas and openfaas-fn namespaces. To alter the namespace use the helm chart.

Ingress

To configure ingress see the helm chart. By default NodePorts are used. These are listed in the deployment guide.

Image pull policy

By default, deployed functions will use an imagePullPolicy of Always, which ensures functions using static image tags are refreshed during an update. If this is not desired behavior, set the image_pull_policy environment variable to an alternative. IfNotPresent is particularly useful when developing locally with minikube. In this case, you can set your local environment to use minikube's docker so faas-cli build builds directly into minikube's image store. faas-cli push is unnecessary in this workflow - use faas-cli build then faas-cli deploy.

Note: When set to Never, only local (or pulled) images will work. When set to IfNotPresent, function deployments may not be updated when using static image tags.