Installation

devedge-sdk is a Go module that provides the server, authz, persistence, and secret packages your service builds on. This page walks you through adding the module to a Go project and installing the optional code-generation tools. Follow it before the Quickstart.

Prerequisites

devedge-sdk is a Go module. To build a service with it you need:

Check your apx version with apx --version (use the flag — recent apx has no apx version subcommand):

apx --version   # e.g. "apx 0.12.1 (...)" — need 0.12.1+

Add the module

go get github.com/infobloxopen/devedge-sdk@latest

This pulls the runtime packages:

import (
    "github.com/infobloxopen/devedge-sdk/authz"
    "github.com/infobloxopen/devedge-sdk/authz/grpcauthz"
    "github.com/infobloxopen/devedge-sdk/server"
    "github.com/infobloxopen/devedge-sdk/secret"
    "github.com/infobloxopen/devedge-sdk/persistence"
    "github.com/infobloxopen/devedge-sdk/seccheck"
    "github.com/infobloxopen/devedge-sdk/middleware"
)

The core packages depend only on the standard library plus gRPC and protobuf. The SDK has no ORM dependency and no policy-engine dependency — those live in adapters built on the SDK, or in the generated storage code’s own module, so gorm.io/gorm never enters the SDK’s go.mod.

Scaffold CLI

The fastest way to start is the devedge-sdk CLI, the recommended path over installing the plugins by hand. It scaffolds a complete, building, authz-gated, persisted service in one command. It declares the public API surface as an apx app module, generates the internal models locally with the SDK plugins, and installs and invokes those plugins for you:

go install github.com/infobloxopen/devedge-sdk/cmd/devedge-sdk@latest

devedge-sdk new service notes --resource Note --backend gorm   # or --backend ent

This emits the buf.yaml/buf.gen.yaml/apx.yaml wiring, an annotated example proto, the server, and a smoke test, then runs the first buf generate. See the Quickstart for the full walk-through. The manual plugin install below is what the CLI does under the hood — useful when wiring an existing repo by hand (see Define a service).

To pin a specific release instead of @latest — recommended for reproducible builds — install with the version tag:

go install github.com/infobloxopen/devedge-sdk/cmd/devedge-sdk@v0.59.0

Verify what actually landed on your PATH:

devedge-sdk --version   # or: devedge-sdk version

Codegen plugins

The codegen plugins are main packages under the SDK repo. Install them onto your PATH so buf generate can invoke them:

go install github.com/infobloxopen/devedge-sdk/cmd/protoc-gen-svc@latest
go install github.com/infobloxopen/devedge-sdk/cmd/protoc-gen-storage@latest
go install github.com/infobloxopen/devedge-sdk/cmd/protoc-gen-ent@latest
go install github.com/infobloxopen/devedge-sdk/cmd/protoc-gen-devedge-authz@latest

If you expose an HTTP/JSON gateway (the quickstart’s curl examples and the Define a service buf template both do), also install the third-party grpc-gateway plugin. It is independently versioned, so @latest is correct here:

go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latest

Its google/api/*.proto imports (annotations.proto, http.proto) come from the buf.build/googleapis/googleapis module — add it to your buf.yaml deps and run buf dep update (see Define a service).

Verify

# In a module (or: `go mod init example.com/scratch` in an empty dir first):
go list -m github.com/infobloxopen/devedge-sdk

# The plugins are plain executables on PATH — `which` works anywhere:
which protoc-gen-svc protoc-gen-storage protoc-gen-ent protoc-gen-devedge-authz

Next: the Quickstart.