sandboxmanager

package
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Jul 2, 2025 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_internal_locald_api_sandboxmanager_sandbox_manager_api_proto protoreflect.FileDescriptor
View Source 
var SandboxManagerAPI_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "sandboxmanager.SandboxManagerAPI",
	HandlerType: (*SandboxManagerAPIServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Status",
			Handler:    _SandboxManagerAPI_Status_Handler,
		},
		{
			MethodName: "Shutdown",
			Handler:    _SandboxManagerAPI_Shutdown_Handler,
		},
		{
			MethodName: "RegisterSandbox",
			Handler:    _SandboxManagerAPI_RegisterSandbox_Handler,
		},
		{
			MethodName: "GetResourceOutputs",
			Handler:    _SandboxManagerAPI_GetResourceOutputs_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "internal/locald/api/sandboxmanager/sandbox_manager_api.proto",
}

SandboxManagerAPI_ServiceDesc is the grpc.ServiceDesc for SandboxManagerAPI service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterSandboxManagerAPIServer 

func RegisterSandboxManagerAPIServer(s grpc.ServiceRegistrar, srv SandboxManagerAPIServer)

func StatusToMap 

func StatusToMap(status *StatusResponse) (map[string]any, error)

func ToCIConfig 

func ToCIConfig(grpcSpec *structpb.Struct) (*config.ConnectInvocationConfig, error)

func ToGRPCCIConfig 

func ToGRPCCIConfig(ciConfig *config.ConnectInvocationConfig) (*structpb.Struct, error)

Types

type GetResourceOutputsRequest added in v1.0.0 

type GetResourceOutputsRequest struct {
	SandboxRoutingKey string `protobuf:"bytes,1,opt,name=sandbox_routing_key,json=sandboxRoutingKey,proto3" json:"sandbox_routing_key,omitempty"`
	// contains filtered or unexported fields
}

Resource outputs ---------------------------------------------------------------------------

func (*GetResourceOutputsRequest) Descriptor deprecated added in v1.0.0 

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

Deprecated: Use GetResourceOutputsRequest.ProtoReflect.Descriptor instead.

func (*GetResourceOutputsRequest) GetSandboxRoutingKey added in v1.0.0 

func (x *GetResourceOutputsRequest) GetSandboxRoutingKey() string

func (*GetResourceOutputsRequest) ProtoMessage added in v1.0.0 

func (*GetResourceOutputsRequest) ProtoMessage()

func (*GetResourceOutputsRequest) ProtoReflect added in v1.0.0 

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

func (*GetResourceOutputsRequest) Reset added in v1.0.0 

func (x *GetResourceOutputsRequest) Reset()

func (*GetResourceOutputsRequest) String added in v1.0.0 

func (x *GetResourceOutputsRequest) String() string

type GetResourceOutputsResponse added in v1.0.0 

type GetResourceOutputsResponse struct {
	ResourceOutputs []*ResourceOutputs `protobuf:"bytes,1,rep,name=resource_outputs,json=resourceOutputs,proto3" json:"resource_outputs,omitempty"`
	// contains filtered or unexported fields
}

func (*GetResourceOutputsResponse) Descriptor deprecated added in v1.0.0 

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

Deprecated: Use GetResourceOutputsResponse.ProtoReflect.Descriptor instead.

func (*GetResourceOutputsResponse) GetResourceOutputs added in v1.0.0 

func (x *GetResourceOutputsResponse) GetResourceOutputs() []*ResourceOutputs

func (*GetResourceOutputsResponse) ProtoMessage added in v1.0.0 

func (*GetResourceOutputsResponse) ProtoMessage()

func (*GetResourceOutputsResponse) ProtoReflect added in v1.0.0 

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

func (*GetResourceOutputsResponse) Reset added in v1.0.0 

func (x *GetResourceOutputsResponse) Reset()

func (*GetResourceOutputsResponse) String added in v1.0.0 

func (x *GetResourceOutputsResponse) String() string

type RegisterSandboxRequest added in v0.6.0 

