Merge pull request #1306 from threefoldtech/development-create-zos4-registrar

create zos4 registerer server

Author: Eslam-Nawara

.github/workflows/publish-images.yml

@@ -34,6 +34,8 @@ jobs:
             image: "tfgridproxy"
           - dir: "tools/relay-cache-warmer"
             image: "relay-cache-warmer"
+          - dir: "node-registrar"
+            image: "tfregistrar"
 
     steps:
       - name: Checkout the repo

Makefile

@@ -1,4 +1,4 @@
-DIRS := "activation-service" "farmerbot" "grid-cli" "grid-client" "grid-proxy" "gridify" "monitoring-bot" "rmb-sdk-go" "user-contracts-mon" "tfrobot"
+DIRS := "activation-service" "farmerbot" "grid-cli" "grid-client" "grid-proxy" "gridify" "monitoring-bot" "rmb-sdk-go" "user-contracts-mon" "tfrobot"  "node-registrar"
 
 mainnet-release:
 	cd grid-client && go get github.com/threefoldtech/tfchain/clients/tfchain-client-go@5d6a2dd

README.md

@@ -17,6 +17,7 @@ This repo contains the go clients for Threefold grid.
 -   [user contracts mon](./user-contracts-mon/README.md)
 -   [activation service](./activation-service/README.md)
 -   [farmerbot](./farmerbot/README.md)
+-   [node-registrar](./node-registrar/README.md)
 
 ## Release
 

node-registrar/Dockerfile

@@ -0,0 +1,21 @@
+FROM golang:1.21-alpine as builder
+
+WORKDIR /app
+
+COPY go.mod go.sum ./
+
+RUN go mod download
+
+COPY . .
+
+RUN go build -o server ./cmds/registrar.go
+
+FROM alpine:3.21
+
+WORKDIR /root/
+
+COPY --from=builder /app/server .
+
+EXPOSE 8080
+
+CMD ["./server"]

node-registrar/Makefile

@@ -0,0 +1,60 @@
+run:
+	go run cmds/registrar.go --postgres-host localhost --postgres-port 5432 --postgres-db postgres --postgres-user postgres --postgres-password password --domain localhost --server-port 8080
+
+postgres:
+	docker run --name postgres -e POSTGRES_USER=postgres POSTGRES_PASSWORD=password POSTGRES_DB=postgres -p 5432:5432 -d postgres
+
+stop-postgres:
+	docker stop postgres && docker rm postgres
+
+build: ## Bulil the server
+	go build -o bin/server cmds/registrar.go
+
+server-start:
+	@go run cmds/registrar.go \
+		--server-port :8080 \
+		--log-level debug \
+		--domain localhost \
+		--sql-log-level 4 \
+		--postgres-host localhost \
+		--postgres-port 5432 \
+		--postgres-db postgres \
+		--postgres-user postgres \
+		--postgres-password password \
+
+getverifiers:
+	@echo "Installing staticcheck" && go get -u honnef.co/go/tools/cmd/staticcheck && go install honnef.co/go/tools/cmd/staticcheck
+	@echo "Installing gocyclo" && go get -u github.com/fzipp/gocyclo/cmd/gocyclo && go install github.com/fzipp/gocyclo/cmd/gocyclo
+	@echo "Installing deadcode" && go get -u github.com/remyoudompheng/go-misc/deadcode && go install github.com/remyoudompheng/go-misc/deadcode
+	@echo "Installing misspell" && go get -u github.com/client9/misspell/cmd/misspell && go install github.com/client9/misspell/cmd/misspell
+	@echo "Installing golangci-lint" && go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.50.1
+	go mod tidy
+
+verifiers: fmt lint cyclo deadcode spelling staticcheck
+
+checks: verifiers
+
+fmt:
+	@echo "Running $@"
+	@gofmt -d .
+
+lint:
+	@echo "Running $@"
+	@$(shell go env GOPATH)/bin/golangci-lint run
+
+cyclo:
+	@echo "Running $@"
+	@$(shell go env GOPATH)/bin/gocyclo -over 100 .
+
+deadcode:
+	@echo "Running $@"
+	@$(shell go env GOPATH)/bin/deadcode -test $(shell go list ./...) || true
+
+spelling:
+	@echo "Running $@"
+	@$(shell go env GOPATH)/bin/misspell -i monitord -error `find .`
+
+staticcheck:
+	@echo "Running $@"
+	@$(shell go env GOPATH)/bin/staticcheck -- ./...
+

node-registrar/README.md

