conduit

Documentation

Overview

Package conduit wires up everything under the hood of a Conduit instance including metrics, telemetry, logging, and server construction. It should only ever interact with the Orchestrator, never individual services. All of that responsibility should be left to the Orchestrator.

Index

• Constants
• Variables
• type Config
  • func (c Config) Validate() error
• type Runtime
  • func NewRuntime(cfg Config) (*Runtime, error)
  • func (r *Runtime) Run(ctx context.Context) (err error)

Constants

const (
	DBTypeBadger   = "badger"
	DBTypePostgres = "postgres"
)

Variables

var Version string

Version is set during the build process (i.e. the Makefile) It follows Go's convention for module version, where the version starts with the letter v, followed by a semantic version.

Types

type Config

type Config struct {
	DB struct {
		Type   string
		Badger struct {
			Path string
		}
		Postgres struct {
			ConnectionString string
			Table            string
		}
	}

	HTTP struct {
		Address string
	}
	GRPC struct {
		Address string
	}
}

Config holds all configurable values for Conduit.

func (Config) Validate

func (c Config) Validate() error

type Runtime

type Runtime struct {
	Config Config

	DB           database.DB
	Orchestrator *orchestrator.Orchestrator
	// contains filtered or unexported fields
}

Runtime sets up all services for serving and monitoring a Conduit instance.

func NewRuntime

func NewRuntime(cfg Config) (*Runtime, error)

NewRuntime sets up a Runtime instance and primes it for start.

func (*Runtime) Run

func (r *Runtime) Run(ctx context.Context) (err error)

Run initializes all of Conduit's underlying services and starts the GRPC and HTTP APIs. This function blocks until the supplied context is cancelled or one of the services experiences a fatal error.