Documentation
¶
Index ¶
- Variables
- func RegisterRunnerServer(s grpc.ServiceRegistrar, srv RunnerServer)
- type CloneOptions
- type CloneRequest
- func (*CloneRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CloneRequest) GetOptions() string
- func (x *CloneRequest) GetTargetPath() string
- func (*CloneRequest) ProtoMessage()
- func (x *CloneRequest) ProtoReflect() protoreflect.Message
- func (x *CloneRequest) Reset()
- func (x *CloneRequest) String() string
- type CloneResponse
- type Kubernetes
- type PlatformBuildOptions
- type PlatformDockerCredentials
- type PlatformGitHttpCredentials
- type PlatformGitSshCredentials
- type PlatformOptions
- type PlatformWorkspaceCredentials
- type RunnerClient
- type RunnerServer
- type UnimplementedRunnerServer
- type UnsafeRunnerServer
Constants ¶
This section is empty.
Variables ¶
var File_runner_proto protoreflect.FileDescriptor
var Runner_ServiceDesc = grpc.ServiceDesc{ ServiceName: "devpod.Runner", HandlerType: (*RunnerServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Clone", Handler: _Runner_Clone_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "runner.proto", }
Runner_ServiceDesc is the grpc.ServiceDesc for Runner service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterRunnerServer ¶
func RegisterRunnerServer(s grpc.ServiceRegistrar, srv RunnerServer)
Types ¶
type CloneOptions ¶
type CloneOptions struct {
// Repository is the repository to clone
Repository string `json:"repository,omitempty"`
// Branch is the branch to use
Branch string `json:"branch,omitempty"`
// Commit is the commit SHA to checkout
Commit string `json:"commit,omitempty"`
// PRReference is the pull request reference to checkout
PRReference string `json:"prReference,omitempty"`
// SubPath is the subpath in the repo to use
SubPath string `json:"subPath,omitempty"`
// CredentialsHelper is the credentials helper to use for the clone
CredentialsHelper string `json:"credentialsHelper,omitempty"`
// ExtraEnv is the extra environment variables to use for the clone
ExtraEnv []string `json:"extraEnv,omitempty"`
}
type CloneRequest ¶
type CloneRequest struct {
TargetPath string `protobuf:"bytes,1,opt,name=targetPath,proto3" json:"targetPath,omitempty"`
Options string `protobuf:"bytes,2,opt,name=options,proto3" json:"options,omitempty"`
// contains filtered or unexported fields
}
func (*CloneRequest) Descriptor
deprecated
func (*CloneRequest) Descriptor() ([]byte, []int)
Deprecated: Use CloneRequest.ProtoReflect.Descriptor instead.
func (*CloneRequest) GetOptions ¶
func (x *CloneRequest) GetOptions() string
func (*CloneRequest) GetTargetPath ¶
func (x *CloneRequest) GetTargetPath() string
func (*CloneRequest) ProtoMessage ¶
func (*CloneRequest) ProtoMessage()
func (*CloneRequest) ProtoReflect ¶
func (x *CloneRequest) ProtoReflect() protoreflect.Message
func (*CloneRequest) Reset ¶
func (x *CloneRequest) Reset()
func (*CloneRequest) String ¶
func (x *CloneRequest) String() string
type CloneResponse ¶
type CloneResponse struct {
// contains filtered or unexported fields
}
func (*CloneResponse) Descriptor
deprecated
func (*CloneResponse) Descriptor() ([]byte, []int)
Deprecated: Use CloneResponse.ProtoReflect.Descriptor instead.
func (*CloneResponse) ProtoMessage ¶
func (*CloneResponse) ProtoMessage()
func (*CloneResponse) ProtoReflect ¶
func (x *CloneResponse) ProtoReflect() protoreflect.Message
func (*CloneResponse) Reset ¶
func (x *CloneResponse) Reset()
func (*CloneResponse) String ¶
func (x *CloneResponse) String() string
type Kubernetes ¶
type PlatformBuildOptions ¶
type PlatformGitSshCredentials ¶
type PlatformGitSshCredentials struct {
Key string `json:"key,omitempty"`
}
type PlatformOptions ¶
type PlatformOptions struct {
// Enabled is true if platform mode is enabled. Be careful with this option as this is only enabled
// when executed on the platform side and not if a platform workspace is used locally.
Enabled bool `json:"enabled,omitempty"`
// DevPodWorkspaceInstance information
InstanceName string `json:"instanceName,omitempty"`
InstanceProject string `json:"instanceProject,omitempty"`
InstanceNamespace string `json:"instanceNamespace,omitempty"`
// connection options
// AccessKey is used by the workspace daemon to authenticate itself
AccessKey string `json:"accessKey,omitempty"`
// UserAccessKey can be used as the workspace owner
UserAccessKey string `json:"userAccessKey,omitempty"`
WorkspaceHost string `json:"workspaceHost,omitempty"`
PlatformHost string `json:"platformHost,omitempty"`
RunnerSocket string `json:"runnerSocket,omitempty"`
// environment template options
EnvironmentTemplate string `json:"environmentTemplate,omitempty"`
EnvironmentTemplateVersion string `json:"environmentTemplateVersion,omitempty"`
GitCloneStrategy storagev1.GitCloneStrategy `json:"gitCloneStrategy,omitempty"`
GitSkipLFS bool `json:"gitSkipLFS,omitempty"`
// Kubernetes holds configuration for workspaces that need information about their kubernetes environment, i.e.
// the ones running in virtual clusters or spaces
Kubernetes *Kubernetes `json:"kubernetes,omitempty"`
// user credentials are the credentials for the user
UserCredentials PlatformWorkspaceCredentials `json:"userCredentials,omitempty"`
ProjectCredentials PlatformWorkspaceCredentials `json:"projectCredentials,omitempty"`
// Remote builds
Build *PlatformBuildOptions `json:"build,omitempty"`
}
type PlatformWorkspaceCredentials ¶
type PlatformWorkspaceCredentials struct {
GitUser string `json:"gitUser,omitempty"`
GitEmail string `json:"gitEmail,omitempty"`
GitHttp []PlatformGitHttpCredentials `json:"gitHttp,omitempty"`
GitSsh []PlatformGitSshCredentials `json:"gitSsh,omitempty"`
}
type RunnerClient ¶
type RunnerClient interface {
Clone(ctx context.Context, in *CloneRequest, opts ...grpc.CallOption) (*CloneResponse, error)
}
RunnerClient is the client API for Runner 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 NewRunnerClient ¶
func NewRunnerClient(cc grpc.ClientConnInterface) RunnerClient
type RunnerServer ¶
type RunnerServer interface {
Clone(context.Context, *CloneRequest) (*CloneResponse, error)
// contains filtered or unexported methods
}
RunnerServer is the server API for Runner service. All implementations must embed UnimplementedRunnerServer for forward compatibility
type UnimplementedRunnerServer ¶
type UnimplementedRunnerServer struct {
}
UnimplementedRunnerServer must be embedded to have forward compatible implementations.
func (UnimplementedRunnerServer) Clone ¶
func (UnimplementedRunnerServer) Clone(context.Context, *CloneRequest) (*CloneResponse, error)
type UnsafeRunnerServer ¶
type UnsafeRunnerServer interface {
// contains filtered or unexported methods
}
UnsafeRunnerServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to RunnerServer will result in compilation errors.