nix2container

package

v0.2.0 Latest Latest Go to latest Published: Feb 18, 2024 License: MIT Imports: 35 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/pdtpartners/nix-snapshotter

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Build(ctx context.Context, configPath, closurePath, copyToRootPath string, ...) (*types.Image, error)
func Export(ctx context.Context, store content.Store, image *types.Image, ref string, ...) error
func Generate(ctx context.Context, image *types.Image, store content.Store) (desc ocispec.Descriptor, err error)
func Load(ctx context.Context, client *containerd.Client, store content.Store, ...) (containerd.Image, error)
func Push(ctx context.Context, store content.Store, archivePath, ref string, ...) error
func TempDir() string
type BuildOpt
- func WithFromImage(fromImage string) BuildOpt
type BuildOpts
type PushConfig
type PushOpt
- func WithPlainHTTP() PushOpt

Constants ¶

View Source

const (
	// NixLayerAnnotation is a remote snapshot OCI annotation to indicate that
	// it will also contain annotations with NixStorePrefixAnnotation.
	NixLayerAnnotation = "containerd.io/snapshot/nix-layer"

	// NixStorePrefixAnnotation is a prefix for remote snapshot OCI annotations
	// for each nix store path that the layer will need.
	NixStorePrefixAnnotation = "containerd.io/snapshot/nix-store-path."
)

Variables ¶

View Source

var (
	// ImageRefPrefix is part of the canonical image reference for images built
	// for nix-snapshotter in the format "nix:0/nix/store/*.tar".
	//
	// Leading slash is not allowed for image references, so we needed a distinct
	// prefix for nix-snapshotter to distinguish regular references from nix
	// references. If nix-snapshotter is configured as the CRI image service,
	// it will be able to resolve the image manifest with nix rather than a
	// Docker Registry.
	ImageRefPrefix = "nix:0"
)

Functions ¶

func Build ¶

func Build(ctx context.Context, configPath, closurePath, copyToRootPath string, opts ...BuildOpt) (*types.Image, error)

Build builds an image specification.

func Export ¶

func Export(ctx context.Context, store content.Store, image *types.Image, ref string, w io.Writer) error

Export writes an OCI archive to the writer using the provided nix image spec.

func Generate ¶

func Generate(ctx context.Context, image *types.Image, store content.Store) (desc ocispec.Descriptor, err error)

Generate adds a nix-snapshotter container image to store and returns its descriptor.

func Load ¶

func Load(ctx context.Context, client *containerd.Client, store content.Store, archivePath string) (containerd.Image, error)

func Push ¶

func Push(ctx context.Context, store content.Store, archivePath, ref string, opts ...PushOpt) error

Push generates a nix-snapshotter image and pushes it to a remote.

func TempDir ¶

func TempDir() string

TempDir returns the location of a temporary dir or XDG_RUNTIME_DIR if it is defined.

Types ¶

type BuildOpt ¶

type BuildOpt func(*BuildOpts)

BuildOpt applies changes to BuildOptions

func WithFromImage ¶

func WithFromImage(fromImage string) BuildOpt

WithFromImage specifies a base image to build the image from.

type BuildOpts ¶

type BuildOpts struct {
	FromImage string
}

BuildOpts contains options concerning how nix images are built.

type PushConfig ¶

type PushConfig struct {
	PlainHTTP bool
}

type PushOpt ¶

type PushOpt func(*PushConfig)

func WithPlainHTTP ¶

func WithPlainHTTP() PushOpt

Source Files ¶

View all Source files

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