type RegisterSandboxRequest struct {
	SandboxName string `protobuf:"bytes,1,opt,name=sandbox_name,json=sandboxName,proto3" json:"sandbox_name,omitempty"`
	RoutingKey  string `protobuf:"bytes,2,opt,name=routing_key,json=routingKey,proto3" json:"routing_key,omitempty"`
	// contains filtered or unexported fields
}

func (*RegisterSandboxRequest) Descriptor deprecated added in v0.6.0 

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

Deprecated: Use RegisterSandboxRequest.ProtoReflect.Descriptor instead.

func (*RegisterSandboxRequest) GetRoutingKey added in v0.6.0 

func (x *RegisterSandboxRequest) GetRoutingKey() string

func (*RegisterSandboxRequest) GetSandboxName added in v0.6.0 

func (x *RegisterSandboxRequest) GetSandboxName() string

func (*RegisterSandboxRequest) ProtoMessage added in v0.6.0 

func (*RegisterSandboxRequest) ProtoMessage()

func (*RegisterSandboxRequest) ProtoReflect added in v0.6.0 

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

func (*RegisterSandboxRequest) Reset added in v0.6.0 

func (x *RegisterSandboxRequest) Reset()

func (*RegisterSandboxRequest) String added in v0.6.0 

func (x *RegisterSandboxRequest) String() string

type RegisterSandboxResponse added in v0.6.0 

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

func (*RegisterSandboxResponse) Descriptor deprecated added in v0.6.0 

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

Deprecated: Use RegisterSandboxResponse.ProtoReflect.Descriptor instead.

func (*RegisterSandboxResponse) ProtoMessage added in v0.6.0 

func (*RegisterSandboxResponse) ProtoMessage()

func (*RegisterSandboxResponse) ProtoReflect added in v0.6.0 

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

func (*RegisterSandboxResponse) Reset added in v0.6.0 

func (x *RegisterSandboxResponse) Reset()

func (*RegisterSandboxResponse) String added in v0.6.0 

func (x *RegisterSandboxResponse) String() string

type ResourceOutputItem added in v1.0.0 

type ResourceOutputItem struct {
	Key   string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*ResourceOutputItem) Descriptor deprecated added in v1.0.0 

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

Deprecated: Use ResourceOutputItem.ProtoReflect.Descriptor instead.

func (*ResourceOutputItem) GetKey added in v1.0.0 

func (x *ResourceOutputItem) GetKey() string

func (*ResourceOutputItem) GetValue added in v1.0.0 

func (x *ResourceOutputItem) GetValue() string

func (*ResourceOutputItem) ProtoMessage added in v1.0.0 

func (*ResourceOutputItem) ProtoMessage()

func (*ResourceOutputItem) ProtoReflect added in v1.0.0 

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

func (*ResourceOutputItem) Reset added in v1.0.0 

func (x *ResourceOutputItem) Reset()

func (*ResourceOutputItem) String added in v1.0.0 

func (x *ResourceOutputItem) String() string

type ResourceOutputs added in v1.0.0 

type ResourceOutputs struct {
	ResourceName string                `protobuf:"bytes,1,opt,name=resource_name,json=resourceName,proto3" json:"resource_name,omitempty"`
	Outputs      []*ResourceOutputItem `protobuf:"bytes,2,rep,name=outputs,proto3" json:"outputs,omitempty"`
	// contains filtered or unexported fields
}

func (*ResourceOutputs) Descriptor deprecated added in v1.0.0 

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

Deprecated: Use ResourceOutputs.ProtoReflect.Descriptor instead.

func (*ResourceOutputs) GetOutputs added in v1.0.0 

func (x *ResourceOutputs) GetOutputs() []*ResourceOutputItem

func (*ResourceOutputs) GetResourceName added in v1.0.0 

func (x *ResourceOutputs) GetResourceName() string

func (*ResourceOutputs) ProtoMessage added in v1.0.0 

func (*ResourceOutputs) ProtoMessage()

func (*ResourceOutputs) ProtoReflect added in v1.0.0 

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

func (*ResourceOutputs) Reset added in v1.0.0 

func (x *ResourceOutputs) Reset()

