docker

Documentation

Index

• Constants
• func Image(thread *starlark.Thread, _ *starlark.Builtin, args starlark.Tuple, ...) (starlark.Value, error)
• func LoadModule() (starlark.StringDict, error)

Constants

const (
	// ModuleName defines the expected name for this Module when used
	// in starlark's load() function, eg: load('docker', 'docker')
	ModuleName = "docker"
)

Functions

func Image

func Image(
	thread *starlark.Thread, _ *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple,
) (starlark.Value, error)

Image returns a starlak.Builtin function capable of instantiate new Image instances.

outline: docker
  functions:
    image(image, constraint) Image
      Returns a new `Image` based on a given image and constraint.

      params:
        image string
          Container image name. Eg.: `ubuntu` or `quay.io/prometheus/prometheus`.
        constraint string
          [Semver](https://github.com/Masterminds/semver/#checking-version-constraints) contraint. Eg.: `1.2.*`

func LoadModule

func LoadModule() (starlark.StringDict, error)

LoadModule loads the os module. It is concurrency-safe and idempotent.

outline: docker
  The docker modules allow you to manipulate docker image names.
  path: docker