You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This commit aligns the configuration options of the
DataGather CRD with those of InsightsDataGather,
making it easier to use both CRDs.
Signed-off-by: Ondrej Pokorny <[email protected]>
// +kubebuilder:printcolumn:name=State,type=string,JSONPath=.status.dataGatherState,description=DataGather job state
@@ -37,28 +37,71 @@ type DataGather struct {
37
37
38
38
// DataGatherSpec contains the configuration for the DataGather.
39
39
typeDataGatherSpecstruct {
40
-
// dataPolicy allows user to enable additional global obfuscation of the IP addresses and base domain
41
-
// in the Insights archive data. Valid values are "ClearText" and "ObfuscateNetworking".
42
-
// When set to ClearText the data is not obfuscated.
40
+
// dataPolicy is an optional list of DataPolicyOptions that allows user to enable additional obfuscation of the Insights archive data.
41
+
// It may not exceed 2 items and must not contain duplicates.
42
+
// Valid values are ObfuscateNetworking and WorkloadNames.
43
43
// When set to ObfuscateNetworking the IP addresses and the cluster domain name are obfuscated.
44
-
// When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time.
45
-
// The current default is ClearText.
44
+
// When set to WorkloadNames, the gathered data about cluster resources will not contain the workload names for your deployments. Resources UIDs will be used instead.
45
+
// When omitted no obfuscation is applied.
46
+
// +kubebuilder:validation:MaxItems=2
47
+
// +kubebuilder:validation:XValidation:rule="self.all(x, self.exists_one(y, x == y))",message="dataPolicy items must be unique"
48
+
// +listType=atomic
46
49
// +optional
47
-
DataPolicyDataPolicy`json:"dataPolicy"`
48
-
// gatherers is an optional list of gatherers configurations.
49
-
// The list must not exceed 100 items.
50
-
// The particular gatherers IDs can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md.
51
-
// Run the following command to get the names of last active gatherers:
52
-
// "oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'"
53
-
// +kubebuilder:validation:MaxItems=100
50
+
DataPolicy []DataPolicyOption`json:"dataPolicy"`
51
+
// gatherers is an optional field that specifies the configuration of the gatherers.
// storage is an optional field that allows user to define persistent storage for gathering jobs to store the Insights data archive.
57
55
// If omitted, the gathering job will use ephemeral storage.
58
56
// +optional
59
57
Storage*Storage`json:"storage,omitempty"`
60
58
}
61
59
60
+
// Gathereres specifies the configuration of the gatherers
61
+
// +kubebuilder:validation:XValidation:rule="has(self.mode) && self.mode == 'Custom' ? has(self.custom) : !has(self.custom)",message="custom is required when mode is Custom, and forbidden otherwise"
62
+
typeGatherersstruct {
63
+
// mode is a required field that specifies the mode for gatherers. Allowed values are All, None, and Custom.
64
+
// When set to All, all gatherers wil run and gather data.
65
+
// When set to None, all gatherers will be disabled and no data will be gathered.
66
+
// When set to Custom, the custom configuration from the custom field will be applied.
67
+
// +required
68
+
ModeGatheringMode`json:"mode"`
69
+
// custom provides gathering configuration.
70
+
// It is required when mode is Custom, and forbidden otherwise.
71
+
// Custom configuration allows user to disable only a subset of gatherers.
72
+
// Gatherers that are not explicitly disabled in custom configuration will run.
73
+
// +optional
74
+
Custom*Custom`json:"custom,omitempty"`
75
+
}
76
+
77
+
// custom provides the custom configuration of gatherers
78
+
typeCustomstruct {
79
+
// configs is a required list of gatherers configurations that can be used to enable or disable specific gatherers.
80
+
// It may not exceed 100 items and each gatherer can be present only once.
81
+
// It is possible to disable an entire set of gatherers while allowing a specific function within that set.
82
+
// The particular gatherers IDs can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md.
83
+
// Run the following command to get the names of last active gatherers:
84
+
// "oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'"
85
+
// +kubebuilder:validation:MaxItems=100
86
+
// +listType=map
87
+
// +listMapKey=name
88
+
// +required
89
+
Configs []GathererConfig`json:"configs"`
90
+
}
91
+
92
+
// gatheringMode defines the valid gathering modes.
93
+
// +kubebuilder:validation:Enum=All;None;Custom
94
+
typeGatheringModestring
95
+
96
+
const (
97
+
// Enabled enables all gatherers
98
+
GatheringModeAllGatheringMode="All"
99
+
// Disabled disables all gatherers
100
+
GatheringModeNoneGatheringMode="None"
101
+
// Custom applies the configuration from GatheringConfig.
102
+
GatheringModeCustomGatheringMode="Custom"
103
+
)
104
+
62
105
// storage provides persistent storage configuration options for gathering jobs.
63
106
// If the type is set to PersistentVolume, then the PersistentVolume must be defined.
64
107
// If the type is set to Ephemeral, then the PersistentVolume must not be defined.
@@ -114,52 +157,49 @@ type PersistentVolumeClaimReference struct {
114
157
Namestring`json:"name"`
115
158
}
116
159
160
+
// dataPolicyOption declares valid data policy types
// gathererConfig allows to configure specific gatherers
145
172
typeGathererConfigstruct {
146
-
// name is the required name of specific gatherer
147
-
// It must be at most 256 characters in length.
148
-
// The format for the gatherer name should be: {gatherer}/{function} where the function is optional.
173
+
// name is the required name of a specific gatherer
174
+
// It may not exceed 256 characters.
175
+
// The format for a gatherer name is: {gatherer}/{function} where the function is optional.
149
176
// Gatherer consists of a lowercase letters only that may include underscores (_).
150
177
// Function consists of a lowercase letters only that may include underscores (_) and is separated from the gatherer by a forward slash (/).
151
178
// The particular gatherers can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md.
179
+
// Run the following command to get the names of last active gatherers:
180
+
// "oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'"
152
181
// +kubebuilder:validation:MaxLength=256
153
182
// +kubebuilder:validation:XValidation:rule=`self.matches("^[a-z]+[_a-z]*[a-z]([/a-z][_a-z]*)?[a-z]$")`,message=`gatherer name must be in the format of {gatherer}/{function} where the gatherer and function are lowercase letters only that may include underscores (_) and are separated by a forward slash (/) if the function is provided`
154
183
// +required
155
184
Namestring`json:"name"`
156
-
// state allows you to configure specific gatherer. Valid values are "Enabled", "Disabled" and omitted.
157
-
// When omitted, this means no opinion and the platform is left to choose a reasonable default.
158
-
// The current default is Enabled.
159
-
// +optional
185
+
// state is a required field that allows you to configure specific gatherer. Valid values are "Enabled" and "Disabled".
186
+
// When set to Enabled the gatherer will run.
187
+
// When set to Disabled the gatherer will not run.
188
+
// +required
160
189
StateGathererState`json:"state"`
161
190
}
162
191
192
+
// state declares valid gatherer state types.
193
+
// +kubebuilder:validation:Enum=Enabled;Disabled
194
+
typeGathererStatestring
195
+
196
+
const (
197
+
// GathererStateEnabled gatherer state, which means that the gatherer will run.
198
+
GathererStateEnabledGathererState="Enabled"
199
+
// GathererStateDisabled gatherer state, which means that the gatherer will not run.
200
+
GathererStateDisabledGathererState="Disabled"
201
+
)
202
+
163
203
// dataGatherState declares valid gathering state types
0 commit comments