Documentation
¶
Overview ¶
Package copy manages the lifecycle of ephemeral database copies.
Index ¶
- type AccessMode
- type CopyClient
- type CopyRuntime
- type CreateOptions
- type HTTPClient
- func (c *HTTPClient) Create(ctx context.Context, opts CreateOptions) (*store.Copy, error)
- func (c *HTTPClient) Destroy(ctx context.Context, id string) error
- func (c *HTTPClient) Events(ctx context.Context, id string) ([]apiv2.CopyEvent, error)
- func (c *HTTPClient) List(ctx context.Context) ([]*store.Copy, error)
- func (c *HTTPClient) Status(ctx context.Context) (*apiv2.StatusResponse, error)
- type Manager
- func (m *Manager) Create(ctx context.Context, opts CreateOptions) (*store.Copy, error)
- func (m *Manager) Destroy(ctx context.Context, id string) error
- func (m *Manager) ExpireOldCopies(ctx context.Context) error
- func (m *Manager) List(ctx context.Context) ([]*store.Copy, error)
- func (m *Manager) RecoverOrphans(ctx context.Context) error
- func (m *Manager) StartPool(ctx context.Context)
- type PortPool
- type RemoteRuntimeConfig
- type WarmPoolRefiller
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessMode ¶ added in v0.2.0
type AccessMode string
const ( AccessModeLocal AccessMode = "local" AccessModeRemote AccessMode = "remote" )
type CopyClient ¶
type CopyClient interface {
Create(ctx context.Context, opts CreateOptions) (*store.Copy, error)
Destroy(ctx context.Context, id string) error
List(ctx context.Context) ([]*store.Copy, error)
}
CopyClient abstracts local (Manager) and remote (HTTPClient) copy operations. Both implementations are used by CLI commands via copyClientFromContext.
type CopyRuntime ¶ added in v0.2.0
type CopyRuntime struct {
Bootstrap engine.CopyBootstrap
Internal engine.ConnectionConfig
External engine.ConnectionConfig
BindHost string
}
CopyRuntime holds the engine bootstrap and the internal/external connection parameters for a single copy.
type CreateOptions ¶
type CreateOptions struct {
TTLSeconds int
RunID string // optional: identifies the run/session that created this copy
JobName string // optional: identifies the job/task within the run
OwnerSubject string // optional: authenticated caller identity for shared-host mode
DumpPath string // optional: override dump path (local, s3://, http://); empty = use cfg.Dump.Path
DumpURI string // optional: remote API hint; the local manager ignores this field
Obfuscate bool // apply post-restore obfuscation rules (explicit opt-in)
}
CreateOptions configures a copy creation request.
type HTTPClient ¶
type HTTPClient struct {
// contains filtered or unexported fields
}
HTTPClient implements CopyClient by talking to a shared ditto host.
func NewHTTPClient ¶
func NewHTTPClient(baseURL, token string) *HTTPClient
NewHTTPClient creates a client. baseURL is e.g. "http://ditto.internal:8080". token is the Bearer auth token; pass "" to skip authentication.
func (*HTTPClient) Create ¶
func (c *HTTPClient) Create(ctx context.Context, opts CreateOptions) (*store.Copy, error)
func (*HTTPClient) Status ¶ added in v0.2.0
func (c *HTTPClient) Status(ctx context.Context) (*apiv2.StatusResponse, error)
type Manager ¶
type Manager struct {
// contains filtered or unexported fields
}
Manager orchestrates the full lifecycle of ephemeral database copies.
func NewManager ¶
func NewManager( cfg *config.Config, eng engine.Engine, copies *store.CopyStore, events *store.EventStore, ports *PortPool, docker *client.Client, ) (*Manager, error)
NewManager creates a Manager from an already-resolved Docker-compatible runtime client.
func NewRemoteManager ¶ added in v0.2.0
func NewRemoteManager( cfg *config.Config, eng engine.Engine, copies *store.CopyStore, events *store.EventStore, ports *PortPool, docker *client.Client, runtime RemoteRuntimeConfig, ) (*Manager, error)
NewRemoteManager creates a Manager configured for shared-host mode.
func (*Manager) Create ¶
Create provisions a new ephemeral database copy. When a pre-warmed copy is available in the pool it is claimed instantly. Otherwise the full slow path (container start + dump restore) is taken.
func (*Manager) ExpireOldCopies ¶
ExpireOldCopies destroys all copies whose TTL has elapsed.
func (*Manager) RecoverOrphans ¶
RecoverOrphans is called at daemon startup. It heals mid-transition records left by a crashed process and removes Docker containers not tracked in SQLite.
type PortPool ¶
type PortPool struct {
// contains filtered or unexported fields
}
PortPool manages a bounded set of host ports for copy containers. Allocate() returns a free port; Release() returns it to the pool. All operations are safe for concurrent use.
func NewPortPool ¶
NewPortPool creates a pool covering ports [start, end] inclusive. Ports in occupied are pre-marked as in-use (loaded from SQLite at startup).
func (*PortPool) Allocate ¶
Allocate returns a free port, marking it as in-use. It scans start-to-end and additionally TCP-dials each candidate to catch externally occupied ports (e.g. orphaned containers from a previous crash).
Returns an error if no port is available.
func (*PortPool) AllocateWithTimeout ¶ added in v0.2.0
AllocateWithTimeout waits up to timeout for a free port, retrying each time a port is released. Returns an error if the timeout elapses before a port becomes available.
type RemoteRuntimeConfig ¶ added in v0.2.0
type RemoteRuntimeConfig struct {
Mode AccessMode
AdvertiseHost string
BindHost string
CopySecret string
TLSEnabled bool
CertFile string
KeyFile string
}
RemoteRuntimeConfig controls how copies are exposed when ditto runs as a shared host.
type WarmPoolRefiller ¶
type WarmPoolRefiller struct {
// contains filtered or unexported fields
}
WarmPoolRefiller maintains a target number of pre-warmed copies in the pool. When a copy is claimed, Signal() triggers an immediate refill check. A 30-second heartbeat ticker catches any silent drops (e.g. TTL expiry of un-claimed warm copies, which is disabled by ListExpired, but kept as defence).
func NewWarmPoolRefiller ¶
func NewWarmPoolRefiller(mgr *Manager, target int) *WarmPoolRefiller
NewWarmPoolRefiller creates a refiller targeting target warm copies. target=0 means the pool is disabled; Run returns immediately.
func (*WarmPoolRefiller) Run ¶
func (r *WarmPoolRefiller) Run(ctx context.Context)
Run blocks until ctx is cancelled. It refills the pool on each signal and on a 30-second heartbeat. Returns immediately when target == 0.
func (*WarmPoolRefiller) Signal ¶
func (r *WarmPoolRefiller) Signal()
Signal queues a refill check. Non-blocking: if a signal is already pending, this call is a no-op.
Source Files