devmode

Documentation

Index

• type ComposeBuild
• type ComposeService
• type DevManager
  • func NewDevManager(cfg *config.Config, verbose bool) *DevManager
  • func (d *DevManager) Build(composePath string) error
  • func (d *DevManager) CheckDocker() error
  • func (d *DevManager) Down(composePath string) error
  • func (d *DevManager) GenerateCompose(outputPath string, envName string) error
  • func (d *DevManager) GetStatus(composePath string) (string, error)
  • func (d *DevManager) Logs(composePath string, service string, follow bool) error
  • func (d *DevManager) Up(composePath string, detach bool) error
• type DockerCompose

Types

type ComposeBuild

type ComposeBuild struct {
	Context    string   `yaml:"context"`
	Dockerfile string   `yaml:"dockerfile,omitempty"`
	Args       []string `yaml:"args,omitempty"`
}

ComposeBuild represents build configuration

type ComposeService

type ComposeService struct {
	Build       *ComposeBuild     `yaml:"build,omitempty"`
	Image       string            `yaml:"image,omitempty"`
	Container   string            `yaml:"container_name,omitempty"`
	Ports       []string          `yaml:"ports,omitempty"`
	Environment map[string]string `yaml:"environment,omitempty"`
	Volumes     []string          `yaml:"volumes,omitempty"`
	Command     string            `yaml:"command,omitempty"`
	Restart     string            `yaml:"restart,omitempty"`
	DependsOn   []string          `yaml:"depends_on,omitempty"`
}

ComposeService represents a service in docker-compose

type DevManager

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

DevManager handles local development environment

func NewDevManager

func NewDevManager(cfg *config.Config, verbose bool) *DevManager

NewDevManager creates a new development manager

func (*DevManager) Build

func (d *DevManager) Build(composePath string) error

Build builds images using docker-compose

func (*DevManager) CheckDocker

func (d *DevManager) CheckDocker() error

CheckDocker checks if Docker is installed and running

func (*DevManager) Down

func (d *DevManager) Down(composePath string) error

Down stops services using docker-compose

func (*DevManager) GenerateCompose

func (d *DevManager) GenerateCompose(outputPath string, envName string) error

GenerateCompose generates a docker-compose.yml file for local development

func (*DevManager) GetStatus

func (d *DevManager) GetStatus(composePath string) (string, error)

GetStatus gets the status of running services

func (*DevManager) Logs

func (d *DevManager) Logs(composePath string, service string, follow bool) error

Logs streams logs from services

func (*DevManager) Up

func (d *DevManager) Up(composePath string, detach bool) error

Up starts services using docker-compose

type DockerCompose

type DockerCompose struct {
	Version  string                    `yaml:"version"`
	Services map[string]ComposeService `yaml:"services"`
	Networks map[string]interface{}    `yaml:"networks,omitempty"`
	Volumes  map[string]interface{}    `yaml:"volumes,omitempty"`
}

DockerCompose represents a docker-compose.yml structure