v1alpha1

package
v1.0.0-cli.0...-2d063a8 Latest Latest
Warning

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

Go to latest
Published: May 4, 2026 License: AGPL-3.0, LGPL-3.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source
const (
	InstanceService_GetInstance_FullMethodName                  = "/instance.v1alpha1.InstanceService/GetInstance"
	InstanceService_ListInstances_FullMethodName                = "/instance.v1alpha1.InstanceService/ListInstances"
	InstanceService_RunFlavorVersion_FullMethodName             = "/instance.v1alpha1.InstanceService/RunFlavorVersion"
	InstanceService_DiscoverInstances_FullMethodName            = "/instance.v1alpha1.InstanceService/DiscoverInstances"
	InstanceService_ReceiveInstanceStatusReports_FullMethodName = "/instance.v1alpha1.InstanceService/ReceiveInstanceStatusReports"
)

Variables

View Source
var (
	InstanceState_name = map[int32]string{
		0: "PENDING",
		1: "CREATING",
		2: "RUNNING",
		3: "DELETING",
		4: "DELETED",
		5: "CREATION_FAILED",
	}
	InstanceState_value = map[string]int32{
		"PENDING":         0,
		"CREATING":        1,
		"RUNNING":         2,
		"DELETING":        3,
		"DELETED":         4,
		"CREATION_FAILED": 5,
	}
)

Enum value maps for InstanceState.

View Source
var File_instance_v1alpha1_api_proto protoreflect.FileDescriptor
View Source
var File_instance_v1alpha1_types_proto protoreflect.FileDescriptor
View Source
var InstanceService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "instance.v1alpha1.InstanceService",
	HandlerType: (*InstanceServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetInstance",
			Handler:    _InstanceService_GetInstance_Handler,
		},
		{
			MethodName: "ListInstances",
			Handler:    _InstanceService_ListInstances_Handler,
		},
		{
			MethodName: "RunFlavorVersion",
			Handler:    _InstanceService_RunFlavorVersion_Handler,
		},
		{
			MethodName: "DiscoverInstances",
			Handler:    _InstanceService_DiscoverInstances_Handler,
		},
		{
			MethodName: "ReceiveInstanceStatusReports",
			Handler:    _InstanceService_ReceiveInstanceStatusReports_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "instance/v1alpha1/api.proto",
}

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

Functions

func RegisterInstanceServiceServer

func RegisterInstanceServiceServer(s grpc.ServiceRegistrar, srv InstanceServiceServer)

Types

type DiscoverInstanceRequest

type DiscoverInstanceRequest struct {
	NodeKey string `protobuf:"bytes,1,opt,name=node_key,json=nodeKey,proto3" json:"node_key,omitempty"`
	// contains filtered or unexported fields
}

func (*DiscoverInstanceRequest) Descriptor deprecated

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

Deprecated: Use DiscoverInstanceRequest.ProtoReflect.Descriptor instead.

func (*DiscoverInstanceRequest) GetNodeKey

func (x *DiscoverInstanceRequest) GetNodeKey() string

func (*DiscoverInstanceRequest) ProtoMessage

func (*DiscoverInstanceRequest) ProtoMessage()

func (*DiscoverInstanceRequest) ProtoReflect

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

func (*DiscoverInstanceRequest) Reset

func (x *DiscoverInstanceRequest) Reset()

func (*DiscoverInstanceRequest) String

func (x *DiscoverInstanceRequest) String() string

type DiscoverInstanceResponse

type DiscoverInstanceResponse struct {
	Instances []*Instance `protobuf:"bytes,1,rep,name=instances,proto3" json:"instances,omitempty"`
	// contains filtered or unexported fields
}

func (*DiscoverInstanceResponse) Descriptor deprecated

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

Deprecated: Use DiscoverInstanceResponse.ProtoReflect.Descriptor instead.

func (*DiscoverInstanceResponse) GetInstances

func (x *DiscoverInstanceResponse) GetInstances() []*Instance

func (*DiscoverInstanceResponse) ProtoMessage

func (*DiscoverInstanceResponse) ProtoMessage()

func (*DiscoverInstanceResponse) ProtoReflect

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

func (*DiscoverInstanceResponse) Reset

func (x *DiscoverInstanceResponse) Reset()

func (*DiscoverInstanceResponse) String

func (x *DiscoverInstanceResponse) String() string

type GetInstanceRequest

type GetInstanceRequest struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetInstanceRequest) Descriptor deprecated

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

Deprecated: Use GetInstanceRequest.ProtoReflect.Descriptor instead.

func (*GetInstanceRequest) GetId

func (x *GetInstanceRequest) GetId() string

func (*GetInstanceRequest) ProtoMessage

func (*GetInstanceRequest) ProtoMessage()

func (*GetInstanceRequest) ProtoReflect

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

