engine

Documentation

Index

• Constants
• Variables
• func ContextWithClientMetadata(ctx context.Context, clientMetadata *ClientMetadata) context.Context
• func RunnerHost() (string, error)
• type ClientMetadata
  • func ClientMetadataFromContext(ctx context.Context) (*ClientMetadata, error)
  • func (m ClientMetadata) AppendToMD(md metadata.MD) metadata.MD
  • func (m ClientMetadata) ClientIDs() []string
  • func (m ClientMetadata) ToGRPCMD() metadata.MD
• type LocalExportOpts
  • func LocalExportOptsFromContext(ctx context.Context) (*LocalExportOpts, error)
  • func (o LocalExportOpts) AppendToOutgoingContext(ctx context.Context) context.Context
  • func (o LocalExportOpts) ToGRPCMD() metadata.MD
• type LocalImportOpts
  • func LocalImportOptsFromContext(ctx context.Context) (*LocalImportOpts, error)
  • func (o LocalImportOpts) AppendToOutgoingContext(ctx context.Context) context.Context
  • func (o LocalImportOpts) ToGRPCMD() metadata.MD

Constants

const (
	StdinPrefix  = "\x00,"
	StdoutPrefix = "\x01,"
	StderrPrefix = "\x02,"
	ResizePrefix = "resize,"
	ExitPrefix   = "exit,"
)

const (
	EngineVersionMetaKey = "x-dagger-engine"
)

Variables

var (
	EngineImageRepo = "registry.dagger.io/engine"

	Package = "github.com/dagger/dagger"

	GPUSupportEnvName = "_EXPERIMENTAL_DAGGER_GPU_SUPPORT"
)

var Version string

Version holds the complete version number. Filled in at linking time. For official tagged releases, this is simple semver like x.y.z For builds off our repo's main branch, this is the git commit sha For local dev builds, this is a content hash of dagger repo source from "git write-tree"

Functions

func ContextWithClientMetadata

func ContextWithClientMetadata(ctx context.Context, clientMetadata *ClientMetadata) context.Context

func RunnerHost

func RunnerHost() (string, error)

Types

type ClientMetadata

type ClientMetadata struct {
	// ClientID is unique to every session created by every client
	ClientID string `json:"client_id"`

	// ClientSecretToken is a secret token that is unique to every client. It's
	// initially provided to the server in the controller.Solve request. Every
	// other request w/ that client ID must also include the same token.
	ClientSecretToken string `json:"client_secret_token"`

	// ServerID is the id of the server that a client and any of its nested
	// module clients connect to
	ServerID string `json:"server_id"`

	// If RegisterClient is true, then a call to Session will initialize the
	// server if it hasn't already been initialized and register the session's
	// attachables with it either way. If false, then the session conn will be
	// forwarded to the server
	RegisterClient bool `json:"register_client"`

	// ClientHostname is the hostname of the client that made the request. It's
	// used opportunistically as a best-effort, semi-stable identifier for the
	// client across multiple sessions, which can be useful for debugging and for
	// minimizing occurrences of both excessive cache misses and excessive cache
	// matches.
	ClientHostname string `json:"client_hostname"`

	// (Optional) Pipeline labels for e.g. vcs info like branch, commit, etc.
	Labels telemetry.Labels `json:"labels"`

	// ParentClientIDs is a list of session ids that are parents of the current
	// session. The first element is the direct parent, the second element is the
	// parent of the parent, and so on.
	ParentClientIDs []string `json:"parent_client_ids"`

	// If this client is for a module function, this digest will be set in the
	// grpc context metadata for any api requests back to the engine. It's used by the API
	// server to determine which schema to serve and other module context metadata.
	ModuleCallerDigest digest.Digest `json:"module_caller_digest"`

	// Import configuration for Buildkit's remote cache
	UpstreamCacheImportConfig []*controlapi.CacheOptionsEntry

	// Export configuration for Buildkit's remote cache
	UpstreamCacheExportConfig []*controlapi.CacheOptionsEntry

	// Dagger Cloud Token
	CloudToken string

	// Disable analytics
	DoNotTrack bool
}

func ClientMetadataFromContext

func ClientMetadataFromContext(ctx context.Context) (*ClientMetadata, error)

func (ClientMetadata) AppendToMD

func (m ClientMetadata) AppendToMD(md metadata.MD) metadata.MD

func (ClientMetadata) ClientIDs

func (m ClientMetadata) ClientIDs() []string

ClientIDs returns the ClientID followed by ParentClientIDs.

func (ClientMetadata) ToGRPCMD

func (m ClientMetadata) ToGRPCMD() metadata.MD

type LocalExportOpts

type LocalExportOpts struct {
	Path               string      `json:"path"`
	IsFileStream       bool        `json:"is_file_stream"`
	FileOriginalName   string      `json:"file_original_name"`
	AllowParentDirPath bool        `json:"allow_parent_dir_path"`
	FileMode           os.FileMode `json:"file_mode"`
	// whether to just merge in contents of a directory to the target on the host
	// or to replace the target entirely such that it matches the source directory,
	// which includes deleting any files that are not in the source directory
	Merge bool
}

func LocalExportOptsFromContext

func LocalExportOptsFromContext(ctx context.Context) (*LocalExportOpts, error)

func (LocalExportOpts) AppendToOutgoingContext

func (o LocalExportOpts) AppendToOutgoingContext(ctx context.Context) context.Context

func (LocalExportOpts) ToGRPCMD

func (o LocalExportOpts) ToGRPCMD() metadata.MD

type LocalImportOpts

type LocalImportOpts struct {
	Path               string   `json:"path"`
	IncludePatterns    []string `json:"include_patterns"`
	ExcludePatterns    []string `json:"exclude_patterns"`
	FollowPaths        []string `json:"follow_paths"`
	ReadSingleFileOnly bool     `json:"read_single_file_only"`
	MaxFileSize        int64    `json:"max_file_size"`
	StatPathOnly       bool     `json:"stat_path_only"`
	StatReturnAbsPath  bool     `json:"stat_return_abs_path"`
}

func LocalImportOptsFromContext

func LocalImportOptsFromContext(ctx context.Context) (*LocalImportOpts, error)

func (LocalImportOpts) AppendToOutgoingContext

func (o LocalImportOpts) AppendToOutgoingContext(ctx context.Context) context.Context

func (LocalImportOpts) ToGRPCMD

func (o LocalImportOpts) ToGRPCMD() metadata.MD