Documentation
¶
Index ¶
- func GetApplicationDockerCompose(options ApplicationOptions) (*types.DockerCompose, error)
- func GetDockerComposeProjectName(appName string) string
- func GetServiceDockerCompose(appContext *context.AppContext, role string, mode types.BuildMode, ...) (*types.DockerCompose, error)
- func GetTestDockerComposeProjectName(appName string) string
- func WriteYML(dir, filename string, file *types.DockerCompose) error
- type ApplicationOptions
- type ServiceComposeBuilder
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetApplicationDockerCompose ¶ added in v0.32.0
func GetApplicationDockerCompose(options ApplicationOptions) (*types.DockerCompose, error)
GetApplicationDockerCompose returns the docker compose for a application
func GetDockerComposeProjectName ¶
GetDockerComposeProjectName creates a docker compose project name the same way docker-compose mutates the COMPOSE_PROJECT_NAME env var
func GetServiceDockerCompose ¶ added in v0.32.0
func GetServiceDockerCompose(appContext *context.AppContext, role string, mode types.BuildMode, serviceEndpoints map[string]*types.ServiceEndpoints) (*types.DockerCompose, error)
GetServiceDockerCompose returns the DockerConfigs for a service and its dependencies in docker-compose.yml
func GetTestDockerComposeProjectName ¶ added in v0.29.0
GetTestDockerComposeProjectName creates a docker compose project name for tests
Types ¶
type ApplicationOptions ¶ added in v0.28.4
type ApplicationOptions struct {
AppContext *context.AppContext
BuildMode types.BuildMode
}
ApplicationOptions are the options to
type ServiceComposeBuilder ¶ added in v0.32.0
type ServiceComposeBuilder struct {
AppConfig types.AppConfig
ServiceConfig types.ServiceConfig
Mode types.BuildMode
ServiceSource types.ServiceSource
BuiltAppDependencies map[string]config.LocalAppDependency
BuiltServiceDependencies map[string]config.LocalAppDependency
Role string
AppDir string
ServiceEndpoints map[string]*types.ServiceEndpoints
}
ServiceComposeBuilder contains the docker-compose.yml config for a single service
func NewServiceComposeBuilder ¶ added in v0.32.0
func NewServiceComposeBuilder(appContext *context.AppContext, role string, mode types.BuildMode, serviceEndpoints map[string]*types.ServiceEndpoints) *ServiceComposeBuilder
NewServiceComposeBuilder is ServiceComposeBuilder's constructor
Source Files
Click to show internal directories.
Click to hide internal directories.