convert

README

umoci/oci/config/convert

One fairly important aspect of creating a runtime bundle is the configuration of the container. While an image configuration and runtime configuration are defined on different levels (images are far more platform agnostic than runtime bundles), conversion from an image to a runtime configuration is defined as part of the OCI specification (thanks to this reference implementation).

This package implements a fairly unopinionated implementation of that conversion, allowing consumers to easily add their own extensions in the runtime configuration generation.

Documentation

Index

• func Example() rspec.Spec
• func MutateRuntimeSpec(spec *rspec.Spec, rootfs string, image ispec.Image) error
• func ToRootless(spec *rspec.Spec) error
• func ToRuntimeSpec(rootfs string, image ispec.Image) (rspec.Spec, error)

Functions

func Example

func Example() rspec.Spec

Example returns an example spec file, used as a "good sane default". XXX: Really we should just use runc's directly.

func MutateRuntimeSpec

func MutateRuntimeSpec(spec *rspec.Spec, rootfs string, image ispec.Image) error

MutateRuntimeSpec mutates a given runtime configuration with the image configuration provided.

func ToRootless

func ToRootless(spec *rspec.Spec) error

ToRootless converts a specification to a version that works with rootless containers. This is done by removing options and other settings that clash with unprivileged user namespaces.

func ToRuntimeSpec

func ToRuntimeSpec(rootfs string, image ispec.Image) (rspec.Spec, error)

ToRuntimeSpec converts the given OCI image configuration to a runtime configuration appropriate for use, which is templated on the default configuration specified by the OCI runtime-tools. It is equivalent to MutateRuntimeSpec("runtime-tools/generate".New(), image).Spec().