remote

package

Go to main page

Versions in this module

v0

v0.0.7

Oct 27, 2026

Changes in this version

+ const IsolationProbeTimeout

+ const MinDenialLogVersion

+ const MinIsolationProbeVersion

+ const MinNodeCABundleVersion

+ const MinNodeCAVersion

+ var ErrIsolationProbeUnavailable = errors.New("remote: isolation probe unavailable")

+ var ErrNodeCABundleUnsupported = errors.New("remote: agent cannot hand two hub CAs to the harness's Node.js")

+ var ErrNodeCAUnsupported = errors.New("remote: agent cannot hand the hub's CA to the harness's Node.js")

+ func SupportsDenialLog(version int) bool

+ func SupportsIsolationProbe(version int) bool

+ func SupportsNodeCA(version int) bool

+ func SupportsNodeCABundle(version int) bool

type AgentCapabilities

+ DenialLog bool

+ DenialLogIssue string

+ HostKernel *isolationprobe.Evidence

+ type DenialsPayload struct

+ func DecodeDenials(f Frame) (DenialsPayload, error)

type Executor

+ func (e *Executor) DenialLogStatus() (bool, string)

+ func (e *Executor) IsolationRuntime() (string, bool)

+ func (e *Executor) ProbeIsolation(ctx context.Context) (executor.IsolationProbe, error)

type FrameType

+ const TypeDenials

+ const TypeIsolationEvidence

+ const TypeIsolationProbe

+ type IsolationEvidencePayload struct

+ Engine string

+ EngineKernel string

+ Error string

+ Evidence *isolationprobe.Evidence

+ Host *isolationprobe.Evidence

+ Image string

+ func DecodeIsolationEvidence(f Frame) (IsolationEvidencePayload, error)

+ type IsolationProbeRequest struct

+ Sandbox executor.SandboxSettings

+ func DecodeIsolationProbeRequest(f Frame) (IsolationProbeRequest, error)

type Virtual

+ func (v *Virtual) DenialLogStatus() (bool, string)

+ func (v *Virtual) IsolationRuntime() (string, bool)

+ func (v *Virtual) ProbeIsolation(ctx context.Context) (executor.IsolationProbe, error)

v0.0.6

Oct 16, 2026

Changes in this version

+ const MaxDeviceChunk

+ const MinForwardedDeviceVersion

+ var ErrForwardedDevicesUnsupported = errors.New("remote: agent cannot attach a forwarded device")

+ func SupportsForwardedDevices(version int) bool

type AgentCapabilities

+ ForwardedL2 bool

+ ForwardedL2Issue string

+ ForwardedUSB bool

+ ForwardedUSBIssue string

+ type DeviceClosePayload struct

+ ChannelID string

+ Reason string

+ func DecodeDeviceClose(f Frame) (DeviceClosePayload, error)

+ type DeviceDataPayload struct

+ ChannelID string

+ Data []byte

+ func DecodeDeviceData(f Frame) (DeviceDataPayload, error)

+ type DeviceOpenPayload struct

+ BindingID string

+ BusID string

+ ChannelID string

+ ForwarderID string

+ Interface *executor.HostInterface

+ Kind string

+ Label string

+ Name string

+ func DecodeDeviceOpen(f Frame) (DeviceOpenPayload, error)

+ func (p DeviceOpenPayload) Validate() error

+ type DeviceOpenedPayload struct

+ ChannelID string

+ LocalBusID string

+ Node string

+ TAP string

+ VHCIPort int

+ func DecodeDeviceOpened(f Frame) (DeviceOpenedPayload, error)

+ type DeviceRegistry struct

+ func (r *DeviceRegistry) Add(d *DeviceStream) bool

+ func (r *DeviceRegistry) Drain() []*DeviceStream

+ func (r *DeviceRegistry) Get(id string) *DeviceStream

+ func (r *DeviceRegistry) Remove(id string)

+ type DeviceStream struct

+ func NewDeviceStream(id string, send func(t FrameType, payload any) error, onEnd func()) *DeviceStream

+ func (d *DeviceStream) Abort(reason string)

+ func (d *DeviceStream) Close() error

+ func (d *DeviceStream) Deliver(data []byte)

+ func (d *DeviceStream) Done() <-chan struct{}

+ func (d *DeviceStream) Finish(reason string)

+ func (d *DeviceStream) ID() string

+ func (d *DeviceStream) Read(p []byte) (int, error)

+ func (d *DeviceStream) Reason() string

