Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Maintenance] Update Documentation #1570

Merged
merged 2 commits into from
Jan 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
270 changes: 135 additions & 135 deletions docs/api/ArangoDeployment.V1.md

Large diffs are not rendered by default.

28 changes: 28 additions & 0 deletions docs/api/ArangoJob.V1.md
Original file line number Diff line number Diff line change
@@ -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)

2 changes: 1 addition & 1 deletion docs/api/ArangoLocalStorage.V1Alpha.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

48 changes: 24 additions & 24 deletions docs/api/ArangoMLExtension.V1Alpha1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

***

Expand All @@ -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)

***

Expand Down Expand Up @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand Down Expand Up @@ -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)

***

Expand Down Expand Up @@ -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)

***

Expand All @@ -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)

***

Expand Down Expand Up @@ -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)

***

Expand Down Expand Up @@ -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)

***

Expand All @@ -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)

***

Expand Down Expand Up @@ -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)

***

Expand Down Expand Up @@ -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)

***

Expand All @@ -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)

***

Expand Down Expand Up @@ -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)

***

Expand Down Expand Up @@ -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)

***

Expand All @@ -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)

***

Expand Down Expand Up @@ -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)

***

Expand Down Expand Up @@ -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)

***

Expand All @@ -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)

***

Expand Down Expand Up @@ -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)

***

Expand Down Expand Up @@ -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)

***

Expand All @@ -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)

***

Expand Down Expand Up @@ -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)

***

Expand Down
6 changes: 3 additions & 3 deletions docs/api/ArangoMLStorage.V1Alpha1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

***

Expand All @@ -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)

***

Expand Down Expand Up @@ -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)

***

Expand Down
6 changes: 3 additions & 3 deletions docs/api/ArangoMember.V1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand Down
6 changes: 6 additions & 0 deletions internal/docs_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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,
Expand Down
Loading