kontext

Documentation

Overview

Package kontext is a set of utilities for bundling up a local directory context within CLIs into a self-extracting container image that when run will expand its payload into the working directory. It is based on github.com/mattmoor/kontext.

Index

• Constants
• Variables
• func Bundle(ctx context.Context, directory string, tag name.Tag) (name.Digest, error)
• func Expand(ctx context.Context) error

Constants

const (
	// StoragePath is where in the container image the files are placed.
	StoragePath = "/var/run/kontext"
)

Variables

var (
	// BaseImageString holds a reference to a built image of ./cmd/kontext-expander
	// See ./hack/build-flags.sh for how this is replaced at link-time.
	BaseImageString = "docker.io/mattmoor/kontext-expander:latest"
	// BaseImage is where we publish ./cmd/kontext-expander
	BaseImage, _ = name.ParseReference(BaseImageString)
)

Functions

func Bundle

func Bundle(ctx context.Context, directory string, tag name.Tag) (name.Digest, error)

Bundle packages up the given directory as a self-extracting container image based on BaseImage and publishes it to tag.

func Expand

func Expand(ctx context.Context) error

Expand recursively copies the current working directory into StoragePath.