Skip to content

Commit fa0648a

Browse files
juevjuev
authored
refactor: rename ManagementState to MaintenanceState across the module (#588)
Signed-off-by: Evsyukov Denis <[email protected]>
1 parent 61e1684 commit fa0648a

File tree

9 files changed

+119
-119
lines changed

9 files changed

+119
-119
lines changed

‎pkg/addon-operator/operator.go

+6-6
Original file line numberDiff line numberDiff line change
@@ -1180,7 +1180,7 @@ func (op *AddonOperator) StartModuleManagerEventHandler() {
11801180
slog.Bool("globalSectionChanged", event.GlobalSectionChanged),
11811181
slog.Any("moduleValuesChanged", event.ModuleValuesChanged),
11821182
slog.Any("moduleEnabledStateChanged", event.ModuleEnabledStateChanged),
1183-
slog.Any("moduleManagementStateChanged", event.ModuleManagementStateChanged))
1183+
slog.Any("moduleMaintenanceChanged", event.ModuleMaintenanceChanged))
11841184
if !op.ModuleManager.GetKubeConfigValid() {
11851185
eventLogEntry.Info("KubeConfig become valid")
11861186
}
@@ -1192,16 +1192,16 @@ func (op *AddonOperator) StartModuleManagerEventHandler() {
11921192
convergeTask sh_task.Task
11931193
)
11941194

