[Maintenance] Update Documentation

arangodb · Jan 9, 2024 · 99d459c · 99d459c
1 parent 73de8aa
commit 99d459c
Show file tree

Hide file tree

Showing 36 changed files with 333 additions and 291 deletions.
diff --git a/README.md b/README.md
@@ -54,17 +54,17 @@ covers individual newer features separately.
 
 | Platform            | Kubernetes Version | ArangoDB Version | State      | Remarks                                   | Provider Remarks                   |
 |:--------------------|:-------------------|:-----------------|:-----------|:------------------------------------------|:-----------------------------------|
-| Google GKE          | 1.21-1.26          | >= 3.6.0         | Production | Don't use micro nodes                     |                                    |
-| Azure AKS           | 1.21-1.26          | >= 3.6.0         | Production |                                           |                                    |
-| Amazon EKS          | 1.21-1.26          | >= 3.6.0         | Production |                                           | [Amazon EKS](./docs/providers/eks) |
-| IBM Cloud           | 1.17               | >= 3.6.0         | Deprecated | Support will be dropped in Operator 1.5.0 |                                    |
-| IBM Cloud           | 1.18-1.21          | >= 3.6.0         | Production |                                           |                                    |
-| OpenShift           | 3.11               | >= 3.6.0         | Deprecated | Support will be dropped in Operator 1.5.0 |                                    |
-| OpenShift           | 4.2-4.13           | >= 3.6.0         | Production |                                           |                                    |
-| BareMetal (kubeadm) | <= 1.20            | >= 3.6.0         | Deprecated | Support will be dropped in Operator 1.5.0 |                                    |
-| BareMetal (kubeadm) | 1.21-1.27          | >= 3.6.0         | Production |                                           |                                    |
-| Minikube            | 1.21-1.27          | >= 3.6.0         | Devel Only |                                           |                                    |
-| Other               | 1.21-1.27          | >= 3.6.0         | Devel Only |                                           |                                    |
+| Google GKE          | 1.21-1.28          | >= 3.8.0         | Production | Don't use micro nodes                     |                                    |
+| Azure AKS           | 1.21-1.28          | >= 3.8.0         | Production |                                           |                                    |
+| Amazon EKS          | 1.21-1.28          | >= 3.8.0         | Production |                                           | [Amazon EKS](./docs/providers/eks) |
+| IBM Cloud           | <= 1.20            | >= 3.8.0         | Deprecated | Support will be dropped in Operator 1.5.0 |                                    |
+| IBM Cloud           | 1.21-1.28          | >= 3.8.0         | Production |                                           |                                    |
+| OpenShift           | 3.11               | >= 3.8.0         | Deprecated | Support will be dropped in Operator 1.5.0 |                                    |
+| OpenShift           | 4.2-4.14           | >= 3.8.0         | Production |                                           |                                    |
+| BareMetal (kubeadm) | <= 1.20            | >= 3.8.0         | Deprecated | Support will be dropped in Operator 1.5.0 |                                    |
+| BareMetal (kubeadm) | 1.21-1.28          | >= 3.8.0         | Production |                                           |                                    |
+| Minikube            | 1.21-1.28          | >= 3.8.0         | Devel Only |                                           |                                    |
+| Other               | 1.21-1.28          | >= 3.8.0         | Devel Only |                                           |                                    |
 
 [END_INJECT]: # (kubernetesVersionsTable)
 

