README
¶
Package gobernate provides an easy HTTP Handler containing all end-points
required to run a golang service in Kubernetes. This code is roughly based on:
https://blog.gopheracademy.com/advent-2017/kubernetes-ready-service/
To use the gobernate package to Kubernetes enable your service simply use:
import (
"fmt"
"net/http"
"github.com/SebastiaanPasterkamp/gobernate"
)
func main() {
g := gobernate.New("8080", "example", "1.0.0", "commit-sha", "build-time")
shutdown := g.Launch()
g.Router.HandleFunc("/hello", func(w http.ResponseWriter, _ *http.Request) {
fmt.Fprint(w, "Hello! Your request was processed.")
})
g.Ready()
<-shutdown
}
The gobernate http service provides:
GET /versionto return a JSON structure with the service.GET /healthto returnhttp.StatusOKto indicate the (web) service is running.GET /readinessto signal when the service is ready. ExpectsReady()to be called before signalinghttp.StatusOK, and will report if the service is already shutting down.GET /metricsto return Prometheus formatted metric data.
To do
- Option to add a custom readiness callback.
- Constructor with configuration struct.
- Built in OpenTelemetry support.
Documentation
¶
Overview ¶
Package gobernate provides an easy HTTP Handler containing all end-points required to run a golang service in Kubernetes. This code is roughly based on: https://blog.gopheracademy.com/advent-2017/kubernetes-ready-service/
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Gobernate ¶
type Gobernate struct {
// Router is the mux router, so extra end-points can be added.
Router *mux.Router
// contains filtered or unexported fields
}
Gobernate provides an easy HTTP Handler containing all end-points required to run a golang service in Kubernetes. This code is roughly based on: https://blog.gopheracademy.com/advent-2017/kubernetes-ready-service/
func (*Gobernate) Launch ¶
Launch runs the gobernate service on the port, and serves the version info. Returns a shutdown channel to either block while serving, or to close to take down the service
func (*Gobernate) Ready ¶
func (g *Gobernate) Ready()
Ready signals that the service is ready to serve. Call once all initialization has completed.
Source Files
Directories