+ func (d *DeviceStream) Write(p []byte) (int, error)

type Executor

+ func (e *Executor) CanTakeForwardedDevices(kinds []string) error

type FrameType

+ const TypeDeviceClose

+ const TypeDeviceData

+ const TypeDeviceOpen

+ const TypeDeviceOpened

type HubOptions

+ ImagePolicy func() (imagepolicy.Policy, error)

+ ImageResolver imagepolicy.Resolver

+ ImageVerifier imagepolicy.Verifier

type Options

+ ImagePolicy func() (imagepolicy.Policy, error)

+ ImageResolver imagepolicy.Resolver

+ ImageVerifier imagepolicy.Verifier

type StartPayload

+ ForwardedDevices []string

type Virtual

+ func (v *Virtual) CanTakeForwardedDevices(kinds []string) error

type WorkspaceCredential

+ Host string

v0.0.5

Oct 12, 2026

Changes in this version

+ const InventoryTimeout

+ const MaxBranchChunkBytes

+ const MinBranchBundleVersion

+ const MinDiskLimitVersion

+ const MinEgressProxyVersion

+ const MinEgressRulesVersion

+ const MinGitCAVersion

+ const MinGrantRevocationVersion

+ const MinSecretRefreshVersion

+ const MinVirtualExecutorVersion

+ const ResultChunkOverhead

+ var ErrGitCAUnsupported = errors.New("remote: agent cannot trust the hub's git proxy certificate")

+ var ErrUpgradeChannel = errors.New("remote: the device does not follow the edge channel")

+ var ErrUpgradeLowersProtocol = errors.New("remote: upgrade would lower the device's protocol")

+ var ErrUpgradeRollback = errors.New("remote: the target is earlier on main than the device's build")

+ var ErrUpgradeTarget = errors.New("remote: upgrade target is not a published release")

+ var ErrVirtualExecutorUnsupported = errors.New("remote: device cannot apply this virtual executor's configuration")

+ var ErrWriteBackBudget = fmt.Errorf("remote: returned work would exceed the hub's memory budget: %w", ...)

+ func CleanUSBInventory(devs []executor.USBDevice) []executor.USBDevice

+ func StoredBuildSequence(raw []byte) int

+ func SupportsBranchBundle(version int) bool

+ func SupportsDiskLimit(version int) bool

+ func SupportsEgressProxy(version int) bool

+ func SupportsEgressRules(version int) bool

+ func SupportsGitCA(version int) bool

+ func SupportsGrantRevocation(version int) bool

+ func SupportsSecretRefresh(version int) bool

+ func SupportsVirtualExecutor(version int) bool

+ func ValidVirtualID(id string) bool

type AgentCapabilities

+ BranchBundles bool

+ BuildSequence int

+ OCIRuntimes []string

+ PacketFilter bool

+ PacketFilterIssue string

+ RemoteUpgrade bool

+ RemoteUpgradeIssue string

+ USBDevices []executor.USBDevice

+ UpdateChannel string

+ type BranchChunkPayload struct

+ Data []byte

+ Offset int64

+ Total int64

+ func DecodeBranchChunk(f Frame) (BranchChunkPayload, error)

+ func (p BranchChunkPayload) End() int64

type Executor

+ func (e *Executor) Abandon(ctx context.Context, handleID, reason string) error

+ func (e *Executor) AddHandleRedactions(handleID string, values ...string) bool

+ func (e *Executor) AgentProtocol() int

+ func (e *Executor) BuildSequence() int

+ func (e *Executor) DeviceProtocol() int

+ func (e *Executor) EgressPosture() executor.EgressPosture

+ func (e *Executor) ExplainBranchBundleRefusal() string

+ func (e *Executor) ExplainDiskLimitRefusal() string

+ func (e *Executor) HeldWorkspaceCredential(handleID string) (executor.HeldWorkspaceCredential, bool)

+ func (e *Executor) PinnedResultBytes() int64

+ func (e *Executor) RefreshInventory(ctx context.Context) (AgentCapabilities, error)

+ func (e *Executor) RefreshSecretFiles(ctx context.Context, req executor.SecretRefreshRequest) executor.SecretRefreshReport

+ func (e *Executor) SecretRefreshShortfall() string

+ func (e *Executor) SupportsSecretRefresh() bool

+ func (e *Executor) UpdateChannel() string

type FrameType

+ const TypeBranchChunk

+ const TypeInventory

+ const TypeInventoryReq

+ const TypeSecretRefresh

