Skip to content

Commit f6aaed0

Browse files
authored
[Documentation] Shutdown Debug Feature (#1931)
1 parent 2bef219 commit f6aaed0

File tree

2 files changed

+17
-3
lines changed

2 files changed

+17
-3
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## [master](https://github.com/arangodb/kube-arangodb/tree/master) (N/A)
44
- (Feature) (Platform) Storage Debug
55
- (Feature) Extend DebugPackage with Debug files
6+
- (Documentation) Shutdown Debug Feature
67

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

docs/integration/shutdown.v1.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,23 @@ Pod will receive shutdown request on port `port1` if containers `app` and `app2`
3636

3737
### DebugPackage PreShutdown Hook
3838

39-
Example:
39+
The PreShutdown hook copies all non-empty files from the debug-package-mount volume when the main container exits.
40+
41+
How to enable:
4042

4143
```yaml
4244
metadata:
4345
labels:
44-
core.shutdown.arangodb.com/app: "wait"
45-
```
46+
shutdown.integration.profiles.arangodb.com/debug: enabled
47+
```
48+
49+
This creates a Pod volume named debug-package-mount, which can be mounted to any container (including InitContainers) via the volumeMounts directive.
50+
51+
```yaml
52+
spec:
53+
containers:
54+
- name: XXX
55+
volumeMounts:
56+
- mountPath: /debug
57+
name: debug-package-mount
58+
```

0 commit comments

Comments
 (0)