client

Documentation

Index

• Constants
• func GetHostStableID(lg *slog.Logger) string
• func LexicalRelativePath(cwdPath, modPath string) (string, error)
• func Tracer(ctx context.Context) trace.Tracer
• type BuildkitSessionServer
  • func ConnectBuildkitSession(ctx context.Context, conn net.Conn, headers http.Header, ...) (*BuildkitSessionServer, error)
  • func NewBuildkitSessionServer(ctx context.Context, conn net.Conn, attachables ...bksession.Attachable) *BuildkitSessionServer
  • func (srv *BuildkitSessionServer) Run(ctx context.Context)
• type Client
  • func Connect(ctx context.Context, params Params) (_ *Client, _ context.Context, rerr error)
  • func (c *Client) AppendHTTPRequestHeaders(headers http.Header) http.Header
  • func (c *Client) Close() (rerr error)
  • func (c *Client) Dagger() *dagger.Client
  • func (c *Client) DialContext(ctx context.Context, _, _ string) (conn net.Conn, err error)
  • func (c *Client) Do(ctx context.Context, query string, opName string, variables map[string]any, ...) (rerr error)
  • func (c *Client) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type DirectConn
  • func EngineConn(engineClient *Client) DirectConn
  • func (f DirectConn) Close() error
  • func (f DirectConn) Do(r *http.Request) (*http.Response, error)
  • func (f DirectConn) Host() string
• type FilesyncSource
  • func (s FilesyncSource) DiffCopy(stream filesync.FileSync_DiffCopyServer) error
  • func (s FilesyncSource) Register(server *grpc.Server)
  • func (s FilesyncSource) TarStream(stream filesync.FileSync_TarStreamServer) error
• type FilesyncTarget
  • func (t FilesyncTarget) DiffCopy(stream filesync.FileSend_DiffCopyServer) (rerr error)
  • func (t FilesyncTarget) Register(server *grpc.Server)
• type Filesyncer
  • func NewFilesyncer(rootDir, cwdPath string, uid, gid *uint32) (Filesyncer, error)
  • func (f Filesyncer) AsSource() FilesyncSource
  • func (f Filesyncer) AsTarget() FilesyncTarget
• type Params
• type SocketProvider
  • func (p SocketProvider) CheckAgent(ctx context.Context, req *sshforward.CheckAgentRequest) (*sshforward.CheckAgentResponse, error)
  • func (p SocketProvider) ForwardAgent(stream sshforward.SSH_ForwardAgentServer) error
  • func (p SocketProvider) Register(server *grpc.Server)

Constants

const InstrumentationLibrary = "dagger.io/engine.client"

const StableIDFileName = "stable_client_id"

Functions

func GetHostStableID

func GetHostStableID(lg *slog.Logger) string

GetHostStableID returns a random ID that's persisted in the caller's XDG state directory. It's currently used to identify clients that are executing on the same host in order to tell buildkit which filesync cache ref to re-use when syncing dirs+files to the engine.

func LexicalRelativePath

func LexicalRelativePath(cwdPath, modPath string) (string, error)

LexicalRelativePath computes a relative path between the current working directory and modPath without relying on runtime.GOOS to estimate OS-specific separators. This is necessary as the code runs inside a Linux container, but the user might have specified a Windows-style modPath.

func Tracer

func Tracer(ctx context.Context) trace.Tracer

Types

type BuildkitSessionServer

type BuildkitSessionServer struct {
	*grpc.Server
	MethodURLs []string
	Conn       net.Conn
}

func ConnectBuildkitSession

func ConnectBuildkitSession(
	ctx context.Context,
	conn net.Conn,
	headers http.Header,
	attachables ...bksession.Attachable,
) (*BuildkitSessionServer, error)

func NewBuildkitSessionServer

func NewBuildkitSessionServer(ctx context.Context, conn net.Conn, attachables ...bksession.Attachable) *BuildkitSessionServer

func (*BuildkitSessionServer) Run

func (srv *BuildkitSessionServer) Run(ctx context.Context)