+ const TypeSecretRefreshed

type Hub

+ func (h *Hub) RefreshLease(ctx context.Context, req executor.SecretRefreshRequest) []RefreshResult

type HubOptions

+ ForwardedTrusted func(*http.Request) bool

+ OnOriginRefused func(*http.Request)

+ ResultBudget *ResultBudget

+ type InventoryPayload struct

+ Capabilities AgentCapabilities

+ func DecodeInventory(f Frame) (InventoryPayload, error)

+ type InventoryRequestPayload struct

type Options

+ ResultBudget *ResultBudget

+ type RefreshResult struct

+ ExecutorID string

+ Report executor.SecretRefreshReport

+ type ResultBudget struct

+ func DefaultResultBudget() *ResultBudget

+ func NewResultBudget(perExecutor, total int64) *ResultBudget

+ func (b *ResultBudget) Limits() (perExecutor, total int64)

+ func (b *ResultBudget) Pinned(executorID string) int64

+ func (b *ResultBudget) SetLimits(perExecutor, total int64)

+ func (b *ResultBudget) Usage() ResultBudgetUsage

+ type ResultBudgetUsage struct

+ Executors int

+ MaxPerExecutor int64

+ PerExecutorLimit int64

+ Pinned int64

+ TotalLimit int64

+ type SecretRefreshPayload struct

+ Files []SecretFile

+ LeaseID string

+ Reason string

+ func DecodeSecretRefresh(f Frame) (SecretRefreshPayload, error)

+ func NewSecretRefreshPayload(req executor.SecretRefreshRequest) SecretRefreshPayload

+ func (p SecretRefreshPayload) GoString() string

+ func (p SecretRefreshPayload) Request() executor.SecretRefreshRequest

+ func (p SecretRefreshPayload) String() string

+ type SecretRefreshedPayload = executor.SecretRefreshReport

+ func DecodeSecretRefreshed(f Frame) (SecretRefreshedPayload, error)

type Session

+ func (s *Session) AgentProtocol() int

type StartPayload

+ Virtual *VirtualStart

type StartedPayload

+ DiskLimit *executor.DiskLimitBreach

type UpgradeRequest

+ TargetProtocol int

+ TargetProtocolIssue string

+ TargetSequence int

+ TargetSequenceKnown bool

+ type Virtual struct

+ func NewVirtual(parent *Executor, id, name string, source VirtualSource) (*Virtual, error)

+ func (v *Virtual) Abandon(ctx context.Context, handleID, reason string) error

+ func (v *Virtual) AgentVersion() string

+ func (v *Virtual) Attach(ctx context.Context, req executor.AttachRequest) (executor.AttachConn, error)

+ func (v *Virtual) Capabilities() executor.Capabilities

+ func (v *Virtual) EgressPosture() executor.EgressPosture

+ func (v *Virtual) ExplainBranchBundleRefusal() string

+ func (v *Virtual) ExplainDiskLimitRefusal() string

+ func (v *Virtual) ExplainEgressScopeRefusal() string

+ func (v *Virtual) HandleStatuses(ctx context.Context) ([]executor.Status, error)

+ func (v *Virtual) HealthCheck(ctx context.Context) error

+ func (v *Virtual) HeldWorkspaceCredential(handleID string) (executor.HeldWorkspaceCredential, bool)

+ func (v *Virtual) HoldsLease(string) bool

+ func (v *Virtual) ID() string

+ func (v *Virtual) Kind() string

+ func (v *Virtual) Leases() []string

+ func (v *Virtual) Name() string

+ func (v *Virtual) Parent() *Executor

+ func (v *Virtual) ParentID() string

+ func (v *Virtual) ProjectResult(handleID string) (executor.ProjectResult, error)

+ func (v *Virtual) Revocations() []executor.RevokeOutcome

+ func (v *Virtual) RevokeLease(_ context.Context, req executor.RevokeRequest) executor.RevokeOutcome

+ func (v *Virtual) Signal(ctx context.Context, handleID string, sig executor.Signal) error

+ func (v *Virtual) Spec() (executor.VirtualSpec, error)

+ func (v *Virtual) Start(ctx context.Context, spec executor.Spec) (executor.Handle, error)

+ func (v *Virtual) Status(ctx context.Context, handleID string) (executor.Status, error)

+ func (v *Virtual) Stream(ctx context.Context, handleID string) (<-chan executor.LogLine, error)

+ func (v *Virtual) SupportsRevocation() bool

