https://github.com/danielgatis/go-rafting
A framework to build fault tolerant apps.
https://github.com/danielgatis/go-rafting
go golang hashicorp-raft raft raft-consensus raft-framework
Last synced: about 2 months ago
JSON representation
A framework to build fault tolerant apps.
- Host: GitHub
- URL: https://github.com/danielgatis/go-rafting
- Owner: danielgatis
- Created: 2022-01-06T03:51:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-25T22:00:21.000Z (over 1 year ago)
- Last Synced: 2025-03-19T00:07:05.191Z (2 months ago)
- Topics: go, golang, hashicorp-raft, raft, raft-consensus, raft-framework
- Language: Go
- Homepage:
- Size: 6.84 MB
- Stars: 26
- Watchers: 1
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Go - Rafting
[](https://goreportcard.com/report/github.com/danielgatis/go-rafting)
[](https://raw.githubusercontent.com/danielgatis/go-rafting/master/LICENSE)
[](https://godoc.org/github.com/danielgatis/go-rafting)
A framework to build fault tolerant apps.
https://user-images.githubusercontent.com/7380/148815170-a7f8d586-405d-4d81-a640-26bcc98c6e02.mp4
## Install
```bash
go get -u github.com/danielgatis/go-rafting
```
And then import the package in your code:
```go
import "github.com/danielgatis/go-rafting"
```
### Usage
Create a new app state with some commands:
```go
state := rafting.NewState(make(map[string]string))
state.Command("set", func(data interface{}, args map[string]interface{}) (interface{}, error) {
d := data.(map[string]string)
key := cast.ToString(args["key"])
val := cast.ToString(args["val"])
d[key] = val
return val, nil
})
state.Command("get", func(data interface{}, args map[string]interface{}) (interface{}, error) {
d := data.(map[string]string)
key := cast.ToString(args["key"])
return d[key], nil
})
state.Command("del", func(data interface{}, args map[string]interface{}) (interface{}, error) {
d := data.(map[string]string)
key := cast.ToString(args["key"])
value := d[key]
delete(d, key)
return value, nil
})
```
Create a new raft node with a mdns discovery:
```go
node, err := rafting.NewNode(rid, state.FSM(), rport, rafting.WithMdnsDiscovery())
if err != nil {
logrus.Fatal(err)
}
```
Starting the node:
```go
node.Start(context.Background())
```
Thats it!
### Example
The example bellow is the code for the banner video.
```go
package main
import (
"context"
"flag"
"fmt"
"time"
"github.com/danielgatis/go-ctrlc"
"github.com/danielgatis/go-rafting"
"github.com/gofiber/fiber/v2"
"github.com/sirupsen/logrus"
"github.com/spf13/cast"
)
var (
rid string
rport int
hport int
)
func init() {
flag.StringVar(&rid, "rid", "1", "raft node id")
flag.IntVar(&rport, "rport", 4001, "raft port number")
flag.IntVar(&hport, "hport", 3001, "http port number")
}
func main() {
flag.Parse()
// raft node
state := rafting.NewState(make(map[string]string))
node, err := rafting.NewNode(rid, state.FSM(), rport, rafting.WithMdnsDiscovery())
if err != nil {
logrus.Fatal(err)
}
state.Command("set", func(data interface{}, args map[string]interface{}) (interface{}, error) {
d := data.(map[string]string)
key := cast.ToString(args["key"])
val := cast.ToString(args["val"])
d[key] = val
return val, nil
})
state.Command("get", func(data interface{}, args map[string]interface{}) (interface{}, error) {
d := data.(map[string]string)
key := cast.ToString(args["key"])
return d[key], nil
})
state.Command("del", func(data interface{}, args map[string]interface{}) (interface{}, error) {
d := data.(map[string]string)
key := cast.ToString(args["key"])
value := d[key]
delete(d, key)
return value, nil
})
ctx, cancel := context.WithCancel(context.Background())
go func() { logrus.Fatal(node.Start(ctx)) }()
// http server
app := fiber.New()
app.Get("/:op/:key/:val?", func(c *fiber.Ctx) error {
result, err := node.Apply(c.Params("op"), time.Second, "key", c.Params("key"), "val", c.Params("val"))
if err != nil {
return err
}
return c.SendString(cast.ToString(result))
})
go func() { logrus.Fatal(app.Listen(fmt.Sprintf(":%d", hport))) }()
// waiting
ctrlc.Watch(func() {
cancel()
app.Shutdown()
})
<-ctx.Done()
}
```
### License
Copyright (c) 2021-present [Daniel Gatis](https://github.com/danielgatis)
Licensed under [MIT License](./LICENSE)
### Buy me a coffee
Liked some of my work? Buy me a coffee (or more likely a beer)
