instance

package

v1.3.1 Latest Latest Go to latest Published: Apr 24, 2024 License: BSD-3-Clause Imports: 15 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/apptainer/apptainer

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Constants
Variables
func CheckName(name string) error
func ExtractName(name string) string
func GetDir(name string, subDir string) (string, error)
func GetLogFilePaths(name string, subDir string) (string, string, error)
func ProcName(name string, username string) (string, error)
func SetLogFile(name string, userNs bool, uid int, subDir string) (*os.File, *os.File, error)
type File
- func (i *File) Delete() error
- func (i *File) Update() error
type LogFormatter
type Logger
- func NewLogger(logPath string, formatter LogFormatter) (*Logger, error)

Constants ¶

View Source

const (
	// OciSubDir represents directory where OCI instance files are stored
	OciSubDir = "oci"
	// AppSubDir represents directory where Apptainer instance files are stored
	AppSubDir = "app"
	// LogSubDir represents directory where Apptainer instance log files are stored
	LogSubDir = "logs"
)

View Source

const (
	// BasicLogFormat represents basic log format.
	BasicLogFormat = "basic"
	// KubernetesLogFormat represents kubernetes log format.
	KubernetesLogFormat = "kubernetes"
	// JSONLogFormat represents JSON log format.
	JSONLogFormat = "json"
)

View Source

const (
	// ProgPrefix is the prefix used by an Apptainer instance process
	ProgPrefix = "Apptainer instance"
)

Variables ¶

View Source

var LogFormats = map[string]LogFormatter{
	BasicLogFormat:      basicLogFormatter,
	KubernetesLogFormat: kubernetesLogFormatter,
	JSONLogFormat:       jsonLogFormatter,
}

LogFormats contains supported log format by default.

Functions ¶

func CheckName ¶

func CheckName(name string) error

CheckName checks if name is a valid instance name

func ExtractName ¶

func ExtractName(name string) string

ExtractName extracts instance name from an instance:// URI

func GetDir ¶

func GetDir(name string, subDir string) (string, error)

GetDir returns directory where instances file will be stored

func GetLogFilePaths ¶

func GetLogFilePaths(name string, subDir string) (string, string, error)

GetLogFilePaths returns the paths of log files containing .err, .out streams, respectively

func ProcName ¶

func ProcName(name string, username string) (string, error)

ProcName returns process name based on instance name and username

func SetLogFile ¶

func SetLogFile(name string, userNs bool, uid int, subDir string) (*os.File, *os.File, error)

SetLogFile replaces stdout/stderr streams and redirect content to log file

Types ¶

type File ¶

type File struct {
	Path        string `json:"-"`
	Pid         int    `json:"pid"`
	PPid        int    `json:"ppid"`
	Name        string `json:"name"`
	User        string `json:"user"`
	Image       string `json:"image"`
	Config      []byte `json:"config"`
	UserNs      bool   `json:"userns"`
	Cgroup      bool   `json:"cgroup"`
	IP          string `json:"ip"`
	LogErrPath  string `json:"logErrPath"`
	LogOutPath  string `json:"logOutPath"`
	Checkpoint  string `json:"checkpoint"`
	ShareNSMode bool   `json:"sharensMode"`
}

File represents an instance file storing instance information

func Add ¶

func Add(name string, subDir string) (*File, error)

Add creates an instance file for a named instance in a privileged or unprivileged path

func Get ¶

func Get(name string, subDir string) (*File, error)

Get returns the instance file corresponding to instance name

func List ¶

func List(username string, name string, subDir string, all bool) ([]*File, error)

List returns instance files matching username and/or name pattern

func (*File) Delete ¶

func (i *File) Delete() error

Delete deletes instance file

func (*File) Update ¶

func (i *File) Update() error

Update stores instance information in associated instance file

type LogFormatter ¶

type LogFormatter func(stream string, data string) string

LogFormatter implements a log formatter.

type Logger ¶

type Logger struct {
	// contains filtered or unexported fields
}

Logger defines a file logger.

func NewLogger ¶

func NewLogger(logPath string, formatter LogFormatter) (*Logger, error)

NewLogger instantiates a new logger with formatter and return it.

func (*Logger) Close ¶

func (l *Logger) Close()

Close closes all pipe pairs created with NewWriter and also closes log file descriptor.

func (*Logger) NewWriter ¶

func (l *Logger) NewWriter(stream string, dropCRNL bool) (*io.PipeWriter, error)

NewWriter create a new pipe pair for corresponding stream.

func (*Logger) ReOpenFile ¶

func (l *Logger) ReOpenFile() error

ReOpenFile closes and re-open log file (eg: log rotation).

Source Files ¶

View all Source files

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