composebuilder

Documentation

Index

• Constants
• func GetApplicationDockerConfigs(options ApplicationOptions) (types.DockerConfigs, error)
• func GetDependenciesDockerConfigs(options ApplicationOptions) (types.DockerConfigs, error)
• func GetDockerComposeProjectName(appName string) string
• func GetLocalRunComposeFileNames() []string
• func GetServiceDockerConfigs(appConfig types.AppConfig, serviceConfig types.ServiceConfig, ...) (types.DockerConfigs, error)
• func GetServicesDockerConfigs(options ApplicationOptions) (types.DockerConfigs, error)
• func GetTestDockerComposeProjectName(appName string) string
• func WriteYML(dir, filename string, dockerConfigs types.DockerConfigs) error
• type ApplicationOptions
• type BuildMode
  • func (b BuildMode) GetDockerComposeFileName() string
• type BuildModeEnvironment
• type BuildModeType
• type DevelopmentDockerComposeBuilder
  • func NewDevelopmentDockerComposeBuilder(appConfig types.AppConfig, serviceConfig types.ServiceConfig, ...) *DevelopmentDockerComposeBuilder
• type ProductionDockerComposeBuilder
  • func NewProductionDockerComposeBuilder(appConfig types.AppConfig, serviceConfig types.ServiceConfig, ...) *ProductionDockerComposeBuilder

Constants

const (
	BuildModeTypeLocal = iota
	BuildModeTypeDeploy
)

Possible values for BuildModeType

const (
	BuildModeEnvironmentTest = iota
	BuildModeEnvironmentDevelopment
	BuildModeEnvironmentProduction
)

Possible values for BuildModeEnvironment

const LocalDevelopmentComposeFileName = "run_development.yml"

LocalDevelopmentComposeFileName is the docker-compose file name for local development runs

const LocalProductionComposeFileName = "run_production.yml"

LocalProductionComposeFileName is the docker-compose file name for local production runs

const LocalTestComposeFileName = "test.yml"

LocalTestComposeFileName is the docker-compose file name for local test runs

Functions

func GetApplicationDockerConfigs

func GetApplicationDockerConfigs(options ApplicationOptions) (types.DockerConfigs, error)

GetApplicationDockerConfigs returns the docker configs for a application

func GetDependenciesDockerConfigs

func GetDependenciesDockerConfigs(options ApplicationOptions) (types.DockerConfigs, error)

GetDependenciesDockerConfigs returns the docker configs for all the application dependencies

func GetDockerComposeProjectName

func GetDockerComposeProjectName(appName string) string

GetDockerComposeProjectName creates a docker compose project name the same way docker-compose mutates the COMPOSE_PROJECT_NAME env var

func GetLocalRunComposeFileNames

func GetLocalRunComposeFileNames() []string

GetLocalRunComposeFileNames returns a list of docker-compose file names for local run processes

func GetServiceDockerConfigs

func GetServiceDockerConfigs(appConfig types.AppConfig, serviceConfig types.ServiceConfig, serviceData types.ServiceData, role string, appDir string, homeDir string, mode BuildMode) (types.DockerConfigs, error)

GetServiceDockerConfigs returns the DockerConfigs for a service and its dependencies in docker-compose.yml

func GetServicesDockerConfigs

func GetServicesDockerConfigs(options ApplicationOptions) (types.DockerConfigs, error)

GetServicesDockerConfigs returns the docker configs for all the application services

func GetTestDockerComposeProjectName

func GetTestDockerComposeProjectName(appName string) string

GetTestDockerComposeProjectName creates a docker compose project name for tests

func WriteYML

func WriteYML(dir, filename string, dockerConfigs types.DockerConfigs) error

WriteYML writes a docker-compose.yml file

Types

type ApplicationOptions

type ApplicationOptions struct {
	AppConfig types.AppConfig
	AppDir    string
	BuildMode BuildMode
	HomeDir   string
}

ApplicationOptions are the options to

type BuildMode

type BuildMode struct {
	Type        BuildModeType
	Mount       bool
	Environment BuildModeEnvironment
}

BuildMode determines what type of docker compose config should be created

func (BuildMode) GetDockerComposeFileName

func (b BuildMode) GetDockerComposeFileName() string

GetDockerComposeFileName returns the proper docker-compose file name for the build environment

type BuildModeEnvironment

type BuildModeEnvironment uint

BuildModeEnvironment indicates which environment to build the docker compose config for

type BuildModeType

type BuildModeType uint

BuildModeType indicates whether the docker compose config should be created local use or for deployment

type DevelopmentDockerComposeBuilder

type DevelopmentDockerComposeBuilder struct {
	AppConfig                types.AppConfig
	ServiceConfig            types.ServiceConfig
	ServiceData              types.ServiceData
	Mode                     BuildMode
	BuiltAppDependencies     map[string]config.AppDevelopmentDependency
	BuiltServiceDependencies map[string]config.AppDevelopmentDependency
	Role                     string
	AppDir                   string
	HomeDir                  string
}

DevelopmentDockerComposeBuilder contains the docker-compose.yml config for a single service

func NewDevelopmentDockerComposeBuilder

func NewDevelopmentDockerComposeBuilder(appConfig types.AppConfig, serviceConfig types.ServiceConfig, serviceData types.ServiceData, role, appDir, homeDir string, mode BuildMode) *DevelopmentDockerComposeBuilder

NewDevelopmentDockerComposeBuilder is DevelopmentDockerComposeBuilder's constructor

type ProductionDockerComposeBuilder

type ProductionDockerComposeBuilder struct {
	ServiceData       types.ServiceData
	BuiltDependencies map[string]config.AppProductionDependency
	Role              string
	AppDir            string
}

ProductionDockerComposeBuilder contains the docker-compose.yml config for a single service

func NewProductionDockerComposeBuilder

func NewProductionDockerComposeBuilder(appConfig types.AppConfig, serviceConfig types.ServiceConfig, serviceData types.ServiceData, role, appDir string) *ProductionDockerComposeBuilder

NewProductionDockerComposeBuilder is ProductionDockerComposeBuilder's constructor