bucket_setup

package
v0.56.0 Latest Latest
Warning

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

 Go to latest Published: Jul 11, 2026 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

View Source 
const ConfigID = ControllerID

ConfigID is the string used to identify this config object.

View Source 
const ControllerID = "hydra/bucket/setup"

ControllerID is the ID of the controller.

Variables

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

Version is the version of the controller implementation.

Functions

This section is empty.

Types

type ApplyBucketConfig 

type ApplyBucketConfig struct {

	// Config is the bucket config.
	Config *bucket.Config `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	// VolumeIdRe is a regex string to match volume IDs.
	// Set to '.*' to match all volumes.
	// If empty: updates only volumes that already have the config.
	// If VolumeIDList is set, it will override this field.
	// Cannot be specified if VolumeIDList is set.
	VolumeIdRe string `protobuf:"bytes,2,opt,name=volume_id_re,json=volumeIdRe,proto3" json:"volumeIdRe,omitempty"`
	// VolumeIdList is a list of volume IDs to match.
	// If the value is in this list, overrides volume_id_re.
	// ignored if empty.
	VolumeIdList []string `protobuf:"bytes,3,rep,name=volume_id_list,json=volumeIdList,proto3" json:"volumeIdList,omitempty"`
	// contains filtered or unexported fields
}

ApplyBucketConfig is the configuration for applying a bucket config.

func (*ApplyBucketConfig) BuildDirective 

func (a *ApplyBucketConfig) BuildDirective() (bucket.ApplyBucketConfig, error)

BuildDirective builds a ApplyBucketConfig directive.

func (*ApplyBucketConfig) CloneMessageVT 

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

func (*ApplyBucketConfig) CloneVT 

func (m *ApplyBucketConfig) CloneVT() *ApplyBucketConfig

func (*ApplyBucketConfig) EqualMessageVT 

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

func (*ApplyBucketConfig) EqualVT 

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

func (*ApplyBucketConfig) GetConfig 

func (x *ApplyBucketConfig) GetConfig() *bucket.Config

func (*ApplyBucketConfig) GetVolumeIdList 

func (x *ApplyBucketConfig) GetVolumeIdList() []string

func (*ApplyBucketConfig) GetVolumeIdRe 

func (x *ApplyBucketConfig) GetVolumeIdRe() string

func (*ApplyBucketConfig) MarshalJSON 

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

MarshalJSON marshals the ApplyBucketConfig to JSON.

func (*ApplyBucketConfig) MarshalProtoJSON 

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

MarshalProtoJSON marshals the ApplyBucketConfig message to JSON.

func (*ApplyBucketConfig) MarshalProtoText 

func (x *ApplyBucketConfig) MarshalProtoText() string

func (*ApplyBucketConfig) MarshalToSizedBufferVT 

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

func (*ApplyBucketConfig) MarshalToVT 

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

func (*ApplyBucketConfig) MarshalVT 

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

func (*ApplyBucketConfig) ParseVolumeIdRe 

func (a *ApplyBucketConfig) ParseVolumeIdRe() (*regexp.Regexp, error)

ParseVolumeIdRe parses the volume id regex field. Returns nil if the field was empty.

func (*ApplyBucketConfig) ProtoMessage 

func (*ApplyBucketConfig) ProtoMessage()

func (*ApplyBucketConfig) Reset 

func (x *ApplyBucketConfig) Reset()

func (*ApplyBucketConfig) SizeVT 

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

func (*ApplyBucketConfig) String 

func (x *ApplyBucketConfig) String() string

func (*ApplyBucketConfig) UnmarshalJSON 

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

UnmarshalJSON unmarshals the ApplyBucketConfig from JSON.

func (*ApplyBucketConfig) UnmarshalProtoJSON 

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

UnmarshalProtoJSON unmarshals the ApplyBucketConfig message from JSON.

func (*ApplyBucketConfig) UnmarshalVT 

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

func (*ApplyBucketConfig) Validate 

func (a *ApplyBucketConfig) Validate() error

Validate checks the ApplyBucketConfig.

type Config 

type Config struct {

	// ApplyBucketConfigs is a list of bucket configurations to apply.
	// Note: does not apply if existing config has a higher rev number.
	// Optional.
	ApplyBucketConfigs []*ApplyBucketConfig `protobuf:"bytes,1,rep,name=apply_bucket_configs,json=applyBucketConfigs,proto3" json:"applyBucketConfigs,omitempty"`
	// contains filtered or unexported fields
}

Config is the setup configuration.

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 other config is equal.

func (*Config) GetApplyBucketConfigs 

func (x *Config) GetApplyBucketConfigs() []*ApplyBucketConfig

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) 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.

type Controller 

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

Controller implements the bucket setup controller.

func NewController 

func NewController(
	le *logrus.Entry,
	bus bus.Bus,
	conf *Config,
) *Controller

NewController constructs a bucket setup controller.

func (*Controller) Close 

func (c *Controller) Close() error

Close releases any resources used by the controller. Error indicates any issue encountered releasing.

func (*Controller) Execute 

func (c *Controller) Execute(ctx context.Context) error

Execute executes the controller. Returning nil ends execution. Returning an error triggers a retry with backoff.

func (*Controller) GetControllerInfo 

func (c *Controller) GetControllerInfo() *controller.Info

GetControllerInfo returns information about the controller.

func (*Controller) HandleDirective 

func (c *Controller) HandleDirective(
	ctx context.Context,
	inst directive.Instance,
) ([]directive.Resolver, error)

HandleDirective asks if the handler can resolve the directive.

type Factory 

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

Factory constructs a setup controller.

func NewFactory 

func NewFactory(bus bus.Bus) *Factory

NewFactory builds a setup 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 configuration ID for the controller.

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.

Source Files

View all Source files

Directories

Path Synopsis

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.