fio

Documentation

Index

• Constants
• type FIO
• type FIOrunner
  • func (f *FIOrunner) RunFio(ctx context.Context, args *RunFIOArgs) (*RunFIOResult, error)
  • func (f *FIOrunner) RunFioHelper(ctx context.Context, args *RunFIOArgs) (*RunFIOResult, error)
• type RunFIOArgs
  • func (a *RunFIOArgs) Validate() error
• type RunFIOResult

Constants

const (
	// DefaultNS describes the default namespace
	DefaultNS = "default"
	// PodNamespaceEnvKey describes the pod namespace env variable
	PodNamespaceEnvKey = "POD_NAMESPACE"
	// DefaultFIOJob describes the default FIO job
	DefaultFIOJob = "default-fio"
	// KubestrFIOJob describes the default FIO job
	KubestrFIOJobGenName = "kubestr-fio"
	// ConfigMapJobKey is the default fio job key
	ConfigMapJobKey = "fiojob"
	// DefaultPVCSize is the default PVC size
	DefaultPVCSize = "100Gi"
	// PVCGenerateName is the name to generate for the PVC
	PVCGenerateName = "kubestr-fio-pvc-"
	// PodGenerateName is the name to generate for the POD
	PodGenerateName = "kubestr-fio-pod-"
	// ContainerName is the name of the container that runs the job
	ContainerName = "kubestr-fio"
	// PodNameEnvKey is the name of the variable used to get the current pod name
	PodNameEnvKey = "HOSTNAME"
	// ConfigMapMountPath is the path where we mount the configmap
	ConfigMapMountPath = "/etc/fio-config"
	// VolumeMountPath is the path where we mount the volume
	VolumeMountPath = "/dataset"
	// CreatedByFIOLabel is the key that desrcibes the label used to mark configmaps
	CreatedByFIOLabel = "createdbyfio"
	DefaultPodImage   = "ghcr.io/kastenhq/kubestr:latest"
)

Types

type FIO

type FIO interface {
	RunFio(ctx context.Context, args *RunFIOArgs) (*RunFIOResult, error) // , test config
}

FIO is an interface that represents FIO related commands

type FIOrunner

type FIOrunner struct {
	Cli kubernetes.Interface
	// contains filtered or unexported fields
}

FIOrunner implments FIO

func (*FIOrunner) RunFio

func (f *FIOrunner) RunFio(ctx context.Context, args *RunFIOArgs) (*RunFIOResult, error)

func (*FIOrunner) RunFioHelper

func (f *FIOrunner) RunFioHelper(ctx context.Context, args *RunFIOArgs) (*RunFIOResult, error)

type RunFIOArgs

type RunFIOArgs struct {
	StorageClass   string
	Size           string
	Namespace      string
	FIOJobFilepath string
	FIOJobName     string
	Image          string
}

func (*RunFIOArgs) Validate

func (a *RunFIOArgs) Validate() error

type RunFIOResult

type RunFIOResult struct {
	Size         string            `json:"size,omitempty"`
	StorageClass *sv1.StorageClass `json:"storageClass,omitempty"`
	FioConfig    string            `json:"fioConfig,omitempty"`
	Result       string            `json:"result,omitempty"`
}