1195-
if event.GlobalSectionChanged || len(event.ModuleValuesChanged)+len(event.ModuleManagementStateChanged) > 0 {
1195+
if event.GlobalSectionChanged || len(event.ModuleValuesChanged)+len(event.ModuleMaintenanceChanged) > 0 {
11961196
kubeConfigTask = converge.NewApplyKubeConfigValuesTask(
11971197
"Apply-Kube-Config-Values-Changes",
11981198
logLabels,
11991199
event.GlobalSectionChanged,
12001200
)
12011201
}
12021202

1203-
for module, state := range event.ModuleManagementStateChanged {
1204-
op.ModuleManager.SetModuleManagementState(module, state)
1203+
for module, state := range event.ModuleMaintenanceChanged {
1204+
op.ModuleManager.SetModuleMaintenanceState(module, state)
12051205
}
12061206

12071207
// if global hooks haven't been run yet, script enabled extender fails due to missing global values,
@@ -1254,14 +1254,14 @@ func (op *AddonOperator) StartModuleManagerEventHandler() {
12541254
op.ConvergeState.Phase = converge.StandBy
12551255
op.ConvergeState.PhaseLock.Unlock()
12561256
} else {
1257-
modulesToRerun := make([]string, 0, len(event.ModuleValuesChanged)+len(event.ModuleManagementStateChanged))
1257+
modulesToRerun := make([]string, 0, len(event.ModuleValuesChanged)+len(event.ModuleMaintenanceChanged))
12581258
for _, moduleName := range event.ModuleValuesChanged {
12591259
if op.ModuleManager.IsModuleEnabled(moduleName) {
12601260
modulesToRerun = append(modulesToRerun, moduleName)
12611261
}
12621262
}
12631263

1264-
for moduleName := range event.ModuleManagementStateChanged {
1264+
for moduleName := range event.ModuleMaintenanceChanged {
12651265
if !slices.Contains(modulesToRerun, moduleName) && op.ModuleManager.IsModuleEnabled(moduleName) {
12661266
modulesToRerun = append(modulesToRerun, moduleName)
12671267
}

‎pkg/kube_config_manager/backend/configmap/configmap.go

+9-9
Original file line numberDiff line numberDiff line change
@@ -195,9 +195,9 @@ func getModulesNamesFromConfigData(configData map[string]string) (map[string]boo
195195
continue
196196
}
197197

198-
// Treat Enabled and ManagementState flags as module section.
198+
// Treat Enabled and MaintenanceState flags as module section.
199199
key = strings.TrimSuffix(key, utils.EnabledSuffix)
200-
key = strings.TrimSuffix(key, utils.ManagementStateSuffix)
200+
key = strings.TrimSuffix(key, utils.MaintenanceStateSuffix)
201201

202202
modName := utils.ModuleNameFromValuesKey(key)
203203

@@ -272,20 +272,20 @@ func fromConfigMapData(moduleName string, configData map[string]string) (*utils.
272272
configValues[mc.ModuleEnabledKey()] = enabled
273273
}
274274

275-
managementStateString, hasKey := configData[mc.ModuleManagementStateKey()]
275+
maintenanceStateString, hasKey := configData[mc.ModuleMaintenanceStateKey()]
276276
if hasKey {
277-
var state utils.ManagementState
277+
var state utils.Maintenance
278278

279-
switch managementStateString {
280-
case "Unmanaged", "unmanaged":
281-
state = utils.Unmanaged
279+
switch maintenanceStateString {
280+
case "NoResourceReconciliation", "noresourcereconciliation":
281+
state = utils.NoResourceReconciliation
282282
case "":
283283
state = utils.Managed
284284
default:
285-
return nil, fmt.Errorf("module managementState key '%s' can only take 'Unmanaged', 'unmanaged' or '' values, got '%v'", mc.ModuleManagementStateKey(), managementStateString)
285+
return nil, fmt.Errorf("module maintenanceState key '%s' can only take 'NoResourceReconciliation', 'noresourcereconciliation' or '' values, got '%v'", mc.ModuleMaintenanceStateKey(), maintenanceStateString)
286286
}
287287

288-
configValues[mc.ModuleManagementStateKey()] = state
288+
configValues[mc.ModuleMaintenanceStateKey()] = state
289289
}
290290

291291
if len(configValues) == 0 {

‎pkg/kube_config_manager/config/config.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@ func NewConfig() *KubeConfig {
4747
type (
4848
KubeConfigType string
4949
KubeConfigEvent struct {
50-
Type KubeConfigType
51-
ModuleEnabledStateChanged []string
52-
ModuleValuesChanged []string
53-
GlobalSectionChanged bool
54-
ModuleManagementStateChanged map[string]utils.ManagementState
50+
Type KubeConfigType
51+
ModuleEnabledStateChanged []string
52+
ModuleValuesChanged []string
53+
GlobalSectionChanged bool
54+
ModuleMaintenanceChanged map[string]utils.Maintenance
5555
}
5656
)
5757

‎pkg/kube_config_manager/kube_config_manager.go

+31-31
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ func (kcm *KubeConfigManager) handleConfigEvent(obj config.Event) {
244244
// some module values
245245
modulesChanged := []string{}
246246
modulesStateChanged := []string{}
247-
moduleManagementStateChanged := make(map[string]utils.ManagementState)
247+
moduleMaintenanceChanged := make(map[string]utils.Maintenance)
248248

249249
// module update
250250
kcm.m.Lock()
@@ -258,18 +258,18 @@ func (kcm *KubeConfigManager) handleConfigEvent(obj config.Event) {
258258
modulesStateChanged = append(modulesStateChanged, moduleName)
259259
}
260260

261-
if kcm.currentConfig.Modules[moduleName].GetManagementState() == utils.Unmanaged {
262-
moduleManagementStateChanged[moduleName] = utils.Managed
261+
if kcm.currentConfig.Modules[moduleName].GetMaintenanceState() == utils.NoResourceReconciliation {
262+
moduleMaintenanceChanged[moduleName] = utils.Managed
263263
}
264264

265265
moduleCfg.Reset()
266266
moduleCfg.Checksum = moduleCfg.ModuleConfig.Checksum()
267267
kcm.currentConfig.Modules[obj.Key] = moduleCfg
268268
kcm.configEventCh <- config.KubeConfigEvent{
269-
Type: config.KubeConfigChanged,
270-
ModuleValuesChanged: modulesChanged,
271-
ModuleEnabledStateChanged: modulesStateChanged,
272-
ModuleManagementStateChanged: moduleManagementStateChanged,
269+
Type: config.KubeConfigChanged,
270+
ModuleValuesChanged: modulesChanged,
271+
ModuleEnabledStateChanged: modulesStateChanged,
272+
ModuleMaintenanceChanged: moduleMaintenanceChanged,
273273
}
274274
return
275275
}
@@ -287,37 +287,37 @@ func (kcm *KubeConfigManager) handleConfigEvent(obj config.Event) {
287287
modulesStateChanged = append(modulesStateChanged, moduleName)
288288
}
289289

290-
if kcm.currentConfig.Modules[moduleName].GetManagementState() != moduleCfg.GetManagementState() {
291-
moduleManagementStateChanged[moduleName] = moduleCfg.GetManagementState()
290+
if kcm.currentConfig.Modules[moduleName].GetMaintenanceState() != moduleCfg.GetMaintenanceState() {
291+
moduleMaintenanceChanged[moduleName] = moduleCfg.GetMaintenanceState()
292292
}
293293
kcm.logger.Info("Module section changed. Enabled flag transition.",
294294
slog.String("moduleName", moduleName),
295295
slog.String("previous", kcm.currentConfig.Modules[moduleName].GetEnabled()),
296296
slog.String("current", moduleCfg.GetEnabled()),
297-
slog.String("ManagementStateFlag", moduleCfg.GetManagementState().String()))
297+
slog.String("maintenanceFlag", moduleCfg.GetMaintenanceState().String()))
298298
} else {
299299
modulesChanged = append(modulesChanged, moduleName)
300300
if moduleCfg.GetEnabled() != "" && moduleCfg.GetEnabled() != "n/d" {
301301
modulesStateChanged = append(modulesStateChanged, moduleName)
302302
}
303303

304-
if moduleCfg.GetManagementState() == utils.Unmanaged {
305-
moduleManagementStateChanged[moduleName] = utils.Unmanaged
304+
if moduleCfg.GetMaintenanceState() == utils.NoResourceReconciliation {
305+
moduleMaintenanceChanged[moduleName] = utils.NoResourceReconciliation
306306
}
307307
kcm.logger.Info("Module section added",
308308
slog.String("moduleName", moduleName),
309309
slog.String("enabledFlag", moduleCfg.GetEnabled()),
310-
slog.String("ManagementStateFlag", moduleCfg.GetManagementState().String()))
310+
slog.String("maintenanceFlag", moduleCfg.GetMaintenanceState().String()))
311311
}
312312
}
313313

314-
if len(modulesChanged)+len(modulesStateChanged)+len(moduleManagementStateChanged) > 0 {
314+
if len(modulesChanged)+len(modulesStateChanged)+len(moduleMaintenanceChanged) > 0 {
315315
kcm.currentConfig.Modules[obj.Key] = moduleCfg
316316
kcm.configEventCh <- config.KubeConfigEvent{
317-
Type: config.KubeConfigChanged,
318-
ModuleValuesChanged: modulesChanged,
319-
ModuleEnabledStateChanged: modulesStateChanged,
320-
ModuleManagementStateChanged: moduleManagementStateChanged,
317+
Type: config.KubeConfigChanged,
318+
ModuleValuesChanged: modulesChanged,
319+
ModuleEnabledStateChanged: modulesStateChanged,
320+
ModuleMaintenanceChanged: moduleMaintenanceChanged,
321321
}
322322
}
323323
}
@@ -354,7 +354,7 @@ func (kcm *KubeConfigManager) handleBatchConfigEvent(obj config.Event) {
354354
currentModuleNames := kcm.currentModuleNames()
355355
modulesChanged := []string{}
356356
modulesStateChanged := []string{}
357-
moduleManagementStateChanged := make(map[string]utils.ManagementState)
357+
moduleMaintenanceChanged := make(map[string]utils.Maintenance)
358358

359359
for moduleName, moduleCfg := range newConfig.Modules {
360360
// Remove module name from current names to detect deleted sections.
@@ -375,29 +375,29 @@ func (kcm *KubeConfigManager) handleBatchConfigEvent(obj config.Event) {
375375
modulesStateChanged = append(modulesStateChanged, moduleName)
376376
}
377377

378-
if kcm.currentConfig.Modules[moduleName].GetManagementState() != moduleCfg.GetManagementState() {
379-
moduleManagementStateChanged[moduleName] = moduleCfg.GetManagementState()
378+
if kcm.currentConfig.Modules[moduleName].GetMaintenanceState() != moduleCfg.GetMaintenanceState() {
379+
moduleMaintenanceChanged[moduleName] = moduleCfg.GetMaintenanceState()
380380
}
381381

382382
kcm.logger.Info("Module section changed. Enabled flag transition",
383383
slog.String("moduleName", moduleName),
384384
slog.String("previous", kcm.currentConfig.Modules[moduleName].GetEnabled()),
385385
slog.String("current", moduleCfg.GetEnabled()),
386-
slog.String("ManagementStateFlag", moduleCfg.GetManagementState().String()))
386+
slog.String("maintenanceFlag", moduleCfg.GetMaintenanceState().String()))
387387
} else {
388388
modulesChanged = append(modulesChanged, moduleName)
389389
if moduleCfg.GetEnabled() != "" && moduleCfg.GetEnabled() != "n/d" {
390390
modulesStateChanged = append(modulesStateChanged, moduleName)
391391
}
392392

393-
if moduleCfg.GetManagementState() == utils.Unmanaged {
394-
moduleManagementStateChanged[moduleName] = utils.Unmanaged
393+
if moduleCfg.GetMaintenanceState() == utils.NoResourceReconciliation {
394+
moduleMaintenanceChanged[moduleName] = utils.NoResourceReconciliation
395395
}
396396

397397
kcm.logger.Info("Module section added",
398398
slog.String("moduleName", moduleName),
399399
slog.String("enabledFlag", moduleCfg.GetEnabled()),
400-
slog.String("ManagementStateFlag", moduleCfg.GetManagementState().String()))
400+
slog.String("maintenanceFlag", moduleCfg.GetMaintenanceState().String()))
401401
}
402402
}
403403
}
@@ -419,13 +419,13 @@ func (kcm *KubeConfigManager) handleBatchConfigEvent(obj config.Event) {
419419
kcm.m.Unlock()
420420

421421
// Fire event if ConfigMap has changes.
422-
if globalChanged || len(modulesChanged)+len(moduleManagementStateChanged) > 0 {
422+
if globalChanged || len(modulesChanged)+len(moduleMaintenanceChanged) > 0 {
423423
kcm.configEventCh <- config.KubeConfigEvent{
424-
Type: config.KubeConfigChanged,
425-
GlobalSectionChanged: globalChanged,
426-
ModuleValuesChanged: modulesChanged,
427-
ModuleEnabledStateChanged: modulesStateChanged,
428-
ModuleManagementStateChanged: moduleManagementStateChanged,
424+
Type: config.KubeConfigChanged,
425+
GlobalSectionChanged: globalChanged,
426+
ModuleValuesChanged: modulesChanged,
427+
ModuleEnabledStateChanged: modulesStateChanged,
428+
ModuleMaintenanceChanged: moduleMaintenanceChanged,
429429
}
430430
}
431431
}

‎pkg/kube_config_manager/kube_config_manager_test.go

+10-10
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ kubeDns: |
7777
config:
7878
resolver: "192.168.0.1"
7979
kubeDnsEnabled: "true"
80-
kubeDnsManagementState: "Unmanaged"
80+
kubeDnsMaintenance: "NoResourceReconciliation"
8181
`
8282

8383
kubeClient := klient.NewFake(nil)
@@ -87,9 +87,9 @@ kubeDnsManagementState: "Unmanaged"
8787
defer kcm.Stop()
8888

8989
tests := map[string]struct {
90-
isEnabled *bool
91-
managementState utils.ManagementState
92-
values utils.Values
90+
isEnabled *bool
91+
maintenance utils.Maintenance
92+
values utils.Values
9393
}{
9494
"global": {
9595
nil,
@@ -141,7 +141,7 @@ kubeDnsManagementState: "Unmanaged"
141141
},
142142
"kube-dns": {
143143
&utils.ModuleEnabled,
144-
utils.Unmanaged,
144+
utils.NoResourceReconciliation,
145145
utils.Values{
146146
utils.ModuleNameToValuesKey("kubeDns"): map[string]interface{}{
147147
"config": map[string]interface{}{
@@ -165,7 +165,7 @@ kubeDnsManagementState: "Unmanaged"
165165
moduleConfig, hasConfig := config.Modules[name]
166166
assert.True(t, hasConfig)
167167
assert.Equal(t, expect.isEnabled, moduleConfig.IsEnabled)
168-
assert.Equal(t, expect.managementState, moduleConfig.ManagementState)
168+
assert.Equal(t, expect.maintenance, moduleConfig.Maintenance)
169169
assert.Equal(t, expect.values, moduleConfig.GetValuesWithModuleName()) //nolint: staticcheck,nolintlint
170170
})
171171
}
@@ -437,8 +437,8 @@ func Test_KubeConfigManager_error_on_Init(t *testing.T) {
437437
"path": "/data/validModuleName",
438438
"value": "modParam1: val1\nmodParam2: val2"},
439439
{"op": "add",
440-
"path": "/data/validModuleNameManagementState",
441-
"value": "Unmanaged"},
440+
"path": "/data/validModuleNameMaintenance",
441+
"value": "NoResourceReconciliation"},
442442
{"op": "remove",
443443
"path": "/data/InvalidName-module"}]`
444444

@@ -458,8 +458,8 @@ func Test_KubeConfigManager_error_on_Init(t *testing.T) {
458458
ModuleEnabledStateChanged: []string{},
459459
ModuleValuesChanged: []string{"valid-module-name"},
460460
GlobalSectionChanged: false,
461-
ModuleManagementStateChanged: map[string]utils.ManagementState{
462-
"valid-module-name": "Unmanaged",
461+
ModuleMaintenanceChanged: map[string]utils.Maintenance{
462+
"valid-module-name": "NoResourceReconciliation",
463463
},
464464
}), "Valid section patch should generate 'changed' event")
465465

0 commit comments

Comments
 (0)