+ func (v *Virtual) WriteBackBundle(handleID string) ([]byte, error)

+ type VirtualDispatch struct

+ ID string

+ Name string

+ Spec executor.VirtualSpec

+ type VirtualSource func() (executor.VirtualSpec, error)

+ type VirtualStart struct

+ Devices []executor.DeviceSelector

+ Firewall *executor.FirewallRules

+ ID string

+ Name string

+ func (v VirtualStart) Validate(sandbox executor.SandboxSettings) error

v0.0.4

Sep 27, 2026

v0.0.3

Sep 27, 2026

Changes in this version

+ const HarnessImageHint

+ const HarnessInstallTimeout

+ const LatestVersion

+ const LevelFail

+ const LevelOK

+ const LevelWarn

+ const MinHarnessInstallVersion

+ const MinProjectResultVersion

+ const MinProjectSeedVersion

+ const MinSandboxModeVersion

+ const MinUpgradeVersion

+ const MinVirtualizationProbeVersion

+ var ErrHarnessInstallUnsupported = errors.New("remote: agent does not support harness install")

+ var ErrHarnessUnavailable = errors.New("remote: device does not have the harness this project needs")

+ var ErrProjectSeedUnsupported = errors.New("remote: agent does not support project seeding")

+ var ErrSandboxModeUnavailable = errors.New("remote: executor sandbox configuration is unreadable")

+ var ErrSandboxModeUnsupported = errors.New("remote: agent does not support sandbox mode selection")

+ var ErrUpgradeUnsupported = errors.New("remote: agent does not support remote upgrade")

+ var ErrVirtualizationUnavailable = errors.New("remote: device cannot start a virtual machine")

+ func SupportsHarnessInstall(version int) bool

+ func SupportsProjectResult(version int) bool

+ func SupportsProjectSeed(version int) bool

+ func SupportsSandboxMode(version int) bool

+ func SupportsUpgrade(version int) bool

+ func SupportsVirtualizationProbe(version int) bool

type AgentCapabilities

+ Virtualization bool

type Executor

+ func (e *Executor) Preflight() PreflightReport

+ func (e *Executor) ProjectResult(handleID string) (executor.ProjectResult, error)

+ func (e *Executor) RequestHarnessInstall(ctx context.Context, harness, reason string) (HarnessInstallOutcome, error)

+ func (e *Executor) RequestUpgrade(ctx context.Context, req UpgradeRequest) (UpgradeOutcome, error)

+ type Finding struct

+ Fix string

+ Level string

+ Message string

+ Name string

type FrameType

+ const TypeHarnessInstalled

+ const TypeInstallHarness

+ const TypeProjectResult

+ const TypeUpgrade

+ const TypeUpgrading

+ type HarnessInstallOutcome struct

+ AlreadyPresent bool

+ Harness string

+ Installed bool

+ Path string

+ Reason string

+ Version string

+ func (o HarnessInstallOutcome) Summary(device string) string

+ type HarnessInstalledPayload struct

+ AlreadyPresent bool

+ Harness string

+ Installed bool

+ Path string

+ Reason string

+ Version string

+ func DecodeHarnessInstalled(f Frame) (HarnessInstalledPayload, error)

type HubOptions

+ AutoInstallHarness func() bool

+ SandboxSource func(executorID string) func() (executor.SandboxSettings, error)

+ type InstallHarnessPayload struct

+ Harness string

+ Reason string

+ func DecodeInstallHarness(f Frame) (InstallHarnessPayload, error)

type Options

+ AutoInstallHarness func() bool

+ Sandbox func() (executor.SandboxSettings, error)

+ type PreflightReport struct

+ ExecutorID string

+ Findings []Finding

+ func (r PreflightReport) Err() error

+ func (r PreflightReport) OK() bool

+ type ProjectResultPayload struct

+ Data []byte

+ Err string

+ func DecodeProjectResult(f Frame) (ProjectResultPayload, error)

type StartPayload

+ ProjectSeed []byte

+ Sandbox executor.SandboxSettings

+ type UpgradeOutcome struct

+ Accepted bool

+ AlreadyCurrent bool

+ FromVersion string

+ Reason string

+ TargetVersion string

+ func (o UpgradeOutcome) Summary(device string) string

+ type UpgradePayload struct

+ Force bool

+ Reason string

+ SettleSeconds int

+ TargetVersion string

+ func DecodeUpgrade(f Frame) (UpgradePayload, error)

+ type UpgradeRequest struct

+ Force bool

+ Reason string

