Skip to content

Commit e1befd0

Browse files
authored
[Maintenance] Extend Documentation (#1855)
1 parent a96c328 commit e1befd0

34 files changed

+494
-19
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Change Log
22

33
## [master](https://github.com/arangodb/kube-arangodb/tree/master) (N/A)
4+
- (Maintenance) Extend Documentation
45

56
## [1.2.47](https://github.com/arangodb/kube-arangodb/tree/1.2.47) (2025-03-28)
67
- (Bugfix) Use Profile Annotations

chart/kube-arangodb-arm64/crds/database-deployment.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,46 @@ spec:
2121
x-kubernetes-preserve-unknown-fields: true
2222
served: true
2323
storage: true
24+
additionalPrinterColumns:
25+
- jsonPath: '.status.conditions[?(@.type=="UpToDate")].status'
26+
description: Defines if ArangoDeployment is UpToDate
27+
name: Ready
28+
type: string
29+
- jsonPath: '.status.accepted-spec.mode'
30+
description: ArangoDeployment Mode
31+
name: Mode
32+
type: string
2433
- name: v1alpha
2534
schema:
2635
openAPIV3Schema:
2736
type: object
2837
x-kubernetes-preserve-unknown-fields: true
2938
served: false
3039
storage: false
40+
additionalPrinterColumns:
41+
- jsonPath: '.status.conditions[?(@.type=="UpToDate")].status'
42+
description: Defines if ArangoDeployment is UpToDate
43+
name: Ready
44+
type: string
45+
- jsonPath: '.status.accepted-spec.mode'
46+
description: ArangoDeployment Mode
47+
name: Mode
48+
type: string
3149
- name: v2alpha1
3250
schema:
3351
openAPIV3Schema:
3452
type: object
3553
x-kubernetes-preserve-unknown-fields: true
3654
served: true
3755
storage: false
56+
additionalPrinterColumns:
57+
- jsonPath: '.status.conditions[?(@.type=="UpToDate")].status'
58+
description: Defines if ArangoDeployment is UpToDate
59+
name: Ready
60+
type: string
61+
- jsonPath: '.status.accepted-spec.mode'
62+
description: ArangoDeployment Mode
63+
name: Mode
64+
type: string
3865
subresources:
3966
status: {}

chart/kube-arangodb-arm64/crds/database-member.yaml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,16 @@ spec:
2020
x-kubernetes-preserve-unknown-fields: true
2121
served: true
2222
storage: true
23+
additionalPrinterColumns:
24+
- jsonPath: '.status.conditions[?(@.type=="Ready")].status'
25+
description: Defines if Member is ready
26+
name: Ready
27+
type: string
28+
- jsonPath: '.status.conditions[?(@.type=="PendingRestart")].status'
29+
description: Defines if Member is pending restart
30+
name: PendingRestart
31+
priority: 1
32+
type: string
2333
subresources:
2434
status: {}
2535
- name: v2alpha1
@@ -29,5 +39,15 @@ spec:
2939
x-kubernetes-preserve-unknown-fields: true
3040
served: true
3141
storage: false
42+
additionalPrinterColumns:
43+
- jsonPath: '.status.conditions[?(@.type=="Ready")].status'
44+
description: Defines if Member is ready
45+
name: Ready
46+
type: string
47+
- jsonPath: '.status.conditions[?(@.type=="PendingRestart")].status'
48+
description: Defines if Member is pending restart
49+
name: PendingRestart
50+
priority: 1
51+
type: string
3252
subresources:
3353
status: {}

chart/kube-arangodb-arm64/crds/networking-route.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,18 @@ spec:
1818
x-kubernetes-preserve-unknown-fields: true
1919
served: true
2020
storage: true
21+
additionalPrinterColumns:
22+
- jsonPath: '.status.conditions[?(@.type=="Ready")].status'
23+
description: Defines if Route is valid
24+
name: Ready
25+
type: string
26+
- jsonPath: '.status.deployment.name'
27+
description: ArangoDeployment Name
28+
name: Deployment
29+
type: string
30+
- jsonPath: '.status.target.route.path'
31+
description: Route Path
32+
name: Route
33+
type: string
2134
subresources:
2235
status: {}

chart/kube-arangodb-arm64/crds/platform-chart.yaml

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,23 @@ spec:
1818
x-kubernetes-preserve-unknown-fields: true
1919
served: true
2020
storage: true
21+
additionalPrinterColumns:
22+
- jsonPath: '.status.conditions[?(@.type=="Ready")].status'
23+
description: Defines if Chart is valid
24+
name: Ready
25+
type: string
26+
- jsonPath: .status.info.details.name
27+
description: Defines the name of Chart
28+
name: ChartName
29+
type: string
30+
- jsonPath: .status.info.details.version
31+
description: Defines the version of Chart
32+
name: ChartVersion
33+
type: string
34+
- jsonPath: .status.info.checksum
35+
description: Defines the checksum of Chart
36+
name: ChartChecksum
37+
type: string
38+
priority: 1
2139
subresources:
2240
status: {}
23-
scale:
24-
specReplicasPath: .spec.replicas
25-
statusReplicasPath: .status.replicas

chart/kube-arangodb-arm64/crds/platform-storage.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,10 @@ spec:
1818
x-kubernetes-preserve-unknown-fields: true
1919
served: true
2020
storage: true
21+
additionalPrinterColumns:
22+
- jsonPath: '.status.conditions[?(@.type=="Ready")].status'
23+
description: Defines if Storage is valid
24+
name: Ready
25+
type: string
2126
subresources:
2227
status: {}

chart/kube-arangodb-enterprise-arm64/crds/database-deployment.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,46 @@ spec:
2121
x-kubernetes-preserve-unknown-fields: true
2222
served: true
2323
storage: true
24+
additionalPrinterColumns:
25+
- jsonPath: '.status.conditions[?(@.type=="UpToDate")].status'
26+
description: Defines if ArangoDeployment is UpToDate
27+
name: Ready
28+
type: string
29+
- jsonPath: '.status.accepted-spec.mode'
30+
description: ArangoDeployment Mode
31+
name: Mode
32+
type: string
2433
- name: v1alpha
2534
schema:
2635
openAPIV3Schema:
2736
type: object
2837
x-kubernetes-preserve-unknown-fields: true
2938
served: false
3039
storage: false
40+
additionalPrinterColumns:
41+
- jsonPath: '.status.conditions[?(@.type=="UpToDate")].status'
42+
description: Defines if ArangoDeployment is UpToDate
43+
name: Ready
44+
type: string
45+
- jsonPath: '.status.accepted-spec.mode'
46+
description: ArangoDeployment Mode
47+
name: Mode
48+
type: string
3149
- name: v2alpha1
3250
schema:
3351
openAPIV3Schema:
3452
type: object
3553
x-kubernetes-preserve-unknown-fields: true
3654
served: true
3755
storage: false
56+
additionalPrinterColumns:
57+
- jsonPath: '.status.conditions[?(@.type=="UpToDate")].status'
58+
description: Defines if ArangoDeployment is UpToDate
59+
name: Ready
60+
type: string
61+
- jsonPath: '.status.accepted-spec.mode'
62+
description: ArangoDeployment Mode
63+
name: Mode
64+
type: string
3865
subresources:
3966
status: {}

chart/kube-arangodb-enterprise-arm64/crds/database-member.yaml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,16 @@ spec:
2020
x-kubernetes-preserve-unknown-fields: true
2121
served: true
2222
storage: true
23+
additionalPrinterColumns:
24+
- jsonPath: '.status.conditions[?(@.type=="Ready")].status'
25+
description: Defines if Member is ready
26+
name: Ready
27+
type: string
28+
- jsonPath: '.status.conditions[?(@.type=="PendingRestart")].status'
29+
description: Defines if Member is pending restart
30+
name: PendingRestart
31+
priority: 1
32+
type: string
2333
subresources:
2434
status: {}
2535
- name: v2alpha1
@@ -29,5 +39,15 @@ spec:
2939
x-kubernetes-preserve-unknown-fields: true
3040
served: true
3141
storage: false
42+
additionalPrinterColumns:
43+
- jsonPath: '.status.conditions[?(@.type=="Ready")].status'
44+
description: Defines if Member is ready
45+
name: Ready
46+
type: string
47+
- jsonPath: '.status.conditions[?(@.type=="PendingRestart")].status'
48+
description: Defines if Member is pending restart
49+
name: PendingRestart
50+
priority: 1
51+
type: string
3252
subresources:
3353
status: {}

chart/kube-arangodb-enterprise-arm64/crds/networking-route.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,18 @@ spec:
1818
x-kubernetes-preserve-unknown-fields: true
1919
served: true
2020
storage: true
21+
additionalPrinterColumns:
22+
- jsonPath: '.status.conditions[?(@.type=="Ready")].status'
23+
description: Defines if Route is valid
24+
name: Ready
25+
type: string
26+
- jsonPath: '.status.deployment.name'
27+
description: ArangoDeployment Name
28+
name: Deployment
29+
type: string
30+
- jsonPath: '.status.target.route.path'
31+
description: Route Path
32+
name: Route
33+
type: string
2134
subresources:
2235
status: {}

chart/kube-arangodb-enterprise-arm64/crds/platform-chart.yaml

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,23 @@ spec:
1818
x-kubernetes-preserve-unknown-fields: true
1919
served: true
2020
storage: true
21+
additionalPrinterColumns:
22+
- jsonPath: '.status.conditions[?(@.type=="Ready")].status'
23+
description: Defines if Chart is valid
24+
name: Ready
25+
type: string
26+
- jsonPath: .status.info.details.name
27+
description: Defines the name of Chart
28+
name: ChartName
29+
type: string
30+
- jsonPath: .status.info.details.version
31+
description: Defines the version of Chart
32+
name: ChartVersion
33+
type: string
34+
- jsonPath: .status.info.checksum
35+
description: Defines the checksum of Chart
36+
name: ChartChecksum
37+
type: string
38+
priority: 1
2139
subresources:
2240
status: {}
23-
scale:
24-
specReplicasPath: .spec.replicas
25-
statusReplicasPath: .status.replicas

chart/kube-arangodb-enterprise-arm64/crds/platform-storage.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,10 @@ spec:
1818
x-kubernetes-preserve-unknown-fields: true
1919
served: true
2020
storage: true
21+
additionalPrinterColumns:
22+
- jsonPath: '.status.conditions[?(@.type=="Ready")].status'
23+
description: Defines if Storage is valid
24+
name: Ready
25+
type: string
2126
subresources:
2227
status: {}

chart/kube-arangodb-enterprise/crds/database-deployment.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,46 @@ spec:
2121
x-kubernetes-preserve-unknown-fields: true
2222
served: true
2323
storage: true
24+
additionalPrinterColumns:
25+
- jsonPath: '.status.conditions[?(@.type=="UpToDate")].status'
26+
description: Defines if ArangoDeployment is UpToDate
27+
name: Ready
28+
type: string
29+
- jsonPath: '.status.accepted-spec.mode'
30+
description: ArangoDeployment Mode
31+
name: Mode
32+
type: string
2433
- name: v1alpha
2534
schema:
2635
openAPIV3Schema:
2736
type: object
2837
x-kubernetes-preserve-unknown-fields: true
2938
served: false
3039
storage: false
40+
additionalPrinterColumns:
41+
- jsonPath: '.status.conditions[?(@.type=="UpToDate")].status'
42+
description: Defines if ArangoDeployment is UpToDate
43+
name: Ready
44+
type: string
45+
- jsonPath: '.status.accepted-spec.mode'
46+
description: ArangoDeployment Mode
47+
name: Mode
48+
type: string
3149
- name: v2alpha1
3250
schema:
3351
openAPIV3Schema:
3452
type: object
3553
x-kubernetes-preserve-unknown-fields: true
3654
served: true
3755
storage: false
56+
additionalPrinterColumns:
57+
- jsonPath: '.status.conditions[?(@.type=="UpToDate")].status'
58+
description: Defines if ArangoDeployment is UpToDate
59+
name: Ready
60+
type: string
61+
- jsonPath: '.status.accepted-spec.mode'
62+
description: ArangoDeployment Mode
63+
name: Mode
64+
type: string
3865
subresources:
3966
status: {}

chart/kube-arangodb-enterprise/crds/database-member.yaml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,16 @@ spec:
2020
x-kubernetes-preserve-unknown-fields: true
2121
served: true
2222
storage: true
23+
additionalPrinterColumns:
24+
- jsonPath: '.status.conditions[?(@.type=="Ready")].status'
25+
description: Defines if Member is ready
26+
name: Ready
27+
type: string
28+
- jsonPath: '.status.conditions[?(@.type=="PendingRestart")].status'
29+
description: Defines if Member is pending restart
30+
name: PendingRestart
31+
priority: 1
32+
type: string
2333
subresources:
2434
status: {}
2535
- name: v2alpha1
@@ -29,5 +39,15 @@ spec:
2939
x-kubernetes-preserve-unknown-fields: true
3040
served: true
3141
storage: false
42+
additionalPrinterColumns:
43+
- jsonPath: '.status.conditions[?(@.type=="Ready")].status'
44+
description: Defines if Member is ready
45+
name: Ready
46+
type: string
47+
- jsonPath: '.status.conditions[?(@.type=="PendingRestart")].status'
48+
description: Defines if Member is pending restart
49+
name: PendingRestart
50+
priority: 1
51+
type: string
3252
subresources:
3353
status: {}

chart/kube-arangodb-enterprise/crds/networking-route.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,18 @@ spec:
1818
x-kubernetes-preserve-unknown-fields: true
1919
served: true
2020
storage: true
21+
additionalPrinterColumns:
22+
- jsonPath: '.status.conditions[?(@.type=="Ready")].status'
23+
description: Defines if Route is valid
24+
name: Ready
25+
type: string
26+
- jsonPath: '.status.deployment.name'
27+
description: ArangoDeployment Name
28+
name: Deployment
29+
type: string
30+
- jsonPath: '.status.target.route.path'
31+
description: Route Path
32+
name: Route
33+
type: string
2134
subresources:
2235
status: {}

0 commit comments

Comments
 (0)