Help us shape the future of Go! Take the 2026 Go Developer Survey

volume_redis

package
v0.57.21 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 2, 2026 License: Apache-2.0 Imports: 26 Imported by: 0

Documentation

Index

Constants

View Source 
const ControllerID = "hydra/volume/redis"

ControllerID identifies the Redis volume controller.

Variables

View Source 
var ConfigID = ControllerID

ConfigID is the id attached to the config objects.

View Source 
var Version = controller.MustParseVersion("0.0.1")

Version is the version of the redis implementation.

Functions

This section is empty.

Types

type Config 

type Config struct {

	// Client configures the redis client.
	Client *redis.ClientConfig `protobuf:"bytes,1,opt,name=client,proto3" json:"client,omitempty"`
	// KvKeyOpts are key/value options.
	KvKeyOpts *kvkey.Config `protobuf:"bytes,2,opt,name=kv_key_opts,json=kvKeyOpts,proto3" json:"kvKeyOpts,omitempty"`
	// NoGenerateKey indicates the controller should not generate a private key if
	// one is not already present. Setting this to false will cause the system to
	// create a new private key if one is not present in the store at startup. If
	// no key is in the store at startup and this is true, returns an error.
	NoGenerateKey bool `protobuf:"varint,3,opt,name=no_generate_key,json=noGenerateKey,proto3" json:"noGenerateKey,omitempty"`
	// NoWriteKey indicates the controller should not write a private key to
	// storage if it generates one. This results in an ephemeral volume peer
	// identity if there is no key present in the store already.
	//
	// Has no effect if the store has a peer private key.
	NoWriteKey bool `protobuf:"varint,7,opt,name=no_write_key,json=noWriteKey,proto3" json:"noWriteKey,omitempty"`
	// Verbose indicates we should log every operation.
	Verbose bool `protobuf:"varint,4,opt,name=verbose,proto3" json:"verbose,omitempty"`
	// VolumeConfig is the volume controller config.
	VolumeConfig *controller.Config `protobuf:"bytes,5,opt,name=volume_config,json=volumeConfig,proto3" json:"volumeConfig,omitempty"`
	// StoreConfig is the store configuration for kvtx.
	StoreConfig *kvtx.Config `protobuf:"bytes,6,opt,name=store_config,json=storeConfig,proto3" json:"storeConfig,omitempty"`
	// contains filtered or unexported fields
}

Config is the redis volume controller config. Url is the only mandatory flag.

func (*Config) BuildRedisOptions 

func (c *Config) BuildRedisOptions() ([]redis.DialOption, error)

BuildRedisOptions builds redis options from the config.

func (*Config) CloneMessageVT 

func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*Config) CloneVT 

func (m *Config) CloneVT() *Config

func (*Config) EqualMessageVT 

func (this *Config) EqualMessageVT(thatMsg any) bool

func (*Config) EqualVT 

func (this *Config) EqualVT(that *Config) bool

func (*Config) EqualsConfig 

func (c *Config) EqualsConfig(other config.Config) bool

EqualsConfig checks if the config is equal to another.

func (*Config) GetClient 

func (x *Config) GetClient() *redis.ClientConfig

func (*Config) GetConfigID 

func (c *Config) GetConfigID() string

GetConfigID returns the unique string for this configuration type. This string is stored with the encoded config.

func (*Config) GetKvKeyOpts 

func (x *Config) GetKvKeyOpts() *kvkey.Config

func (*Config) GetNoGenerateKey 

func (x *Config) GetNoGenerateKey() bool

func (*Config) GetNoWriteKey 

func (x *Config) GetNoWriteKey() bool

func (*Config) GetStoreConfig 

func (x *Config) GetStoreConfig() *kvtx.Config

func (*Config) GetVerbose 

func (x *Config) GetVerbose() bool

func (*Config) GetVolumeConfig 

func (x *Config) GetVolumeConfig() *controller.Config

func (*Config) MarshalJSON 

func (x *Config) MarshalJSON() ([]byte, error)

MarshalJSON marshals the Config to JSON.

func (*Config) MarshalProtoJSON 