func (*ResourceOutputs) String added in v1.0.0 

func (x *ResourceOutputs) String() string

type SandboxManagerAPIClient 

type SandboxManagerAPIClient interface {
	// This method returns the status of the local controller
	Status(ctx context.Context, in *StatusRequest, opts ...grpc.CallOption) (*StatusResponse, error)
	// This method requests the root controller to shutdown
	Shutdown(ctx context.Context, in *ShutdownRequest, opts ...grpc.CallOption) (*ShutdownResponse, error)
	// This method is used to register sandboxes in the local controller. It is
	// mainly used in the context of old operators (the ones that don't support
	// WatchLocalSandboxes in tunnel-api)
	RegisterSandbox(ctx context.Context, in *RegisterSandboxRequest, opts ...grpc.CallOption) (*RegisterSandboxResponse, error)
	// This method returns all the available resource outputs for a sandbox given
	// its routing key.
	GetResourceOutputs(ctx context.Context, in *GetResourceOutputsRequest, opts ...grpc.CallOption) (*GetResourceOutputsResponse, error)
}

SandboxManagerAPIClient is the client API for SandboxManagerAPI 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 NewSandboxManagerAPIClient 

func NewSandboxManagerAPIClient(cc grpc.ClientConnInterface) SandboxManagerAPIClient

type SandboxManagerAPIServer 

type SandboxManagerAPIServer interface {
	// This method returns the status of the local controller
	Status(context.Context, *StatusRequest) (*StatusResponse, error)
	// This method requests the root controller to shutdown
	Shutdown(context.Context, *ShutdownRequest) (*ShutdownResponse, error)
	// This method is used to register sandboxes in the local controller. It is
	// mainly used in the context of old operators (the ones that don't support
	// WatchLocalSandboxes in tunnel-api)
	RegisterSandbox(context.Context, *RegisterSandboxRequest) (*RegisterSandboxResponse, error)
	// This method returns all the available resource outputs for a sandbox given
	// its routing key.
	GetResourceOutputs(context.Context, *GetResourceOutputsRequest) (*GetResourceOutputsResponse, error)
	// contains filtered or unexported methods
}

SandboxManagerAPIServer is the server API for SandboxManagerAPI service. All implementations must embed UnimplementedSandboxManagerAPIServer for forward compatibility

type ShutdownRequest 

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

func (*ShutdownRequest) Descriptor deprecated 

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

Deprecated: Use ShutdownRequest.ProtoReflect.Descriptor instead.

func (*ShutdownRequest) ProtoMessage 

func (*ShutdownRequest) ProtoMessage()

func (*ShutdownRequest) ProtoReflect 

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

func (*ShutdownRequest) Reset 

func (x *ShutdownRequest) Reset()

func (*ShutdownRequest) String 

func (x *ShutdownRequest) String() string

type ShutdownResponse 

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

func (*ShutdownResponse) Descriptor deprecated 

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

Deprecated: Use ShutdownResponse.ProtoReflect.Descriptor instead.

func (*ShutdownResponse) ProtoMessage 

func (*ShutdownResponse) ProtoMessage()

func (*ShutdownResponse) ProtoReflect 

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

func (*ShutdownResponse) Reset 

func (x *ShutdownResponse) Reset()

func (*ShutdownResponse) String 

func (x *ShutdownResponse) String() string

type StatusRequest 

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

func (*StatusRequest) Descriptor deprecated 

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

Deprecated: Use StatusRequest.ProtoReflect.Descriptor instead.

func (*StatusRequest) ProtoMessage 

func (*StatusRequest) ProtoMessage()

func (*StatusRequest) ProtoReflect 

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

func (*StatusRequest) Reset 

func (x *StatusRequest) Reset()

func (*StatusRequest) String 

func (x *StatusRequest) String() string

type StatusResponse 

