Skip to content

Commit 44441a5

Browse files
ajanikowajanikow
authored
[Documentation] ManualUpgrade (#1930)
1 parent f6aaed0 commit 44441a5

File tree

6 files changed

+50
-23
lines changed

6 files changed

+50
-23
lines changed

‎CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
- (Feature) (Platform) Storage Debug
55
- (Feature) Extend DebugPackage with Debug files
66
- (Documentation) Shutdown Debug Feature
7+
- (Documentation) ManualUpgrade Docs
78

89
## [1.2.50](https://github.com/arangodb/kube-arangodb/tree/1.2.50) (2025-07-04)
910
- (Feature) (Platform) MetaV1 Integration Service

‎docs/api/ArangoDeployment.V1.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ LabelsMode Define labels mode which should be use while overriding labels
234234

235235
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/deployment/v1/server_group_spec.go#L224)</sup>
236236

237-
UpgradeMode Defines the manually triggered upgrade mode for the Member
237+
ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
238238

239239
Possible Values:
240240
* `"inplace"` (default) - Inplace Upgrade procedure (with Upgrade initContainer)
@@ -1344,7 +1344,7 @@ LabelsMode Define labels mode which should be use while overriding labels
13441344

13451345
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/deployment/v1/server_group_spec.go#L224)</sup>
13461346

1347-
UpgradeMode Defines the manually triggered upgrade mode for the Member
1347+
ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
13481348

13491349
Possible Values:
13501350
* `"inplace"` (default) - Inplace Upgrade procedure (with Upgrade initContainer)
@@ -2322,7 +2322,7 @@ LabelsMode Define labels mode which should be use while overriding labels
23222322

23232323
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/deployment/v1/server_group_spec.go#L224)</sup>
23242324

2325-
UpgradeMode Defines the manually triggered upgrade mode for the Member
2325+
ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
23262326

23272327
Possible Values:
23282328
* `"inplace"` (default) - Inplace Upgrade procedure (with Upgrade initContainer)
@@ -3521,7 +3521,7 @@ LabelsMode Define labels mode which should be use while overriding labels
35213521

35223522
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/deployment/v1/server_group_spec.go#L224)</sup>
35233523

3524-
UpgradeMode Defines the manually triggered upgrade mode for the Member
3524+
ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
35253525

35263526
Possible Values:
35273527
* `"inplace"` (default) - Inplace Upgrade procedure (with Upgrade initContainer)
@@ -5264,7 +5264,7 @@ LabelsMode Define labels mode which should be use while overriding labels
52645264

52655265
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/deployment/v1/server_group_spec.go#L224)</sup>
52665266

5267-
UpgradeMode Defines the manually triggered upgrade mode for the Member
5267+
ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
52685268

52695269
Possible Values:
52705270
* `"inplace"` (default) - Inplace Upgrade procedure (with Upgrade initContainer)
@@ -6456,7 +6456,7 @@ LabelsMode Define labels mode which should be use while overriding labels
64566456

64576457
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/deployment/v1/server_group_spec.go#L224)</sup>
64586458

6459-
UpgradeMode Defines the manually triggered upgrade mode for the Member
6459+
ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
64606460

64616461
Possible Values:
64626462
* `"inplace"` (default) - Inplace Upgrade procedure (with Upgrade initContainer)
@@ -7426,7 +7426,7 @@ LabelsMode Define labels mode which should be use while overriding labels
74267426

74277427
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/deployment/v1/server_group_spec.go#L224)</sup>
74287428

7429-
UpgradeMode Defines the manually triggered upgrade mode for the Member
7429+
ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
74307430

74317431
Possible Values:
74327432
* `"inplace"` (default) - Inplace Upgrade procedure (with Upgrade initContainer)

‎docs/how-to/manual-upgrade.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
layout: page
3+
title: How to run upgrade manually
4+
parent: How to ...
5+
---
6+
7+
# How to upgrade deployment manually (within Maintenance windows)
8+
9+
## Upgrade Mode Change
10+
11+
In order to upgrade Members manually, Upgrade Mode needs to be changed on the ArangoDeployment Level to `manual`.
12+
13+
Use `spec.dbservers.upgradeMode` field of ArangoDeployment CR to configure that:
14+
```
15+
spec:
16+
# ...
17+
dbservers:
18+
upgradeMode: manual
19+
20+
```
21+
22+
## Trigger upgrade
23+
24+
In order to trigger upgrade annotation `upgrade.deployment.arangodb.com/allow` needs to be set on the Pod.
25+
26+
Kubectl command: `kubectl annotate pod arango-pod upgrade.deployment.arangodb.com/allow=true`

‎pkg/apis/deployment/v1/server_group_spec.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ type ServerGroupSpec struct {
217217
// +doc/default: inplace
218218
UpgradeMode *ServerGroupUpgradeMode `json:"upgradeMode,omitempty"`
219219

220-
// UpgradeMode Defines the manually triggered upgrade mode for the Member
220+
// ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
221221
// +doc/enum: inplace|Inplace Upgrade procedure (with Upgrade initContainer)
222222
// +doc/enum: replace|Replaces server instead of upgrading. Takes an effect only on DBServer
223223
// +doc/default: inplace

‎pkg/apis/deployment/v2alpha1/server_group_spec.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ type ServerGroupSpec struct {
217217
// +doc/default: inplace
218218
UpgradeMode *ServerGroupUpgradeMode `json:"upgradeMode,omitempty"`
219219

220-
// UpgradeMode Defines the manually triggered upgrade mode for the Member
220+
// ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
221221
// +doc/enum: inplace|Inplace Upgrade procedure (with Upgrade initContainer)
222222
// +doc/enum: replace|Replaces server instead of upgrading. Takes an effect only on DBServer
223223
// +doc/default: inplace

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

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -916,7 +916,7 @@ v1:
916916
description: LabelsMode Define labels mode which should be use while overriding labels
917917
type: string
918918
manualUpgradeMode:
919-
description: UpgradeMode Defines the manually triggered upgrade mode for the Member
919+
description: ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
920920
enum:
921921
- inplace
922922
- replace
@@ -3218,7 +3218,7 @@ v1:
32183218
description: LabelsMode Define labels mode which should be use while overriding labels
32193219
type: string
32203220
manualUpgradeMode:
3221-
description: UpgradeMode Defines the manually triggered upgrade mode for the Member
3221+
description: ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
32223222
enum:
32233223
- inplace
32243224
- replace
@@ -5438,7 +5438,7 @@ v1:
54385438
description: LabelsMode Define labels mode which should be use while overriding labels
54395439
type: string
54405440
manualUpgradeMode:
5441-
description: UpgradeMode Defines the manually triggered upgrade mode for the Member
5441+
description: ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
54425442
enum:
54435443
- inplace
54445444
- replace
@@ -7778,7 +7778,7 @@ v1:
77787778
description: LabelsMode Define labels mode which should be use while overriding labels
77797779
type: string
77807780
manualUpgradeMode:
7781-
description: UpgradeMode Defines the manually triggered upgrade mode for the Member
7781+
description: ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
77827782
enum:
77837783
- inplace
77847784
- replace
@@ -11213,7 +11213,7 @@ v1:
1121311213
description: LabelsMode Define labels mode which should be use while overriding labels
1121411214
type: string
1121511215
manualUpgradeMode:
11216-
description: UpgradeMode Defines the manually triggered upgrade mode for the Member
11216+
description: ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
1121711217
enum:
1121811218
- inplace
1121911219
- replace
@@ -13578,7 +13578,7 @@ v1:
1357813578
description: LabelsMode Define labels mode which should be use while overriding labels
1357913579
type: string
1358013580
manualUpgradeMode:
13581-
description: UpgradeMode Defines the manually triggered upgrade mode for the Member
13581+
description: ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
1358213582
enum:
1358313583
- inplace
1358413584
- replace
@@ -15791,7 +15791,7 @@ v1:
1579115791
description: LabelsMode Define labels mode which should be use while overriding labels
1579215792
type: string
1579315793
manualUpgradeMode:
15794-
description: UpgradeMode Defines the manually triggered upgrade mode for the Member
15794+
description: ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
1579515795
enum:
1579615796
- inplace
1579715797
- replace
@@ -18111,7 +18111,7 @@ v2alpha1:
1811118111
description: LabelsMode Define labels mode which should be use while overriding labels
1811218112
type: string
1811318113
manualUpgradeMode:
18114-
description: UpgradeMode Defines the manually triggered upgrade mode for the Member
18114+
description: ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
1811518115
enum:
1811618116
- inplace
1811718117
- replace
@@ -20413,7 +20413,7 @@ v2alpha1:
2041320413
description: LabelsMode Define labels mode which should be use while overriding labels
2041420414
type: string
2041520415
manualUpgradeMode:
20416-
description: UpgradeMode Defines the manually triggered upgrade mode for the Member
20416+
description: ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
2041720417
enum:
2041820418
- inplace
2041920419
- replace
@@ -22633,7 +22633,7 @@ v2alpha1:
2263322633
description: LabelsMode Define labels mode which should be use while overriding labels
2263422634
type: string
2263522635
manualUpgradeMode:
22636-
description: UpgradeMode Defines the manually triggered upgrade mode for the Member
22636+
description: ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
2263722637
enum:
2263822638
- inplace
2263922639
- replace
@@ -24973,7 +24973,7 @@ v2alpha1:
2497324973
description: LabelsMode Define labels mode which should be use while overriding labels
2497424974
type: string
2497524975
manualUpgradeMode:
24976-
description: UpgradeMode Defines the manually triggered upgrade mode for the Member
24976+
description: ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
2497724977
enum:
2497824978
- inplace
2497924979
- replace
@@ -28408,7 +28408,7 @@ v2alpha1:
2840828408
description: LabelsMode Define labels mode which should be use while overriding labels
2840928409
type: string
2841028410
manualUpgradeMode:
28411-
description: UpgradeMode Defines the manually triggered upgrade mode for the Member
28411+
description: ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
2841228412
enum:
2841328413
- inplace
2841428414
- replace
@@ -30773,7 +30773,7 @@ v2alpha1:
3077330773
description: LabelsMode Define labels mode which should be use while overriding labels
3077430774
type: string
3077530775
manualUpgradeMode:
30776-
description: UpgradeMode Defines the manually triggered upgrade mode for the Member
30776+
description: ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
3077730777
enum:
3077830778
- inplace
3077930779
- replace
@@ -32986,7 +32986,7 @@ v2alpha1:
3298632986
description: LabelsMode Define labels mode which should be use while overriding labels
3298732987
type: string
3298832988
manualUpgradeMode:
32989-
description: UpgradeMode Defines the manually triggered upgrade mode for the Member
32989+
description: ManualUpgradeMode Defines the manually triggered upgrade mode for the Member
3299032990
enum:
3299132991
- inplace
3299232992
- replace

0 commit comments

Comments
 (0)