tools

Documentation

Index

• Constants
• func BundleUser(bundlePath, user string) (u *user.User, err error)
• func CreateLoop(file *os.File, offset, size uint64) (string, io.Closer, error)
• func CreateOverlay(bundlePath string) error
• func CreateOverlayTmpfs(bundlePath string, sizeMiB int, allowSetuid bool) (string, error)
• func DeleteBundle(bundlePath string) error
• func DeleteOverlay(bundlePath string) error
• func DeleteOverlayTmpfs(bundlePath, olDir string) error
• func GenerateBundleConfig(bundlePath string, config *specs.Spec) (*generate.Generator, error)
• func SaveBundleConfig(bundlePath string, g *generate.Generator) error
• type Config
  • func (c Config) Path() string
• type RootFs
  • func (r RootFs) Path() string
• type Volumes
  • func (v Volumes) Path() string

Constants

const RunScript = "/.singularity.d/actions/run"

RunScript is the default process argument

Functions

func BundleUser

func BundleUser(bundlePath, user string) (u *user.User, err error)

BundleUser returns a user struct for the specified user, from the bundle passwd file.

func CreateLoop

func CreateLoop(file *os.File, offset, size uint64) (string, io.Closer, error)

CreateLoop associates a file to loop device and returns path of loop device used and a closer to close the loop device

func CreateOverlay

func CreateOverlay(bundlePath string) error

CreateOverlay creates a writable overlay using a directory inside the OCI bundle.

func CreateOverlayTmpfs

func CreateOverlayTmpfs(bundlePath string, sizeMiB int, allowSetuid bool) (string, error)

CreateOverlay creates a writable overlay using tmpfs.

func DeleteBundle

func DeleteBundle(bundlePath string) error

DeleteBundle deletes bundle directory

func DeleteOverlay

func DeleteOverlay(bundlePath string) error

DeleteOverlay deletes an overlay previously created using a directory inside the OCI bundle.

func DeleteOverlayTmpfs

func DeleteOverlayTmpfs(bundlePath, olDir string) error

DeleteOverlayTmpfs deletes an overlay previously created using tmpfs.

func GenerateBundleConfig

func GenerateBundleConfig(bundlePath string, config *specs.Spec) (*generate.Generator, error)

GenerateBundleConfig generates a minimal OCI bundle directory with the provided OCI configuration or a default one if there is no configuration

func SaveBundleConfig

func SaveBundleConfig(bundlePath string, g *generate.Generator) error

SaveBundleConfig creates config.json in OCI bundle directory and saves OCI configuration

Types

type Config

type Config string

Config is the OCI configuration path

func (Config) Path

func (c Config) Path() string

Path returns the OCI configuration path

type RootFs

type RootFs string

RootFs is the default root path for OCI bundle

func (RootFs) Path

func (r RootFs) Path() string

Path returns the root path inside bundle

type Volumes

type Volumes string

Volumes is the parent volumes path

func (Volumes) Path

func (v Volumes) Path() string

Path returns the volumes path inside bundle