@@ -0,0 +1,74 @@
+
+## Project Documentation
+
+### Overview
+This project provides an API for registring zos nodes using the Go Gin framework and PostgreSQL database. 
+The API supports operations like registring, listing, and updating farms and nodes, as well as reporting uptime and consumption data for nodes.
+
+### Endpoint Descriptions
+
+#### Farms Endpoints
+1. **GET /farms/** - List all farms, or use FarmFilter to list specific set of farms.
+2. **GET /farms/:farm_id** - Get a specific farm by ID.
+3. **POST /farms/** - Create a new farm.
+4. **PATCH /farms/** - Update an existing farm.
+
+#### Nodes Endpoints
+1. **GET /nodes/** - List all nodes, or use NodeFilter to list specific set of nodes.
+2. **GET /nodes/:node_id** - Get a specific node by ID.
+3. **POST /nodes/** - Register a new node.
+4. **POST /nodes/:node_id/uptime** - Report uptime for a specific node.
+5. **POST /nodes/:node_id/consumption** - Report consumption for a specific node.
+
+## Setup Instructions
+
+1. **Start PostgreSQL:**
+   ```bash
+   make postgres
+   ```
+2. **Run the Server:**
+   ```bash
+   make run
+   ```
+3. **Stop PostgreSQL:**
+   ```bash
+   make stop-postgres
+   ```
+
+### Swagger Documentation
+Once the server is running, Swagger documentation can be accessed at:
+```
+http://<domain>:<port>/swagger/index.html
+```
+Replace `<domain>` and `<port>` with the appropriate values.
+
+### How to Use the Server
+1. Use a tool like Postman or cURL to interact with the API.
+2. Refer to the Swagger documentation for detailed information about request parameters and response structures.
+
+### How to run the server with docker
+1. use the docker file to build the docker image 
+```
+docker build -t registrar:latest .
+```
+2. run the image
+```
+docker run -d \
+  -p 8080:8080 \
+  --name registrar \
+  registrar:latest \
+  ./server
+  --postgres-host=<your-postgres-host> \
+  --postgres-port=5432 \
+  --postgres-db=<your-db-name> \
+  --postgres-user=<your-db-user> \
+  --postgres-password=<your-db-password> \
+  --ssl-mode=disable \
+  --sql-log-level=2 \
+  --max-open-conn=10 \
+  --max-idle-conn=5 \
+  --server-port=8080 \
+  --<domain=your-domain> \
+  --network=main\
+  --debug
+```

node-registrar/cmds/registrar.go

@@ -0,0 +1,119 @@
+package main
+
+import (
+	"flag"
+	"fmt"
+	"net"
+	"os"
+	"os/signal"
+	"strings"
+	"syscall"
+
+	"github.com/pkg/errors"
+	"github.com/rs/zerolog"
+	"github.com/rs/zerolog/log"
+	"github.com/threefoldtech/tfgrid-sdk-go/node-registrar/pkg/db"
+	"github.com/threefoldtech/tfgrid-sdk-go/node-registrar/pkg/server"
+	"gorm.io/gorm/logger"
+)
+
+type flags struct {
+	db.Config
+	debug      bool
+	version    bool
+	domain     string
+	serverPort uint
+	network    string
+}
+
+var (
+	commit  string
+	version string
+)
+
+func main() {
+	if err := Run(); err != nil {
+		log.Fatal().Err(err).Send()
+	}
+}
+
+func Run() error {
+	f := flags{}
+	var sqlLogLevel int
+	flag.StringVar(&f.PostgresHost, "postgres-host", "", "postgres host")
+	flag.Uint64Var(&f.Config.PostgresPort, "postgres-port", 5432, "postgres port")
+	flag.StringVar(&f.DBName, "postgres-db", "", "postgres database")
+	flag.StringVar(&f.PostgresUser, "postgres-user", "", "postgres username")
+	flag.StringVar(&f.PostgresPassword, "postgres-password", "", "postgres password")
+	flag.StringVar(&f.SSLMode, "ssl-mode", "disable", "postgres ssl mode[disable, require, verify-ca, verify-full]")
+	flag.IntVar(&sqlLogLevel, "sql-log-level", 2, "sql logger level")
+	flag.Uint64Var(&f.MaxOpenConns, "max-open-conn", 3, "max open sql connections")
+	flag.Uint64Var(&f.MaxIdleConns, "max-idle-conn", 3, "max idle sql connections")
+
+	flag.BoolVar(&f.version, "v", false, "shows the package version")
+	flag.BoolVar(&f.debug, "debug", false, "allow debug logs")
+	flag.UintVar(&f.serverPort, "server-port", 8080, "server port")
+	flag.StringVar(&f.domain, "domain", "", "domain on which the server will be served")
+	flag.StringVar(&f.network, "network", "dev", "the registrar network")
+
+	flag.Parse()
+	f.SqlLogLevel = logger.LogLevel(sqlLogLevel)
+
+	if f.version {
+		log.Info().Str("version", version).Str("commit", commit).Send()
+		return nil
+	}
+
+	if err := f.validate(); err != nil {
+		return err
+	}
+
+	log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stderr})
+	zerolog.SetGlobalLevel(zerolog.InfoLevel)
+	if f.debug {
+		zerolog.SetGlobalLevel(zerolog.DebugLevel)
+	}
+
+	db, err := db.NewDB(f.Config)
+	if err != nil {
+		return errors.Wrap(err, "failed to open database with the specified configurations")
+	}
+
+	defer func() {
+		err = db.Close()
+		if err != nil {
+			log.Error().Err(err).Msg("failed to close database connection")
+		}
+	}()
+
+	s, err := server.NewServer(db, f.network)
+	if err != nil {
+		return errors.Wrap(err, "failed to start gin server")
+	}
+
+	quit := make(chan os.Signal, 1)
+	signal.Notify(quit, os.Interrupt, syscall.SIGTERM)
+
+	log.Info().Msg("server is running on port :8080")
+	err = s.Run(quit, fmt.Sprintf("%s:%d", f.domain, f.serverPort))
+	if err != nil {
+		return errors.Wrap(err, "failed to run gin server")
+	}
+
+	return nil
+}
+
+func (f flags) validate() error {
+	if f.serverPort < 1 && f.serverPort > 65535 {
+		return errors.Errorf("invalid port %d, server port should be in the valid port range 1–65535", f.serverPort)
+	}
+
+	if strings.TrimSpace(f.domain) == "" {
+		return errors.New("invalid domain name, domain name should not be empty")
+	}
+	if _, err := net.LookupHost(f.domain); err != nil {
+		return errors.Wrapf(err, "invalid domain %s", f.PostgresHost)
+	}
+
+	return f.Config.Validate()
+}