+ SettleTimeout time.Duration

+ TargetVersion string

+ type UpgradingPayload struct

+ Accepted bool

+ AlreadyCurrent bool

+ FromVersion string

+ Reason string

+ TargetVersion string

+ func DecodeUpgrading(f Frame) (UpgradingPayload, error)

v0.0.2

Sep 17, 2026

Changes in this version

+ const MaxAttachChunk

+ const MinAttachVersion

+ func EnrollmentRemediation(err error) string

+ func SupportsAttach(version int) bool

+ type AttachClosePayload struct

+ ExitCode int

+ Reason string

+ SessionID string

+ func DecodeAttachClose(f Frame) (AttachClosePayload, error)

+ type AttachDataPayload struct

+ Data []byte

+ SessionID string

+ func DecodeAttachData(f Frame) (AttachDataPayload, error)

+ type AttachOpenPayload struct

+ Cols uint16

+ Command []string

+ Env []string

+ Rows uint16

+ SessionID string

+ Stdin bool

+ TTY bool

+ func DecodeAttachOpen(f Frame) (AttachOpenPayload, error)

+ type AttachOpenedPayload struct

+ SessionID string

+ TTY bool

+ func DecodeAttachOpened(f Frame) (AttachOpenedPayload, error)

+ type AttachResizePayload struct

+ Cols uint16

+ Rows uint16

+ SessionID string

+ func DecodeAttachResize(f Frame) (AttachResizePayload, error)

type Executor

+ func (e *Executor) Attach(ctx context.Context, req executor.AttachRequest) (executor.AttachConn, error)

type FrameType

+ const TypeAttachClose

+ const TypeAttachData

+ const TypeAttachOpen

+ const TypeAttachOpened

+ const TypeAttachResize

v0.0.1

Sep 13, 2026

Changes in this version

+ const CodeBusy

+ const CodeForbiddenPath

+ const CodeProtocol

+ const CodeRevokeUnsupported

+ const CodeStartFailed

+ const CodeUnauthorized

+ const CodeUnknownHandle

+ const CodeVersionUnsupported

+ const CodeWriteBackFailed

+ const DefaultEnrollTTL

+ const DefaultLeaseJanitorInterval

+ const HeartbeatInterval

+ const JitterFraction

+ const LogAckBytes

+ const MaxEnrollTTL

+ const MaxFrameBytes

+ const MaxLogChunkBytes

+ const MaxResultChunkBytes

+ const MaxSecretFilesBytes

+ const MinProtocolVersion

+ const MinResumeTerminateVersion

+ const MinRevocationVersion

+ const MinSecretFilesVersion

+ const MinWorkspaceVersion

+ const MinWriteBackVersion

+ const MissedHeartbeatLimit

+ const ProtocolVersion

+ const RevokeKill

+ const RevokeScrub

+ const RevokeStateFailed

+ const RevokeStatePending

+ const RevokeStateRevoked

+ const RevokeStateUnreachable

+ const StatusOffline

+ const StatusOnline

+ const StatusUnreachable

+ const TokenFileMode

+ const WriteTimeout

+ var ErrAgentBusy = errors.New("remote: agent is at capacity")

+ var ErrAgentNotFound = errors.New("remote: agent not enrolled")

+ var ErrAgentUnreachable = errors.New("remote: agent is unreachable")

+ var ErrCredentialInvalid = errors.New("remote: invalid agent credential")

+ var ErrLeaseNotHeld = errors.New("remote: agent is not holding this lease")

+ var ErrPathOutsideRoot = errors.New("remote: workdir escapes agent root")

+ var ErrProtocol = errors.New("remote: protocol error")

+ var ErrRevocationUnsupported = fmt.Errorf("remote: agent does not support lease revocation: %w", ...)

+ var ErrRevoked = errors.New("remote: credential revoked")

+ var ErrSecretFilesUnsupported = errors.New("remote: agent does not support secret credential files")

+ var ErrSessionClosed = errors.New("remote: session closed")

+ var ErrTokenAlreadyUsed = errors.New("remote: enrollment token already redeemed")

+ var ErrTokenExpired = errors.New("remote: enrollment token expired")

+ var ErrTokenInvalid = errors.New("remote: invalid enrollment token")

+ var ErrVersionUnsupported = errors.New("remote: unsupported protocol version")

+ var ErrWorkspaceUnsupported = errors.New("remote: agent does not support workspace provisioning")

+ func HeartbeatDeadline() time.Duration

