func ExpandAllDevcontainerPaths(loggerslog.Logger, expandPath func(string) (string,error), devcontainers []codersdk.WorkspaceAgentDevcontainer) []codersdk.WorkspaceAgentDevcontainer

func ExtractDevcontainerScripts(devcontainers []codersdk.WorkspaceAgentDevcontainer,scripts []codersdk.WorkspaceAgentScript,) (filteredScripts []codersdk.WorkspaceAgentScript, devcontainerScripts map[uuid.UUID]codersdk.WorkspaceAgentScript)

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

funcNewAPI¶added inv2.22.0

func NewAPI(loggerslog.Logger, options ...Option) *API

NewAPI returns a new API with the given options applied.

func (*API)Close¶added inv2.22.0

func (api *API) Close()error

func (*API)CreateDevcontainer¶added inv2.24.0

func (api *API) CreateDevcontainer(workspaceFolder, configPathstring, opts ...DevcontainerCLIUpOptions)error

createDevcontainer should run in its own goroutine and is responsible forrecreating a devcontainer based on the provided devcontainer configuration.It updates the devcontainer status and logs the process. The configPath ispassed as a parameter for the odd chance that the container being recreatedhas a different config file than the one stored in the devcontainer state.The devcontainer state must be set to starting and the asyncWg must beincremented before calling this function.

func (*API)Init¶added inv2.24.0

func (api *API) Init(opts ...Option)

Init applies a final set of options to the API and thencloses initDone. This method can only be called once.

func (*API)RefreshContainers¶added inv2.24.0

func (api *API) RefreshContainers(ctxcontext.Context) (errerror)

RefreshContainers triggers an immediate update of the container listand waits for it to complete.

func (*API)Routes¶added inv2.22.0

func (api *API) Routes()http.Handler

Routes returns the HTTP handler for container-related routes.

func (*API)Start¶added inv2.24.0

func (api *API) Start()

Start starts the API by initializing the watcher and updater loops.This method calls Init, if it is desired to apply options afterthe API has been created, it should be done by calling Init beforeStart. This method must only be called once.

func (*API)UpdateSubAgentClient¶added inv2.24.0

func (api *API) UpdateSubAgentClient(clientSubAgentClient)

UpdateSubAgentClient updates the `SubAgentClient` for the API.

type CoderCustomization struct {DisplayApps map[codersdk.DisplayApp]bool `json:"displayApps,omitempty"`Apps        []SubAgentApp                `json:"apps,omitempty"`Namestring                       `json:"name,omitempty"`Ignorebool                         `json:"ignore,omitempty"`}

type CommandEnv func(eiusershell.EnvInfoer, addEnv []string) (shell, dirstring, env []string, errerror)

