infra

package

v0.9.0 Latest Latest Go to latest Published: Nov 17, 2025 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/hookdeck/outpost

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Init(ctx context.Context, cfg Config, redisClient redis.Cmdable) error
type Config
- func (cfg *Config) SetSensiblePolicyDefaults()
type Infra
- func NewInfra(cfg Config, redisClient redis.Cmdable) Infra
- func NewInfraWithProvider(lock Lock, provider InfraProvider, shouldManage bool) *Infra
type InfraProvider
type Lock
- func NewRedisLock(client redis.Cmdable, opts ...LockOption) Lock
type LockOption
- func LockWithKey(key string) LockOption
- func LockWithTTL(ttl time.Duration) LockOption

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrInfraNotFound is returned when infrastructure does not exist and auto provisioning is disabled
	ErrInfraNotFound = errors.New("required message queues do not exist. Either create them manually or set MQS_AUTO_PROVISION=true to enable auto-provisioning")
)

Functions ¶

func Init ¶ added in v0.9.0

func Init(ctx context.Context, cfg Config, redisClient redis.Cmdable) error

Init initializes and verifies infrastructure based on configuration. If AutoProvision is true (default), it will create infrastructure if needed. If AutoProvision is false, it will only verify infrastructure exists.

Types ¶

type Config ¶

type Config struct {
	DeliveryMQ    *mqinfra.MQInfraConfig
	LogMQ         *mqinfra.MQInfraConfig
	AutoProvision *bool
}

func (*Config) SetSensiblePolicyDefaults ¶

func (cfg *Config) SetSensiblePolicyDefaults()

type Infra ¶ added in v0.4.0

type Infra struct {
	// contains filtered or unexported fields
}

func NewInfra ¶ added in v0.4.0

func NewInfra(cfg Config, redisClient redis.Cmdable) Infra

func NewInfraWithProvider ¶ added in v0.4.0

func NewInfraWithProvider(lock Lock, provider InfraProvider, shouldManage bool) *Infra

NewInfraWithProvider creates an Infra instance with custom lock and provider (for testing)

func (*Infra) Declare ¶ added in v0.4.0

func (infra *Infra) Declare(ctx context.Context) error

func (*Infra) Teardown ¶ added in v0.4.0

func (infra *Infra) Teardown(ctx context.Context) error

func (*Infra) Verify ¶ added in v0.9.0

func (infra *Infra) Verify(ctx context.Context) error

Verify checks if infrastructure exists and returns an error if it doesn't.

type InfraProvider ¶ added in v0.4.0

type InfraProvider interface {
	Exist(ctx context.Context) (bool, error)
	Declare(ctx context.Context) error
	Teardown(ctx context.Context) error
}

InfraProvider handles the actual infrastructure operations

type Lock ¶ added in v0.4.0

type Lock interface {
	AttemptLock(ctx context.Context) (bool, error)
	Unlock(ctx context.Context) (bool, error)
}

func NewRedisLock ¶ added in v0.4.0

func NewRedisLock(client redis.Cmdable, opts ...LockOption) Lock

NewRedisLock creates a new Redis-based distributed lock

type LockOption ¶ added in v0.4.0

type LockOption func(*redisLock)

LockOption configures a redisLock

func LockWithKey ¶ added in v0.4.0

func LockWithKey(key string) LockOption

LockWithKey sets a custom key for the lock

func LockWithTTL ¶ added in v0.4.0

func LockWithTTL(ttl time.Duration) LockOption

LockWithTTL sets a custom TTL for the lock

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL