common

Documentation

Overview

Package common contains common types and functions used across multiple components.

Index

• type RepairActionType
• type SuggestedActions
  • func (s *SuggestedActions) Add(other *SuggestedActions)
  • func (s *SuggestedActions) RequiresReboot() bool
  • func (s *SuggestedActions) RequiresRepair() bool

Types

type RepairActionType

type RepairActionType string

const (
	// RepairActionTypeRebootSystem represents a suggested action to reboot the system.
	// Specific to NVIDIA GPUs, this implies GPU reset by rebooting the system.
	RepairActionTypeRebootSystem RepairActionType = "REBOOT_SYSTEM"

	// RepairActionTypeRepairHardware represents a suggested action to repair the hardware, externally.
	// This often involves data center (or cloud provider) support to physically check/repair the machine.
	RepairActionTypeRepairHardware RepairActionType = "REPAIR_HARDWARE"
)

type SuggestedActions

type SuggestedActions struct {
	// A list of repair actions to mitigate the issue.
	RepairActions []RepairActionType `json:"repair_actions"`

	// A list of descriptions for the suggested actions.
	Descriptions []string `json:"descriptions"`
}

SuggestedActions represents a set of suggested actions to mitigate an issue.

func (*SuggestedActions) Add

func (s *SuggestedActions) Add(other *SuggestedActions)

func (*SuggestedActions) RequiresReboot

func (s *SuggestedActions) RequiresReboot() bool

func (*SuggestedActions) RequiresRepair

func (s *SuggestedActions) RequiresRepair() bool