compose

README

docker-compose - Go Package

A Go package that allows you to create and manage Docker Compose configurations programmatically.

Installation

go get github.com/cdvelop/compose

Basic Usage in docker-compose_test.go

Main Features

• Programmatic creation of docker-compose.yml files
• Support for defining services, networks and volumes
• Automatic configuration validation
• Dynamic configuration generation
• Integration with other Go tools

License

This project is licensed under the MIT License - see the LICENSE file for more details.

Documentation

Index

• func NewCompose(version string, services ...Service) (*composeConfig, error)
• type HealthCheck
• type Network
• type Service
  • func NewService(name string) *Service
  • func (s *Service) AddEnvironment(key, value string) *Service
  • func (s *Service) AddPort(host, container string) *Service
  • func (s *Service) AddVolume(volume Volume) *Service
  • func (s *Service) DependsOn(services ...Service) *Service
  • func (s *Service) SetContainerName(name string) *Service
  • func (s *Service) SetHealthCheck(test []string, interval, timeout string, retries int) *Service
  • func (s *Service) SetImage(image string) *Service
  • func (s *Service) SetRestartPolicy(policy string) *Service
• type Volume

Functions

func NewCompose

func NewCompose(version string, services ...Service) (*composeConfig, error)

NewCompose crea una nueva configuración de docker-compose

Types

type HealthCheck

type HealthCheck struct {
	Test     []string
	Interval string
	Timeout  string
	Retries  int
}

HealthCheck representa la configuración de healthcheck

type Network

type Network struct {
	Name    string            `yaml:"-"`
	Driver  string            `yaml:"driver,omitempty"`
	Options map[string]string `yaml:"options,omitempty"`
}

Network representa una red en docker-compose

type Service

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

Service representa un servicio en docker-compose

func NewService

func NewService(name string) *Service

NewService crea una nueva configuración de servicio

func (*Service) AddEnvironment

func (s *Service) AddEnvironment(key, value string) *Service

AddEnvironment añade una variable de entorno al servicio

func (*Service) AddPort

func (s *Service) AddPort(host, container string) *Service

AddPort añade un mapeo de puertos al servicio

func (*Service) AddVolume

func (s *Service) AddVolume(volume Volume) *Service

AddVolume añade un volumen al servicio

func (*Service) DependsOn

func (s *Service) DependsOn(services ...Service) *Service

DependsOn establece las dependencias del servicio

func (*Service) SetContainerName

func (s *Service) SetContainerName(name string) *Service

SetContainerName establece el nombre del contenedor

func (*Service) SetHealthCheck

func (s *Service) SetHealthCheck(test []string, interval, timeout string, retries int) *Service

SetHealthCheck configura el healthcheck del servicio

func (*Service) SetImage

func (s *Service) SetImage(image string) *Service

SetImage establece la imagen del servicio

func (*Service) SetRestartPolicy

func (s *Service) SetRestartPolicy(policy string) *Service

SetRestartPolicy establece la política de reinicio del servicio

type Volume

type Volume struct {
	Source string `yaml:"-"`
	Target string `yaml:"-"`
}

Volume representa un volumen en docker-compose