func (*GetInstanceRequest) Reset

func (x *GetInstanceRequest) Reset()

func (*GetInstanceRequest) String

func (x *GetInstanceRequest) String() string

type GetInstanceResponse

type GetInstanceResponse struct {
	Instance *Instance `protobuf:"bytes,1,opt,name=instance,proto3" json:"instance,omitempty"`
	// contains filtered or unexported fields
}

func (*GetInstanceResponse) Descriptor deprecated

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

Deprecated: Use GetInstanceResponse.ProtoReflect.Descriptor instead.

func (*GetInstanceResponse) GetInstance

func (x *GetInstanceResponse) GetInstance() *Instance

func (*GetInstanceResponse) ProtoMessage

func (*GetInstanceResponse) ProtoMessage()

func (*GetInstanceResponse) ProtoReflect

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

func (*GetInstanceResponse) Reset

func (x *GetInstanceResponse) Reset()

func (*GetInstanceResponse) String

func (x *GetInstanceResponse) String() string

type Instance

type Instance struct {
	Id            string                  `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Chunk         *v1alpha1.Chunk         `protobuf:"bytes,2,opt,name=chunk,proto3" json:"chunk,omitempty"`
	FlavorVersion *v1alpha1.FlavorVersion `protobuf:"bytes,3,opt,name=flavor_version,json=flavorVersion,proto3" json:"flavor_version,omitempty"`
	Ip            string                  `protobuf:"bytes,4,opt,name=ip,proto3" json:"ip,omitempty"`
	Port          uint32                  `protobuf:"varint,5,opt,name=port,proto3" json:"port,omitempty"`
	State         InstanceState           `protobuf:"varint,6,opt,name=state,proto3,enum=instance.v1alpha1.InstanceState" json:"state,omitempty"`
	Owner         *v1alpha11.User         `protobuf:"bytes,7,opt,name=owner,proto3" json:"owner,omitempty"`
	// contains filtered or unexported fields
}

Instance defines a running replica of a specific chunk flavor.

We differentiate between Chunks and Instances. Chunks define the configuration and provide metadata, like a name, description tags and so on, that describe the experience the user can expect when attempting to run the chunk. Instances on the other hand, are a running replica of a particular Chunk flavor. This means that there can be multiple replicas of a chunk flavor by different users.

func (*Instance) Descriptor deprecated

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

Deprecated: Use Instance.ProtoReflect.Descriptor instead.

func (*Instance) GetChunk

func (x *Instance) GetChunk() *v1alpha1.Chunk

func (*Instance) GetFlavorVersion

func (x *Instance) GetFlavorVersion() *v1alpha1.FlavorVersion

func (*Instance) GetId

func (x *Instance) GetId() string

func (*Instance) GetIp

func (x *Instance) GetIp() string

func (*Instance) GetOwner

func (x *Instance) GetOwner() *v1alpha11.User

func (*Instance) GetPort

func (x *Instance) GetPort() uint32

func (*Instance) GetState

func (x *Instance) GetState() InstanceState

func (*Instance) ProtoMessage

func (*Instance) ProtoMessage()

func (*Instance) ProtoReflect

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

func (*Instance) Reset

func (x *Instance) Reset()

func (*Instance) String

func (x *Instance) String() string

type InstanceServiceClient

type InstanceServiceClient interface {
	// GetInstance returns an instance by its id.
	//
	// Defined error codes:
	// - NOT_FOUND:
	//   - instance with the specified id could not be found
	//
	// - INVALID_ARGUMENT:
	//   - the provided instance id is invalid
	GetInstance(ctx context.Context, in *GetInstanceRequest, opts ...grpc.CallOption) (*GetInstanceResponse, error)
	// ListInstances returns all created instances.
	ListInstances(ctx context.Context, in *ListInstancesRequest, opts ...grpc.CallOption) (*ListInstancesResponse, error)
	// RunFlavorVersion creates an instance for a specific flavor version of a
	// Chunk and schedules it to be run on a node. The connection information
	// of the returned instance will only be partially set, because the
	// port will not be allocated at this point. However, the IP address
	// is set.
	RunFlavorVersion(ctx context.Context, in *RunFlavorVersionRequest, opts ...grpc.CallOption) (*RunFlavorVersionResponse, error)
	// DiscoverInstances returns all workloads that have been scheduled to a node for
	// creation or removal. Platformd identifies itself using its unique node key.
	DiscoverInstances(ctx context.Context, in *DiscoverInstanceRequest, opts ...grpc.CallOption) (*DiscoverInstanceResponse, error)
	// ReceiveInstanceStatusReports is intended to be called by platformd in order to report
	// status updates back to the control plane.
	ReceiveInstanceStatusReports(ctx context.Context, in *ReceiveInstanceStatusReportsRequest, opts ...grpc.CallOption) (*ReceiveInstanceStatusReportsResponse, error)
}

InstanceServiceClient is the client API for InstanceService 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.

type InstanceServiceServer

type InstanceServiceServer interface {
	// GetInstance returns an instance by its id.
	//
	// Defined error codes:
	// - NOT_FOUND:
	//   - instance with the specified id could not be found
	//
	// - INVALID_ARGUMENT:
	//   - the provided instance id is invalid
	GetInstance(context.Context, *GetInstanceRequest) (*GetInstanceResponse, error)
	// ListInstances returns all created instances.
	ListInstances(context.Context, *ListInstancesRequest) (*ListInstancesResponse, error)
	// RunFlavorVersion creates an instance for a specific flavor version of a
	// Chunk and schedules it to be run on a node. The connection information
	// of the returned instance will only be partially set, because the
	// port will not be allocated at this point. However, the IP address
	// is set.
	RunFlavorVersion(context.Context, *RunFlavorVersionRequest) (*RunFlavorVersionResponse, error)
	// DiscoverInstances returns all workloads that have been scheduled to a node for
	// creation or removal. Platformd identifies itself using its unique node key.
	DiscoverInstances(context.Context, *DiscoverInstanceRequest) (*DiscoverInstanceResponse, error)
	// ReceiveInstanceStatusReports is intended to be called by platformd in order to report
	// status updates back to the control plane.
	ReceiveInstanceStatusReports(context.Context, *ReceiveInstanceStatusReportsRequest) (*ReceiveInstanceStatusReportsResponse, error)
	// contains filtered or unexported methods
}

InstanceServiceServer is the server API for InstanceService service. All implementations must embed UnimplementedInstanceServiceServer for forward compatibility.

type InstanceState

type InstanceState int32
const (
	InstanceState_PENDING         InstanceState = 0
	InstanceState_CREATING        InstanceState = 1
	InstanceState_RUNNING         InstanceState = 2
	InstanceState_DELETING        InstanceState = 3
	InstanceState_DELETED         InstanceState = 4
	InstanceState_CREATION_FAILED InstanceState = 5
)

func (InstanceState) Descriptor

func (InstanceState) Enum

func (x InstanceState) Enum() *InstanceState

func (InstanceState) EnumDescriptor deprecated

func (InstanceState) EnumDescriptor() ([]byte, []int)

Deprecated: Use InstanceState.Descriptor instead.

func (InstanceState) Number

func (InstanceState) String

func (x InstanceState) String() string

func (InstanceState) Type

type InstanceStatusReport

type InstanceStatusReport struct {
	InstanceId string        `protobuf:"bytes,1,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
	Port       uint32        `protobuf:"varint,2,opt,name=port,proto3" json:"port,omitempty"`
	State      InstanceState `protobuf:"varint,3,opt,name=state,proto3,enum=instance.v1alpha1.InstanceState" json:"state,omitempty"`
	// contains filtered or unexported fields
}

