Documentation
¶
Index ¶
- Constants
- Variables
- func NewFactory(b bus.Bus) controller.Factory
- 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 (c *Config) GetConfigID() string
- func (x *Config) GetObjectStoreId() string
- func (x *Config) GetObjectStoreKey() string
- func (x *Config) GetTransformConf() *transform.Config
- func (x *Config) GetVolumeId() string
- 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 (*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 StoredValue
- func (m *StoredValue) CloneMessageVT() protobuf_go_lite.CloneMessage
- func (m *StoredValue) CloneVT() *StoredValue
- func (this *StoredValue) EqualMessageVT(thatMsg any) bool
- func (this *StoredValue) EqualVT(that *StoredValue) bool
- func (x *StoredValue) GetPrivKeyPem() string
- func (x *StoredValue) MarshalJSON() ([]byte, error)
- func (x *StoredValue) MarshalProtoJSON(s *json.MarshalState)
- func (x *StoredValue) MarshalProtoText() string
- func (m *StoredValue) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *StoredValue) MarshalToVT(dAtA []byte) (int, error)
- func (m *StoredValue) MarshalVT() (dAtA []byte, err error)
- func (*StoredValue) ProtoMessage()
- func (x *StoredValue) Reset()
- func (m *StoredValue) SizeVT() (n int)
- func (x *StoredValue) String() string
- func (x *StoredValue) UnmarshalJSON(b []byte) error
- func (x *StoredValue) UnmarshalProtoJSON(s *json.UnmarshalState)
- func (m *StoredValue) UnmarshalVT(dAtA []byte) error
Constants ¶
const ConfigID = ControllerID
ConfigID is the config identifier.
const ControllerID = "object/peer"
ControllerID is the controller id.
Variables ¶
var Version = semver.MustParse("0.0.1")
Version is the component version
Functions ¶
func NewFactory ¶
func NewFactory(b bus.Bus) controller.Factory
NewFactory constructs the component factory.
Types ¶
type Config ¶
type Config struct {
// ObjectStoreId is the hydra object store to open to store the private key.
// Required.
ObjectStoreId string `protobuf:"bytes,1,opt,name=object_store_id,json=objectStoreId,proto3" json:"objectStoreId,omitempty"`
// VolumeId is the volume id to use for the object store.
// Can be empty to select any.
VolumeId string `protobuf:"bytes,2,opt,name=volume_id,json=volumeId,proto3" json:"volumeId,omitempty"`
// ObjectStoreKey is the key to use in the object store for the private key.
//
// Defaults to "priv"
ObjectStoreKey string `protobuf:"bytes,3,opt,name=object_store_key,json=objectStoreKey,proto3" json:"objectStoreKey,omitempty"`
// TransformConf transforms the private key before storing it in storage.
TransformConf *transform.Config `protobuf:"bytes,4,opt,name=transform_conf,json=transformConf,proto3" json:"transformConf,omitempty"`
// contains filtered or unexported fields
}
Config configures the object store peer controller. The controller stores a peer private key in an ObjectStore.
It can optionally apply the provided transform config to the key data.
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) GetConfigID ¶
GetConfigID returns the unique string for this configuration type.
func (*Config) GetObjectStoreId ¶
func (*Config) GetObjectStoreKey ¶
func (*Config) GetTransformConf ¶
func (*Config) GetVolumeId ¶
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) 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 struct {
*bus.BusController[*Config]
// contains filtered or unexported fields
}
Controller is the root resource controller.
func NewController ¶
func NewController(base *bus.BusController[*Config]) (*Controller, error)
NewController constructs a new Controller.
func (*Controller) Execute ¶
func (c *Controller) Execute(ctx context.Context) error
Execute executes the controller.
func (*Controller) HandleDirective ¶
func (c *Controller) HandleDirective(ctx context.Context, di directive.Instance) ([]directive.Resolver, error)
HandleDirective asks if the handler can resolve the directive. If it can, it returns a resolver. If not, returns nil. Any unexpected errors are returned for logging. It is safe to add a reference to the directive during this call.
func (*Controller) ResolvePeer ¶
ResolvePeer adds a reference to the Peer and waits for a value. Returns the value, reference, and any error. If err != nil, value and reference will be nil. Returns a release function.
type StoredValue ¶
type StoredValue struct {
// PrivKeyPem is the private key value in pem format.
PrivKeyPem string `protobuf:"bytes,1,opt,name=priv_key_pem,json=privKeyPem,proto3" json:"privKeyPem,omitempty"`
// contains filtered or unexported fields
}
StoredValue is the value for the ObjectStore containing the private key.
func (*StoredValue) CloneMessageVT ¶
func (m *StoredValue) CloneMessageVT() protobuf_go_lite.CloneMessage
func (*StoredValue) CloneVT ¶
func (m *StoredValue) CloneVT() *StoredValue
func (*StoredValue) EqualMessageVT ¶
func (this *StoredValue) EqualMessageVT(thatMsg any) bool
func (*StoredValue) EqualVT ¶
func (this *StoredValue) EqualVT(that *StoredValue) bool
func (*StoredValue) GetPrivKeyPem ¶
func (x *StoredValue) GetPrivKeyPem() string
func (*StoredValue) MarshalJSON ¶
func (x *StoredValue) MarshalJSON() ([]byte, error)
MarshalJSON marshals the StoredValue to JSON.
func (*StoredValue) MarshalProtoJSON ¶
func (x *StoredValue) MarshalProtoJSON(s *json.MarshalState)
MarshalProtoJSON marshals the StoredValue message to JSON.
func (*StoredValue) MarshalProtoText ¶
func (x *StoredValue) MarshalProtoText() string
func (*StoredValue) MarshalToSizedBufferVT ¶
func (m *StoredValue) MarshalToSizedBufferVT(dAtA []byte) (int, error)
func (*StoredValue) MarshalToVT ¶
func (m *StoredValue) MarshalToVT(dAtA []byte) (int, error)
func (*StoredValue) MarshalVT ¶
func (m *StoredValue) MarshalVT() (dAtA []byte, err error)
func (*StoredValue) ProtoMessage ¶
func (*StoredValue) ProtoMessage()
func (*StoredValue) Reset ¶
func (x *StoredValue) Reset()
func (*StoredValue) SizeVT ¶
func (m *StoredValue) SizeVT() (n int)
func (*StoredValue) String ¶
func (x *StoredValue) String() string
func (*StoredValue) UnmarshalJSON ¶
func (x *StoredValue) UnmarshalJSON(b []byte) error
UnmarshalJSON unmarshals the StoredValue from JSON.
func (*StoredValue) UnmarshalProtoJSON ¶
func (x *StoredValue) UnmarshalProtoJSON(s *json.UnmarshalState)
UnmarshalProtoJSON unmarshals the StoredValue message from JSON.
func (*StoredValue) UnmarshalVT ¶
func (m *StoredValue) UnmarshalVT(dAtA []byte) error