https://github.com/foomo/keel

Opinionated k8s service framework.
https://github.com/foomo/keel

foomo foomo-keel go golang microservice microservices

Last synced: 9 months ago
JSON representation

Opinionated k8s service framework.

• Host: GitHub
• URL: https://github.com/foomo/keel
• Owner: foomo
• License: mit
• Created: 2021-05-18T05:21:17.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2025-04-16T23:24:02.000Z (11 months ago)
• Last Synced: 2025-05-04T22:37:38.541Z (11 months ago)
• Topics: foomo, foomo-keel, go, golang, microservice, microservices
• Language: Go
• Homepage: https://www.foomo.org
• Size: 2.07 MB
• Stars: 8
• Watchers: 13
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
[![Build Status](https://github.com/foomo/keel/actions/workflows/test.yml/badge.svg?branch=main&event=push)](https://github.com/foomo/keel/actions/workflows/test.yml)

[![Go Report Card](https://goreportcard.com/badge/github.com/foomo/keel)](https://goreportcard.com/report/github.com/foomo/keel)

[![Coverage Status](https://coveralls.io/repos/github/foomo/keel/badge.svg?branch=main&)](https://coveralls.io/github/foomo/keel?branch=main)

[![GoDoc](https://godoc.org/github.com/foomo/keel?status.svg)](https://godoc.org/github.com/foomo/keel)



  



# keel

> Opinionated way to run services on Kubernetes

## Stack

- Zap

- Nats

- Viper

- GoTSRPC

- Temporal

- OpenTelemetry

## Examples

See the examples folder for usages

```go

package main

import (

  "net/http"

  "github.com/foomo/keel"

  "github.com/foomo/keel/service"

)

func main() {

  svr := keel.NewServer(

    keel.WithHTTPZapService(true),

    keel.WithHTTPViperService(true),

    keel.WithHTTPPrometheusService(true),

  )

  l := svr.Logger()

  svs := newService()

  svr.AddService(

    service.NewHTTP(l, "demo", "localhost:8080", svs),

  )

  svr.Run()

}

func newService() *http.ServeMux {

  s := http.NewServeMux()

  s.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {

    w.WriteHeader(http.StatusOK)

    _, _ = w.Write([]byte("OK"))

  })

  return s

}

```

## How to Contribute

Please refer to the [CONTRIBUTING](.gihub/CONTRIBUTING.md) details and follow the [CODE_OF_CONDUCT](.gihub/CODE_OF_CONDUCT.md) and [SECURITY](.github/SECURITY.md) guidelines.

## License

Distributed under MIT License, please see license file within the code for more details.

_Made with ♥ [foomo](https://www.foomo.org) by [bestbytes](https://www.bestbytes.com)_