type StatusResponse struct {

	// connect invocation config
	// (instance of internal/config/locald.ConnectInvocationConfig)
	CiConfig          *structpb.Struct             `protobuf:"bytes,1,opt,name=ci_config,json=ciConfig,proto3" json:"ci_config,omitempty"`
	OperatorInfo      *api.OperatorInfo            `protobuf:"bytes,7,opt,name=operator_info,json=operatorInfo,proto3" json:"operator_info,omitempty"`
	Localnet          *api.LocalNetStatus          `protobuf:"bytes,2,opt,name=localnet,proto3" json:"localnet,omitempty"`
	Hosts             *api.HostsStatus             `protobuf:"bytes,3,opt,name=hosts,proto3" json:"hosts,omitempty"`
	Portforward       *api.PortForwardStatus       `protobuf:"bytes,4,opt,name=portforward,proto3" json:"portforward,omitempty"`
	ControlPlaneProxy *api.ControlPlaneProxyStatus `protobuf:"bytes,8,opt,name=control_plane_proxy,json=controlPlaneProxy,proto3" json:"control_plane_proxy,omitempty"`
	Watcher           *api.WatcherStatus           `protobuf:"bytes,6,opt,name=watcher,proto3" json:"watcher,omitempty"`
	Sandboxes         []*api.SandboxStatus         `protobuf:"bytes,5,rep,name=sandboxes,proto3" json:"sandboxes,omitempty"`
	// contains filtered or unexported fields
}

func (*StatusResponse) Descriptor deprecated 

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

Deprecated: Use StatusResponse.ProtoReflect.Descriptor instead.

func (*StatusResponse) GetCiConfig 

func (x *StatusResponse) GetCiConfig() *structpb.Struct

func (*StatusResponse) GetControlPlaneProxy added in v0.7.0 

func (x *StatusResponse) GetControlPlaneProxy() *api.ControlPlaneProxyStatus

func (*StatusResponse) GetHosts 

func (x *StatusResponse) GetHosts() *api.HostsStatus

func (*StatusResponse) GetLocalnet 

func (x *StatusResponse) GetLocalnet() *api.LocalNetStatus

func (*StatusResponse) GetOperatorInfo added in v0.6.0 

func (x *StatusResponse) GetOperatorInfo() *api.OperatorInfo

func (*StatusResponse) GetPortforward 

func (x *StatusResponse) GetPortforward() *api.PortForwardStatus

func (*StatusResponse) GetSandboxes 

func (x *StatusResponse) GetSandboxes() []*api.SandboxStatus

func (*StatusResponse) GetWatcher added in v0.6.0 

func (x *StatusResponse) GetWatcher() *api.WatcherStatus

func (*StatusResponse) ProtoMessage 

func (*StatusResponse) ProtoMessage()

func (*StatusResponse) ProtoReflect 

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

func (*StatusResponse) Reset 

func (x *StatusResponse) Reset()

func (*StatusResponse) String 

func (x *StatusResponse) String() string

type UnimplementedSandboxManagerAPIServer 

type UnimplementedSandboxManagerAPIServer struct {
}

UnimplementedSandboxManagerAPIServer must be embedded to have forward compatible implementations.

func (UnimplementedSandboxManagerAPIServer) GetResourceOutputs added in v1.0.0 

func (UnimplementedSandboxManagerAPIServer) GetResourceOutputs(context.Context, *GetResourceOutputsRequest) (*GetResourceOutputsResponse, error)

func (UnimplementedSandboxManagerAPIServer) RegisterSandbox added in v0.6.0 

func (UnimplementedSandboxManagerAPIServer) RegisterSandbox(context.Context, *RegisterSandboxRequest) (*RegisterSandboxResponse, error)

func (UnimplementedSandboxManagerAPIServer) Shutdown 

func (UnimplementedSandboxManagerAPIServer) Shutdown(context.Context, *ShutdownRequest) (*ShutdownResponse, error)

func (UnimplementedSandboxManagerAPIServer) Status 

func (UnimplementedSandboxManagerAPIServer) Status(context.Context, *StatusRequest) (*StatusResponse, error)

type UnsafeSandboxManagerAPIServer 

type UnsafeSandboxManagerAPIServer interface {
	// contains filtered or unexported methods
}

UnsafeSandboxManagerAPIServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SandboxManagerAPIServer will result in compilation errors.

Source Files

View all Source files

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.