serviceregistry

Documentation

Index

• func RegisterService(r Registration) error
• type DBRegister
• type HandlerServer
• type NamespaceMap
• type RegisterFunc
• type Registration
• type RegistrationParams
• type RemoteServiceConfig
• type Service
• type ServiceConfig
• type ServiceMap

Functions

func RegisterService

func RegisterService(r Registration) error

Types

type DBRegister

type DBRegister struct {
	Required bool
	// Required to support automatic migrations
	Migrations *embed.FS
}

type HandlerServer

type HandlerServer func(ctx context.Context, mux *runtime.ServeMux, server any) error

type NamespaceMap

type NamespaceMap map[string]ServiceMap

var RegisteredServices NamespaceMap

Map of namespaces to services

type RegisterFunc

type RegisterFunc func(RegistrationParams) (Impl any, HandlerServer HandlerServer)

type Registration

type Registration struct {
	Namespace    string
	ServiceDesc  *grpc.ServiceDesc
	RegisterFunc RegisterFunc

	// Optional to specify if the service requires a database connection
	DB DBRegister
}

type RegistrationParams

type RegistrationParams struct {
	Config          ServiceConfig
	OTDF            *server.OpenTDFServer
	DBClient        *db.Client
	Engine          *opa.Engine
	SDK             *sdk.SDK
	WellKnownConfig func(namespace string, config any) error
}

type RemoteServiceConfig

type RemoteServiceConfig struct {
	Endpoint string `yaml:"endpoint"`
}

type Service

type Service struct {
	Registration
	Started bool
	Close   func()
}

type ServiceConfig

type ServiceConfig struct {
	Enabled    bool                   `yaml:"enabled"`
	Remote     RemoteServiceConfig    `yaml:"remote"`
	ExtraProps map[string]interface{} `json:"-" mapstructure:",remain"`
}

type ServiceMap

type ServiceMap map[string]Service