/
fio_types.go
137 lines (110 loc) · 4.48 KB
/
fio_types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/*
Copyright 2023.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package v1alpha1
import (
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
// FioSpec defines the desired state of Fio
// Reference https://fio.readthedocs.io/en/latest/fio_doc.html
type FioSpec struct {
// The total size of file I/O for each thread of the test.
// Please refer to https://fio.readthedocs.io/en/latest/fio_doc.html#i-o-size
// +kubebuilder:validation:Pattern=^[0-9]+[kKmMgG]?$
// +kubebuilder:default="1G"
// +optional
Size string `json:"size,omitempty"`
// The block size to use for the test.
// Please refer to https://fio.readthedocs.io/en/latest/fio_doc.html#block-size
// +kubebuilder:validation:Pattern=^[0-9]+[kKmMgG]?$
// +kubebuilder:default="4k"
// +optional
Bs string `json:"bs,omitempty"`
// The number of threads to use for the test.
// Please refer to https://fio.readthedocs.io/en/latest/fio_doc.html#job-description
// +kubebuilder:validation:MinItems=1
// +kubebuilder:default={1}
// +optional
Numjobs []int `json:"numjobs,omitempty"`
// Limit runtime. The test will run until it completes the configured I/O workload
// or until it has run for this specified amount of time, whichever occurs first.
// Please refer to https://fio.readthedocs.io/en/latest/fio_doc.html##time-related-parameters
// +kubebuilder:validation:Minimum=0
// +optional
RunTime int `json:"runtime,omitempty"`
// Number of I/O units to keep in flight against the file.
// Please refer to https://fio.readthedocs.io/en/latest/fio_doc.html#i-o-depth
// +kubebuilder:validation:Minimum=1
// +kubebuilder:default=1
// +optional
Iodepth int `json:"iodepth,omitempty"`
// The I/O engine to use.
// Please refer to https://fio.readthedocs.io/en/latest/fio_doc.html#cmdoption-arg-ioengine
// +kubebuilder:default=psync
// +optional
IoEngine string `json:"ioengine,omitempty"`
// Whether to use non-buffered I/O.
// Please refer to https://fio.readthedocs.io/en/latest/fio_doc.html#i-o-type
// +kubebuilder:default=true
// +optional
Direct bool `json:"direct,omitempty"`
// The type of I/O pattern to use.
// Please refer to https://fio.readthedocs.io/en/latest/fio_doc.html#i-o-type
// +kubebuilder:validation:MinItems=1
// +kubebuilder:default={read}
// +optional
Rws []string `json:"rws,omitempty"`
// The other fio run command flags to use for benchmark
// +optional
ExtraArgs []string `json:"extraArgs,omitempty"`
// If specified, the pod's tolerations.
// +optional
Tolerations []corev1.Toleration `json:"tolerations,omitempty" protobuf:"bytes,22,opt,name=tolerations"`
// the resource requirements for the benchmark
ResourceLimits *ResourceList `json:"resourceLimits,omitempty"`
ResourceRequests *ResourceList `json:"resourceRequests,omitempty"`
}
// FioStatus defines the observed state of Fio
type FioStatus struct {
// Phase is the current state of the test. Valid values are Disabled, Enabled, Failed, Enabling, Disabling.
// +kubebuilder:validation:Enum={Pending,Running,Completed,Failed}
Phase BenchmarkPhase `json:"phase,omitempty"`
// completions is the completed/total number of pgbench runs
Completions string `json:"completions,omitempty"`
// succeeded is the number of successful pgbench runs
Succeeded int `json:"succeeded,omitempty"`
// total is the number of pgbench runs
Total int `json:"total,omitempty"`
// Describes the current state of benchmark conditions.
// +optional
Conditions []metav1.Condition `json:"conditions,omitempty"`
}
//+kubebuilder:object:root=true
//+kubebuilder:subresource:status
// Fio is the Schema for the fios API
type Fio struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec FioSpec `json:"spec,omitempty"`
Status FioStatus `json:"status,omitempty"`
}
//+kubebuilder:object:root=true
// FioList contains a list of Fio
type FioList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Fio `json:"items"`
}
func init() {
SchemeBuilder.Register(&Fio{}, &FioList{})
}