func (*InstanceStatusReport) Descriptor deprecated

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

Deprecated: Use InstanceStatusReport.ProtoReflect.Descriptor instead.

func (*InstanceStatusReport) GetInstanceId

func (x *InstanceStatusReport) GetInstanceId() string

func (*InstanceStatusReport) GetPort

func (x *InstanceStatusReport) GetPort() uint32

func (*InstanceStatusReport) GetState

func (x *InstanceStatusReport) GetState() InstanceState

func (*InstanceStatusReport) ProtoMessage

func (*InstanceStatusReport) ProtoMessage()

func (*InstanceStatusReport) ProtoReflect

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

func (*InstanceStatusReport) Reset

func (x *InstanceStatusReport) Reset()

func (*InstanceStatusReport) String

func (x *InstanceStatusReport) String() string

type ListInstancesRequest

type ListInstancesRequest struct {

	// at the moment just return all instances
	// later add filter for things like a specific
	// chunk, state etc.
	PageSize  uint32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListInstancesRequest) Descriptor deprecated

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

Deprecated: Use ListInstancesRequest.ProtoReflect.Descriptor instead.

func (*ListInstancesRequest) GetPageSize

func (x *ListInstancesRequest) GetPageSize() uint32

func (*ListInstancesRequest) GetPageToken

func (x *ListInstancesRequest) GetPageToken() string

func (*ListInstancesRequest) ProtoMessage

func (*ListInstancesRequest) ProtoMessage()

func (*ListInstancesRequest) ProtoReflect

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

func (*ListInstancesRequest) Reset

func (x *ListInstancesRequest) Reset()

func (*ListInstancesRequest) String

func (x *ListInstancesRequest) String() string

type ListInstancesResponse

