compute

Documentation

Index

• Variables
• func PodError(pod *corev1.Pod, reason string, msgFormat string, msgArgs ...any)
• func SystemPanic(err error, errFormat string, errArgs ...any)
• type HostEnvironment
• type VirtualEnvironment

Variables

var (
	Environment  HostEnvironment
	K8SClient    client.Client
	K8SClientset *kubernetes.Clientset

	HPK endpoint.HPKPath
)

var (
	ReasonObjectNotFound      = "ObjectNotFound"
	ReasonSpecError           = "SpecError"
	ReasonUnsupportedFeatures = "UnsupportedFeatures"
	ReasonExecutionError      = "ExecutionError"
	ReasonInitializationError = "InitializationError"
)

var (
	ErrUnboundedPVC         = errors.New("unbound pvc")
	ErrUnsupportedClaimMode = errors.New("hpk does not support block volume provisioning")
)

Volume Errors

var (
	DefaultLogger = zap.New(zap.UseDevMode(true))
)

Instantiated Types

Functions

func PodError

func PodError(pod *corev1.Pod, reason string, msgFormat string, msgArgs ...any)

func SystemPanic

func SystemPanic(err error, errFormat string, errArgs ...any)

Types

type HostEnvironment

type HostEnvironment struct {
	KubeMasterHost    string
	ContainerRegistry string
	ApptainerBin      string

	EnableCgroupV2 bool

	WorkingDirectory string

	// KubeDNS points to the internal DNS of a Kubernetes cluster.
	KubeDNS string
}

HostEnvironment containers information about the execution environment.

type VirtualEnvironment

type VirtualEnvironment struct {
	// PodDirectory points to the pod directory on the underlying filesystem.
	PodDirectory string

	// CgroupFilePath points to the cgroup configuration for the virtual environment.
	CgroupFilePath string

	// ConstructorFilePath points to the script for creating the virtual environment for Pod.
	ConstructorFilePath string

	// IPAddressPath is where we store the internal Pod's ip.
	IPAddressPath string

	// StdoutPath instruct Slurm to write stdout into the specified path.
	StdoutPath string

	// StdoutPath instruct Slurm to write stderr into the specified path.
	StderrPath string

	// SysErrorFilePath indicate a system failure that cause the Pod to fail Immediately, bypassing any other checks.
	SysErrorFilePath string
}

The VirtualEnvironment create lightweight "virtual environments" that resemble "Pods" semantics.