README
¶
Serverless
This project provides Serverless runtimes for use with Knative.
Runtimes
- Go
Go
The Go runtime reserves the following HTTP paths:
/metricsfor 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 (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" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Builder ¶ added in v0.2.0
type Builder struct {
// contains filtered or unexported fields
}
func NewBuilder ¶ added in v0.2.0
func (*Builder) WithGRPC ¶ added in v0.3.0
WithGRPC allows the server to support hybrid http/grpc calls
func (*Builder) WithHandlers ¶ added in v0.3.1
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 ¶ added in v0.4.1
WithLogger configures the logging implementation that is used.
Defaults to https://github.com/go-logr/stdr if this function is not called.
func (*Builder) WithProbes ¶ added in v0.5.0
WithProbes overrides the default configuration used for the HTTP health checks
func (*Builder) WithPrometheus ¶ added in v0.2.0
WithPrometheus enables Prometheus metric collection from function invocation.
Deprecated
Source Files