configv1

Documentation

Index

• Variables
• func ConfigServiceServer(server ConfigServer) pluginsdk.ServiceServer
• func RegisterConfigServer(s grpc.ServiceRegistrar, srv ConfigServer)
• type ConfigClient
  • func NewConfigClient(cc grpc.ClientConnInterface) ConfigClient
• type ConfigServer
• type ConfigServiceClient
  • func (c *ConfigServiceClient) GRPCServiceName() string
  • func (c *ConfigServiceClient) InitClient(conn grpc.ClientConnInterface) interface{}
  • func (c *ConfigServiceClient) IsInitialized() bool
• type ConfigureRequest
  • func (*ConfigureRequest) Descriptor() ([]byte, []int)
  • func (x *ConfigureRequest) GetCoreConfiguration() *CoreConfiguration
  • func (x *ConfigureRequest) GetHclConfiguration() string
  • func (*ConfigureRequest) ProtoMessage()
  • func (x *ConfigureRequest) ProtoReflect() protoreflect.Message
  • func (x *ConfigureRequest) Reset()
  • func (x *ConfigureRequest) String() string
• type ConfigureResponse
  • func (*ConfigureResponse) Descriptor() ([]byte, []int)
  • func (*ConfigureResponse) ProtoMessage()
  • func (x *ConfigureResponse) ProtoReflect() protoreflect.Message
  • func (x *ConfigureResponse) Reset()
  • func (x *ConfigureResponse) String() string
• type CoreConfiguration
  • func (*CoreConfiguration) Descriptor() ([]byte, []int)
  • func (x *CoreConfiguration) GetTrustDomain() string
  • func (*CoreConfiguration) ProtoMessage()
  • func (x *CoreConfiguration) ProtoReflect() protoreflect.Message
  • func (x *CoreConfiguration) Reset()
  • func (x *CoreConfiguration) String() string
• type UnimplementedConfigServer
  • func (UnimplementedConfigServer) Configure(context.Context, *ConfigureRequest) (*ConfigureResponse, error)
• type UnsafeConfigServer

Variables

