apps

Documentation

Overview

Package apps [apps-plugin] provides the functions which are necessary for adding SCI-F apps support to Singularity 3.0.0. In 3.1.0+, this package will be able to be built standalone as a plugin so it will be maintainable separately from the core Apptainer functionality

Index

• type App
• type BuildApp
  • func New() *BuildApp
  • func (pl *BuildApp) HandleBundle(b *types.Bundle)
  • func (pl *BuildApp) HandlePost(b *types.Bundle) (string, error)
  • func (pl *BuildApp) HandleSection(ident, section string)
  • func (pl *BuildApp) Name() string

Types

type App

type App struct {
	Name    string
	Install string
	Files   string
	Env     string
	Test    string
	Help    string
	Run     string
	Labels  string
}

App stores the deffile sections of the app

type BuildApp

type BuildApp struct {
	Apps map[string]*App `json:"appsDefined"`
	sync.Mutex
}

BuildApp is the type which the build system can use to build an app in a bundle

func New

func New() *BuildApp

New returns a new BuildPlugin for the plugin registry to hold

func (*BuildApp) HandleBundle

func (pl *BuildApp) HandleBundle(b *types.Bundle)

HandleBundle is a hook where we can modify the bundle

func (*BuildApp) HandlePost

func (pl *BuildApp) HandlePost(b *types.Bundle) (string, error)

HandlePost returns a script that should run after %post

func (*BuildApp) HandleSection

func (pl *BuildApp) HandleSection(ident, section string)

HandleSection receives a string of each section from the deffile

func (*BuildApp) Name

func (pl *BuildApp) Name() string

Name returns this handler's name [apptainer_apps]