diff --git a/docs/api/ArangoDeployment.V1.md b/docs/api/ArangoDeployment.V1.md
diff --git a/docs/api/ArangoJob.V1.md b/docs/api/ArangoJob.V1.md
@@ -0,0 +1,28 @@
+---
+layout: page
+parent: CRD reference
+title: ArangoJob V1
+---
+
+# API Reference for ArangoJob V1
+
+## Spec
+
+### .spec.arangoDeploymentName
+
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/apps/v1/job_spec.go#L27)</sup>
+
+ArangoDeploymentName holds the name of ArangoDeployment
+
+***
+
+### .spec.jobTemplate
+
+Type: `batch.JobSpec` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/apps/v1/job_spec.go#L33)</sup>
+
+JobTemplate holds the Kubernetes Job Template
+
+Links:
+* [Kubernetes Documentation](https://kubernetes.io/docs/concepts/workloads/controllers/job/)
+* [Documentation of batch.JobSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#jobspec-v1-batch)
+
diff --git a/docs/api/ArangoLocalStorage.V1Alpha.md b/docs/api/ArangoLocalStorage.V1Alpha.md
@@ -82,5 +82,5 @@ Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arango
 Tolerations specifies the tolerations added to pods of storage provisioner
 
 Links:
-* [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core)
+* [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#toleration-v1-core)
 
diff --git a/docs/api/ArangoMLExtension.V1Alpha1.md b/docs/api/ArangoMLExtension.V1Alpha1.md
@@ -79,7 +79,7 @@ Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blo
 Env keeps the information about environment variables provided to the container
 
 Links:
-* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core)
+* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core)
 
 ***
 
@@ -90,7 +90,7 @@ Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arang
 EnvFrom keeps the information about environment variable sources provided to the container
 
 Links:
-* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envfromsource-v1-core)
+* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envfromsource-v1-core)
 
 ***
 
@@ -145,7 +145,7 @@ Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kub
 Resources holds resource requests & limits for container
 
 Links:
-* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
+* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)
 
 ***
 
@@ -167,7 +167,7 @@ Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blo
 Env keeps the information about environment variables provided to the container
 
 Links:
-* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core)
+* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core)
 
 ***
 
@@ -178,7 +178,7 @@ Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arang
 EnvFrom keeps the information about environment variable sources provided to the container
 
 Links:
-* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envfromsource-v1-core)
+* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envfromsource-v1-core)
 
 ***
 
@@ -233,7 +233,7 @@ Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kub
 Resources holds resource requests & limits for container
 
 Links:
-* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
+* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)
 
 ***
 
@@ -317,7 +317,7 @@ Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blo
 Env keeps the information about environment variables provided to the container
 
 Links:
-* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core)
+* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core)
 
 ***
 
@@ -328,7 +328,7 @@ Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arang
 EnvFrom keeps the information about environment variable sources provided to the container
 
 Links:
-* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envfromsource-v1-core)
+* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envfromsource-v1-core)
 
 ***
 
@@ -383,7 +383,7 @@ Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kub
 Resources holds resource requests & limits for container
 
 Links:
-* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
+* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)
 
 ***
 
@@ -424,7 +424,7 @@ Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blo
 Env keeps the information about environment variables provided to the container
 
 Links:
-* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core)
+* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core)
 
 ***
 
@@ -435,7 +435,7 @@ Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arang
 EnvFrom keeps the information about environment variable sources provided to the container
 
 Links:
-* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envfromsource-v1-core)
+* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envfromsource-v1-core)
 
 ***
 
@@ -525,7 +525,7 @@ Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kub
 Resources holds resource requests & limits for container
 
 Links:
-* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
+* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)
 
 ***
 
@@ -593,7 +593,7 @@ Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blo
 Env keeps the information about environment variables provided to the container
 
 Links:
-* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core)
+* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core)
 
 ***
 
@@ -604,7 +604,7 @@ Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arang
 EnvFrom keeps the information about environment variable sources provided to the container
 
 Links:
-* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envfromsource-v1-core)
+* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envfromsource-v1-core)
 
 ***
 
@@ -694,7 +694,7 @@ Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kub
 Resources holds resource requests & limits for container
 
 Links:
-* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
+* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)
 
 ***
 
@@ -762,7 +762,7 @@ Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blo
 Env keeps the information about environment variables provided to the container
 
 Links:
-* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core)
+* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core)
 
 ***
 
@@ -773,7 +773,7 @@ Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arang
 EnvFrom keeps the information about environment variable sources provided to the container
 
 Links:
-* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envfromsource-v1-core)
+* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envfromsource-v1-core)
 
 ***
 
@@ -863,7 +863,7 @@ Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kub
 Resources holds resource requests & limits for container
 
 Links:
-* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
+* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)
 
 ***
 
@@ -931,7 +931,7 @@ Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blo
 Env keeps the information about environment variables provided to the container
 
 Links:
-* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core)
+* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core)
 
 ***
 
@@ -942,7 +942,7 @@ Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arang
 EnvFrom keeps the information about environment variable sources provided to the container
 
 Links:
-* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envfromsource-v1-core)
+* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envfromsource-v1-core)
 
 ***
 
@@ -1032,7 +1032,7 @@ Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kub
 Resources holds resource requests & limits for container
 
 Links:
-* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
+* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)
 
 ***
 
@@ -1100,7 +1100,7 @@ Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blo
 Env keeps the information about environment variables provided to the container
 
 Links:
-* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core)
+* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core)
 
 ***
 
@@ -1111,7 +1111,7 @@ Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arang
 EnvFrom keeps the information about environment variable sources provided to the container
 
 Links:
-* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envfromsource-v1-core)
+* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envfromsource-v1-core)
 
 ***
 
@@ -1201,7 +1201,7 @@ Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kub
 Resources holds resource requests & limits for container
 
 Links:
-* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
+* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)
 
 ***
 

diff --git a/docs/api/ArangoMLStorage.V1Alpha1.md b/docs/api/ArangoMLStorage.V1Alpha1.md
@@ -111,7 +111,7 @@ Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blo
 Env keeps the information about environment variables provided to the container
 
 Links:
-* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core)
+* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core)
 
 ***
 
@@ -122,7 +122,7 @@ Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arang
 EnvFrom keeps the information about environment variable sources provided to the container
 
 Links:
-* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envfromsource-v1-core)
+* [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envfromsource-v1-core)
 
 ***
 
@@ -169,7 +169,7 @@ Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kub
 Resources holds resource requests & limits for container
 
 Links:
-* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
+* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)
 
 ***
 

diff --git a/docs/api/ArangoMember.V1.md b/docs/api/ArangoMember.V1.md
@@ -47,7 +47,7 @@ Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kub
 Resources holds resource requests & limits. Overrides template provided on the group level.
 
 Links:
-* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
+* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)
 
 ***
 
@@ -58,7 +58,7 @@ Type: `core.PersistentVolumeClaim` <sup>[\[ref\]](https://github.com/arangodb/ku
 VolumeClaimTemplate specifies a template for volume claims. Overrides template provided on the group level.
 
 Links:
-* [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core)
+* [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#persistentvolumeclaim-v1-core)
 
 ***
 
@@ -85,7 +85,7 @@ Type: `core.PodTemplateSpec` <sup>[\[ref\]](https://github.com/arangodb/kube-ara
 PodSpec specifies the Pod Spec used for this Member.
 
 Links:
-* [Documentation of core.PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podtemplatespec-v1-core)
+* [Documentation of core.PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podtemplatespec-v1-core)
 
 ***
 

diff --git a/internal/docs_test.go b/internal/docs_test.go
@@ -36,6 +36,7 @@ import (
 	"github.com/coreos/go-semver/semver"
 	"github.com/stretchr/testify/require"
 
+	appsApi "github.com/arangodb/kube-arangodb/pkg/apis/apps/v1"
 	backupApi "github.com/arangodb/kube-arangodb/pkg/apis/backup/v1"
 	deploymentApi "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
 	mlApi "github.com/arangodb/kube-arangodb/pkg/apis/ml/v1alpha1"
@@ -148,6 +149,11 @@ func Test_GenerateAPIDocs(t *testing.T) {
 				"Spec": deploymentApi.ArangoMember{}.Spec,
 			},
 		},
+		fmt.Sprintf("%s/pkg/apis/apps/v1", root): {
+			"ArangoJob.V1": {
+				"Spec": appsApi.ArangoJob{}.Spec,
+			},
+		},
 		fmt.Sprintf("%s/pkg/apis/backup/v1", root): {
 			"ArangoBackup.V1": {
 				"Spec":   backupApi.ArangoBackup{}.Spec,