type Client

type Client struct {
	Params
	// contains filtered or unexported fields
}

func Connect

func Connect(ctx context.Context, params Params) (_ *Client, _ context.Context, rerr error)

func (*Client) AppendHTTPRequestHeaders

func (c *Client) AppendHTTPRequestHeaders(headers http.Header) http.Header

func (*Client) Close

func (c *Client) Close() (rerr error)

func (*Client) Dagger

func (c *Client) Dagger() *dagger.Client

A client to the Dagger API hooked up directly with this engine client.

func (*Client) DialContext

func (c *Client) DialContext(ctx context.Context, _, _ string) (conn net.Conn, err error)

func (*Client) Do

func (c *Client) Do(
	ctx context.Context,
	query string,
	opName string,
	variables map[string]any,
	data any,
) (rerr error)

func (*Client) ServeHTTP

func (c *Client) ServeHTTP(w http.ResponseWriter, r *http.Request)

type DirectConn

type DirectConn func(*http.Request) (*http.Response, error)

func EngineConn

func EngineConn(engineClient *Client) DirectConn

func (DirectConn) Close

func (f DirectConn) Close() error

func (DirectConn) Do

func (f DirectConn) Do(r *http.Request) (*http.Response, error)

func (DirectConn) Host

func (f DirectConn) Host() string

type FilesyncSource

type FilesyncSource Filesyncer

func (FilesyncSource) DiffCopy

func (s FilesyncSource) DiffCopy(stream filesync.FileSync_DiffCopyServer) error

func (FilesyncSource) Register

func (s FilesyncSource) Register(server *grpc.Server)

func (FilesyncSource) TarStream

func (s FilesyncSource) TarStream(stream filesync.FileSync_TarStreamServer) error

type FilesyncTarget

type FilesyncTarget Filesyncer

func (FilesyncTarget) DiffCopy

func (t FilesyncTarget) DiffCopy(stream filesync.FileSend_DiffCopyServer) (rerr error)

func (FilesyncTarget) Register

func (t FilesyncTarget) Register(server *grpc.Server)

type Filesyncer

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

func NewFilesyncer

func NewFilesyncer(rootDir, cwdPath string, uid, gid *uint32) (Filesyncer, error)

func (Filesyncer) AsSource

func (f Filesyncer) AsSource() FilesyncSource

func (Filesyncer) AsTarget

func (f Filesyncer) AsTarget() FilesyncTarget

type Params

type Params struct {
	// The id to connect to the API server with. If blank, will be set to a
	// new random value.
	ID string

	// The id of the session to connect to, or if blank a new one should be started.
	SessionID string

	SecretToken string

	RunnerHost string // host of dagger engine runner serving buildkit apis
	UserAgent  string

	DisableHostRW bool

	EngineCallback   func(context.Context, string, string, string)
	CloudURLCallback func(context.Context, string, string, bool)

	EngineTrace sdktrace.SpanExporter
	EngineLogs  sdklog.Exporter

	// Log level (0 = INFO)
	LogLevel slog.Level

	Interactive        bool
	InteractiveCommand []string

	WithTerminal session.WithTerminalFunc
}

type SocketProvider

type SocketProvider struct {
	EnableHostNetworkAccess bool

	// Dialer to use for tcp/udp socket. Optional, defaults to net.Dial if not set
	IPDialer func(network, addr string) (net.Conn, error)

	// If unix sock paths need to be remapped (i.e. nested execs), use this function to do so.
	// Otherwise paths are passed through as-is.
	UnixPathMapper func(path string) (string, error)
}

func (SocketProvider) CheckAgent

func (p SocketProvider) CheckAgent(ctx context.Context, req *sshforward.CheckAgentRequest) (*sshforward.CheckAgentResponse, error)

func (SocketProvider) ForwardAgent

func (p SocketProvider) ForwardAgent(stream sshforward.SSH_ForwardAgentServer) error

func (SocketProvider) Register

func (p SocketProvider) Register(server *grpc.Server)