Documentation ¶
Index ¶
- Constants
- Variables
- func BuildConfigCmd() *cobra.Command
- func BuildConfigConfigurationHistoryCmd() *cobra.Command
- func BuildConfigGetConfigurationCmd() *cobra.Command
- func BuildConfigGetDefaultConfigurationCmd() *cobra.Command
- func BuildConfigResetConfigurationCmd() *cobra.Command
- func BuildConfigResetDefaultConfigurationCmd() *cobra.Command
- func BuildConfigSetConfigurationCmd() *cobra.Command
- func BuildConfigSetDefaultConfigurationCmd() *cobra.Command
- func BuildExampleAPIExtensionCmd() *cobra.Command
- func BuildExampleAPIExtensionEchoCmd() *cobra.Command
- func BuildExampleAPIExtensionReadyCmd() *cobra.Command
- func BuildExampleUnaryExtensionCmd() *cobra.Command
- func BuildExampleUnaryExtensionHelloCmd() *cobra.Command
- func ContextWithConfigClient(ctx context.Context, client ConfigClient) context.Context
- func ContextWithExampleAPIExtensionClient(ctx context.Context, client ExampleAPIExtensionClient) context.Context
- func ContextWithExampleUnaryExtensionClient(ctx context.Context, client ExampleUnaryExtensionClient) context.Context
- func RegisterConfigServer(s grpc.ServiceRegistrar, srv ConfigServer)
- func RegisterExampleAPIExtensionServer(s grpc.ServiceRegistrar, srv ExampleAPIExtensionServer)
- func RegisterExampleUnaryExtensionServer(s grpc.ServiceRegistrar, srv ExampleUnaryExtensionServer)
- func Scheme(ctx context.Context) meta.Scheme
- type ConfigClient
- type ConfigServer
- type ConfigServerBackend
- func (b *ConfigServerBackend) ConfigurationHistory(ctx context.Context, in *driverutil.ConfigurationHistoryRequest) (*HistoryResponse, error)
- func (b *ConfigServerBackend) DryRun(ctx context.Context, in *DryRunRequest) (*DryRunResponse, error)
- func (b *ConfigServerBackend) GetConfiguration(ctx context.Context, in *driverutil.GetRequest) (*ConfigSpec, error)
- func (b *ConfigServerBackend) GetDefaultConfiguration(ctx context.Context, in *driverutil.GetRequest) (*ConfigSpec, error)
- func (b *ConfigServerBackend) Initialize(driver ExampleDriver)
- func (b *ConfigServerBackend) ResetConfiguration(ctx context.Context, in *ResetRequest) (*emptypb.Empty, error)
- func (b *ConfigServerBackend) ResetDefaultConfiguration(ctx context.Context, in *emptypb.Empty) (*emptypb.Empty, error)
- func (b *ConfigServerBackend) SetConfiguration(ctx context.Context, in *ConfigSpec) (*emptypb.Empty, error)
- func (b *ConfigServerBackend) SetDefaultConfiguration(ctx context.Context, in *ConfigSpec) (*emptypb.Empty, error)
- type ConfigSpec
- func (*ConfigSpec) Descriptor() ([]byte, []int)deprecated
- func (in *ConfigSpec) FlagSet(prefix ...string) *pflag.FlagSet
- func (x *ConfigSpec) GetBoolVar() bool
- func (x *ConfigSpec) GetEnabled() bool
- func (x *ConfigSpec) GetIntVar() int32
- func (x *ConfigSpec) GetMessageVar() *Message
- func (x *ConfigSpec) GetRevision() *v1.Revision
- func (x *ConfigSpec) GetSecretVar() string
- func (x *ConfigSpec) GetStringVar() string
- func (*ConfigSpec) ProtoMessage()
- func (x *ConfigSpec) ProtoReflect() protoreflect.Message
- func (in *ConfigSpec) RedactSecrets()
- func (x *ConfigSpec) Reset()
- func (x *ConfigSpec) String() string
- func (in *ConfigSpec) UnredactSecrets(unredacted *ConfigSpec) error
- type DriverImpl
- type DryRunRequest
- func (*DryRunRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DryRunRequest) GetAction() driverutil.Action
- func (x *DryRunRequest) GetMask() *fieldmaskpb.FieldMask
- func (x *DryRunRequest) GetPatch() *ConfigSpec
- func (x *DryRunRequest) GetRevision() *v1.Revision
- func (x *DryRunRequest) GetSpec() *ConfigSpec
- func (x *DryRunRequest) GetTarget() driverutil.Target
- func (*DryRunRequest) ProtoMessage()
- func (x *DryRunRequest) ProtoReflect() protoreflect.Message
- func (x *DryRunRequest) Reset()
- func (x *DryRunRequest) String() string
- type DryRunResponse
- func (*DryRunResponse) Descriptor() ([]byte, []int)deprecated
- func (x *DryRunResponse) GetCurrent() *ConfigSpec
- func (x *DryRunResponse) GetModified() *ConfigSpec
- func (x *DryRunResponse) GetValidationErrors() []*driverutil.ValidationError
- func (*DryRunResponse) ProtoMessage()
- func (x *DryRunResponse) ProtoReflect() protoreflect.Message
- func (x *DryRunResponse) Reset()
- func (x *DryRunResponse) String() string
- type EchoRequest
- func (*EchoRequest) Descriptor() ([]byte, []int)deprecated
- func (in *EchoRequest) FlagSet(prefix ...string) *pflag.FlagSet
- func (x *EchoRequest) GetMessage() string
- func (*EchoRequest) ProtoMessage()
- func (x *EchoRequest) ProtoReflect() protoreflect.Message
- func (x *EchoRequest) Reset()
- func (x *EchoRequest) String() string
- type EchoResponse
- type ExampleAPIExtensionClient
- type ExampleAPIExtensionServer
- type ExampleDriver
- type ExampleDriverImplOptions
- type ExamplePlugin
- func (s *ExamplePlugin) CanInstall(context.Context, *emptypb.Empty) (*emptypb.Empty, error)
- func (s *ExamplePlugin) CancelUninstall(_ context.Context, ref *corev1.Reference) (*emptypb.Empty, error)
- func (s *ExamplePlugin) ConfigureRoutes(app *gin.Engine)
- func (s *ExamplePlugin) Echo(_ context.Context, req *EchoRequest) (*EchoResponse, error)
- func (s *ExamplePlugin) Hello(context.Context, *emptypb.Empty) (*EchoResponse, error)
- func (s *ExamplePlugin) Info(context.Context, *emptypb.Empty) (*capabilityv1.Details, error)
- func (s *ExamplePlugin) Initialize()
- func (s *ExamplePlugin) Install(ctx context.Context, req *capabilityv1.InstallRequest) (*capabilityv1.InstallResponse, error)
- func (s *ExamplePlugin) InstallerTemplate(context.Context, *emptypb.Empty) (*capabilityv1.InstallerTemplateResponse, error)
- func (s *ExamplePlugin) Ready(_ context.Context, _ *emptypb.Empty) (*emptypb.Empty, error)
- func (s *ExamplePlugin) Status(ctx context.Context, ref *corev1.Reference) (*capabilityv1.NodeCapabilityStatus, error)
- func (s *ExamplePlugin) Uninstall(ctx context.Context, req *capabilityv1.UninstallRequest) (*emptypb.Empty, error)
- func (s *ExamplePlugin) UninstallStatus(_ context.Context, ref *corev1.Reference) (*corev1.TaskStatus, error)
- func (s *ExamplePlugin) UseCachingProvider(cacheProvider caching.CachingProvider[proto.Message])
- func (s *ExamplePlugin) UseKeyValueStore(client system.KeyValueStoreClient)
- func (s *ExamplePlugin) UseManagementAPI(client managementv1.ManagementClient)
- type ExampleUnaryExtensionClient
- type ExampleUnaryExtensionServer
- type HistoryResponse
- func (*HistoryResponse) Descriptor() ([]byte, []int)deprecated
- func (x *HistoryResponse) GetEntries() []*ConfigSpec
- func (*HistoryResponse) ProtoMessage()
- func (x *HistoryResponse) ProtoReflect() protoreflect.Message
- func (h *HistoryResponse) RenderText(out cli.Writer)
- func (x *HistoryResponse) Reset()
- func (x *HistoryResponse) String() string
- type Message
- func (*Message) Descriptor() ([]byte, []int)deprecated
- func (in *Message) FlagSet(prefix ...string) *pflag.FlagSet
- func (x *Message) GetStringMapVar() map[string]string
- func (x *Message) GetStringSliceVar() []string
- func (*Message) ProtoMessage()
- func (x *Message) ProtoReflect() protoreflect.Message
- func (x *Message) Reset()
- func (x *Message) String() string
- type ResetRequest
- func (*ResetRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ResetRequest) GetMask() *fieldmaskpb.FieldMask
- func (x *ResetRequest) GetPatch() *ConfigSpec
- func (*ResetRequest) ProtoMessage()
- func (x *ResetRequest) ProtoReflect() protoreflect.Message
- func (x *ResetRequest) Reset()
- func (x *ResetRequest) String() string
- type UnimplementedConfigServer
- func (UnimplementedConfigServer) ConfigurationHistory(context.Context, *driverutil.ConfigurationHistoryRequest) (*HistoryResponse, error)
- func (UnimplementedConfigServer) DryRun(context.Context, *DryRunRequest) (*DryRunResponse, error)
- func (UnimplementedConfigServer) GetConfiguration(context.Context, *driverutil.GetRequest) (*ConfigSpec, error)
- func (UnimplementedConfigServer) GetDefaultConfiguration(context.Context, *driverutil.GetRequest) (*ConfigSpec, error)
- func (UnimplementedConfigServer) ResetConfiguration(context.Context, *ResetRequest) (*emptypb.Empty, error)
- func (UnimplementedConfigServer) ResetDefaultConfiguration(context.Context, *emptypb.Empty) (*emptypb.Empty, error)
- func (UnimplementedConfigServer) SetConfiguration(context.Context, *ConfigSpec) (*emptypb.Empty, error)
- func (UnimplementedConfigServer) SetDefaultConfiguration(context.Context, *ConfigSpec) (*emptypb.Empty, error)
- type UnimplementedExampleAPIExtensionServer
- type UnimplementedExampleUnaryExtensionServer
- type UnsafeConfigServer
- type UnsafeExampleAPIExtensionServer
- type UnsafeExampleUnaryExtensionServer
Constants ¶
const ( ExampleAPIExtension_Echo_FullMethodName = "/example.ExampleAPIExtension/Echo" ExampleAPIExtension_Ready_FullMethodName = "/example.ExampleAPIExtension/Ready" )
const ( Config_GetDefaultConfiguration_FullMethodName = "/example.Config/GetDefaultConfiguration" Config_SetDefaultConfiguration_FullMethodName = "/example.Config/SetDefaultConfiguration" Config_GetConfiguration_FullMethodName = "/example.Config/GetConfiguration" Config_SetConfiguration_FullMethodName = "/example.Config/SetConfiguration" Config_ResetDefaultConfiguration_FullMethodName = "/example.Config/ResetDefaultConfiguration" Config_ResetConfiguration_FullMethodName = "/example.Config/ResetConfiguration" Config_DryRun_FullMethodName = "/example.Config/DryRun" Config_ConfigurationHistory_FullMethodName = "/example.Config/ConfigurationHistory" )
const (
ExampleUnaryExtension_Hello_FullMethodName = "/example.ExampleUnaryExtension/Hello"
)
Variables ¶
var Config_ServiceDesc = grpc.ServiceDesc{ ServiceName: "example.Config", HandlerType: (*ConfigServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetDefaultConfiguration", Handler: _Config_GetDefaultConfiguration_Handler, }, { MethodName: "SetDefaultConfiguration", Handler: _Config_SetDefaultConfiguration_Handler, }, { MethodName: "GetConfiguration", Handler: _Config_GetConfiguration_Handler, }, { MethodName: "SetConfiguration", Handler: _Config_SetConfiguration_Handler, }, { MethodName: "ResetDefaultConfiguration", Handler: _Config_ResetDefaultConfiguration_Handler, }, { MethodName: "ResetConfiguration", Handler: _Config_ResetConfiguration_Handler, }, { MethodName: "DryRun", Handler: _Config_DryRun_Handler, }, { MethodName: "ConfigurationHistory", Handler: _Config_ConfigurationHistory_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "github.com/rancher/opni/plugins/example/pkg/example/example.proto", }
Config_ServiceDesc is the grpc.ServiceDesc for Config service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var ExampleAPIExtension_ServiceDesc = grpc.ServiceDesc{ ServiceName: "example.ExampleAPIExtension", HandlerType: (*ExampleAPIExtensionServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Echo", Handler: _ExampleAPIExtension_Echo_Handler, }, { MethodName: "Ready", Handler: _ExampleAPIExtension_Ready_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "github.com/rancher/opni/plugins/example/pkg/example/example.proto", }
ExampleAPIExtension_ServiceDesc is the grpc.ServiceDesc for ExampleAPIExtension service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var ExampleUnaryExtension_ServiceDesc = grpc.ServiceDesc{ ServiceName: "example.ExampleUnaryExtension", HandlerType: (*ExampleUnaryExtensionServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Hello", Handler: _ExampleUnaryExtension_Hello_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "github.com/rancher/opni/plugins/example/pkg/example/example.proto", }
ExampleUnaryExtension_ServiceDesc is the grpc.ServiceDesc for ExampleUnaryExtension service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_github_com_rancher_opni_plugins_example_pkg_example_example_proto protoreflect.FileDescriptor
Functions ¶
func BuildConfigCmd ¶ added in v0.12.0
func BuildConfigConfigurationHistoryCmd ¶ added in v0.12.0
func BuildConfigGetConfigurationCmd ¶ added in v0.12.0
func BuildConfigGetDefaultConfigurationCmd ¶ added in v0.12.0
func BuildConfigResetConfigurationCmd ¶ added in v0.12.0
func BuildConfigResetDefaultConfigurationCmd ¶ added in v0.12.0
func BuildConfigSetConfigurationCmd ¶ added in v0.12.0
func BuildConfigSetDefaultConfigurationCmd ¶ added in v0.12.0
func BuildExampleAPIExtensionCmd ¶ added in v0.12.0
func BuildExampleAPIExtensionEchoCmd ¶ added in v0.12.0
func BuildExampleAPIExtensionReadyCmd ¶ added in v0.12.0
func BuildExampleUnaryExtensionCmd ¶ added in v0.12.0
func BuildExampleUnaryExtensionHelloCmd ¶ added in v0.12.0
func ContextWithConfigClient ¶ added in v0.12.0
func ContextWithConfigClient(ctx context.Context, client ConfigClient) context.Context
func ContextWithExampleAPIExtensionClient ¶ added in v0.12.0
func ContextWithExampleAPIExtensionClient(ctx context.Context, client ExampleAPIExtensionClient) context.Context
func ContextWithExampleUnaryExtensionClient ¶ added in v0.12.0
func ContextWithExampleUnaryExtensionClient(ctx context.Context, client ExampleUnaryExtensionClient) context.Context
func RegisterConfigServer ¶ added in v0.12.0
func RegisterConfigServer(s grpc.ServiceRegistrar, srv ConfigServer)
func RegisterExampleAPIExtensionServer ¶
func RegisterExampleAPIExtensionServer(s grpc.ServiceRegistrar, srv ExampleAPIExtensionServer)
func RegisterExampleUnaryExtensionServer ¶ added in v0.5.4
func RegisterExampleUnaryExtensionServer(s grpc.ServiceRegistrar, srv ExampleUnaryExtensionServer)
Types ¶
type ConfigClient ¶ added in v0.12.0
type ConfigClient interface { GetDefaultConfiguration(ctx context.Context, in *driverutil.GetRequest, opts ...grpc.CallOption) (*ConfigSpec, error) SetDefaultConfiguration(ctx context.Context, in *ConfigSpec, opts ...grpc.CallOption) (*emptypb.Empty, error) GetConfiguration(ctx context.Context, in *driverutil.GetRequest, opts ...grpc.CallOption) (*ConfigSpec, error) SetConfiguration(ctx context.Context, in *ConfigSpec, opts ...grpc.CallOption) (*emptypb.Empty, error) ResetDefaultConfiguration(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*emptypb.Empty, error) ResetConfiguration(ctx context.Context, in *ResetRequest, opts ...grpc.CallOption) (*emptypb.Empty, error) DryRun(ctx context.Context, in *DryRunRequest, opts ...grpc.CallOption) (*DryRunResponse, error) ConfigurationHistory(ctx context.Context, in *driverutil.ConfigurationHistoryRequest, opts ...grpc.CallOption) (*HistoryResponse, error) }
ConfigClient is the client API for Config service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func ConfigClientFromContext ¶ added in v0.12.0
func ConfigClientFromContext(ctx context.Context) (ConfigClient, bool)
func NewConfigClient ¶ added in v0.12.0
func NewConfigClient(cc grpc.ClientConnInterface) ConfigClient
type ConfigServer ¶ added in v0.12.0
type ConfigServer interface { GetDefaultConfiguration(context.Context, *driverutil.GetRequest) (*ConfigSpec, error) SetDefaultConfiguration(context.Context, *ConfigSpec) (*emptypb.Empty, error) GetConfiguration(context.Context, *driverutil.GetRequest) (*ConfigSpec, error) SetConfiguration(context.Context, *ConfigSpec) (*emptypb.Empty, error) ResetDefaultConfiguration(context.Context, *emptypb.Empty) (*emptypb.Empty, error) ResetConfiguration(context.Context, *ResetRequest) (*emptypb.Empty, error) DryRun(context.Context, *DryRunRequest) (*DryRunResponse, error) ConfigurationHistory(context.Context, *driverutil.ConfigurationHistoryRequest) (*HistoryResponse, error) // contains filtered or unexported methods }
ConfigServer is the server API for Config service. All implementations must embed UnimplementedConfigServer for forward compatibility
type ConfigServerBackend ¶ added in v0.12.0
type ConfigServerBackend struct { util.Initializer UnsafeConfigServer // contains filtered or unexported fields }
func (*ConfigServerBackend) ConfigurationHistory ¶ added in v0.12.0
func (b *ConfigServerBackend) ConfigurationHistory(ctx context.Context, in *driverutil.ConfigurationHistoryRequest) (*HistoryResponse, error)
func (*ConfigServerBackend) DryRun ¶ added in v0.12.0
func (b *ConfigServerBackend) DryRun(ctx context.Context, in *DryRunRequest) (*DryRunResponse, error)
func (*ConfigServerBackend) GetConfiguration ¶ added in v0.12.0
func (b *ConfigServerBackend) GetConfiguration(ctx context.Context, in *driverutil.GetRequest) (*ConfigSpec, error)
func (*ConfigServerBackend) GetDefaultConfiguration ¶ added in v0.12.0
func (b *ConfigServerBackend) GetDefaultConfiguration(ctx context.Context, in *driverutil.GetRequest) (*ConfigSpec, error)
func (*ConfigServerBackend) Initialize ¶ added in v0.12.0
func (b *ConfigServerBackend) Initialize(driver ExampleDriver)
func (*ConfigServerBackend) ResetConfiguration ¶ added in v0.12.0
func (b *ConfigServerBackend) ResetConfiguration(ctx context.Context, in *ResetRequest) (*emptypb.Empty, error)
func (*ConfigServerBackend) ResetDefaultConfiguration ¶ added in v0.12.0
func (*ConfigServerBackend) SetConfiguration ¶ added in v0.12.0
func (b *ConfigServerBackend) SetConfiguration(ctx context.Context, in *ConfigSpec) (*emptypb.Empty, error)
func (*ConfigServerBackend) SetDefaultConfiguration ¶ added in v0.12.0
func (b *ConfigServerBackend) SetDefaultConfiguration(ctx context.Context, in *ConfigSpec) (*emptypb.Empty, error)
type ConfigSpec ¶ added in v0.12.0
type ConfigSpec struct { Enabled *bool `protobuf:"varint,1,opt,name=enabled,proto3,oneof" json:"enabled,omitempty"` Revision *v1.Revision `protobuf:"bytes,2,opt,name=revision,proto3" json:"revision,omitempty"` StringVar *string `protobuf:"bytes,3,opt,name=stringVar,proto3,oneof" json:"stringVar,omitempty"` IntVar *int32 `protobuf:"varint,4,opt,name=intVar,proto3,oneof" json:"intVar,omitempty"` BoolVar *bool `protobuf:"varint,5,opt,name=boolVar,proto3,oneof" json:"boolVar,omitempty"` MessageVar *Message `protobuf:"bytes,6,opt,name=messageVar,proto3,oneof" json:"messageVar,omitempty"` SecretVar *string `protobuf:"bytes,7,opt,name=secretVar,proto3,oneof" json:"secretVar,omitempty"` // contains filtered or unexported fields }
func (*ConfigSpec) Descriptor
deprecated
added in
v0.12.0
func (*ConfigSpec) Descriptor() ([]byte, []int)
Deprecated: Use ConfigSpec.ProtoReflect.Descriptor instead.
func (*ConfigSpec) FlagSet ¶ added in v0.12.0
func (in *ConfigSpec) FlagSet(prefix ...string) *pflag.FlagSet
func (*ConfigSpec) GetBoolVar ¶ added in v0.12.0
func (x *ConfigSpec) GetBoolVar() bool
func (*ConfigSpec) GetEnabled ¶ added in v0.12.0
func (x *ConfigSpec) GetEnabled() bool
func (*ConfigSpec) GetIntVar ¶ added in v0.12.0
func (x *ConfigSpec) GetIntVar() int32
func (*ConfigSpec) GetMessageVar ¶ added in v0.12.0
func (x *ConfigSpec) GetMessageVar() *Message
func (*ConfigSpec) GetRevision ¶ added in v0.12.0
func (x *ConfigSpec) GetRevision() *v1.Revision
func (*ConfigSpec) GetSecretVar ¶ added in v0.12.0
func (x *ConfigSpec) GetSecretVar() string
func (*ConfigSpec) GetStringVar ¶ added in v0.12.0
func (x *ConfigSpec) GetStringVar() string
func (*ConfigSpec) ProtoMessage ¶ added in v0.12.0
func (*ConfigSpec) ProtoMessage()
func (*ConfigSpec) ProtoReflect ¶ added in v0.12.0
func (x *ConfigSpec) ProtoReflect() protoreflect.Message
func (*ConfigSpec) RedactSecrets ¶ added in v0.12.0
func (in *ConfigSpec) RedactSecrets()
func (*ConfigSpec) Reset ¶ added in v0.12.0
func (x *ConfigSpec) Reset()
func (*ConfigSpec) String ¶ added in v0.12.0
func (x *ConfigSpec) String() string
func (*ConfigSpec) UnredactSecrets ¶ added in v0.12.0
func (in *ConfigSpec) UnredactSecrets(unredacted *ConfigSpec) error
type DriverImpl ¶ added in v0.12.0
type DriverImpl struct { *driverutil.BaseConfigServer[*ResetRequest, *HistoryResponse, *ConfigSpec] }
func NewExampleDriverImpl ¶ added in v0.12.0
func NewExampleDriverImpl(options ExampleDriverImplOptions) *DriverImpl
func (*DriverImpl) DryRun ¶ added in v0.12.0
func (d *DriverImpl) DryRun(ctx context.Context, req *DryRunRequest) (*DryRunResponse, error)
DryRun implements ExampleDriver.
type DryRunRequest ¶ added in v0.12.0
type DryRunRequest struct { Target driverutil.Target `protobuf:"varint,1,opt,name=target,proto3,enum=driverutil.Target" json:"target,omitempty"` Action driverutil.Action `protobuf:"varint,2,opt,name=action,proto3,enum=driverutil.Action" json:"action,omitempty"` Spec *ConfigSpec `protobuf:"bytes,3,opt,name=spec,proto3" json:"spec,omitempty"` // Set Revision *v1.Revision `protobuf:"bytes,4,opt,name=revision,proto3" json:"revision,omitempty"` // Reset Patch *ConfigSpec `protobuf:"bytes,5,opt,name=patch,proto3" json:"patch,omitempty"` // Reset Mask *fieldmaskpb.FieldMask `protobuf:"bytes,6,opt,name=mask,proto3" json:"mask,omitempty"` // Reset // contains filtered or unexported fields }
func (*DryRunRequest) Descriptor
deprecated
added in
v0.12.0
func (*DryRunRequest) Descriptor() ([]byte, []int)
Deprecated: Use DryRunRequest.ProtoReflect.Descriptor instead.
func (*DryRunRequest) GetAction ¶ added in v0.12.0
func (x *DryRunRequest) GetAction() driverutil.Action
func (*DryRunRequest) GetMask ¶ added in v0.12.0
func (x *DryRunRequest) GetMask() *fieldmaskpb.FieldMask
func (*DryRunRequest) GetPatch ¶ added in v0.12.0
func (x *DryRunRequest) GetPatch() *ConfigSpec
func (*DryRunRequest) GetRevision ¶ added in v0.12.0
func (x *DryRunRequest) GetRevision() *v1.Revision
func (*DryRunRequest) GetSpec ¶ added in v0.12.0
func (x *DryRunRequest) GetSpec() *ConfigSpec
func (*DryRunRequest) GetTarget ¶ added in v0.12.0
func (x *DryRunRequest) GetTarget() driverutil.Target
func (*DryRunRequest) ProtoMessage ¶ added in v0.12.0
func (*DryRunRequest) ProtoMessage()
func (*DryRunRequest) ProtoReflect ¶ added in v0.12.0
func (x *DryRunRequest) ProtoReflect() protoreflect.Message
func (*DryRunRequest) Reset ¶ added in v0.12.0
func (x *DryRunRequest) Reset()
func (*DryRunRequest) String ¶ added in v0.12.0
func (x *DryRunRequest) String() string
type DryRunResponse ¶ added in v0.12.0
type DryRunResponse struct { Current *ConfigSpec `protobuf:"bytes,1,opt,name=current,proto3" json:"current,omitempty"` Modified *ConfigSpec `protobuf:"bytes,2,opt,name=modified,proto3" json:"modified,omitempty"` ValidationErrors []*driverutil.ValidationError `protobuf:"bytes,3,rep,name=validationErrors,proto3" json:"validationErrors,omitempty"` // contains filtered or unexported fields }
func (*DryRunResponse) Descriptor
deprecated
added in
v0.12.0
func (*DryRunResponse) Descriptor() ([]byte, []int)
Deprecated: Use DryRunResponse.ProtoReflect.Descriptor instead.
func (*DryRunResponse) GetCurrent ¶ added in v0.12.0
func (x *DryRunResponse) GetCurrent() *ConfigSpec
func (*DryRunResponse) GetModified ¶ added in v0.12.0
func (x *DryRunResponse) GetModified() *ConfigSpec
func (*DryRunResponse) GetValidationErrors ¶ added in v0.12.0
func (x *DryRunResponse) GetValidationErrors() []*driverutil.ValidationError
func (*DryRunResponse) ProtoMessage ¶ added in v0.12.0
func (*DryRunResponse) ProtoMessage()
func (*DryRunResponse) ProtoReflect ¶ added in v0.12.0
func (x *DryRunResponse) ProtoReflect() protoreflect.Message
func (*DryRunResponse) Reset ¶ added in v0.12.0
func (x *DryRunResponse) Reset()
func (*DryRunResponse) String ¶ added in v0.12.0
func (x *DryRunResponse) String() string
type EchoRequest ¶
type EchoRequest struct { Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"` // contains filtered or unexported fields }
func (*EchoRequest) Descriptor
deprecated
func (*EchoRequest) Descriptor() ([]byte, []int)
Deprecated: Use EchoRequest.ProtoReflect.Descriptor instead.
func (*EchoRequest) FlagSet ¶ added in v0.12.0
func (in *EchoRequest) FlagSet(prefix ...string) *pflag.FlagSet
func (*EchoRequest) GetMessage ¶
func (x *EchoRequest) GetMessage() string
func (*EchoRequest) ProtoMessage ¶
func (*EchoRequest) ProtoMessage()
func (*EchoRequest) ProtoReflect ¶
func (x *EchoRequest) ProtoReflect() protoreflect.Message
func (*EchoRequest) Reset ¶
func (x *EchoRequest) Reset()
func (*EchoRequest) String ¶
func (x *EchoRequest) String() string
type EchoResponse ¶
type EchoResponse struct { Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"` // contains filtered or unexported fields }
func (*EchoResponse) Descriptor
deprecated
func (*EchoResponse) Descriptor() ([]byte, []int)
Deprecated: Use EchoResponse.ProtoReflect.Descriptor instead.
func (*EchoResponse) GetMessage ¶
func (x *EchoResponse) GetMessage() string
func (*EchoResponse) ProtoMessage ¶
func (*EchoResponse) ProtoMessage()
func (*EchoResponse) ProtoReflect ¶
func (x *EchoResponse) ProtoReflect() protoreflect.Message
func (*EchoResponse) Reset ¶
func (x *EchoResponse) Reset()
func (*EchoResponse) String ¶
func (x *EchoResponse) String() string
type ExampleAPIExtensionClient ¶
type ExampleAPIExtensionClient interface { Echo(ctx context.Context, in *EchoRequest, opts ...grpc.CallOption) (*EchoResponse, error) Ready(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*emptypb.Empty, error) }
ExampleAPIExtensionClient is the client API for ExampleAPIExtension service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func ExampleAPIExtensionClientFromContext ¶ added in v0.12.0
func ExampleAPIExtensionClientFromContext(ctx context.Context) (ExampleAPIExtensionClient, bool)
func NewExampleAPIExtensionClient ¶
func NewExampleAPIExtensionClient(cc grpc.ClientConnInterface) ExampleAPIExtensionClient
type ExampleAPIExtensionServer ¶
type ExampleAPIExtensionServer interface { Echo(context.Context, *EchoRequest) (*EchoResponse, error) Ready(context.Context, *emptypb.Empty) (*emptypb.Empty, error) // contains filtered or unexported methods }
ExampleAPIExtensionServer is the server API for ExampleAPIExtension service. All implementations must embed UnimplementedExampleAPIExtensionServer for forward compatibility
type ExampleDriver ¶ added in v0.12.0
type ExampleDriver interface { driverutil.ConfigServer[*ConfigSpec, *ResetRequest, *HistoryResponse] driverutil.DryRunServer[*ConfigSpec, *DryRunRequest, *DryRunResponse] }
type ExampleDriverImplOptions ¶ added in v0.12.0
type ExampleDriverImplOptions struct { DefaultConfigStore storage.ValueStoreT[*ConfigSpec] `option:"defaultConfigStore"` ActiveConfigStore storage.ValueStoreT[*ConfigSpec] `option:"activeConfigStore"` }
type ExamplePlugin ¶
type ExamplePlugin struct { util.Initializer UnsafeExampleAPIExtensionServer UnsafeExampleUnaryExtensionServer capabilityv1.UnsafeBackendServer system.UnimplementedSystemPluginClient // contains filtered or unexported fields }
func (*ExamplePlugin) CanInstall ¶
func (*ExamplePlugin) CancelUninstall ¶ added in v0.6.0
func (*ExamplePlugin) ConfigureRoutes ¶
func (s *ExamplePlugin) ConfigureRoutes(app *gin.Engine)
func (*ExamplePlugin) Echo ¶
func (s *ExamplePlugin) Echo(_ context.Context, req *EchoRequest) (*EchoResponse, error)
func (*ExamplePlugin) Hello ¶ added in v0.5.4
func (s *ExamplePlugin) Hello(context.Context, *emptypb.Empty) (*EchoResponse, error)
func (*ExamplePlugin) Info ¶ added in v0.6.0
func (s *ExamplePlugin) Info(context.Context, *emptypb.Empty) (*capabilityv1.Details, error)
func (*ExamplePlugin) Initialize ¶ added in v0.11.0
func (s *ExamplePlugin) Initialize()
func (*ExamplePlugin) Install ¶
func (s *ExamplePlugin) Install(ctx context.Context, req *capabilityv1.InstallRequest) (*capabilityv1.InstallResponse, error)
func (*ExamplePlugin) InstallerTemplate ¶
func (s *ExamplePlugin) InstallerTemplate(context.Context, *emptypb.Empty) (*capabilityv1.InstallerTemplateResponse, error)
func (*ExamplePlugin) Status ¶ added in v0.6.0
func (s *ExamplePlugin) Status(ctx context.Context, ref *corev1.Reference) (*capabilityv1.NodeCapabilityStatus, error)
func (*ExamplePlugin) Uninstall ¶ added in v0.4.2
func (s *ExamplePlugin) Uninstall(ctx context.Context, req *capabilityv1.UninstallRequest) (*emptypb.Empty, error)
func (*ExamplePlugin) UninstallStatus ¶ added in v0.6.0
func (s *ExamplePlugin) UninstallStatus(_ context.Context, ref *corev1.Reference) (*corev1.TaskStatus, error)
func (*ExamplePlugin) UseCachingProvider ¶ added in v0.9.2
func (s *ExamplePlugin) UseCachingProvider(cacheProvider caching.CachingProvider[proto.Message])
func (*ExamplePlugin) UseKeyValueStore ¶
func (s *ExamplePlugin) UseKeyValueStore(client system.KeyValueStoreClient)
func (*ExamplePlugin) UseManagementAPI ¶
func (s *ExamplePlugin) UseManagementAPI(client managementv1.ManagementClient)
type ExampleUnaryExtensionClient ¶ added in v0.5.4
type ExampleUnaryExtensionClient interface {
Hello(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*EchoResponse, error)
}
ExampleUnaryExtensionClient is the client API for ExampleUnaryExtension service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func ExampleUnaryExtensionClientFromContext ¶ added in v0.12.0
func ExampleUnaryExtensionClientFromContext(ctx context.Context) (ExampleUnaryExtensionClient, bool)
func NewExampleUnaryExtensionClient ¶ added in v0.5.4
func NewExampleUnaryExtensionClient(cc grpc.ClientConnInterface) ExampleUnaryExtensionClient
type ExampleUnaryExtensionServer ¶ added in v0.5.4
type ExampleUnaryExtensionServer interface { Hello(context.Context, *emptypb.Empty) (*EchoResponse, error) // contains filtered or unexported methods }
ExampleUnaryExtensionServer is the server API for ExampleUnaryExtension service. All implementations must embed UnimplementedExampleUnaryExtensionServer for forward compatibility
type HistoryResponse ¶ added in v0.12.0
type HistoryResponse struct { Entries []*ConfigSpec `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty"` // contains filtered or unexported fields }
func (*HistoryResponse) Descriptor
deprecated
added in
v0.12.0
func (*HistoryResponse) Descriptor() ([]byte, []int)
Deprecated: Use HistoryResponse.ProtoReflect.Descriptor instead.
func (*HistoryResponse) GetEntries ¶ added in v0.12.0
func (x *HistoryResponse) GetEntries() []*ConfigSpec
func (*HistoryResponse) ProtoMessage ¶ added in v0.12.0
func (*HistoryResponse) ProtoMessage()
func (*HistoryResponse) ProtoReflect ¶ added in v0.12.0
func (x *HistoryResponse) ProtoReflect() protoreflect.Message
func (*HistoryResponse) RenderText ¶ added in v0.12.0
func (h *HistoryResponse) RenderText(out cli.Writer)
Enables the history terminal UI
func (*HistoryResponse) Reset ¶ added in v0.12.0
func (x *HistoryResponse) Reset()
func (*HistoryResponse) String ¶ added in v0.12.0
func (x *HistoryResponse) String() string
type Message ¶ added in v0.12.0
type Message struct { StringSliceVar []string `protobuf:"bytes,1,rep,name=stringSliceVar,proto3" json:"stringSliceVar,omitempty"` StringMapVar map[string]string `` /* 165-byte string literal not displayed */ // contains filtered or unexported fields }
func (*Message) Descriptor
deprecated
added in
v0.12.0
func (*Message) GetStringMapVar ¶ added in v0.12.0
func (*Message) GetStringSliceVar ¶ added in v0.12.0
func (*Message) ProtoMessage ¶ added in v0.12.0
func (*Message) ProtoMessage()
func (*Message) ProtoReflect ¶ added in v0.12.0
func (x *Message) ProtoReflect() protoreflect.Message
type ResetRequest ¶ added in v0.12.0
type ResetRequest struct { Mask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=mask,proto3" json:"mask,omitempty"` Patch *ConfigSpec `protobuf:"bytes,2,opt,name=patch,proto3" json:"patch,omitempty"` // contains filtered or unexported fields }
func (*ResetRequest) Descriptor
deprecated
added in
v0.12.0
func (*ResetRequest) Descriptor() ([]byte, []int)
Deprecated: Use ResetRequest.ProtoReflect.Descriptor instead.
func (*ResetRequest) GetMask ¶ added in v0.12.0
func (x *ResetRequest) GetMask() *fieldmaskpb.FieldMask
func (*ResetRequest) GetPatch ¶ added in v0.12.0
func (x *ResetRequest) GetPatch() *ConfigSpec
func (*ResetRequest) ProtoMessage ¶ added in v0.12.0
func (*ResetRequest) ProtoMessage()
func (*ResetRequest) ProtoReflect ¶ added in v0.12.0
func (x *ResetRequest) ProtoReflect() protoreflect.Message
func (*ResetRequest) Reset ¶ added in v0.12.0
func (x *ResetRequest) Reset()
func (*ResetRequest) String ¶ added in v0.12.0
func (x *ResetRequest) String() string
type UnimplementedConfigServer ¶ added in v0.12.0
type UnimplementedConfigServer struct { }
UnimplementedConfigServer must be embedded to have forward compatible implementations.
func (UnimplementedConfigServer) ConfigurationHistory ¶ added in v0.12.0
func (UnimplementedConfigServer) ConfigurationHistory(context.Context, *driverutil.ConfigurationHistoryRequest) (*HistoryResponse, error)
func (UnimplementedConfigServer) DryRun ¶ added in v0.12.0
func (UnimplementedConfigServer) DryRun(context.Context, *DryRunRequest) (*DryRunResponse, error)
func (UnimplementedConfigServer) GetConfiguration ¶ added in v0.12.0
func (UnimplementedConfigServer) GetConfiguration(context.Context, *driverutil.GetRequest) (*ConfigSpec, error)
func (UnimplementedConfigServer) GetDefaultConfiguration ¶ added in v0.12.0
func (UnimplementedConfigServer) GetDefaultConfiguration(context.Context, *driverutil.GetRequest) (*ConfigSpec, error)
func (UnimplementedConfigServer) ResetConfiguration ¶ added in v0.12.0
func (UnimplementedConfigServer) ResetConfiguration(context.Context, *ResetRequest) (*emptypb.Empty, error)
func (UnimplementedConfigServer) ResetDefaultConfiguration ¶ added in v0.12.0
func (UnimplementedConfigServer) SetConfiguration ¶ added in v0.12.0
func (UnimplementedConfigServer) SetConfiguration(context.Context, *ConfigSpec) (*emptypb.Empty, error)
func (UnimplementedConfigServer) SetDefaultConfiguration ¶ added in v0.12.0
func (UnimplementedConfigServer) SetDefaultConfiguration(context.Context, *ConfigSpec) (*emptypb.Empty, error)
type UnimplementedExampleAPIExtensionServer ¶
type UnimplementedExampleAPIExtensionServer struct { }
UnimplementedExampleAPIExtensionServer must be embedded to have forward compatible implementations.
func (UnimplementedExampleAPIExtensionServer) Echo ¶
func (UnimplementedExampleAPIExtensionServer) Echo(context.Context, *EchoRequest) (*EchoResponse, error)
type UnimplementedExampleUnaryExtensionServer ¶ added in v0.5.4
type UnimplementedExampleUnaryExtensionServer struct { }
UnimplementedExampleUnaryExtensionServer must be embedded to have forward compatible implementations.
func (UnimplementedExampleUnaryExtensionServer) Hello ¶ added in v0.5.4
func (UnimplementedExampleUnaryExtensionServer) Hello(context.Context, *emptypb.Empty) (*EchoResponse, error)
type UnsafeConfigServer ¶ added in v0.12.0
type UnsafeConfigServer interface {
// contains filtered or unexported methods
}
UnsafeConfigServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ConfigServer will result in compilation errors.
type UnsafeExampleAPIExtensionServer ¶
type UnsafeExampleAPIExtensionServer interface {
// contains filtered or unexported methods
}
UnsafeExampleAPIExtensionServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ExampleAPIExtensionServer will result in compilation errors.
type UnsafeExampleUnaryExtensionServer ¶ added in v0.5.4
type UnsafeExampleUnaryExtensionServer interface {
// contains filtered or unexported methods
}
UnsafeExampleUnaryExtensionServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ExampleUnaryExtensionServer will result in compilation errors.