Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
42 changes: 35 additions & 7 deletions docs/api/ArangoDeployment.V1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions pkg/apis/deployment/v1/server_group_spec.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"`
}

Expand Down
3 changes: 3 additions & 0 deletions pkg/apis/deployment/v2alpha1/server_group_spec.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"`
}

Expand Down
42 changes: 42 additions & 0 deletions pkg/crd/crds/database-deployment.schema.generated.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down