+ func MintBundle(store Store, opts MintOptions) (Bundle, EnrollmentRecord, error)

+ func NegotiateVersion(peerVersion int) (int, error)

+ func NewPipe(buffer int) (Conn, Conn)

+ func Revoke(store Store, id string, now time.Time) (kind string, err error)

+ func SupportsResumeTerminate(version int) bool

+ func SupportsRevocation(version int) bool

+ func SupportsSecretFiles(version int) bool

+ func SupportsWorkspaceProvisioning(version int) bool

+ func SupportsWriteBack(version int) bool

+ func ValidateSecretFiles(files []SecretFile) error

+ type AcceptOptions struct

+ Agent AgentRecord

+ Executor *Executor

+ HeartbeatPoll time.Duration

+ IssuedCredential string

+ Now func() time.Time

+ type AgentCapabilities struct

+ Arch string

+ CPUs int

+ ContainerRuntimes []string

+ Harnesses []string

+ Labels map[string]string

+ MaxConcurrent int

+ MemoryMB int

+ OS string

+ WorkDirRoot string

+ WorkspaceProvisioning bool

+ WriteBack bool

+ func (c AgentCapabilities) Executor() executor.Capabilities

+ type AgentRecord struct

+ AgentID string

+ CreatedAt time.Time

+ EnrollmentID string

+ Labels map[string]string

+ LastSeen time.Time

+ Name string

+ RevokedAt time.Time

+ SecretHash string

+ WorkDirRoot string

+ func Authenticate(store Store, credential string, now time.Time) (AgentRecord, error)

+ func Redeem(store Store, token string, opts RedeemOptions) (credential string, agent AgentRecord, err error)

+ func (r AgentRecord) Revoked() bool

+ type Bundle struct

+ EnrollmentID string

+ ExpiresAt time.Time

+ Name string

+ Pin string

+ Server string

+ Token string

+ WorkDirRoot string

+ func DecodeBundle(s string) (Bundle, error)

+ func ReadTokenFile(path string) (b Bundle, warning string, err error)

+ func (b Bundle) Command() string

+ func (b Bundle) Encode() (string, error)

+ func (b Bundle) Validate() error

+ type ByePayload struct

+ Reason string

+ Reconnect bool

+ func DecodeBye(f Frame) (ByePayload, error)

+ type Conn interface

+ Close func(reason string) error

+ ReadFrame func(ctx context.Context) (Frame, error)

+ WriteFrame func(ctx context.Context, f Frame) error

+ func NewWSConn(c *websocket.Conn) Conn

+ type EnrollmentRecord struct

+ CreatedAt time.Time

+ CreatedBy string

+ ExpiresAt time.Time

+ ID string

+ Labels map[string]string

+ Name string

+ RedeemedAgentID string

+ RedeemedAt time.Time

+ RevokedAt time.Time

+ SecretHash string

+ WorkDirRoot string

+ func Mint(store Store, opts MintOptions) (token string, rec EnrollmentRecord, err error)

+ func (r EnrollmentRecord) Expired(now time.Time) bool

+ func (r EnrollmentRecord) Redeemed() bool

+ func (r EnrollmentRecord) Revoked() bool

+ type ErrorPayload struct

+ Code string

+ Message string

+ func DecodeError(f Frame) (ErrorPayload, error)

+ type Executor struct

+ func NewExecutor(opts Options) (*Executor, error)

+ func (e *Executor) AgentCapabilities() AgentCapabilities

+ func (e *Executor) AgentInventory() (AgentCapabilities, bool)

+ func (e *Executor) AgentVersion() string

+ func (e *Executor) AttachHandleStore(store executor.HandleStore)

+ func (e *Executor) Capabilities() executor.Capabilities

+ func (e *Executor) ConnStatus() string

+ func (e *Executor) Connected() bool

+ func (e *Executor) HandleStatuses(ctx context.Context) ([]executor.Status, error)

+ func (e *Executor) Handles() []string

+ func (e *Executor) HealthCheck(ctx context.Context) error

+ func (e *Executor) HoldsLease(leaseID string) bool

+ func (e *Executor) ID() string

+ func (e *Executor) Kind() string

+ func (e *Executor) Leases() []string

+ func (e *Executor) LogGapped(handleID string) bool

+ func (e *Executor) Name() string

+ func (e *Executor) ProtocolVersion() int

+ func (e *Executor) Revocations() []RevokeResult

+ func (e *Executor) RevokeLease(ctx context.Context, p RevokePayload) RevokeResult

