docker

Documentation

Overview

Package docker contains docker images and metadata for the suite of scribe docker images and utilities

Index

• Variables
• func BuildSteps(sw *scribe.Scribe, images []Image) []pipeline.Step
• func Login(username, password pipeline.Argument) pipeline.Step
• func PushSteps(sw *scribe.Scribe, images []Image) []pipeline.Step
• type Image
  • func (i Image) BuildStep(sw *scribe.Scribe) pipeline.Step
  • func (i Image) PushStep(sw *scribe.Scribe) pipeline.Step
  • func (i Image) Tag() (string, error)
• type ImageData

Variables

var (
	ArgumentDockerAuthToken = pipeline.NewStringArgument("docker-auth-token")
)

var Dockerfiles embed.FS

var Images = []Image{
	{
		Name:       "git",
		Dockerfile: "./ci/docker/scribe.git.Dockerfile",
		Context:    ".",
	},
	{
		Name:       "go",
		Dockerfile: "./ci/docker/scribe.go.Dockerfile",
		Context:    ".",
	},
	{
		Name:       "node",
		Dockerfile: "./ci/docker/scribe.node.Dockerfile",
		Context:    ".",
	},
	{
		Name:       "docker",
		Dockerfile: "./ci/docker/scribe.docker.Dockerfile",
		Context:    ".",
	},
}

Images is a list of images derived from the ScribeImage

var ScribeImage = Image{
	Name:       "scribe",
	Dockerfile: "./ci/docker/scribe.Dockerfile",
	Context:    ".",
}

ScribeImage has to be built before its derivitive images.

Functions

func BuildSteps

func BuildSteps(sw *scribe.Scribe, images []Image) []pipeline.Step

func Login

func Login(username, password pipeline.Argument) pipeline.Step

func PushSteps

func PushSteps(sw *scribe.Scribe, images []Image) []pipeline.Step

Types

type Image

type Image struct {
	Name       string
	Dockerfile string
	Context    string
}

func (Image) BuildStep

func (i Image) BuildStep(sw *scribe.Scribe) pipeline.Step

func (Image) PushStep

func (i Image) PushStep(sw *scribe.Scribe) pipeline.Step

func (Image) Tag

func (i Image) Tag() (string, error)

type ImageData

type ImageData struct {
	Version string
}