riff

README

= riff is for functions image:https://travis-ci.org/projectriff/riff.svg?branch=master["Build Status", link="https://travis-ci.org/projectriff/riff"]

image::logo.png[riff logo, link=https://projectriff.io/]
A FaaS for Kubernetes

== Installation of the latest release

See link:Getting-Started.adoc[Getting Started] for how to install riff with a Helm Chart,
and how to install the riff CLI.

== Developer installation

See link:Development-Helm-install.adoc[Installing the riff development version using Helm] to install the latest unreleased builds (git master branch) of riff.

== [[manual]] Manual build

This is the best option if you want to modify the riff components.

=== Prerequisites

You need:

* A working Go environment
* A local 1.7+ Kubernetes cluster
* A docker daemon

To build images with docker in minikube use

[source, bash]
----
eval $(minikube docker-env)
----

=== Get the main riff repo and install the CLI

[source, bash]
----
go get github.com/projectriff/riff
----

=== Build the riff core components

[source, bash]
----
cd $(go env GOPATH)/src/github.com/projectriff/riff
make dockerize
----

=== Deploy Kafka

Create the `riff-system` namespace:

[source, bash]
----
kubectl create namespace riff-system
----

Install the kafka/zookeeper deployments and services:

[source, bash]
----
kubectl apply -n riff-system -f config/kafka
----

=== Deploy the riff Custom Resource Definitions and deploy the riff core components

This creates the the _topic_ and _function_ link:kubernetes-crds[CRDS], then deploys the HTTP Gateway, Topic Controller, and Function Controller:

[source, bash]
----
make kubectl-apply
----

If your cluster has RBAC enabled, then you also need to create a Role and a RoleBinding:

[source, bash]
----
kubectl apply -f config/rbac
----

=== To tear it all down

Once you're done playing with riff (see samples below), you can destroy everything created above by running:

[source, bash]
----
./teardown
----

== [[samples]]Try Some Samples

With riff running try some of the link:samples/README.adoc[samples].

== Running the tests

To run all riff's unit and integration tests, ensure Kafka (with `auto.create.topics.enable=true`, which
is the default) and Zookeeper are running locally, then issue:

[source, bash]
----
KAFKA_BROKERS=localhost:9092 KAFKA_BROKER=localhost:9092 make test
----


== Contributing to riff

Please refer to the link:CONTRIBUTING.adoc[Contributors' Guide].

== Maintaining riff

Please refer to the link:MAINTAINING.adoc[Maintainers' Guide].