riff is for functions
Clone or download

README.adoc

riff is for functions Build Status

riff logo

A FaaS for Kubernetes

The riff CLI helps developers build and run functions using Knative. It includes commands to install Knative in a Kubernetes cluster, and for managing functions, services, channels, and subscriptions.

Installation of the latest release

Official binary release are available from the Releases page. See Getting started on Minikube or Getting started on GKE for how to install the riff CLI and the riff system.

See Community releases for Mac Homebrew and Debian Apt packages.

Developer installation of Knative

The code for Knative serving and eventing and build lives in repos under the knative GitHub organization. Developers can use the riff CLI against their own Knative builds, by installing a Knative development environment.

Manual build of the riff CLI

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

Prerequisites

You need:

  • A working Go environment

  • The dep command line tool installed

Get the main riff repo

go get -d github.com/projectriff/riff/...

Build the riff CLI

cd $(go env GOPATH)/src/github.com/projectriff/riff
make build

Build and install the riff CLI

cd $(go env GOPATH)/src/github.com/projectriff/riff
make build install
Note
This installs the CLI in $GOBIN, or if that is not set, in the bin subdirectory of the directory specified in $GOPATH.

Contributing to riff

Please refer to the Contributors' Guide.

Maintaining riff

Please refer to the Maintainers' Guide.