serverless

README

Serverless

This project provides Serverless runtimes for use with Knative.

Runtimes

• Go

Go

The Go runtime reserves the following HTTP paths:

• /metrics for Prometheus Metrics (if enabled)

Usage:

package main

import (
	"gitlab.com/autokubeops/serverless"
	"net/http"
)

func main() {
	serverless.NewBuilder(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		// put your application logic here
		_, _ = w.Write([]byte("OK"))
	})).
		WithPrometheus(). // enable prometheus metrics (optional)
		Run()
}

GRPC

The Go runtime supports dual HTTP/gRPC servers. It can be configured by calling the WithGRPC function when building the serverless function.

Example:

package main

import (
	"gitlab.com/autokubeops/serverless"
	"google.golang.org/grpc"
	"net/http"
)

func main() {
	// todo register your gRPC servers
	srv := grpc.NewServer()
	serverless.NewBuilder(http.NotFoundHandler()).
		WithGRPC(srv).
		Run()
}

Documentation

Index

• Constants
• type Builder
  • func NewBuilder(handler http.Handler) *Builder
  • func (b *Builder) Run()
  • func (b *Builder) WithGRPC(srv *grpc.Server) *Builder
  • func (b *Builder) WithHandlers(enabled bool) *Builder
  • func (b *Builder) WithLogger(log logr.Logger) *Builder
  • func (b *Builder) WithPort(port int) *Builder
  • func (b *Builder) WithProbes(probes *probe.Handler) *Builder
  • func (b *Builder) WithPrometheus() *Builder
  • func (b *Builder) WithTLS(certFile, keyFile string, tlsConfig *tls.Config) *Builder

Constants

const (
	HeaderContentType = "Content-Type"
	ApplicationGRPC   = "application/grpc"
)

Types

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

func NewBuilder

func NewBuilder(handler http.Handler) *Builder

func (*Builder) Run

func (b *Builder) Run()

func (*Builder) WithGRPC

func (b *Builder) WithGRPC(srv *grpc.Server) *Builder

WithGRPC allows the server to support hybrid http/grpc calls

func (*Builder) WithHandlers

func (b *Builder) WithHandlers(enabled bool) *Builder

WithHandlers toggles the use of Gorilla Handlers.

Handlers are enabled by default:

* RecoveryHandler - converts panics into 500 Internal Server Error * CombinedLoggingHandler - logging HTTP requests in a known format

func (*Builder) WithLogger

func (b *Builder) WithLogger(log logr.Logger) *Builder

WithLogger configures the logging implementation that is used.

Defaults to https://github.com/go-logr/stdr if this function is not called.

func (*Builder) WithPort

func (b *Builder) WithPort(port int) *Builder

WithPort sets the port that the server will run on.

func (*Builder) WithProbes

func (b *Builder) WithProbes(probes *probe.Handler) *Builder

WithProbes overrides the default configuration used for the HTTP health checks

func (*Builder) WithPrometheus

func (b *Builder) WithPrometheus() *Builder

WithPrometheus enables Prometheus metric collection from function invocation.

Deprecated

func (*Builder) WithTLS

func (b *Builder) WithTLS(certFile, keyFile string, tlsConfig *tls.Config) *Builder