type ContainerCLI interface {// List returns a list of containers visible to the workspace agent.// This should include running and stopped containers.List(ctxcontext.Context) (codersdk.WorkspaceAgentListContainersResponse,error)// DetectArchitecture detects the architecture of a container.DetectArchitecture(ctxcontext.Context, containerNamestring) (string,error)// Copy copies a file from the host to a container.Copy(ctxcontext.Context, containerName, src, dststring)error// ExecAs executes a command in a container as a specific user.ExecAs(ctxcontext.Context, containerName, userstring, args ...string) ([]byte,error)}

funcNewDockerCLI¶added inv2.24.0

func NewDockerCLI(execeragentexec.Execer)ContainerCLI

type DevcontainerCLI interface {Up(ctxcontext.Context, workspaceFolder, configPathstring, opts ...DevcontainerCLIUpOptions) (idstring, errerror)Exec(ctxcontext.Context, workspaceFolder, configPathstring, cmdstring, cmdArgs []string, opts ...DevcontainerCLIExecOptions)errorReadConfig(ctxcontext.Context, workspaceFolder, configPathstring, env []string, opts ...DevcontainerCLIReadConfigOptions) (DevcontainerConfig,error)}

funcNewDevcontainerCLI¶added inv2.22.0

func NewDevcontainerCLI(loggerslog.Logger, execeragentexec.Execer)DevcontainerCLI

type DevcontainerCLIExecOptions func(*devcontainerCLIExecConfig)

funcWithExecContainerID¶added inv2.24.0

func WithExecContainerID(idstring)DevcontainerCLIExecOptions

WithExecContainerID sets the container ID to target a specificcontainer.

funcWithExecOutput¶added inv2.24.0

func WithExecOutput(stdout, stderrio.Writer)DevcontainerCLIExecOptions

WithExecOutput sets additional stdout and stderr writers for logsduring Exec operations.

funcWithRemoteEnv¶added inv2.24.0

func WithRemoteEnv(env ...string)DevcontainerCLIExecOptions

WithRemoteEnv sets environment variables for the Exec command.

type DevcontainerCLIReadConfigOptions func(*devcontainerCLIReadConfigConfig)

funcWithReadConfigOutput¶added inv2.24.0

func WithReadConfigOutput(stdout, stderrio.Writer)DevcontainerCLIReadConfigOptions

WithReadConfigOutput sets additional stdout and stderr writers for logsduring ReadConfig operations.

type DevcontainerCLIUpOptions func(*devcontainerCLIUpConfig)

funcWithRemoveExistingContainer¶added inv2.22.0

func WithRemoveExistingContainer()DevcontainerCLIUpOptions

WithRemoveExistingContainer is an option to remove the existingcontainer.

funcWithUpOutput¶added inv2.24.0

func WithUpOutput(stdout, stderrio.Writer)DevcontainerCLIUpOptions

WithUpOutput sets additional stdout and stderr writers for logsduring Up operations.

type DevcontainerConfig struct {MergedConfigurationDevcontainerMergedConfiguration `json:"mergedConfiguration"`ConfigurationDevcontainerConfiguration       `json:"configuration"`WorkspaceDevcontainerWorkspace           `json:"workspace"`}

type DevcontainerConfiguration struct {CustomizationsDevcontainerCustomizations `json:"customizations,omitempty"`}

type DevcontainerCustomizations struct {CoderCoderCustomization `json:"coder,omitempty"`}

type DevcontainerFeatures map[string]any

func (DevcontainerFeatures)OptionsAsEnvs¶added inv2.24.0

func (fDevcontainerFeatures) OptionsAsEnvs() []string

OptionsAsEnvs converts the DevcontainerFeatures into a list ofenvironment variables that can be used to set feature options.The format is FEATURE_<FEATURE_NAME>_OPTION_<OPTION_NAME>=<value>.For example, if the feature is:

"ghcr.io/coder/devcontainer-features/code-server:1": {   "port": 9090, }

It will produce:

FEATURE_CODE_SERVER_OPTION_PORT=9090

Note that the feature name is derived from the last part of the key,so "ghcr.io/coder/devcontainer-features/code-server:1" becomes"CODE_SERVER". The version part (e.g. ":1") is removed, and dashes inthe feature and option names are replaced with underscores.

type DevcontainerMergedConfiguration struct {CustomizationsDevcontainerMergedCustomizations `json:"customizations,omitempty"`FeaturesDevcontainerFeatures             `json:"features,omitempty"`}

type DevcontainerMergedCustomizations struct {Coder []CoderCustomization `json:"coder,omitempty"`}

type DevcontainerWorkspace struct {WorkspaceFolderstring `json:"workspaceFolder"`}

type DockerEnvInfoer struct {usershell.SystemEnvInfo// contains filtered or unexported fields}

funcEnvInfo¶

func EnvInfo(ctxcontext.Context, execeragentexec.Execer, container, containerUserstring) (*DockerEnvInfoer,error)

EnvInfo returns information about the environment of a container.

func (*DockerEnvInfoer)ModifyCommand¶

func (dei *DockerEnvInfoer) ModifyCommand(cmdstring, args ...string) (string, []string)

func (*DockerEnvInfoer)Shell¶added inv2.21.0

func (dei *DockerEnvInfoer) Shell(string) (string,error)

func (*DockerEnvInfoer)User¶added inv2.21.0

func (dei *DockerEnvInfoer) User() (*user.User,error)

type Option func(*API)

funcWithClock¶added inv2.22.0

func WithClock(clockquartz.Clock)Option

WithClock sets the quartz.Clock implementation to use.This is primarily used for testing to control time.

funcWithCommandEnv¶added inv2.24.0

func WithCommandEnv(ceCommandEnv)Option

WithCommandEnv sets the CommandEnv implementation to use.

funcWithContainerCLI¶added inv2.24.0

func WithContainerCLI(ccliContainerCLI)Option

WithContainerCLI sets the agentcontainers.ContainerCLI implementationto use. The default implementation uses the Docker CLI.

funcWithContainerLabelIncludeFilter¶added inv2.24.0

func WithContainerLabelIncludeFilter(label, valuestring)Option

WithContainerLabelIncludeFilter sets a label filter for containers.This option can be given multiple times to filter by multiple labels.The behavior is such that only containers matching one or more of theprovided labels will be included.

funcWithDevcontainerCLI¶added inv2.22.0

func WithDevcontainerCLI(dccliDevcontainerCLI)Option

WithDevcontainerCLI sets the DevcontainerCLI implementation to use.This can be used in tests to modify @devcontainer/cli behavior.

funcWithDevcontainers¶added inv2.22.0

func WithDevcontainers(devcontainers []codersdk.WorkspaceAgentDevcontainer, scripts []codersdk.WorkspaceAgentScript)Option

WithDevcontainers sets the known devcontainers for the API. Thisallows the API to be aware of devcontainers defined in the workspaceagent manifest.

funcWithExecer¶added inv2.22.0

func WithExecer(execeragentexec.Execer)Option

WithExecer sets the agentexec.Execer implementation to use.

funcWithManifestInfo¶added inv2.24.0

func WithManifestInfo(owner, workspace, parentAgentstring)Option

WithManifestInfo sets the owner name, and workspace namefor the sub-agent.

funcWithScriptLogger¶added inv2.23.0

func WithScriptLogger(scriptLogger func(logSourceIDuuid.UUID)ScriptLogger)Option

WithScriptLogger sets the script logger provider for devcontainer operations.

funcWithSubAgentClient¶added inv2.24.0

func WithSubAgentClient(clientSubAgentClient)Option

WithSubAgentClient sets the SubAgentClient implementation to use.This is used to list, create, and delete devcontainer agents.

funcWithSubAgentEnv¶added inv2.24.0

func WithSubAgentEnv(env ...string)Option

WithSubAgentEnv sets the environment variables for the sub-agent.

funcWithSubAgentURL¶added inv2.24.0

func WithSubAgentURL(urlstring)Option

WithSubAgentURL sets the agent URL for the sub-agent forcommunicating with the control plane.

funcWithWatcher¶added inv2.22.0

func WithWatcher(wwatcher.Watcher)Option

WithWatcher sets the file watcher implementation to use. By default anoop watcher is used. This can be used in tests to modify the watcherbehavior or to use an actual file watcher (e.g. fsnotify).

type ScriptLogger interface {Send(ctxcontext.Context, log ...agentsdk.Log)errorFlush(ctxcontext.Context)error}

type SubAgent struct {IDuuid.UUIDNamestringAuthTokenuuid.UUIDDirectorystringArchitecturestringOperatingSystemstringApps            []SubAgentAppDisplayApps     []codersdk.DisplayApp}

func (SubAgent)CloneConfig¶added inv2.24.0

func (sSubAgent) CloneConfig(dccodersdk.WorkspaceAgentDevcontainer)SubAgent

CloneConfig makes a copy of SubAgent without ID and AuthToken. Thename is inherited from the devcontainer.

func (SubAgent)EqualConfig¶added inv2.24.0

func (sSubAgent) EqualConfig(otherSubAgent)bool

type SubAgentApp struct {Slugstring                            `json:"slug"`Commandstring                            `json:"command"`DisplayNamestring                            `json:"displayName"`Externalbool                              `json:"external"`Groupstring                            `json:"group"`HealthCheckSubAgentHealthCheck               `json:"healthCheck"`Hiddenbool                              `json:"hidden"`Iconstring                            `json:"icon"`OpenIncodersdk.WorkspaceAppOpenIn       `json:"openIn"`Orderint32                             `json:"order"`Sharecodersdk.WorkspaceAppSharingLevel `json:"share"`Subdomainbool                              `json:"subdomain"`URLstring                            `json:"url"`}

func (SubAgentApp)ToProtoApp¶added inv2.24.0

func (appSubAgentApp) ToProtoApp() (*agentproto.CreateSubAgentRequest_App,error)

type SubAgentClient interface {// List returns a list of all agents.List(ctxcontext.Context) ([]SubAgent,error)// Create adds a new agent.Create(ctxcontext.Context, agentSubAgent) (SubAgent,error)// Delete removes an agent by its ID.Delete(ctxcontext.Context, iduuid.UUID)error}

funcNewSubAgentClientFromAPI¶added inv2.24.0

func NewSubAgentClientFromAPI(loggerslog.Logger, agentAPIagentproto.DRPCAgentClient26)SubAgentClient

type SubAgentHealthCheck struct {Intervalint32  `json:"interval"`Thresholdint32  `json:"threshold"`URLstring `json:"url"`}