+ func (e *Executor) Signal(ctx context.Context, handleID string, sig executor.Signal) error

+ func (e *Executor) Start(ctx context.Context, spec executor.Spec) (handle executor.Handle, err error)

+ func (e *Executor) Status(ctx context.Context, handleID string) (executor.Status, error)

+ func (e *Executor) Stream(ctx context.Context, handleID string) (<-chan executor.LogLine, error)

+ func (e *Executor) SupportsRevocation() bool

+ func (e *Executor) SupportsWorkspaceProvisioning() bool

+ func (e *Executor) SupportsWriteBack() bool

+ func (e *Executor) WriteBackBundle(handleID string) ([]byte, error)

+ type ExpiredLease struct

+ LeaseID string

+ Reason string

+ type ExpiredLeaseSweeper func(now time.Time) []ExpiredLease

+ type Frame struct

+ Handle string

+ ID string

+ Payload json.RawMessage

+ Type FrameType

+ V int

+ func NewFrame(t FrameType, id, handle string, payload any) (Frame, error)

+ func NewFrameAt(version int, t FrameType, id, handle string, payload any) (Frame, error)

+ func (f Frame) String() string

+ func (f Frame) Validate() error

+ type FrameType string

+ const TypeBye

+ const TypeError

+ const TypeHeartbeat

+ const TypeHeartbeatAck

+ const TypeHello

+ const TypeLogAck

+ const TypeLogChunk

+ const TypeResult

+ const TypeResultChunk

+ const TypeRevoke

+ const TypeRevoked

+ const TypeSignal

+ const TypeStart

+ const TypeStarted

+ const TypeStatus

+ const TypeStatusReq

+ const TypeWelcome

+ type HeartbeatAckPayload struct

+ Seq uint64

+ ServerTime time.Time

+ func DecodeHeartbeatAck(f Frame) (HeartbeatAckPayload, error)

+ type HeartbeatPayload struct

+ ActiveHandles []string

+ LoadPercent int

+ Seq uint64

+ func DecodeHeartbeat(f Frame) (HeartbeatPayload, error)

+ type HelloPayload struct

+ AgentID string

+ AgentVersion string

+ Capabilities AgentCapabilities

+ Name string

+ ProtocolVersion int

+ Resume []ResumeHandle

+ func DecodeHello(f Frame) (HelloPayload, error)

+ type Hub struct

+ func NewHub(opts HubOptions) (*Hub, error)

+ func (h *Hub) Deregister(agentID string)

+ func (h *Hub) Executor(agentID string) (*Executor, bool)

+ func (h *Hub) Executors() []*Executor

+ func (h *Hub) LeaseHolders(leaseID string) []string

+ func (h *Hub) Restore() error

+ func (h *Hub) Revocations() []RevokeResult

+ func (h *Hub) Revoke(agentID string) error

+ func (h *Hub) RevokeExecutorLeases(ctx context.Context, executorID, reason string, action RevokeAction) []RevokeResult

+ func (h *Hub) RevokeLease(ctx context.Context, p RevokePayload) []RevokeResult

+ func (h *Hub) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (h *Hub) StartLeaseJanitor(ctx context.Context, interval time.Duration, sweep ExpiredLeaseSweeper) (stop func())

+ type HubOptions struct

+ AllowedOrigins []string

+ ExternalURL string

+ HandleStore executor.HandleStore

+ Logf func(format string, args ...any)

+ Now func() time.Time

+ OnConnect func(agent AgentRecord, caps AgentCapabilities, agentVersion string)

+ OnEnroll func(agent AgentRecord, caps AgentCapabilities)

+ OnRevokeAck func(executorID, leaseID string, ack RevokedPayload)

+ OnStatusChange func(executorID, status string, at time.Time)

+ Registry *executor.Registry

+ Store Store

+ WorkspaceSource func(executorID string) executor.WorkspaceCredentialSource

+ type LogAckPayload struct

+ Offset int64

+ func DecodeLogAck(f Frame) (LogAckPayload, error)

+ type LogChunkPayload struct

+ Offset int64

+ Stream executor.StreamName

+ Text string

+ Time time.Time

+ func DecodeLogChunk(f Frame) (LogChunkPayload, error)

+ func (p LogChunkPayload) End() int64

+ type MintOptions struct

+ CreatedBy string

+ Labels map[string]string

+ Name string

+ Now func() time.Time

+ Pin string

+ Server string

+ TTL time.Duration

+ WorkDirRoot string