var Config_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "spire.service.common.config.v1.Config",
	HandlerType: (*ConfigServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Configure",
			Handler:    _Config_Configure_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "spire/service/common/config/v1/config.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 File_spire_service_common_config_v1_config_proto protoreflect.FileDescriptor

Functions

func ConfigServiceServer

func ConfigServiceServer(server ConfigServer) pluginsdk.ServiceServer

func RegisterConfigServer

func RegisterConfigServer(s grpc.ServiceRegistrar, srv ConfigServer)

Types

type ConfigClient

type ConfigClient interface {
	// Configure is called by SPIRE to configure the plugin with the plugin
	// specific configuration data and a set of SPIRE core configuration. It is
	// currently called when the plugin is first loaded after it has been
	// initialized. At a future point, it may be called to reconfigure the
	// plugin during runtime. Implementations should therefore expect that
	// calls to Configure can happen concurrently with other RPCs against the
	// plugin.
	Configure(ctx context.Context, in *ConfigureRequest, opts ...grpc.CallOption) (*ConfigureResponse, 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 NewConfigClient

func NewConfigClient(cc grpc.ClientConnInterface) ConfigClient

type ConfigServer

type ConfigServer interface {
	// Configure is called by SPIRE to configure the plugin with the plugin
	// specific configuration data and a set of SPIRE core configuration. It is
	// currently called when the plugin is first loaded after it has been
	// initialized. At a future point, it may be called to reconfigure the
	// plugin during runtime. Implementations should therefore expect that
	// calls to Configure can happen concurrently with other RPCs against the
	// plugin.
	Configure(context.Context, *ConfigureRequest) (*ConfigureResponse, error)
	// contains filtered or unexported methods
}

ConfigServer is the server API for Config service. All implementations must embed UnimplementedConfigServer for forward compatibility

type ConfigServiceClient

type ConfigServiceClient struct {
	ConfigClient
}

func (*ConfigServiceClient) GRPCServiceName

func (c *ConfigServiceClient) GRPCServiceName() string

func (*ConfigServiceClient) InitClient

func (c *ConfigServiceClient) InitClient(conn grpc.ClientConnInterface) interface{}

func (*ConfigServiceClient) IsInitialized

func (c *ConfigServiceClient) IsInitialized() bool

type ConfigureRequest

type ConfigureRequest struct {

	// Required. Core SPIRE configuration.
	CoreConfiguration *CoreConfiguration `protobuf:"bytes,1,opt,name=core_configuration,json=coreConfiguration,proto3" json:"core_configuration,omitempty"`
	// Required. HCL encoded plugin configuration.
	HclConfiguration string `protobuf:"bytes,2,opt,name=hcl_configuration,json=hclConfiguration,proto3" json:"hcl_configuration,omitempty"`
	// contains filtered or unexported fields
}

func (*ConfigureRequest) Descriptor

func (*ConfigureRequest) Descriptor() ([]byte, []int)

Deprecated: Use ConfigureRequest.ProtoReflect.Descriptor instead.

func (*ConfigureRequest) GetCoreConfiguration

func (x *ConfigureRequest) GetCoreConfiguration() *CoreConfiguration

func (*ConfigureRequest) GetHclConfiguration

func (x *ConfigureRequest) GetHclConfiguration() string

func (*ConfigureRequest) ProtoMessage

func (*ConfigureRequest) ProtoMessage()

func (*ConfigureRequest) ProtoReflect

func (x *ConfigureRequest) ProtoReflect() protoreflect.Message

func (*ConfigureRequest) Reset

func (x *ConfigureRequest) Reset()

func (*ConfigureRequest) String

func (x *ConfigureRequest) String() string

type ConfigureResponse

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

func (*ConfigureResponse) Descriptor

func (*ConfigureResponse) Descriptor() ([]byte, []int)

Deprecated: Use ConfigureResponse.ProtoReflect.Descriptor instead.

func (*ConfigureResponse) ProtoMessage

func (*ConfigureResponse) ProtoMessage()

func (*ConfigureResponse) ProtoReflect

func (x *ConfigureResponse) ProtoReflect() protoreflect.Message

func (*ConfigureResponse) Reset

func (x *ConfigureResponse) Reset()

func (*ConfigureResponse) String

func (x *ConfigureResponse) String() string

type CoreConfiguration

type CoreConfiguration struct {

	// Required. The trust domain name SPIRE is configured with (e.g.
	// "example.org").
	TrustDomain string `protobuf:"bytes,1,opt,name=trust_domain,json=trustDomain,proto3" json:"trust_domain,omitempty"`
	// contains filtered or unexported fields
}

func (*CoreConfiguration) Descriptor

func (*CoreConfiguration) Descriptor() ([]byte, []int)

Deprecated: Use CoreConfiguration.ProtoReflect.Descriptor instead.

func (*CoreConfiguration) GetTrustDomain

func (x *CoreConfiguration) GetTrustDomain() string

func (*CoreConfiguration) ProtoMessage

func (*CoreConfiguration) ProtoMessage()

func (*CoreConfiguration) ProtoReflect

func (x *CoreConfiguration) ProtoReflect() protoreflect.Message

func (*CoreConfiguration) Reset

func (x *CoreConfiguration) Reset()

func (*CoreConfiguration) String

func (x *CoreConfiguration) String() string

type UnimplementedConfigServer

type UnimplementedConfigServer struct {
}

UnimplementedConfigServer must be embedded to have forward compatible implementations.

func (UnimplementedConfigServer) Configure

func (UnimplementedConfigServer) Configure(context.Context, *ConfigureRequest) (*ConfigureResponse, error)

type UnsafeConfigServer

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.