Skip to content

Commit 15f9030

Browse files
ajanikowajanikow
authored
[Maintenance] Update Documentation (#1570)
1 parent d796697 commit 15f9030

36 files changed

+333
-291
lines changed

‎README.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -54,17 +54,17 @@ covers individual newer features separately.
5454

5555
| Platform | Kubernetes Version | ArangoDB Version | State | Remarks | Provider Remarks |
5656
|:--------------------|:-------------------|:-----------------|:-----------|:------------------------------------------|:-----------------------------------|
57-
| Google GKE | 1.21-1.26 | >= 3.6.0 | Production | Don't use micro nodes | |
58-
| Azure AKS | 1.21-1.26 | >= 3.6.0 | Production | | |
59-
| Amazon EKS | 1.21-1.26 | >= 3.6.0 | Production | | [Amazon EKS](./docs/providers/eks) |
60-
| IBM Cloud | 1.17 | >= 3.6.0 | Deprecated | Support will be dropped in Operator 1.5.0 | |
61-
| IBM Cloud | 1.18-1.21 | >= 3.6.0 | Production | | |
62-
| OpenShift | 3.11 | >= 3.6.0 | Deprecated | Support will be dropped in Operator 1.5.0 | |
63-
| OpenShift | 4.2-4.13 | >= 3.6.0 | Production | | |
64-
| BareMetal (kubeadm) | <= 1.20 | >= 3.6.0 | Deprecated | Support will be dropped in Operator 1.5.0 | |
65-
| BareMetal (kubeadm) | 1.21-1.27 | >= 3.6.0 | Production | | |
66-
| Minikube | 1.21-1.27 | >= 3.6.0 | Devel Only | | |
67-
| Other | 1.21-1.27 | >= 3.6.0 | Devel Only | | |
57+
| Google GKE | 1.21-1.28 | >= 3.8.0 | Production | Don't use micro nodes | |
58+
| Azure AKS | 1.21-1.28 | >= 3.8.0 | Production | | |
59+
| Amazon EKS | 1.21-1.28 | >= 3.8.0 | Production | | [Amazon EKS](./docs/providers/eks) |
60+
| IBM Cloud | <= 1.20 | >= 3.8.0 | Deprecated | Support will be dropped in Operator 1.5.0 | |
61+
| IBM Cloud | 1.21-1.28 | >= 3.8.0 | Production | | |
62+
| OpenShift | 3.11 | >= 3.8.0 | Deprecated | Support will be dropped in Operator 1.5.0 | |
63+
| OpenShift | 4.2-4.14 | >= 3.8.0 | Production | | |
64+
| BareMetal (kubeadm) | <= 1.20 | >= 3.8.0 | Deprecated | Support will be dropped in Operator 1.5.0 | |
65+
| BareMetal (kubeadm) | 1.21-1.28 | >= 3.8.0 | Production | | |
66+
| Minikube | 1.21-1.28 | >= 3.8.0 | Devel Only | | |
67+
| Other | 1.21-1.28 | >= 3.8.0 | Devel Only | | |
6868

6969
[END_INJECT]: # (kubernetesVersionsTable)
7070

‎docs/api/ArangoDeployment.V1.md‎

Lines changed: 135 additions & 135 deletions
Large diffs are not rendered by default.

‎docs/api/ArangoJob.V1.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
layout: page
3+
parent: CRD reference
4+
title: ArangoJob V1
5+
---
6+
7+
# API Reference for ArangoJob V1
8+
9+
## Spec
10+
11+
### .spec.arangoDeploymentName
12+
13+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/apps/v1/job_spec.go#L27)</sup>
14+
15+
ArangoDeploymentName holds the name of ArangoDeployment
16+
17+
***
18+
19+
### .spec.jobTemplate
20+
21+
Type: `batch.JobSpec` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/apps/v1/job_spec.go#L33)</sup>
22+
23+
JobTemplate holds the Kubernetes Job Template
24+
25+
Links:
26+
* [Kubernetes Documentation](https://kubernetes.io/docs/concepts/workloads/controllers/job/)
27+
* [Documentation of batch.JobSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#jobspec-v1-batch)
28+

‎docs/api/ArangoLocalStorage.V1Alpha.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,5 +82,5 @@ Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arango
8282
Tolerations specifies the tolerations added to pods of storage provisioner
8383

8484
Links:
85-
* [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core)
85+
* [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#toleration-v1-core)
8686

‎docs/api/ArangoMLExtension.V1Alpha1.md‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blo
7979
Env keeps the information about environment variables provided to the container
8080

8181
Links:
82-
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core)
82+
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core)
8383

8484
***
8585

@@ -90,7 +90,7 @@ Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arang
9090
EnvFrom keeps the information about environment variable sources provided to the container
9191

9292
Links:
93-
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envfromsource-v1-core)
93+
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envfromsource-v1-core)
9494

