IP

Prefix

package mainimport ("context""fmt""time"    goipam"github.com/metal-stack/go-ipam")funcmain() {// The background contextbgCtx:=context.Background()// Create a ipamer with in memory storageipam:=goipam.New(bgCtx)// Optionally, we can pass around a context for a given namespacenamespace:="tenant-a"err:=ipam.CreateNamespace(bgCtx,namespace)iferr!=nil {panic(err)    }ctx:=goipam.NewContextWithNamespace(bgCtx,namespace)ctx,cancel:=context.WithTimeout(ctx,5*time.Second)defercancel()// Create a prefix to manage some IPsprefix,err:=ipam.NewPrefix(ctx,"192.168.0.0/24")iferr!=nil {panic(err)    }// Acquire and release an IP with this prefixip,err:=ipam.AcquireIP(ctx,prefix.Cidr)iferr!=nil {panic(err)    }fmt.Printf("got IP: %s\n",ip.IP)prefix,err=ipam.ReleaseIP(ctx,ip)iferr!=nil {panic(err)    }fmt.Printf("IP: %s released.\n",ip.IP)// Now a IPv6 Super Prefix with Child Prefixesprefix,err=ipam.NewPrefix(ctx,"2001:aabb::/48")iferr!=nil {panic(err)    }cp1,err:=ipam.AcquireChildPrefix(ctx,prefix.Cidr,64)iferr!=nil {panic(err)    }fmt.Printf("got Prefix: %s\n",cp1)cp2,err:=ipam.AcquireChildPrefix(ctx,prefix.Cidr,72)iferr!=nil {panic(err)    }fmt.Printf("got Prefix: %s\n",cp2)ip21,err:=ipam.AcquireIP(ctx,cp2.Cidr)iferr!=nil {panic(err)    }fmt.Printf("got IP: %s\n",ip21.IP)}

GRPC Service

docker run -it --rm ghcr.io/metal-stack/go-ipam postgres

package mainimport ("http""github.com/bufbuild/connect-go"    v1"github.com/metal-stack/go-ipam/api/v1""github.com/metal-stack/go-ipam/api/v1/apiv1connect")funcmain() {c:=apiv1connect.NewIpamServiceClient(http.DefaultClient,"http://localhost:9090",connect.WithGRPC(),    )bgCtx:=context.Background()// Optional with Namespacectx:=goipam.NewContextWithNamespace(bgCtx,"tenant-a")result,err:=c.CreatePrefix(ctx,connect.NewRequest(&v1.CreatePrefixRequest{Cidr:"192.168.0.0/16",}))iferr!=nil {panic(err)    }fmt.Println("Prefix:%q created",result.Msg.GetPrefix().GetCidr())}

GRPC client

docker run -it --rm --entrypoint /cli ghcr.io/metal-stack/go-ipam

Metrics

http://localhost:2112/metrics

pprof

go tool pprof -http :8080 localhost:2113/debug/pprof/heapgo tool pprof -http :8080 localhost:2113/debug/pprof/goroutine

Docker Compose example

docker compose up -d# check if up and runningdocker compose psNAME                 IMAGE             COMMAND                  SERVICE    CREATED          STATUS                    PORTSgo-ipam-ipam-1       go-ipam"/server postgres"       ipam       14 seconds ago   Up 13 seconds (healthy)   0.0.0.0:9090->9090/tcp, :::9090->9090/tcpgo-ipam-postgres-1   postgres:alpine"docker-entrypoint.s…"   postgres   8 minutes ago    Up 13 seconds             5432/tcp# Then execute the cli to create prefixes and acquire ipsdocker composeexec ipam /cli prefix create --cidr 192.168.0.0/16prefix:"192.168.0.0/16" createddocker composeexec ipam /cli ip acquire --prefix  192.168.0.0/16ip:"192.168.0.1" acquired# Queries can also made against the Rest api like so:curl -v -X POST -d'{}' -H'Content-Type: application/json' localhost:9090/api.v1.IpamService/ListPrefixes

Supported Databases & Performance

Database Version Compatibility

Testing individual Backends

BACKEND=backend maketest