func (x *Config) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the Config message to JSON.

func (*Config) MarshalProtoText 

func (x *Config) MarshalProtoText() string

func (*Config) MarshalToSizedBufferVT 

func (m *Config) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Config) MarshalToVT 

func (m *Config) MarshalToVT(dAtA []byte) (int, error)

func (*Config) MarshalVT 

func (m *Config) MarshalVT() (dAtA []byte, err error)

func (*Config) ProtoMessage 

func (*Config) ProtoMessage()

func (*Config) Reset 

func (x *Config) Reset()

func (*Config) SizeVT 

func (m *Config) SizeVT() (n int)

func (*Config) String 

func (x *Config) String() string

func (*Config) UnmarshalJSON 

func (x *Config) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the Config from JSON.

func (*Config) UnmarshalProtoJSON 

func (x *Config) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the Config message from JSON.

func (*Config) UnmarshalVT 

func (m *Config) UnmarshalVT(dAtA []byte) error

func (*Config) Validate 

func (c *Config) Validate() error

Validate validates the configuration. This is a cursory validation to see if the values "look correct."

type Coordinator added in v0.57.2 

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

Coordinator combines an inner coordinator for ObjectStore scopes with TTL-guarded redis keys for cross-process keyed exclusion.

func NewCoordinator added in v0.57.2 

func NewCoordinator(pool *redis.Pool, storeID string, inner coord.Coordinator) *Coordinator

NewCoordinator builds a redis coordinator. Scopes without a Key delegate to inner. storeID identifies the volume's redis key namespace.

func (*Coordinator) Capability added in v0.57.2 

func (c *Coordinator) Capability(ctx context.Context, scope coord.Scope) (*coord.Capability, error)

Capability reports keyed redis lease support, delegating ObjectStore scopes.

func (*Coordinator) Snapshot added in v0.57.2 

func (c *Coordinator) Snapshot(ctx context.Context, scope coord.Scope) (*coord.Snapshot, error)

Snapshot delegates ObjectStore scopes; keyed scopes carry no generations.

func (*Coordinator) TryAcquireWriteLease added in v0.57.2 

func (c *Coordinator) TryAcquireWriteLease(ctx context.Context, scope coord.Scope) (coord.WriteLease, bool, error)

TryAcquireWriteLease attempts to set the keyed redis lease without blocking.

func (*Coordinator) WaitAcquireWriteLease added in v0.57.2 

func (c *Coordinator) WaitAcquireWriteLease(ctx context.Context, scope coord.Scope) (coord.WriteLease, error)

WaitAcquireWriteLease waits until the keyed redis lease is available.

func (*Coordinator) Watch added in v0.57.2 

func (c *Coordinator) Watch(ctx context.Context, scope coord.Scope, afterGeneration uint64) (coord.Watch, error)

Watch delegates ObjectStore scopes; keyed scopes carry no event stream.

type Factory 

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

Factory constructs a Redis-backed volume.

func NewFactory 

func NewFactory(bus bus.Bus) *Factory

NewFactory builds a Redis-backed volume factory.

func (*Factory) Construct 

func (t *Factory) Construct(
	ctx context.Context,
	conf config.Config,
	opts controller.ConstructOpts,
) (controller.Controller, error)

Construct constructs the associated controller given configuration.

func (*Factory) ConstructConfig 

func (t *Factory) ConstructConfig() config.Config

ConstructConfig constructs an instance of the controller configuration.

func (*Factory) GetConfigID 

func (t *Factory) GetConfigID() string

GetConfigID returns the unique ID for the config.

func (*Factory) GetControllerID 

func (t *Factory) GetControllerID() string

GetControllerID returns the unique ID for the controller.

func (*Factory) GetVersion 

func (t *Factory) GetVersion() controller.Version

GetVersion returns the version of this controller.

type Redis 

type Redis = kvtx.Volume

Redis implements a RedisDB backed volume.

func NewRedis 

func NewRedis(
	ctx context.Context,
	le *logrus.Entry,
	conf *Config,
) (*Redis, error)

NewRedis builds a new Redis volume, opening the database.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.