9595
***
9696

@@ -145,7 +145,7 @@ Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kub
145145
Resources holds resource requests & limits for container
146146

147147
Links:
148-
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
148+
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)
149149

150150
***
151151

@@ -167,7 +167,7 @@ Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blo
167167
Env keeps the information about environment variables provided to the container
168168

169169
Links:
170-
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core)
170+
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core)
171171

172172
***
173173

@@ -178,7 +178,7 @@ Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arang
178178
EnvFrom keeps the information about environment variable sources provided to the container
179179

180180
Links:
181-
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envfromsource-v1-core)
181+
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envfromsource-v1-core)
182182

183183
***
184184

@@ -233,7 +233,7 @@ Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kub
233233
Resources holds resource requests & limits for container
234234

235235
Links:
236-
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
236+
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)
237237

238238
***
239239

@@ -317,7 +317,7 @@ Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blo
317317
Env keeps the information about environment variables provided to the container
318318

319319
Links:
320-
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core)
320+
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core)
321321

322322
***
323323

@@ -328,7 +328,7 @@ Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arang
328328
EnvFrom keeps the information about environment variable sources provided to the container
329329

330330
Links:
331-
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envfromsource-v1-core)
331+
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envfromsource-v1-core)
332332

333333
***
334334

@@ -383,7 +383,7 @@ Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kub
383383
Resources holds resource requests & limits for container
384384

385385
Links:
386-
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
386+
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)
387387

388388
***
389389

@@ -424,7 +424,7 @@ Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blo
424424
Env keeps the information about environment variables provided to the container
425425

426426
Links:
427-
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core)
427+
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core)
428428

429429
***
430430

@@ -435,7 +435,7 @@ Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arang
435435
EnvFrom keeps the information about environment variable sources provided to the container
436436

437437
Links:
438-
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envfromsource-v1-core)
438+
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envfromsource-v1-core)
439439

440440
***
441441

@@ -525,7 +525,7 @@ Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kub
525525
Resources holds resource requests & limits for container
526526

527527
Links:
528-
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
528+
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)
529529

530530
***
531531

@@ -593,7 +593,7 @@ Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blo
593593
Env keeps the information about environment variables provided to the container
594594

595595
Links:
596-
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core)
596+
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core)
597597

598598
***
599599

@@ -604,7 +604,7 @@ Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arang
604604
EnvFrom keeps the information about environment variable sources provided to the container
605605

606606
Links:
607-
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envfromsource-v1-core)
607+
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envfromsource-v1-core)
608608

609609
***
610610

@@ -694,7 +694,7 @@ Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kub
694694
Resources holds resource requests & limits for container
695695

696696
Links:
697-
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
697+
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)
698698

699699
***
700700

@@ -762,7 +762,7 @@ Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blo
762762
Env keeps the information about environment variables provided to the container
763763

764764
Links:
765-
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core)
765+
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core)
766766

767767
***
768768

@@ -773,7 +773,7 @@ Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arang
773773
EnvFrom keeps the information about environment variable sources provided to the container
774774

775775
Links:
776-
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envfromsource-v1-core)
776+
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envfromsource-v1-core)
777777

778778
***
779779

@@ -863,7 +863,7 @@ Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kub
863863
Resources holds resource requests & limits for container
864864

865865
Links:
866-
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
866+
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)
867867

868868
***
869869

