constants

Documentation

Index

• Constants

Constants

const (
	// ObfuscationString is the string is used to hide sensitive data such as token in logs
	ObfuscationString = "*************"

	// TimestampFormat is the common timestamp format ACR Builder uses
	TimestampFormat = time.RFC3339

	// SourceNameWebArchive is the name of the web archive source
	SourceNameWebArchive = "web archive"

	// SourceNameGit is the name of the git source
	SourceNameGit = "git repository"

	// SourceNameLocal is the name of local source
	SourceNameLocal = "local directory"

	// DependencyTypeBuild denotes build time dependency
	DependencyTypeBuild = "build"

	// DependencyTypeRuntime denotes runtime dependency
	DependencyTypeRuntime = "runtime"

	// FromStdin denotes when context or dockerfile is to be read from stdin
	FromStdin = "-"

	// NoBaseImageSpecifierLatest is the empty base image
	// Note that :latest is not valid in the FROM clause, but we're
	// always appending :latest to tags during processing.
	NoBaseImageSpecifierLatest = "scratch:latest"
)

const (

	// ExportsDockerfilePath is the variable name for docker file path
	ExportsDockerfilePath = dockerDomainPrefix + "FILE"

	// ExportsDockerBuildContext is the docker build context directory
	ExportsDockerBuildContext = dockerDomainPrefix + "CONTEXT"

	// ExportsDockerRegistry is the docker registry to push to
	ExportsDockerRegistry = dockerDomainPrefix + "REGISTRY"

	// ExportsPushOnSuccess is the boolean value denoting whether the build will push on success
	ExportsPushOnSuccess = acrBuildPrefix + "PUSH_ON_SUCCESS"

	// ExportsBuildTimestamp is the timestamp when the build started in ISO format
	ExportsBuildTimestamp = acrBuildPrefix + "TIMESTAMP"
)

const (

	//ArgNameDockerContextString is the parameter name docker build context, it could be local path, git, or archive url
	ArgNameDockerContextString = "c"

	// ArgNameDockerfile is the parameter name for dockerfile
	ArgNameDockerfile = "f"

	// ArgNameDockerImage is the parameter name for docker image (registry url must be excluded from the image name parameter)
	ArgNameDockerImage = "t"

	// ArgNameDockerRegistry is the parameter name for docker registry to push to
	ArgNameDockerRegistry = "docker-registry"

	// ArgNameDockerUser is the parameter name for docker username used for pushing
	ArgNameDockerUser = "docker-user"

	// ArgNameDockerPW is the parameter name for docker password used for pushing
	ArgNameDockerPW = "docker-password"

	// ArgNameDockerBuildArg is the parameter name for build args passed in to docker. This parameter is repeatable.
	ArgNameDockerBuildArg = "docker-build-arg"

	// ArgNameDockerSecretBuildArg is the parameter name for build args passed in to docker. The argument value contains a secret which will be hidden from the log. This parameter is repeatable.
	ArgNameDockerSecretBuildArg = "docker-secret-build-arg"

	// ArgNameBuildEnv is the parameter name for build environment variables to be set. This parameter is repeatable
	ArgNameBuildEnv = "build-env"

	// ArgNamePull is the parameter determining if attempting to pull a newer version of the base images. Default: false
	ArgNamePull = "pull"

	// ArgNameIsolation is the parameter name for specifying isolation technology for container. This option is useful for running docker containers in Windows.Supported values are default, process and hyperv
	ArgNameIsolation = "isolation"

	// ArgNameNoCache is the parameter determining if not using any cached layer when building the image. Default: false
	ArgNameNoCache = "no-cache"

	// ArgNamePush is the parameter determining whether or not push should occur if the build would succeed. Default: false
	ArgNamePush = "push"

	// ArgNameDebug is the parameter that enables debug logs
	ArgNameDebug = "verbose"
)

const (
	// GeneralErrorExitCode is a catchall for general errors.
	GeneralErrorExitCode = 1
)