internal

Documentation

Index

• Constants
• Variables
• func AppNameFromDir(dirName string) string
• func DirNameFromAppName(appName string) string
• func FullVersion() string
• func ValidateAppName(appName string) error

Constants

const (
	// AppExtension is the extension used by an application.
	AppExtension = ".dockerapp"
	// ImageLabel is the label used to distinguish applications from Docker images.
	ImageLabel = "com.docker.application"
	// MetadataFileName is metadata file name
	MetadataFileName = "metadata.yml"
	// ComposeFileName is compose file name
	ComposeFileName = "docker-compose.yml"
	// SettingsFileName is settings file name
	SettingsFileName = "settings.yml"
)

Variables

var (
	// Experimental enables experimental features if set to "on"
	Experimental = "on"
	// MetadataVersion defines the current schema version
	MetadataVersion = "v0.1"
)

var (
	// Version is the git tag that this was built from.
	Version = "unknown"
	// GitCommit is the commit that this was built from.
	GitCommit = "unknown"
	// BuildTime is the time at which the binary was built.
	BuildTime = "unknown"
)

var (
	// FileNames lists the application file names, in order.
	FileNames = []string{MetadataFileName, ComposeFileName, SettingsFileName}
)

Functions

func AppNameFromDir

func AppNameFromDir(dirName string) string

AppNameFromDir takes a path to an app directory and returns the application's name

func DirNameFromAppName

func DirNameFromAppName(appName string) string

DirNameFromAppName takes an application name and returns the corresponding directory name

func FullVersion

func FullVersion() string

FullVersion returns a string of version information.

func ValidateAppName

func ValidateAppName(appName string) error

ValidateAppName takes an app name and returns an error if it doesn't match the expected format