@@ -931,7 +931,7 @@ Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blo
931931
Env keeps the information about environment variables provided to the container
932932

933933
Links:
934-
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core)
934+
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core)
935935

936936
***
937937

@@ -942,7 +942,7 @@ Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arang
942942
EnvFrom keeps the information about environment variable sources provided to the container
943943

944944
Links:
945-
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envfromsource-v1-core)
945+
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envfromsource-v1-core)
946946

947947
***
948948

@@ -1032,7 +1032,7 @@ Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kub
10321032
Resources holds resource requests & limits for container
10331033

10341034
Links:
1035-
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
1035+
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)
10361036

10371037
***
10381038

@@ -1100,7 +1100,7 @@ Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blo
11001100
Env keeps the information about environment variables provided to the container
11011101

11021102
Links:
1103-
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core)
1103+
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core)
11041104

11051105
***
11061106

@@ -1111,7 +1111,7 @@ Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arang
11111111
EnvFrom keeps the information about environment variable sources provided to the container
11121112

11131113
Links:
1114-
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envfromsource-v1-core)
1114+
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envfromsource-v1-core)
11151115

11161116
***
11171117

@@ -1201,7 +1201,7 @@ Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kub
12011201
Resources holds resource requests & limits for container
12021202

12031203
Links:
1204-
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
1204+
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)
12051205

12061206
***
12071207

‎docs/api/ArangoMLStorage.V1Alpha1.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blo
111111
Env keeps the information about environment variables provided to the container
112112

113113
Links:
114-
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core)
114+
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core)
115115

116116
***
117117

@@ -122,7 +122,7 @@ Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arang
122122
EnvFrom keeps the information about environment variable sources provided to the container
123123

124124
Links:
125-
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envfromsource-v1-core)
125+
* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envfromsource-v1-core)
126126

127127
***
128128

@@ -169,7 +169,7 @@ Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kub
169169
Resources holds resource requests & limits for container
170170

171171
Links:
172-
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
172+
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)
173173

174174
***
175175

‎docs/api/ArangoMember.V1.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kub
4747
Resources holds resource requests & limits. Overrides template provided on the group level.
4848

4949
Links:
50-
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
50+
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)
5151

5252
***
5353

@@ -58,7 +58,7 @@ Type: `core.PersistentVolumeClaim` <sup>[\[ref\]](https://github.com/arangodb/ku
5858
VolumeClaimTemplate specifies a template for volume claims. Overrides template provided on the group level.
5959

6060
Links:
61-
* [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core)
61+
* [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#persistentvolumeclaim-v1-core)
6262

6363
***
6464

@@ -85,7 +85,7 @@ Type: `core.PodTemplateSpec` <sup>[\[ref\]](https://github.com/arangodb/kube-ara
8585
PodSpec specifies the Pod Spec used for this Member.
8686

8787
Links:
88-
* [Documentation of core.PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podtemplatespec-v1-core)
88+
* [Documentation of core.PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podtemplatespec-v1-core)
8989

9090
***
9191

‎internal/docs_test.go‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ import (
3636
"github.com/coreos/go-semver/semver"
3737
"github.com/stretchr/testify/require"
3838

39+
appsApi "github.com/arangodb/kube-arangodb/pkg/apis/apps/v1"
3940
backupApi "github.com/arangodb/kube-arangodb/pkg/apis/backup/v1"
4041
deploymentApi "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
4142
mlApi "github.com/arangodb/kube-arangodb/pkg/apis/ml/v1alpha1"
@@ -148,6 +149,11 @@ func Test_GenerateAPIDocs(t *testing.T) {
148149
"Spec": deploymentApi.ArangoMember{}.Spec,
149150
},
150151
},
152+
fmt.Sprintf("%s/pkg/apis/apps/v1", root): {
153+
"ArangoJob.V1": {
154+
"Spec": appsApi.ArangoJob{}.Spec,
155+
},
156+
},
151157
fmt.Sprintf("%s/pkg/apis/backup/v1", root): {
152158
"ArangoBackup.V1": {
153159
"Spec": backupApi.ArangoBackup{}.Spec,

0 commit comments

Comments
 (0)