singularity

Documentation

Index

• func CapabilityAdd(capFile string, c CapManageConfig) error
• func CapabilityAvail(c CapAvailConfig) error
• func CapabilityDrop(capFile string, c CapManageConfig) error
• func CapabilityList(capFile string, c CapListConfig) error
• func CleanCache(cacheType string) error
• func CleanCacheName(cacheName string, libraryCache, ociCache bool) (bool, error)
• func CleanSingularityCache(cleanAll bool, cacheCleanTypes []string, cacheName string) error
• func ListSingularityCache(cacheListTypes []string, listAll bool) error
• func OciAttach(containerID string) error
• func OciCreate(containerID string, args *OciArgs) error
• func OciDelete(containerID string) error
• func OciExec(containerID string, cmdArgs []string) error
• func OciKill(containerID string, killSignal string, killTimeout int) error
• func OciMount(image string, bundle string) error
• func OciPauseResume(containerID string, pause bool) error
• func OciRun(containerID string, args *OciArgs) error
• func OciStart(containerID string) error
• func OciState(containerID string, args *OciArgs) error
• func OciUmount(bundle string) error
• func OciUpdate(containerID string, args *OciArgs) error
• type CapAvailConfig
• type CapListConfig
• type CapManageConfig
• type OciArgs

Functions

func CapabilityAdd

func CapabilityAdd(capFile string, c CapManageConfig) error

CapabilityAdd adds the specified capability set to the capability file

func CapabilityAvail

func CapabilityAvail(c CapAvailConfig) error

CapabilityAvail lists the capabilities based on the CapAvailConfig

func CapabilityDrop

func CapabilityDrop(capFile string, c CapManageConfig) error

CapabilityDrop drops the specified capability set from the capability file

func CapabilityList

func CapabilityList(capFile string, c CapListConfig) error

CapabilityList lists the capabilities based on the CapListConfig

func CleanCache

func CleanCache(cacheType string) error

CleanCache : clean a type of cache (cacheType string). will return a error if one occurs.

func CleanCacheName

func CleanCacheName(cacheName string, libraryCache, ociCache bool) (bool, error)

CleanCacheName : will clean a container with the same name as cacheName (in the cache directory). if libraryCache == true; only search thrught library cache. if ociCache == true; only search the oci-tmp cache. if both are false; search all cache, and if both are true; again, search all cache.

func CleanSingularityCache

func CleanSingularityCache(cleanAll bool, cacheCleanTypes []string, cacheName string) error

CleanSingularityCache : the main function that drives all these other functions, if allClean == true; clean all cache. if typeNameClean contains somthing; only clean that type. if cacheName contains somthing; clean only cache with that name.

func ListSingularityCache

func ListSingularityCache(cacheListTypes []string, listAll bool) error

ListSingularityCache : list local singularity cache, typeNameList : is a string of what cache to list (seprate each type with a comma; like this: library,oci,blob) allList : force list all cache.

func OciAttach

func OciAttach(containerID string) error

OciAttach attaches console to a running container

func OciCreate

func OciCreate(containerID string, args *OciArgs) error

OciCreate creates a container from an OCI bundle

func OciDelete

func OciDelete(containerID string) error

OciDelete deletes container resources

func OciExec

func OciExec(containerID string, cmdArgs []string) error

OciExec executes a command in a container

func OciKill

func OciKill(containerID string, killSignal string, killTimeout int) error

OciKill kills container process

func OciMount

func OciMount(image string, bundle string) error

OciMount mount a SIF image to create an OCI bundle

func OciPauseResume

func OciPauseResume(containerID string, pause bool) error

OciPauseResume pauses/resumes processes in a container

func OciRun

func OciRun(containerID string, args *OciArgs) error

OciRun runs a container (equivalent to create/start/delete)

func OciStart

func OciStart(containerID string) error

OciStart starts a previously create container

func OciState

func OciState(containerID string, args *OciArgs) error

OciState query container state

func OciUmount

func OciUmount(bundle string) error

OciUmount umount SIF and delete OCI bundle

func OciUpdate

func OciUpdate(containerID string, args *OciArgs) error

OciUpdate updates container cgroups resources

Types

type CapAvailConfig

type CapAvailConfig struct {
	Caps string
	Desc bool
}

CapAvailConfig instructs CapabilityAvail on what capability to list/describe

type CapListConfig

type CapListConfig struct {
	User  string
	Group string
	All   bool
}

CapListConfig instructs CapabilityList on what to list

type CapManageConfig

type CapManageConfig struct {
	Caps  string
	User  string
	Group string
}

CapManageConfig specifies what capability set to edit in the capability file

type OciArgs

type OciArgs struct {
	BundlePath     string
	LogPath        string
	LogFormat      string
	SyncSocketPath string
	EmptyProcess   bool
	PidFile        string
	FromFile       string
	KillSignal     string
}

OciArgs contains CLI arguments