+ type Options struct

+ Capabilities AgentCapabilities

+ HandleStore executor.HandleStore

+ ID string

+ Name string

+ Now func() time.Time

+ OnRevokeAck func(executorID, leaseID string, ack RevokedPayload)

+ OnStatusChange func(executorID, status string, at time.Time)

+ Workspace executor.WorkspaceCredentialSource

+ type RedeemOptions struct

+ Now func() time.Time

+ type ResultChunkPayload struct

+ Data []byte

+ Offset int64

+ func DecodeResultChunk(f Frame) (ResultChunkPayload, error)

+ func (p ResultChunkPayload) End() int64

+ type ResultPayload struct

+ Result executor.WriteBackResult

+ func DecodeResult(f Frame) (ResultPayload, error)

+ type ResumeAck struct

+ Action ResumeAction

+ FromOffset int64

+ HandleID string

+ Reason string

+ func (a ResumeAck) Effective() ResumeAction

+ type ResumeAction string

+ const ResumeContinue

+ const ResumeTerminate

+ func (a ResumeAction) Valid() bool

+ type ResumeHandle struct

+ HandleID string

+ LogOffset int64

+ StartedAt time.Time

+ type RevokeAction = executor.RevokeAction

+ type RevokePayload = executor.RevokeRequest

+ func DecodeRevoke(f Frame) (RevokePayload, error)

+ type RevokeResult = executor.RevokeOutcome

+ type RevokeState = executor.RevokeState

+ type RevokedPayload = executor.RevokeReport

+ func DecodeRevoked(f Frame) (RevokedPayload, error)

+ type SecretFile struct

+ Content []byte

+ Dir string

+ GrantID string

+ LeaseID string

+ Mode uint32

+ Name string

+ func NewSecretFile(f executor.SecretFile) SecretFile

+ func NewSecretFiles(files []executor.SecretFile) []SecretFile

+ func (f SecretFile) Executor() executor.SecretFile

+ func (f SecretFile) GoString() string

+ func (f SecretFile) String() string

+ func (f SecretFile) Validate() error

+ type Session struct

+ func Accept(ctx context.Context, conn Conn, opts AcceptOptions) (*Session, error)

+ func (s *Session) AgentID() string

+ func (s *Session) AgentVersion() string

+ func (s *Session) Capabilities() AgentCapabilities

+ func (s *Session) Close() error

+ func (s *Session) Done() <-chan struct{}

+ func (s *Session) LastSeen() time.Time

+ func (s *Session) Version() int

+ type SignalPayload struct

+ Signal executor.Signal

+ func DecodeSignal(f Frame) (SignalPayload, error)

+ type StartPayload struct

+ HandleID string

+ SecretFiles []SecretFile

+ Spec executor.Spec

+ WorkspaceCredential *WorkspaceCredential

+ func DecodeStart(f Frame) (StartPayload, error)

+ func (p StartPayload) CredentialFiles() []executor.SecretFile

+ func (p StartPayload) GitCredential() executor.GitCredential

+ type StartedPayload struct

+ Error string

+ HandleID string

+ PID int

+ StartedAt time.Time

+ func DecodeStarted(f Frame) (StartedPayload, error)

+ type StatusPayload struct

+ FinalOffset int64

+ Status executor.Status

+ func DecodeStatus(f Frame) (StatusPayload, error)

+ type StatusReqPayload struct

+ type Store interface

+ GetAgent func(agentID string) (AgentRecord, error)

+ GetEnrollment func(id string) (EnrollmentRecord, error)

+ ListAgents func() ([]AgentRecord, error)

+ ListEnrollments func() ([]EnrollmentRecord, error)

+ PutAgent func(rec AgentRecord) error

+ PutEnrollment func(rec EnrollmentRecord) error

+ RedeemEnrollment func(id, agentID string, at time.Time) error

+ RevokeAgent func(agentID string, at time.Time) error

+ RevokeEnrollment func(id string, at time.Time) error

+ TouchAgent func(agentID string, at time.Time) error

+ type WelcomePayload struct

+ Credential string

+ ExecutorID string

+ HeartbeatSeconds int

+ ProtocolVersion int

+ ResumeAccepted []ResumeAck

+ func DecodeWelcome(f Frame) (WelcomePayload, error)

+ type WorkspaceCredential struct

+ ExpiresAt time.Time

+ Password string

+ Username string

+ func (c WorkspaceCredential) GoString() string

+ func (c WorkspaceCredential) String() string

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