docker

package

v1.5.8 Latest Latest Go to latest Published: Apr 15, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/elisasre/mageutil

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Build(ctx context.Context, platform, dockerfile, buildCtx string, tags []string, ...) error
func BuildDefault(ctx context.Context, imageName, url string) error
func BuildDefaultWithDockerfile(ctx context.Context, imageName, url string, dockerfile string) error
func DefaultLabels(imageName, url, desc string) map[string]string
func Docker(ctx context.Context, args ...string) error
func PushAllTags(ctx context.Context, imageName string) error
func Run(ctx context.Context, args ...string) error
func Tags(imageName string, tags ...string) []string

Constants ¶

View Source

const (
	OCILabelTitle       = "org.opencontainers.image.title"
	OCILabelURL         = "org.opencontainers.image.url"
	OCILabelVersion     = "org.opencontainers.image.version"
	OCILabelDescription = "org.opencontainers.image.description"
	OCILabelCreated     = "org.opencontainers.image.created"
	OCILabelSource      = "org.opencontainers.image.source"
	OCILabelLicenses    = "org.opencontainers.image.licenses"
	OCILabelAuthors     = "org.opencontainers.image.authors"
	OCILabelVendor      = "org.opencontainers.image.vendor"
	OCILabelRevision    = "org.opencontainers.image.revision"
)

View Source

const (
	DefaultPlatform   = "linux/amd64"
	DefaultDockerfile = "Dockerfile"
	DefaultBuildCtx   = "."
	DefaultExtraCtx   = "./target/bin/linux/amd64/"
)

Variables ¶

This section is empty.

Functions ¶

func Build ¶

func Build(ctx context.Context, platform, dockerfile, buildCtx string, tags []string, extraCtx, labels map[string]string) error

Build is a short hand for docker buildx build with sane default flags.

func BuildDefault ¶

func BuildDefault(ctx context.Context, imageName, url string) error

BuildDefault builds image with sane defaults.

func BuildDefaultWithDockerfile ¶ added in v1.5.7

func BuildDefaultWithDockerfile(ctx context.Context, imageName, url string, dockerfile string) error

BuildDefaultWithDockerfile builds image from custom Dockerfile location

func DefaultLabels ¶

func DefaultLabels(imageName, url, desc string) map[string]string

DefaultLabels provides labels for Elisa SoSe/SRE organization.

func Docker ¶

func Docker(ctx context.Context, args ...string) error

Docker executes systems docker cmd with given args.

func PushAllTags ¶

func PushAllTags(ctx context.Context, imageName string) error

PushAllTags pushes all tags for given image.

func Run ¶

func Run(ctx context.Context, args ...string) error

Run executes docker run cmd with given args.

func Tags ¶

func Tags(imageName string, tags ...string) []string

Tags creates slice of tags using `tags` variable and DOCKER_IMAGE_TAGS env variable.

Types ¶

This section is empty.

Source Files ¶

View all Source files

docker.go

Directories ¶

Path	Synopsis
target Package target exposes docker targets that can be imported in magefile using [import syntax].	Package target exposes docker targets that can be imported in magefile using [import syntax].

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL