env

Documentation

Index

• Constants
• Variables
• func GetenvLegacy(key, legacyKey string) string
• func SetContainerEnv(g *generate.Generator, hostEnvs []string, cleanEnv bool, homeDest string) map[string]string
• func SetFromList(environ []string) error
• func TrimApptainerKey(key string) string

Constants

const (
	// DefaultPath defines default value for PATH environment variable.
	DefaultPath = "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"

	// ApptainerPrefix Apptainer environment variable recognized prefixes for Apptainer CLI
	ApptainerPrefix = "APPTAINER_"

	// ApptainerEnvPrefix Apptainer environment variables recognized prefixes for passthru to container
	ApptainerEnvPrefix = "APPTAINERENV_"

	// Legacy singularity prefix
	LegacySingularityPrefix = "SINGULARITY_"

	// Legacy singularity env prefix
	LegacySingularityEnvPrefix = "SINGULARITYENV_"
)

Variables

var ApptainerEnvPrefixes = []string{ApptainerEnvPrefix, LegacySingularityEnvPrefix}

ApptainerEnvPrefixes defines the environment variable prefixes for passthru to container

var ApptainerPrefixes = []string{ApptainerPrefix, LegacySingularityPrefix}

ApptainerPrefixes the following prefixes are for settings looked at by Apptainer command

var ReadOnlyVars = map[string]bool{
	"EUID":   true,
	"GID":    true,
	"HOME":   true,
	"IFS":    true,
	"OPTIND": true,
	"PWD":    true,
	"UID":    true,
}

Functions

func GetenvLegacy

func GetenvLegacy(key, legacyKey string) string

GetenvLegacy retrieves environment variables value from both APPTAINER_ and SINGULARITY_ and display warning accordingly if the old SINGULARITY_ prefix is used. APPTAINER_ prefixed variable always take precedence if not empty.

func SetContainerEnv

func SetContainerEnv(g *generate.Generator, hostEnvs []string, cleanEnv bool, homeDest string) map[string]string

SetContainerEnv cleans environment variables before running the container.

func SetFromList

func SetFromList(environ []string) error

SetFromList sets environment variables from environ argument list.

func TrimApptainerKey

func TrimApptainerKey(key string) string

TrimApptainerKey returns the key without APPTAINER_ prefix.