Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

devcontainer

package

Go to main page

Versions in this module

v0

v0.4.0

Sep 17, 2024

Changes in this version

+ const DefaultWorkingDir

type Config

+ func (c *Config) IsComposeDevContainer() bool

+ func (c *Config) IsDockerfileDevContainer() bool

+ func (c *Config) IsImageDevContainer() bool

+ type ContainerManager interface

+ CreateContainer func(ctx context.Context, image string, projectPath string, config Config) (string, error)

+ Exec func(ctx context.Context, containerId string, command []string) (ExecResult, error)

+ StartContainer func(ctx context.Context, containerId string) error

+ StopContainer func(ctx context.Context, containerId string) error

+ func NewDockerContainerManager(dockerContainerCli client.ContainerAPIClient) ContainerManager

+ type DockerContainerManager struct

+ func (cm *DockerContainerManager) CreateContainer(ctx context.Context, image string, projectPath string, config Config) (string, error)

+ func (cm *DockerContainerManager) Exec(ctx context.Context, containerId string, command []string) (ExecResult, error)

+ func (cm *DockerContainerManager) StartContainer(ctx context.Context, containerId string) error

+ func (cm *DockerContainerManager) StopContainer(ctx context.Context, containerId string) error

+ type DockerHubRegistryCredentials struct

+ func (c *DockerHubRegistryCredentials) GetCredentials() (string, error)

+ type DockerImageManager struct

+ func (im *DockerImageManager) BuildImage(ctx context.Context, workingDir string, config Config) (string, error)

+ func (im *DockerImageManager) PullImage(ctx context.Context, name string) error

+ type Executor interface

+ Run func(command []string, dir string, stdout, stderr io.Writer) error

+ func NewExecutorImpl() Executor

+ type ExecutorImpl struct

+ func (e *ExecutorImpl) Run(command []string, dir string, stdout, stderr io.Writer) error

+ type ImageDevContainer struct

+ type ImageManager interface

+ BuildImage func(ctx context.Context, workingDir string, config Config) (string, error)

+ PullImage func(ctx context.Context, name string) error

+ func NewImageManager(dockerImageCli client.ImageAPIClient, randomString func(int) string, ...) ImageManager

+ type RegistryCredentials interface

+ GetCredentials func() (string, error)

+ func NewDockerHubRegistryCredentials(username, password string) RegistryCredentials

v0.3.0

Aug 20, 2024

v0.2.0

Jul 26, 2024

v0.1.0

Jun 26, 2024

Changes in this version

+ const DefaultShell

+ var DefaultContainerCommand = []string

+ func ReadOutputFromContainer(src io.Reader, stdout, stderr io.Writer) error

+ type AppPort []int

+ func (a *AppPort) UnmarshalJSON(data []byte) error

+ type BuildProps struct

+ Args map[string]*string

+ CacheFrom StringArray

+ Context string

+ Dockerfile string

+ Options []string

+ Target string

+ func (b *BuildProps) Equals(other *BuildProps) bool

+ type Config struct

+ Path string

+ func ParseConfig(configFile File) (*Config, error)

+ func (c *Config) Equals(other *Config) bool

+ type Customizations struct

+ Hide *HideCustomization

+ func (c Customizations) Equals(other Customizations) bool

+ type DockerComposeProps struct

+ DockerComposeFile StringArray

+ RunServices []string

+ Service string

+ func (d *DockerComposeProps) Equals(other *DockerComposeProps) bool

+ type DockerImageProps struct

+ AppPort AppPort

+ Build *BuildProps

+ Context string

+ Dockerfile string

+ Image string

+ RunArgs []string

+ WorkspaceFolder string

+ WorkspaceMount *Mount

+ func (d *DockerImageProps) Equals(other *DockerImageProps) bool

+ type DockerRunner struct

+ func (r *DockerRunner) Exec(containerID string, command []string) (ExecResult, error)

+ func (r *DockerRunner) Run(projectPath string, config Config) (string, error)

+ func (r *DockerRunner) Stop(containerId string) error

+ type DockerRunnerConfig struct

+ Password string

+ Username string

+ type ExecResult struct

+ ExitCode int

+ StdErr string

+ StdOut string

+ type File struct

+ Content []byte

+ Path string

+ func FindConfig(fileSystem fs.FS) (File, error)

+ func (f *File) Equals(other *File) bool

+ type GeneralProperties struct

+ CapAdd []string

+ ContainerEnv map[string]string

+ ContainerUser string

+ Customizations Customizations

+ ForwardPorts []string

+ Init bool

+ Mounts []Mount

+ Name string

+ OtherPortsAttributes PortAttributes

+ OverrideCommand bool

+ OverrideFeatureInstallOrder []string

+ PortsAttributes map[string]PortAttributes

+ Privileged bool

+ RemoteEnv map[string]string

+ RemoteUser string

+ SecurityOpt []string

+ ShutdownAction string

+ UpdateRemoteUserUID bool

+ UserEnvProbe string

+ func (g *GeneralProperties) Equals(other *GeneralProperties) bool

+ type HideCustomization struct

+ Tasks []Task

+ func (h *HideCustomization) Equals(other *HideCustomization) bool

+ type HostRequirements struct

+ Cpus int

+ Memory string

+ Storage string

+ func (h *HostRequirements) Equals(other *HostRequirements) bool

+ type LifecycleCommand map[string][]string

+ func (c *LifecycleCommand) Equals(other *LifecycleCommand) bool

+ func (c *LifecycleCommand) UnmarshalJSON(data []byte) error

+ type LifecycleProps struct

+ InitializeCommand LifecycleCommand

+ OnCreateCommand LifecycleCommand

+ PostAttachCommand LifecycleCommand

+ PostCreateCommand LifecycleCommand

+ PostStartCommand LifecycleCommand

+ UpdateContentCommand LifecycleCommand

+ WaitFor string

+ func (l *LifecycleProps) Equals(other *LifecycleProps) bool

+ type Mount struct

+ Destination string

+ Source string

+ Type string

+ func (m *Mount) UnmarshalJSON(data []byte) error

+ type PortAttributes struct

+ ElevateIfNeeded bool

+ Label string

+ OnAutoForward string

+ Protocol string

+ RequireLocalPort bool

+ func (p *PortAttributes) Equals(other *PortAttributes) bool

+ type Runner interface

+ Exec func(containerId string, command []string) (ExecResult, error)

+ Run func(projectPath string, config Config) (string, error)

+ Stop func(containerId string) error

+ func NewDockerRunner(client *client.Client, commandExecutor util.Executor, context context.Context, ...) Runner

+ type StringArray []string

+ func (c *StringArray) UnmarshalJSON(data []byte) error

+ type Task struct

+ Alias string

+ Command string