type ListInstancesResponse struct {
	Instances     []*Instance `protobuf:"bytes,1,rep,name=instances,proto3" json:"instances,omitempty"`
	NextPageToken string      `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListInstancesResponse) Descriptor deprecated

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

Deprecated: Use ListInstancesResponse.ProtoReflect.Descriptor instead.

func (*ListInstancesResponse) GetInstances

func (x *ListInstancesResponse) GetInstances() []*Instance

func (*ListInstancesResponse) GetNextPageToken

func (x *ListInstancesResponse) GetNextPageToken() string

func (*ListInstancesResponse) ProtoMessage

func (*ListInstancesResponse) ProtoMessage()

func (*ListInstancesResponse) ProtoReflect

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

func (*ListInstancesResponse) Reset

func (x *ListInstancesResponse) Reset()

func (*ListInstancesResponse) String

func (x *ListInstancesResponse) String() string

type ReceiveInstanceStatusReportsRequest

type ReceiveInstanceStatusReportsRequest struct {
	Reports []*InstanceStatusReport `protobuf:"bytes,1,rep,name=reports,proto3" json:"reports,omitempty"`
	// contains filtered or unexported fields
}

func (*ReceiveInstanceStatusReportsRequest) Descriptor deprecated

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

Deprecated: Use ReceiveInstanceStatusReportsRequest.ProtoReflect.Descriptor instead.

func (*ReceiveInstanceStatusReportsRequest) GetReports

func (*ReceiveInstanceStatusReportsRequest) ProtoMessage

func (*ReceiveInstanceStatusReportsRequest) ProtoMessage()

func (*ReceiveInstanceStatusReportsRequest) ProtoReflect

func (*ReceiveInstanceStatusReportsRequest) Reset

func (*ReceiveInstanceStatusReportsRequest) String

type ReceiveInstanceStatusReportsResponse

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

func (*ReceiveInstanceStatusReportsResponse) Descriptor deprecated

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

Deprecated: Use ReceiveInstanceStatusReportsResponse.ProtoReflect.Descriptor instead.

func (*ReceiveInstanceStatusReportsResponse) ProtoMessage

func (*ReceiveInstanceStatusReportsResponse) ProtoMessage()

func (*ReceiveInstanceStatusReportsResponse) ProtoReflect

func (*ReceiveInstanceStatusReportsResponse) Reset

func (*ReceiveInstanceStatusReportsResponse) String

type RunFlavorVersionRequest

type RunFlavorVersionRequest struct {
	ChunkId         string `protobuf:"bytes,1,opt,name=chunk_id,json=chunkId,proto3" json:"chunk_id,omitempty"`
	FlavorVersionId string `protobuf:"bytes,2,opt,name=flavor_version_id,json=flavorVersionId,proto3" json:"flavor_version_id,omitempty"`
	// contains filtered or unexported fields
}

func (*RunFlavorVersionRequest) Descriptor deprecated

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

Deprecated: Use RunFlavorVersionRequest.ProtoReflect.Descriptor instead.

func (*RunFlavorVersionRequest) GetChunkId

func (x *RunFlavorVersionRequest) GetChunkId() string

func (*RunFlavorVersionRequest) GetFlavorVersionId

func (x *RunFlavorVersionRequest) GetFlavorVersionId() string

func (*RunFlavorVersionRequest) ProtoMessage

func (*RunFlavorVersionRequest) ProtoMessage()

func (*RunFlavorVersionRequest) ProtoReflect

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

func (*RunFlavorVersionRequest) Reset

func (x *RunFlavorVersionRequest) Reset()

func (*RunFlavorVersionRequest) String

func (x *RunFlavorVersionRequest) String() string

type RunFlavorVersionResponse

type RunFlavorVersionResponse struct {
	Instance *Instance `protobuf:"bytes,1,opt,name=instance,proto3" json:"instance,omitempty"`
	// contains filtered or unexported fields
}

func (*RunFlavorVersionResponse) Descriptor deprecated

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

Deprecated: Use RunFlavorVersionResponse.ProtoReflect.Descriptor instead.

func (*RunFlavorVersionResponse) GetInstance

func (x *RunFlavorVersionResponse) GetInstance() *Instance

func (*RunFlavorVersionResponse) ProtoMessage

func (*RunFlavorVersionResponse) ProtoMessage()

func (*RunFlavorVersionResponse) ProtoReflect

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

func (*RunFlavorVersionResponse) Reset

func (x *RunFlavorVersionResponse) Reset()

func (*RunFlavorVersionResponse) String

func (x *RunFlavorVersionResponse) String() string

type UnimplementedInstanceServiceServer

type UnimplementedInstanceServiceServer struct{}

UnimplementedInstanceServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedInstanceServiceServer) DiscoverInstances

func (UnimplementedInstanceServiceServer) GetInstance

func (UnimplementedInstanceServiceServer) ListInstances

func (UnimplementedInstanceServiceServer) RunFlavorVersion

type UnsafeInstanceServiceServer

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL