container

Documentation

Index

• func ComputeChecksum(data []byte) string
• func GetEnv(key string) string
• func Getenv(key string) string
• func ParseImageTag(imageTag string) (string, string)
• func SumChecksum(sums ...[]byte) string
• func TarDir(src fs.ReadDirFS) (*bytes.Buffer, error)
• type Build
  • func GetBuild() *Build
  • func InitRuntime() *Build
  • func NewBuild(build *Build) *Build
  • func NewGoServiceBuild(appName string) Build
  • func NewMavenServiceBuild(appName string) Build
  • func NewPythonServiceBuild(appName string) Build
  • func NewServiceBuild(appName string, buildType BuildType) Build
  • func (b *Build) AsFlags() []string
  • func (b *Build) CustomString(key string) string
  • func (b *Build) Defaults() *Build
  • func (b *Build) ImageURI() string
• type BuildType
  • func (e *BuildType) Set(v string) error
  • func (e *BuildType) String() string
  • func (e *BuildType) Type() string
• type Container
  • func New(env EnvType) *Container
  • func (c *Container) Apply(opts *types.ContainerConfig)
  • func (c *Container) BuildImage(dockerfile []byte, imageName string) error
  • func (c *Container) BuildImageByPlatform(dockerfile []byte, imageName string, platform string) error
  • func (c *Container) BuildImageByPlatforms(dockerfile []byte, dockerCtx *bytes.Buffer, imageName string, ...) ([]string, error)
  • func (c *Container) BuildIntermidiateContainer(image string, dockerFile []byte, platforms ...string) error
  • func (c *Container) BuildingContainer(opts types.ContainerConfig) error
  • func (c *Container) Commit(imageTag string, comment string, changes ...string) (string, error)
  • func (c *Container) CopyContentTo(content, dest string) error
  • func (c *Container) CopyDirectoryTo(srcPath, dstPath string) error
  • func (c *Container) CopyFileFromContainer(srcPath string) (string, error)
  • func (c *Container) CopyFileTo(srcPath, destPath string) error
  • func (c *Container) Create(opts types.ContainerConfig) error
  • func (c *Container) Exec(cmd ...string) error
  • func (c *Container) ImageExists(imageName string, platforms ...string) (bool, error)
  • func (c *Container) Inspect() (*types.ContainerConfig, error)
  • func (c *Container) InspectImage(image string) (*types.ImageInfo, error)
  • func (c *Container) Pull(imageTags ...string) error
  • func (c *Container) PullByPlatform(platform string, imageTags ...string) error
  • func (c *Container) PullDefault(imageTags ...string) error
  • func (c *Container) Push(source, target string, opts ...PushOption) error
  • func (c *Container) Ready() error
  • func (c *Container) Start() error
  • func (c *Container) Stop() error
  • func (c *Container) Tag(source, target string) error
  • func (c *Container) Wait() error
• type EnvType
  • func (e *EnvType) Set(v string) error
  • func (e *EnvType) String() string
  • func (e *EnvType) Type() string
• type PushOption

Functions

func ComputeChecksum

func ComputeChecksum(data []byte) string

TODO: provide a shorter checksum

func GetEnv

func GetEnv(key string) string

func Getenv

func Getenv(key string) string

func ParseImageTag

func ParseImageTag(imageTag string) (string, string)

func SumChecksum

func SumChecksum(sums ...[]byte) string

func TarDir

func TarDir(src fs.ReadDirFS) (*bytes.Buffer, error)

Types

type Build

type Build struct {
	App      string `json:"app"`
	Env      EnvType
	File     string
	Folder   string
	Image    string `json:"image"`
	ImageTag string `json:"image_tag"`
	Custom   map[string][]string

	BuildType BuildType `json:"build_type"`
	// docker or podman
	Runtime utils.RuntimeType

	Organization       string
	Platform           types.Platform
	Registry           string
	ContainifyRegistry string
	Repository         string
	SourcePackages     []string
	SourceFiles        []string
	Verbose            bool
	Registries         map[string]*protos2.ContainerRegistry
	// contains filtered or unexported fields
}

TODO: add target container platform

func GetBuild

func GetBuild() *Build

func InitRuntime

func InitRuntime() *Build

func NewBuild

func NewBuild(build *Build) *Build

func NewGoServiceBuild

func NewGoServiceBuild(appName string) Build

func NewMavenServiceBuild

func NewMavenServiceBuild(appName string) Build

func NewPythonServiceBuild

func NewPythonServiceBuild(appName string) Build

func NewServiceBuild

func NewServiceBuild(appName string, buildType BuildType) Build

func (*Build) AsFlags

func (b *Build) AsFlags() []string

func (*Build) CustomString

func (b *Build) CustomString(key string) string

func (*Build) Defaults

func (b *Build) Defaults() *Build

func (*Build) ImageURI

func (b *Build) ImageURI() string

type BuildType

type BuildType string

const (
	GoLang  BuildType = "GoLang"
	Maven   BuildType = "Maven"
	Python  BuildType = "Python"
	Generic BuildType = "Generic"
)

func (*BuildType) Set

func (e *BuildType) Set(v string) error

Set must have pointer receiver so it doesn't change the value of a copy

func (*BuildType) String

func (e *BuildType) String() string

String is used both by fmt.Print and by Cobra in help text

func (*BuildType) Type

func (e *BuildType) Type() string

Type is only used in help text

type Container

type Container struct {
	// private fields
	ID      string
	Name    string
	Image   string
	Env     EnvType
	Verbose bool

	Source fs.ReadDirFS

	Opts types.ContainerConfig
	// contains filtered or unexported fields
}

func New

func New(env EnvType) *Container

func (*Container) Apply

func (c *Container) Apply(opts *types.ContainerConfig)

func (*Container) BuildImage

func (c *Container) BuildImage(dockerfile []byte, imageName string) error

func (*Container) BuildImageByPlatform

func (c *Container) BuildImageByPlatform(dockerfile []byte, imageName string, platform string) error

func (*Container) BuildImageByPlatforms

func (c *Container) BuildImageByPlatforms(dockerfile []byte, dockerCtx *bytes.Buffer, imageName string, platforms []string) ([]string, error)

func (*Container) BuildIntermidiateContainer

func (c *Container) BuildIntermidiateContainer(image string, dockerFile []byte, platforms ...string) error

func (*Container) BuildingContainer

func (c *Container) BuildingContainer(opts types.ContainerConfig) error

func (*Container) Commit

func (c *Container) Commit(imageTag string, comment string, changes ...string) (string, error)

func (*Container) CopyContentTo

func (c *Container) CopyContentTo(content, dest string) error

func (*Container) CopyDirectoryTo

func (c *Container) CopyDirectoryTo(srcPath, dstPath string) error

TODO: ignore hidden folder and files maybe support .dockerignore file or more .dockerinclude file to include folder and files that are ignored by default

func (*Container) CopyFileFromContainer

func (c *Container) CopyFileFromContainer(srcPath string) (string, error)

CopyFileFromContainer reads a single file from a container and returns its content as a string.

func (*Container) CopyFileTo

func (c *Container) CopyFileTo(srcPath, destPath string) error

func (*Container) Create

func (c *Container) Create(opts types.ContainerConfig) error

func (*Container) Exec

func (c *Container) Exec(cmd ...string) error

func (*Container) ImageExists

func (c *Container) ImageExists(imageName string, platforms ...string) (bool, error)

imageExists checks if the image with the specified tag exists.

func (*Container) Inspect

func (c *Container) Inspect() (*types.ContainerConfig, error)

func (*Container) InspectImage

func (c *Container) InspectImage(image string) (*types.ImageInfo, error)

func (*Container) Pull

func (c *Container) Pull(imageTags ...string) error

func (*Container) PullByPlatform

func (c *Container) PullByPlatform(platform string, imageTags ...string) error

func (*Container) PullDefault

func (c *Container) PullDefault(imageTags ...string) error

func (*Container) Push

func (c *Container) Push(source, target string, opts ...PushOption) error

TODO: find a better way to provide optional parameters like PushOption

func (*Container) Ready

func (c *Container) Ready() error

func (*Container) Start

func (c *Container) Start() error

func (*Container) Stop

func (c *Container) Stop() error

func (*Container) Tag

func (c *Container) Tag(source, target string) error

func (*Container) Wait

func (c *Container) Wait() error

type EnvType

type EnvType string

const (
	LocalEnv EnvType = "local"
	BuildEnv EnvType = "build"
	ProdEnv  EnvType = "production"
)

func (*EnvType) Set

func (e *EnvType) Set(v string) error

Set must have pointer receiver so it doesn't change the value of a copy

func (*EnvType) String

func (e *EnvType) String() string

String is used both by fmt.Print and by Cobra in help text

func (*EnvType) Type

func (e *EnvType) Type() string

Type is only used in help text

type PushOption

type PushOption struct {
	Remove bool
}