Documentation
¶
Index ¶
- Constants
- Variables
- func GetDBAImage() string
- func GetDBImage(dbType string, dbVersion ...string) string
- func GetDockerComposeVersion() (string, error)
- func GetDockerVersion() (string, error)
- func GetLiveDockerComposeVersion() (string, error)
- func GetLiveMutagenVersion() (string, error)
- func GetRequiredDockerComposeVersion() string
- func GetRouterImage() string
- func GetSSHAuthImage() string
- func GetVersionInfo() map[string]string
- func GetWebImage() string
Constants ¶
const RequiredMutagenVersion = "0.12.0"
Variables ¶
var BUILDINFO = "BUILDINFO should have new info"
BUILDINFO is information with date and context, supplied by make
var BaseDBTag = "v1.18.2"
BaseDBTag is the main tag, DBTag is constructed from it
var BusyboxImage = "busybox:stable"
Busybox is used a couple of places for a quick-pull
var DBAImg = "phpmyadmin"
DBAImg defines the default phpmyadmin image tag used for applications.
var DBATag = "5" // Note that this can be overridden by make
DBATag defines the default phpmyadmin image tag used for applications.
var DBImg = "drud/ddev-dbserver"
DBImg defines the default db image used for applications.
var DdevVersion = "v0.0.0-overridden-by-make" // Note that this is overridden by make
DdevVersion is the current version of ddev, by default the git committish (should be current git tag)
var DockerComposeFileFormatVersion = "3.6"
DockerComposeFileFormatVersion is the compose version to be used
var DockerComposeVersion = ""
DockerComposeVersion is filled with the version we find for docker-compose
var DockerComposeVersionConstraint = ">= 1.25.0-alpha1 < 2.0.0-alpha1 || >= v2.0.0-rc.2"
DockerComposeVersionConstraint is the versions allowed for ddev REMEMBER TO CHANGE docs/index.md if you touch this! The constraint MUST HAVE a -pre of some kind on it for successful comparison. See https://github.com/drud/ddev/pull/738.. and regression https://github.com/drud/ddev/issues/1431
var DockerVersion = ""
DockerVersion is cached version of docker
var DockerVersionConstraint = ">= 18.06.1-alpha1"
DockerVersionConstraint is the current minimum version of docker required for ddev. See https://godoc.org/github.com/Masterminds/semver#hdr-Checking_Version_Constraints for examples defining version constraints. REMEMBER TO CHANGE docs/index.md if you touch this! The constraint MUST HAVE a -pre of some kind on it for successful comparison. See https://github.com/drud/ddev/pull/738.. and regression https://github.com/drud/ddev/issues/1431
var MutagenVersion = ""
MutagenVersion is filled with the version we find for mutagen in use
var RequiredDockerComposeVersion = "v2.2.2"
This is var instead of const so it can be changed in test, but should not otherwise be touched. Otherwise we can't test if the version on the machine is equal to version required
var RouterImage = "drud/ddev-router"
RouterImage defines the image used for the router.
var RouterTag = "v1.18.2" // Note that this can be overridden by make
RouterTag defines the tag used for the router.
var SSHAuthImage = "drud/ddev-ssh-agent"
SSHAuthImage is image for agent
var SSHAuthTag = "v1.18.0"
SSHAuthTag is ssh-agent auth tag
var SegmentKey = ""
SegmentKey is the ddev-specific key for Segment service Compiled with link-time variables
var WebImg = "drud/ddev-webserver"
WebImg defines the default web image used for applications.
var WebTag = "v1.18.2" // Note that this can be overridden by make
WebTag defines the default web image tag
Functions ¶
func GetDBAImage ¶ added in v1.4.0
func GetDBAImage() string
GetDBAImage returns the correctly formatted dba image:tag reference
func GetDBImage ¶ added in v1.4.0
GetDBImage returns the correctly formatted db image:tag reference
func GetDockerComposeVersion ¶ added in v1.5.0
GetDockerComposeVersion runs docker-compose -v to get the current version
func GetDockerVersion ¶ added in v1.5.0
GetDockerVersion gets the cached or api-sourced version of docker engine
func GetLiveDockerComposeVersion ¶ added in v1.18.2
GetLiveDockerComposeVersion runs `docker-compose --version` and caches result
func GetLiveMutagenVersion ¶ added in v1.18.0
GetLiveMutagenVersion runs `mutagen version` and caches result
func GetRequiredDockerComposeVersion ¶ added in v1.18.2
func GetRequiredDockerComposeVersion() string
GetRequiredDockerComposeVersion returns the version of docker-compose we need based on the compiled version, or overrides in globalconfig, like required_docker_compose_version and use_docker_compose_from_path In the case of UseDockerComposeFromPath there is no required version, so this will return empty string.
func GetRouterImage ¶ added in v1.10.3
func GetRouterImage() string
GetRouterImage returns the correctly formatted router image:tag reference
func GetSSHAuthImage ¶ added in v1.10.3
func GetSSHAuthImage() string
GetSSHAuthImage returns the correctly formatted sshauth image:tag reference
func GetVersionInfo ¶ added in v0.12.0
GetVersionInfo returns a map containing the version info defined above.
func GetWebImage ¶ added in v1.4.0
func GetWebImage() string
GetWebImage returns the correctly formatted web image:tag reference
Types ¶
This section is empty.