[Maitnenance] Ensure Enum in the UpgradeMode Enum Schema (#1830)

Author: ajanikow

CHANGELOG.md

@@ -17,6 +17,7 @@
 - (Feature) (Platform) ArangoRoute Timeout option
 - (Feature) Delay Action
 - (Feature) MigrateMember Action
+- (Maintenance) Ensure Enum in the UpgradeMode Enum Schema
 
 ## [1.2.44](https://github.com/arangodb/kube-arangodb/tree/1.2.44) (2025-02-03)
 - (Maintenance) Kubernetes 1.31.1 libraries

docs/api/ArangoDeployment.V1.md

@@ -837,10 +837,14 @@ Links:
 
 ### .spec.agents.upgradeMode
 
-Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.44/pkg/apis/deployment/v1/server_group_spec.go#L217)</sup>
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.44/pkg/apis/deployment/v1/server_group_spec.go#L220)</sup>
 
 UpgradeMode Defines the upgrade mode for the Member
 
+Possible Values: 
+* `"inplace"` (default) - Inplace Upgrade procedure (with Upgrade initContainer)
+* `"replace"` - Replaces server instead of upgrading. Takes an effect only on DBServer
+
 ***
 
 ### .spec.agents.volumeAllowShrink
@@ -1915,10 +1919,14 @@ Links:
 
 ### .spec.coordinators.upgradeMode
 
-Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.44/pkg/apis/deployment/v1/server_group_spec.go#L217)</sup>
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.44/pkg/apis/deployment/v1/server_group_spec.go#L220)</sup>
 
 UpgradeMode Defines the upgrade mode for the Member
 
+Possible Values: 
+* `"inplace"` (default) - Inplace Upgrade procedure (with Upgrade initContainer)
+* `"replace"` - Replaces server instead of upgrading. Takes an effect only on DBServer
+
 ***
 
 ### .spec.coordinators.volumeAllowShrink
@@ -2861,10 +2869,14 @@ Links:
 
 ### .spec.dbservers.upgradeMode
 
-Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.44/pkg/apis/deployment/v1/server_group_spec.go#L217)</sup>
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.44/pkg/apis/deployment/v1/server_group_spec.go#L220)</sup>
 
 UpgradeMode Defines the upgrade mode for the Member
 
+Possible Values: 
+* `"inplace"` (default) - Inplace Upgrade procedure (with Upgrade initContainer)
+* `"replace"` - Replaces server instead of upgrading. Takes an effect only on DBServer
+
 ***
 
 ### .spec.dbservers.volumeAllowShrink
@@ -3950,10 +3962,14 @@ Links:
 
 ### .spec.gateways.upgradeMode
 
-Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.44/pkg/apis/deployment/v1/server_group_spec.go#L217)</sup>
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.44/pkg/apis/deployment/v1/server_group_spec.go#L220)</sup>
 
 UpgradeMode Defines the upgrade mode for the Member
 
+Possible Values: 
+* `"inplace"` (default) - Inplace Upgrade procedure (with Upgrade initContainer)
+* `"replace"` - Replaces server instead of upgrading. Takes an effect only on DBServer
+
 ***
 
 ### .spec.gateways.volumeAllowShrink
@@ -5639,10 +5655,14 @@ Links:
 
 ### .spec.single.upgradeMode
 
-Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.44/pkg/apis/deployment/v1/server_group_spec.go#L217)</sup>
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.44/pkg/apis/deployment/v1/server_group_spec.go#L220)</sup>
 
 UpgradeMode Defines the upgrade mode for the Member
 
+Possible Values: 
+* `"inplace"` (default) - Inplace Upgrade procedure (with Upgrade initContainer)
+* `"replace"` - Replaces server instead of upgrading. Takes an effect only on DBServer
+
 ***
 
 ### .spec.single.volumeAllowShrink
@@ -6799,10 +6819,14 @@ Links:
 
 ### .spec.syncmasters.upgradeMode
 
-Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.44/pkg/apis/deployment/v1/server_group_spec.go#L217)</sup>
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.44/pkg/apis/deployment/v1/server_group_spec.go#L220)</sup>
 
 UpgradeMode Defines the upgrade mode for the Member
 
+Possible Values: 
+* `"inplace"` (default) - Inplace Upgrade procedure (with Upgrade initContainer)
+* `"replace"` - Replaces server instead of upgrading. Takes an effect only on DBServer
+
 ***
 
 ### .spec.syncmasters.volumeAllowShrink
@@ -7737,10 +7761,14 @@ Links:
 
 ### .spec.syncworkers.upgradeMode
 
-Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.44/pkg/apis/deployment/v1/server_group_spec.go#L217)</sup>
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.44/pkg/apis/deployment/v1/server_group_spec.go#L220)</sup>
 
 UpgradeMode Defines the upgrade mode for the Member
 
+Possible Values: 
+* `"inplace"` (default) - Inplace Upgrade procedure (with Upgrade initContainer)
+* `"replace"` - Replaces server instead of upgrading. Takes an effect only on DBServer
+
 ***
 
 ### .spec.syncworkers.volumeAllowShrink

pkg/apis/deployment/v1/server_group_spec.go

@@ -214,6 +214,9 @@ type ServerGroupSpec struct {
 	Numactl *ServerGroupSpecNumactl `json:"numactl,omitempty"`
 
 	// UpgradeMode Defines the upgrade mode for the Member
+	// +doc/enum: inplace|Inplace Upgrade procedure (with Upgrade initContainer)
+	// +doc/enum: replace|Replaces server instead of upgrading. Takes an effect only on DBServer
+	// +doc/default: inplace
 	UpgradeMode *ServerGroupUpgradeMode `json:"upgradeMode,omitempty"`
 }
 

pkg/apis/deployment/v2alpha1/server_group_spec.go

@@ -214,6 +214,9 @@ type ServerGroupSpec struct {
 	Numactl *ServerGroupSpecNumactl `json:"numactl,omitempty"`
 
 	// UpgradeMode Defines the upgrade mode for the Member
+	// +doc/enum: inplace|Inplace Upgrade procedure (with Upgrade initContainer)
+	// +doc/enum: replace|Replaces server instead of upgrading. Takes an effect only on DBServer
+	// +doc/default: inplace
 	UpgradeMode *ServerGroupUpgradeMode `json:"upgradeMode,omitempty"`
 }
 

pkg/crd/crds/database-deployment.schema.generated.yaml

@@ -1871,6 +1871,9 @@ v1:
                 type: array
               upgradeMode:
                 description: UpgradeMode Defines the upgrade mode for the Member
+                enum:
+                  - inplace
+                  - replace
                 type: string
               volumeAllowShrink:
                 description: VolumeAllowShrink allows shrinking of the volume
@@ -4157,6 +4160,9 @@ v1:
                 type: array
               upgradeMode:
                 description: UpgradeMode Defines the upgrade mode for the Member
+                enum:
+                  - inplace
+                  - replace
                 type: string
               volumeAllowShrink:
                 description: VolumeAllowShrink allows shrinking of the volume
@@ -6361,6 +6367,9 @@ v1:
                 type: array
               upgradeMode:
                 description: UpgradeMode Defines the upgrade mode for the Member
+                enum:
+                  - inplace
+                  - replace
                 type: string
               volumeAllowShrink:
                 description: VolumeAllowShrink allows shrinking of the volume
@@ -8651,6 +8660,9 @@ v1:
                 type: array
               upgradeMode:
                 description: UpgradeMode Defines the upgrade mode for the Member
+                enum:
+                  - inplace
+                  - replace
                 type: string
               volumeAllowShrink:
                 description: VolumeAllowShrink allows shrinking of the volume
@@ -12057,6 +12069,9 @@ v1:
                 type: array
               upgradeMode:
                 description: UpgradeMode Defines the upgrade mode for the Member
+                enum:
+                  - inplace
+                  - replace
                 type: string
               volumeAllowShrink:
                 description: VolumeAllowShrink allows shrinking of the volume
@@ -14406,6 +14421,9 @@ v1:
                 type: array
               upgradeMode:
                 description: UpgradeMode Defines the upgrade mode for the Member
+                enum:
+                  - inplace
+                  - replace
                 type: string
               volumeAllowShrink:
                 description: VolumeAllowShrink allows shrinking of the volume
@@ -16603,6 +16621,9 @@ v1:
                 type: array
               upgradeMode:
                 description: UpgradeMode Defines the upgrade mode for the Member
+                enum:
+                  - inplace
+                  - replace
                 type: string
               volumeAllowShrink:
                 description: VolumeAllowShrink allows shrinking of the volume
@@ -18901,6 +18922,9 @@ v2alpha1:
                 type: array
               upgradeMode:
                 description: UpgradeMode Defines the upgrade mode for the Member
+                enum:
+                  - inplace
+                  - replace
                 type: string
               volumeAllowShrink:
                 description: VolumeAllowShrink allows shrinking of the volume
@@ -21187,6 +21211,9 @@ v2alpha1:
                 type: array
               upgradeMode:
                 description: UpgradeMode Defines the upgrade mode for the Member
+                enum:
+                  - inplace
+                  - replace
                 type: string
               volumeAllowShrink:
                 description: VolumeAllowShrink allows shrinking of the volume
@@ -23391,6 +23418,9 @@ v2alpha1:
                 type: array
               upgradeMode:
                 description: UpgradeMode Defines the upgrade mode for the Member
+                enum:
+                  - inplace
+                  - replace
                 type: string
               volumeAllowShrink:
                 description: VolumeAllowShrink allows shrinking of the volume
@@ -25681,6 +25711,9 @@ v2alpha1:
                 type: array
               upgradeMode:
                 description: UpgradeMode Defines the upgrade mode for the Member
+                enum:
+                  - inplace
+                  - replace
                 type: string
               volumeAllowShrink:
                 description: VolumeAllowShrink allows shrinking of the volume
@@ -29087,6 +29120,9 @@ v2alpha1:
                 type: array
               upgradeMode:
                 description: UpgradeMode Defines the upgrade mode for the Member
+                enum:
+                  - inplace
+                  - replace
                 type: string
               volumeAllowShrink:
                 description: VolumeAllowShrink allows shrinking of the volume
@@ -31436,6 +31472,9 @@ v2alpha1:
                 type: array
               upgradeMode:
                 description: UpgradeMode Defines the upgrade mode for the Member
+                enum:
+                  - inplace
+                  - replace
                 type: string
               volumeAllowShrink:
                 description: VolumeAllowShrink allows shrinking of the volume
@@ -33633,6 +33672,9 @@ v2alpha1:
                 type: array
               upgradeMode:
                 description: UpgradeMode Defines the upgrade mode for the Member
+                enum:
+                  - inplace
+                  - replace
                 type: string
               volumeAllowShrink:
                 description: VolumeAllowShrink allows shrinking of the volume