Documentation
¶
Index ¶
- Constants
- Variables
- func NewBlockStoreBuilder(le *logrus.Entry, b bus.Bus, conf *Config) block_store_controller.BlockStoreBuilder
- type Config
- func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage
- func (m *Config) CloneVT() *Config
- func (this *Config) EqualMessageVT(thatMsg any) bool
- func (this *Config) EqualVT(that *Config) bool
- func (c *Config) EqualsConfig(other config.Config) bool
- func (x *Config) GetBlockStoreId() string
- func (x *Config) GetBucketIds() []string
- func (x *Config) GetCacheBlockStoreId() string
- func (x *Config) GetCdnBaseUrl() string
- func (c *Config) GetConfigID() string
- func (x *Config) GetPointerTtlDur() string
- func (x *Config) GetRangeCacheMaxBytes() int64
- func (x *Config) GetSkipNotFound() bool
- func (x *Config) GetSpaceId() string
- func (x *Config) GetVerbose() bool
- func (x *Config) GetWritebackWindowBytes() int64
- func (x *Config) MarshalJSON() ([]byte, error)
- func (x *Config) MarshalProtoJSON(s *json.MarshalState)
- func (x *Config) MarshalProtoText() string
- func (m *Config) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *Config) MarshalToVT(dAtA []byte) (int, error)
- func (m *Config) MarshalVT() (dAtA []byte, err error)
- func (c *Config) ParsePointerTTLDur() (time.Duration, error)
- func (*Config) ProtoMessage()
- func (x *Config) Reset()
- func (m *Config) SizeVT() (n int)
- func (x *Config) String() string
- func (x *Config) UnmarshalJSON(b []byte) error
- func (x *Config) UnmarshalProtoJSON(s *json.UnmarshalState)
- func (m *Config) UnmarshalVT(dAtA []byte) error
- func (c *Config) Validate() error
- type Controller
- type Factory
- func (t *Factory) Construct(_ context.Context, conf config.Config, opts controller.ConstructOpts) (controller.Controller, error)
- func (t *Factory) ConstructConfig() config.Config
- func (t *Factory) GetConfigID() string
- func (t *Factory) GetControllerID() string
- func (t *Factory) GetVersion() semver.Version
Constants ¶
const ConfigID = ControllerID
ConfigID is the string used to identify this config object.
const ControllerID = "spacewave/cdn/bstore"
ControllerID identifies the anonymous CDN block store controller.
Variables ¶
var Version = semver.MustParse("0.0.1")
Version is the version of the block store implementation.
Functions ¶
func NewBlockStoreBuilder ¶
func NewBlockStoreBuilder(le *logrus.Entry, b bus.Bus, conf *Config) block_store_controller.BlockStoreBuilder
NewBlockStoreBuilder constructs a new block store builder from config.
Types ¶
type Config ¶
type Config struct {
// BlockStoreId is the block store id to use on the bus.
BlockStoreId string `protobuf:"bytes,1,opt,name=block_store_id,json=blockStoreId,proto3" json:"blockStoreId,omitempty"`
// SpaceId is the public CDN Space id.
SpaceId string `protobuf:"bytes,2,opt,name=space_id,json=spaceId,proto3" json:"spaceId,omitempty"`
// CdnBaseUrl is the public CDN base URL.
CdnBaseUrl string `protobuf:"bytes,3,opt,name=cdn_base_url,json=cdnBaseUrl,proto3" json:"cdnBaseUrl,omitempty"`
// PointerTtlDur is the cached root pointer TTL.
// Empty uses the CDN block store default. Negative disables expiry.
PointerTtlDur string `protobuf:"bytes,4,opt,name=pointer_ttl_dur,json=pointerTtlDur,proto3" json:"pointerTtlDur,omitempty"`
// CacheBlockStoreId optionally resolves a local block store for co-block
// writeback while reading remote pack ranges.
CacheBlockStoreId string `protobuf:"bytes,5,opt,name=cache_block_store_id,json=cacheBlockStoreId,proto3" json:"cacheBlockStoreId,omitempty"`
// WritebackWindowBytes sets the semantic co-block writeback window.
WritebackWindowBytes int64 `protobuf:"varint,6,opt,name=writeback_window_bytes,json=writebackWindowBytes,proto3" json:"writebackWindowBytes,omitempty"`
// RangeCacheMaxBytes sets the resident range-cache budget per pack reader.
RangeCacheMaxBytes int64 `protobuf:"varint,7,opt,name=range_cache_max_bytes,json=rangeCacheMaxBytes,proto3" json:"rangeCacheMaxBytes,omitempty"`
// BucketIds is a list of bucket ids to serve LookupBlockFromNetwork directives.
BucketIds []string `protobuf:"bytes,8,rep,name=bucket_ids,json=bucketIds,proto3" json:"bucketIds,omitempty"`
// SkipNotFound skips returning a value if the block was not found.
SkipNotFound bool `protobuf:"varint,9,opt,name=skip_not_found,json=skipNotFound,proto3" json:"skipNotFound,omitempty"`
// Verbose enables verbose logging of the block store.
Verbose bool `protobuf:"varint,10,opt,name=verbose,proto3" json:"verbose,omitempty"`
// contains filtered or unexported fields
}
Config configures an anonymous CDN block store controller.
func (*Config) CloneMessageVT ¶
func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage
func (*Config) EqualMessageVT ¶
func (*Config) EqualsConfig ¶
EqualsConfig checks if the config is equal to another.
func (*Config) GetBlockStoreId ¶
func (*Config) GetBucketIds ¶
func (*Config) GetCacheBlockStoreId ¶
func (*Config) GetCdnBaseUrl ¶
func (*Config) GetConfigID ¶
GetConfigID returns the unique string for this configuration type.
func (*Config) GetPointerTtlDur ¶
func (*Config) GetRangeCacheMaxBytes ¶
func (*Config) GetSkipNotFound ¶
func (*Config) GetSpaceId ¶
func (*Config) GetVerbose ¶
func (*Config) GetWritebackWindowBytes ¶
func (*Config) MarshalJSON ¶
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 (*Config) MarshalToSizedBufferVT ¶
func (*Config) ParsePointerTTLDur ¶
ParsePointerTTLDur parses the root pointer TTL field.
func (*Config) ProtoMessage ¶
func (*Config) ProtoMessage()
func (*Config) UnmarshalJSON ¶
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 ¶
type Controller ¶
type Controller = block_store_controller.Controller
Controller implements the anonymous CDN block store controller.
func NewController ¶
NewController builds a new anonymous CDN block store controller.
type Factory ¶
type Factory struct {
// contains filtered or unexported fields
}
Factory constructs the CDN block store.
func (*Factory) Construct ¶
func (t *Factory) Construct( _ context.Context, conf config.Config, opts controller.ConstructOpts, ) (controller.Controller, error)
Construct constructs the associated controller given configuration.
func (*Factory) ConstructConfig ¶
ConstructConfig constructs an instance of the controller configuration.
func (*Factory) GetConfigID ¶
GetConfigID returns the configuration ID for the controller.
func (*Factory) GetControllerID ¶
GetControllerID returns the unique ID for the controller.
func (*Factory) GetVersion ¶
GetVersion returns the version of this controller.