/
opensearch_webhook.go
443 lines (360 loc) · 12.4 KB
/
opensearch_webhook.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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
/*
Copyright 2022.
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 v1beta1
import (
"context"
"fmt"
"regexp"
"k8s.io/apimachinery/pkg/runtime"
ctrl "sigs.k8s.io/controller-runtime"
logf "sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/webhook"
"github.com/instaclustr/operator/pkg/models"
"github.com/instaclustr/operator/pkg/validation"
)
var opensearchlog = logf.Log.WithName("opensearch-resource")
type openSearchValidator struct {
API validation.Validation
}
func (r *OpenSearch) SetupWebhookWithManager(mgr ctrl.Manager, api validation.Validation) error {
return ctrl.NewWebhookManagedBy(mgr).
For(r).WithValidator(webhook.CustomValidator(&openSearchValidator{
API: api,
})).
Complete()
}
// TODO(user): change verbs to "verbs=create;update;delete" if you want to enable deletion validation.
//+kubebuilder:webhook:path=/validate-clusters-instaclustr-com-v1beta1-opensearch,mutating=false,failurePolicy=fail,sideEffects=None,groups=clusters.instaclustr.com,resources=opensearches,verbs=create;update,versions=v1beta1,name=vopensearch.kb.io,admissionReviewVersions=v1
//+kubebuilder:webhook:path=/mutate-clusters-instaclustr-com-v1beta1-opensearch,mutating=true,failurePolicy=fail,sideEffects=None,groups=clusters.instaclustr.com,resources=opensearches,verbs=create;update,versions=v1beta1,name=mopensearch.kb.io,admissionReviewVersions=v1
var _ webhook.CustomValidator = &openSearchValidator{}
var _ webhook.Defaulter = &OpenSearch{}
func (os *OpenSearch) Default() {
for _, dataCentre := range os.Spec.DataCentres {
setDefaultValues(dataCentre)
if os.GetAnnotations() == nil {
os.SetAnnotations(map[string]string{
models.ResourceStateAnnotation: "",
})
}
if dataCentre.Name == "" {
dataCentre.Name = dataCentre.Region
}
}
opensearchlog.Info("default values are set", "name", os.Name)
if os.Spec.Name == "" {
os.Spec.Name = os.Name
}
}
func setDefaultValues(dc *OpenSearchDataCentre) {
if dc.ProviderAccountName == "" {
dc.ProviderAccountName = models.DefaultAccountName
}
}
// ValidateCreate implements webhook.Validator so a webhook will be registered for the type
func (osv *openSearchValidator) ValidateCreate(ctx context.Context, obj runtime.Object) error {
os, ok := obj.(*OpenSearch)
if !ok {
return fmt.Errorf("cannot assert object %v to openSearch", obj.GetObjectKind())
}
opensearchlog.Info("validate create", "name", os.Name)
if os.Spec.RestoreFrom != nil {
if os.Spec.RestoreFrom.ClusterID == "" {
return fmt.Errorf("restore clusterID field is empty")
} else {
return nil
}
}
err := os.Spec.ValidateCreation()
if err != nil {
return err
}
if len(os.Spec.DataCentres) == 0 {
return models.ErrZeroDataCentres
}
err = os.Spec.validateDedicatedManager()
if err != nil {
return err
}
for _, dc := range os.Spec.DataCentres {
err = validateCreation(dc)
if err != nil {
return err
}
err = dc.validateDataNode(os.Spec.DataNodes)
if err != nil {
return err
}
err = validateReplicationFactor(models.OpenSearchReplicationFactors, dc.ReplicationFactor)
if err != nil {
return err
}
err = dc.ValidatePrivateLink()
if err != nil {
return err
}
}
appVersions, err := osv.API.ListAppVersions(models.OpenSearchAppKind)
if err != nil {
return fmt.Errorf("cannot list versions for kind: %v, err: %w",
models.OpenSearchAppKind, err)
}
err = validateAppVersion(appVersions, models.OpenSearchAppType, os.Spec.Version)
if err != nil {
return err
}
err = os.Spec.validateResizeSettings(len(os.Spec.ClusterManagerNodes))
if err != nil {
return err
}
for _, node := range os.Spec.DataNodes {
err = os.Spec.validateResizeSettings(node.NodesNumber)
if err != nil {
return err
}
}
return nil
}
func validateCreation(dc *OpenSearchDataCentre) error {
if !validation.Contains(dc.CloudProvider, models.CloudProviders) {
return fmt.Errorf("cloud provider %s is unavailable for data centre: %s, available values: %v",
dc.CloudProvider, dc.Name, models.CloudProviders)
}
switch dc.CloudProvider {
case "AWS_VPC":
if !validation.Contains(dc.Region, models.AWSRegions) {
return fmt.Errorf("AWS Region: %s is unavailable, available regions: %v",
dc.Region, models.AWSRegions)
}
case "AZURE_AZ":
if !validation.Contains(dc.Region, models.AzureRegions) {
return fmt.Errorf("azure Region: %s is unavailable, available regions: %v",
dc.Region, models.AzureRegions)
}
case "GCP":
if !validation.Contains(dc.Region, models.GCPRegions) {
return fmt.Errorf("GCP Region: %s is unavailable, available regions: %v",
dc.Region, models.GCPRegions)
}
}
if dc.ProviderAccountName == models.DefaultAccountName && len(dc.CloudProviderSettings) != 0 {
return fmt.Errorf("cloud provider settings can be used only with RIYOA accounts")
}
if len(dc.CloudProviderSettings) > 1 {
return fmt.Errorf("cloud provider settings should not have more than 1 item")
}
for _, cp := range dc.CloudProviderSettings {
err := cp.ValidateCreation()
if err != nil {
return err
}
}
networkMatched, err := regexp.Match(models.PeerSubnetsRegExp, []byte(dc.Network))
if !networkMatched || err != nil {
return fmt.Errorf("the provided CIDR: %s must contain four dot separated parts and form the Private IP address. All bits in the host part of the CIDR must be 0. Suffix must be between 16-28. %v", dc.Network, err)
}
return nil
}
// ValidateUpdate implements webhook.Validator so a webhook will be registered for the type
func (osv *openSearchValidator) ValidateUpdate(ctx context.Context, old runtime.Object, new runtime.Object) error {
os, ok := new.(*OpenSearch)
if !ok {
return fmt.Errorf("cannot assert object %v to openSearch", new.GetObjectKind())
}
opensearchlog.Info("validate update", "name", os.Name)
// skip validation when we receive cluster specification update from the Instaclustr Console.
if os.Annotations[models.ExternalChangesAnnotation] == models.True {
return nil
}
oldCluster := old.(*OpenSearch)
if oldCluster.Spec.BundledUseOnly && !oldCluster.Spec.IsEqual(os.Spec) {
return models.ErrBundledUseOnlyResourceUpdateIsNotSupported
}
if oldCluster.Spec.RestoreFrom != nil {
return nil
}
if os.Status.ID == "" {
return osv.ValidateCreate(ctx, os)
}
err := os.Spec.validateUpdate(oldCluster.Spec)
if err != nil {
return err
}
// ensuring if the cluster is ready for the spec updating
if (os.Status.CurrentClusterOperationStatus != models.NoOperation || os.Status.State != models.RunningStatus) && os.Generation != oldCluster.Generation {
return models.ErrClusterIsNotReadyToUpdate
}
return nil
}
// ValidateDelete implements webhook.Validator so a webhook will be registered for the type
func (osv *openSearchValidator) ValidateDelete(ctx context.Context, obj runtime.Object) error {
os, ok := obj.(*OpenSearch)
if !ok {
return fmt.Errorf("cannot assert object %v to openSearch", obj.GetObjectKind())
}
opensearchlog.Info("validate delete", "name", os.Name)
// TODO(user): fill in your validation logic upon object deletion.
return nil
}
type immutableOpenSearchFields struct {
specificFields specificOpenSearchFields
cluster immutableCluster
}
type specificOpenSearchFields struct {
ICUPlugin bool
AsynchronousSearchPlugin bool
KNNPlugin bool
ReportingPlugin bool
SQLPlugin bool
NotificationsPlugin bool
AnomalyDetectionPlugin bool
LoadBalancer bool
IndexManagementPlugin bool
AlertingPlugin bool
BundledUseOnly bool
}
func (oss *OpenSearchSpec) newImmutableFields() *immutableOpenSearchFields {
return &immutableOpenSearchFields{
specificFields: specificOpenSearchFields{
ICUPlugin: oss.ICUPlugin,
AsynchronousSearchPlugin: oss.AsynchronousSearchPlugin,
KNNPlugin: oss.KNNPlugin,
ReportingPlugin: oss.ReportingPlugin,
SQLPlugin: oss.SQLPlugin,
NotificationsPlugin: oss.NotificationsPlugin,
AnomalyDetectionPlugin: oss.AnomalyDetectionPlugin,
LoadBalancer: oss.LoadBalancer,
IndexManagementPlugin: oss.IndexManagementPlugin,
AlertingPlugin: oss.AlertingPlugin,
BundledUseOnly: oss.BundledUseOnly,
},
cluster: oss.Cluster.newImmutableFields(),
}
}
type immutableOpenSearchDCFields struct {
immutableDC
specificOpenSearchDC
}
type specificOpenSearchDC struct {
PrivateLink bool
ReplicationFactor int
}
func (oss *OpenSearchDataCentre) newImmutableFields() *immutableOpenSearchDCFields {
return &immutableOpenSearchDCFields{
immutableDC{
Name: oss.Name,
Region: oss.Region,
CloudProvider: oss.CloudProvider,
ProviderAccountName: oss.ProviderAccountName,
Network: oss.Network,
},
specificOpenSearchDC{
PrivateLink: oss.PrivateLink,
ReplicationFactor: oss.ReplicationFactor,
},
}
}
func (oss *OpenSearchSpec) validateDedicatedManager() error {
for _, node := range oss.ClusterManagerNodes {
if node.DedicatedManager && oss.DataNodes == nil {
return fmt.Errorf("cluster with dedicated manager nodes must have data nodes")
}
}
return nil
}
func (oss *OpenSearchSpec) validateUpdate(oldSpec OpenSearchSpec) error {
newImmutableFields := oss.newImmutableFields()
oldImmutableFields := oldSpec.newImmutableFields()
if *newImmutableFields != *oldImmutableFields {
return fmt.Errorf("cannot update immutable fields: old spec: %+v: new spec: %+v", oldImmutableFields, newImmutableFields)
}
err := oss.validateImmutableDataCentresUpdate(oldSpec.DataCentres)
if err != nil {
return err
}
err = validateTwoFactorDelete(oss.TwoFactorDelete, oldSpec.TwoFactorDelete)
if err != nil {
return err
}
err = validateDataNode(oss.DataNodes, oldSpec.DataNodes)
if err != nil {
return err
}
return nil
}
func (oss *OpenSearchSpec) validateImmutableDataCentresUpdate(oldDCs []*OpenSearchDataCentre) error {
newDCs := oss.DataCentres
if len(newDCs) != len(oldDCs) {
return models.ErrImmutableDataCentresNumber
}
toValidate := map[string]*OpenSearchDataCentre{}
for _, dc := range oldDCs {
toValidate[dc.Name] = dc
}
for _, newDC := range newDCs {
oldDC, ok := toValidate[newDC.Name]
if !ok {
return fmt.Errorf("cannot change datacentre name: %v", newDC.Name)
}
newDCImmutableFields := newDC.newImmutableFields()
oldDCImmutableFields := oldDC.newImmutableFields()
if *newDCImmutableFields != *oldDCImmutableFields {
return fmt.Errorf("cannot update immutable data centre fields: new spec: %v: old spec: %v", newDCImmutableFields, oldDCImmutableFields)
}
err := validateImmutableCloudProviderSettingsUpdate(newDC.CloudProviderSettings, oldDC.CloudProviderSettings)
if err != nil {
return err
}
err = newDC.validateDataNode(oss.DataNodes)
if err != nil {
return err
}
err = validateTagsUpdate(newDC.Tags, oldDC.Tags)
if err != nil {
return err
}
}
return nil
}
func (dc *OpenSearchDataCentre) validateDataNode(nodes []*OpenSearchDataNodes) error {
for _, node := range nodes {
if node.NodesNumber%dc.ReplicationFactor != 0 {
return fmt.Errorf("number of data nodes must be a multiple of replication factor: %v", dc.ReplicationFactor)
}
}
return nil
}
func validateImmutableCloudProviderSettingsUpdate(newSettings, oldSettings []*CloudProviderSettings) error {
if len(oldSettings) != len(newSettings) {
return models.ErrImmutableCloudProviderSettings
}
for i := range newSettings {
if *newSettings[i] != *oldSettings[i] {
return models.ErrImmutableCloudProviderSettings
}
}
return nil
}
func validateDataNode(newNodes, oldNodes []*OpenSearchDataNodes) error {
for i := range oldNodes {
if oldNodes[i].NodesNumber > newNodes[i].NodesNumber {
return fmt.Errorf("deleting nodes is not supported. Number of nodes must be greater than: %v", oldNodes[i].NodesNumber)
}
}
return nil
}
func (dc *OpenSearchDataCentre) ValidatePrivateLink() error {
if dc.CloudProvider != models.AWSVPC && dc.PrivateLink {
return models.ErrPrivateLinkSupportedOnlyForAWS
}
return nil
}