Skip to content

Commit 1cdea86

Browse files
ajanikowajanikow
authored
[Maintenance] Update README (#1736)
1 parent 0121b4b commit 1cdea86

File tree

9 files changed

+302
-119
lines changed

9 files changed

+302
-119
lines changed

‎Makefile

+80-55
Original file line numberDiff line numberDiff line change
@@ -542,75 +542,100 @@ manifests-crd-kustomize: manifests-crd-file
542542
manifests: manifests-crd-kustomize
543543

544544
$(eval $(call manifest-generator, deployment, kube-arangodb, \
545-
--set "operator.features.deployment=true" \
546-
--set "operator.features.deploymentReplications=false" \
547-
--set "operator.features.storage=false" \
548-
--set "operator.features.apps=false" \
549-
--set "operator.features.ml=false" \
550-
--set "operator.features.k8sToK8sClusterSync=false" \
551-
--set "operator.features.backup=false"))
545+
--set "operator.features.deployment=true" \
546+
--set "operator.features.deploymentReplications=false" \
547+
--set "operator.features.storage=false" \
548+
--set "operator.features.backup=false" \
549+
--set "operator.features.apps=false" \
550+
--set "operator.features.k8sToK8sClusterSync=false" \
551+
--set "operator.features.ml=false" \
552+
--set "operator.features.analytics=false" \
553+
--set "operator.features.networking=true" \
554+
--set "operator.features.scheduler=true"))
552555

553556
$(eval $(call manifest-generator, deployment-replication, kube-arangodb, \
554-
--set "operator.features.deployment=false" \
555-
--set "operator.features.deploymentReplications=true" \
556-
--set "operator.features.storage=false" \
557-
--set "operator.features.apps=false" \
558-
--set "operator.features.k8sToK8sClusterSync=false" \
559-
--set "operator.features.backup=false"))
557+
--set "operator.features.deployment=false" \
558+
--set "operator.features.deploymentReplications=true" \
559+
--set "operator.features.storage=false" \
560+
--set "operator.features.backup=false" \
561+
--set "operator.features.apps=false" \
562+
--set "operator.features.k8sToK8sClusterSync=false" \
563+
--set "operator.features.ml=false" \
564+
--set "operator.features.analytics=false" \
565+
--set "operator.features.networking=false" \
566+
--set "operator.features.scheduler=false"))
560567

561568
$(eval $(call manifest-generator, storage, kube-arangodb, \
562-
--set "operator.features.deployment=false" \
563-
--set "operator.features.deploymentReplications=false" \
564-
--set "operator.features.storage=true" \
565-
--set "operator.features.apps=false" \
566-
--set "operator.features.ml=false" \
567-
--set "operator.features.k8sToK8sClusterSync=false" \
568-
--set "operator.features.backup=false"))
569+
--set "operator.features.deployment=false" \
570+
--set "operator.features.deploymentReplications=false" \
571+
--set "operator.features.storage=true" \
572+
--set "operator.features.backup=false" \
573+
--set "operator.features.apps=false" \
574+
--set "operator.features.k8sToK8sClusterSync=false" \
575+
--set "operator.features.ml=false" \
576+
--set "operator.features.analytics=false" \
577+
--set "operator.features.networking=false" \
578+
--set "operator.features.scheduler=false"))
569579

570580
$(eval $(call manifest-generator, backup, kube-arangodb, \
571-
--set "operator.features.deployment=false" \
572-
--set "operator.features.deploymentReplications=false" \
573-
--set "operator.features.storage=false" \
574-
--set "operator.features.apps=false" \
575-
--set "operator.features.ml=false" \
576-
--set "operator.features.k8sToK8sClusterSync=false" \
577-
--set "operator.features.backup=true"))
581+
--set "operator.features.deployment=false" \
582+
--set "operator.features.deploymentReplications=false" \
583+
--set "operator.features.storage=false" \
584+
--set "operator.features.backup=true" \
585+
--set "operator.features.apps=false" \
586+
--set "operator.features.k8sToK8sClusterSync=false" \
587+
--set "operator.features.ml=false" \
588+
--set "operator.features.analytics=false" \
589+
--set "operator.features.networking=false" \
590+
--set "operator.features.scheduler=false"))
578591

579592
$(eval $(call manifest-generator, apps, kube-arangodb, \
580-
--set "operator.features.deployment=false" \
581-
--set "operator.features.deploymentReplications=false" \
582-
--set "operator.features.storage=false" \
583-
--set "operator.features.apps=true" \
584-
--set "operator.features.ml=false" \
585-
--set "operator.features.k8sToK8sClusterSync=false" \
586-
--set "operator.features.backup=false"))
593+
--set "operator.features.deployment=false" \
594+
--set "operator.features.deploymentReplications=false" \
595+
--set "operator.features.storage=false" \
596+
--set "operator.features.backup=false" \
597+
--set "operator.features.apps=true" \
598+
--set "operator.features.k8sToK8sClusterSync=false" \
599+
--set "operator.features.ml=false" \
600+
--set "operator.features.analytics=false" \
601+
--set "operator.features.networking=false" \
602+
--set "operator.features.scheduler=false"))
587603

588604
$(eval $(call manifest-generator, ml, kube-arangodb, \
589-
--set "operator.features.deployment=false" \
590-
--set "operator.features.deploymentReplications=false" \
591-
--set "operator.features.storage=false" \
592-
--set "operator.features.apps=false" \
593-
--set "operator.features.ml=true" \
594-
--set "operator.features.k8sToK8sClusterSync=false" \
595-
--set "operator.features.backup=false"))
605+
--set "operator.features.deployment=false" \
606+
--set "operator.features.deploymentReplications=false" \
607+
--set "operator.features.storage=false" \
608+
--set "operator.features.backup=false" \
609+
--set "operator.features.apps=false" \
610+
--set "operator.features.k8sToK8sClusterSync=false" \
611+
--set "operator.features.ml=true" \
612+
--set "operator.features.analytics=false" \
613+
--set "operator.features.networking=false" \
614+
--set "operator.features.scheduler=false"))
596615

597616
$(eval $(call manifest-generator, k2kclustersync, kube-arangodb, \
598-
--set "operator.features.deployment=false" \
599-
--set "operator.features.deploymentReplications=false" \
600-
--set "operator.features.storage=false" \
601-
--set "operator.features.apps=false" \
602-
--set "operator.features.ml=false" \
603-
--set "operator.features.k8sToK8sClusterSync=true" \
604-
--set "operator.features.backup=false"))
617+
--set "operator.features.deployment=false" \
618+
--set "operator.features.deploymentReplications=false" \
619+
--set "operator.features.storage=false" \
620+
--set "operator.features.backup=false" \
621+
--set "operator.features.apps=false" \
622+
--set "operator.features.k8sToK8sClusterSync=true" \
623+
--set "operator.features.ml=false" \
624+
--set "operator.features.analytics=false" \
625+
--set "operator.features.networking=false" \
626+
--set "operator.features.scheduler=false"))
605627

606628
$(eval $(call manifest-generator, all, kube-arangodb, \
607-
--set "operator.features.deployment=true" \
608-
--set "operator.features.deploymentReplications=true" \
609-
--set "operator.features.storage=true" \
610-
--set "operator.features.apps=true" \
611-
--set "operator.features.ml=true" \
612-
--set "operator.features.k8sToK8sClusterSync=true" \
613-
--set "operator.features.backup=true"))
629+
--set "operator.features.deployment=true" \
630+
--set "operator.features.deploymentReplications=true" \
631+
--set "operator.features.storage=true" \
632+
--set "operator.features.backup=true" \
633+
--set "operator.features.apps=true" \
634+
--set "operator.features.k8sToK8sClusterSync=true" \
635+
--set "operator.features.ml=true" \
636+
--set "operator.features.analytics=true" \
637+
--set "operator.features.networking=true" \
638+
--set "operator.features.scheduler=true"))
614639

615640
.PHONY: chart-crd
616641
chart-crd: export CHART_NAME := kube-arangodb-crd

‎README.md

+26-13
Original file line numberDiff line numberDiff line change
@@ -52,19 +52,32 @@ covers individual newer features separately.
5252

5353
[START_INJECT]: # (kubernetesVersionsTable)
5454

55-
| Platform | Kubernetes Version | ArangoDB Version | State | Remarks | Provider Remarks |
56-
|:--------------------|:-------------------|:-----------------|:-----------|:------------------------------------------|:-----------------------------------|
57-
| Google GKE | 1.25-1.30 | >= 3.8.0 | Production | Don't use micro nodes | |
58-
| Azure AKS | 1.25-1.30 | >= 3.8.0 | Production | | |
59-
| Amazon EKS | 1.25-1.30 | >= 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.25-1.30 | >= 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.25-1.30 | >= 3.8.0 | Production | | |
66-
| Minikube | 1.25-1.30 | >= 3.8.0 | Devel Only | | |
67-
| Other | 1.25-1.30 | >= 3.8.0 | Devel Only | | |
55+
| Platform | State | Kubernetes Version | ArangoDB Version | Remarks | Provider Remarks |
56+
|:--------------------|:-------------|:-------------------|:-----------------|:----------------------|:-----------------------------------|
57+
| Google GKE | Production | 1.28-1.31 | >= 3.11.0 | Don't use micro nodes | |
58+
| | EOL | 1.25-1.27 | 3.9.0-3.10.0 | Don't use micro nodes | |
59+
| | NotSupported | < 1.25 | < 3.8.0 | Don't use micro nodes | |
60+
| Azure AKS | Production | 1.28-1.32 | >= 3.11.0 | | |
61+
| | EOL | 1.25-1.27 | 3.9.0-3.10.0 | | |
62+
| | NotSupported | < 1.25 | < 3.8.0 | | |
63+
| Amazon EKS | Production | 1.28-1.31 | >= 3.11.0 | | [Amazon EKS](./docs/providers/eks) |
64+
| | EOL | 1.25-1.27 | 3.9.0-3.10.0 | | [Amazon EKS](./docs/providers/eks) |
65+
| | NotSupported | < 1.25 | < 3.8.0 | | [Amazon EKS](./docs/providers/eks) |
66+
| IBM Cloud | Production | 1.29-1.31 | >= 3.11.0 | | |
67+
| | EOL | 1.25-1.28 | 3.9.0-3.10.0 | | |
68+
| | NotSupported | < 1.25 | < 3.8.0 | | |
69+
| OpenShift | Production | 4.11-4.17 | >= 3.11.0 | | |
70+
| | EOL | 4.2-4.11 | 3.9.0-3.10.0 | | |
71+
| | NotSupported | < 4.2 | < 3.8.0 | | |
72+
| BareMetal (kubeadm) | Production | 1.28-1.31 | >= 3.11.0 | | |
73+
| | EOL | 1.25-1.27 | 3.9.0-3.10.0 | | |
74+
| | NotSupported | < 1.25 | < 3.8.0 | | |
75+
| Minikube | Devel Only | 1.28-1.31 | >= 3.11.0 | | |
76+
| | EOL | 1.25-1.27 | 3.9.0-3.10.0 | | |
77+
| | NotSupported | < 1.25 | < 3.8.0 | | |
78+
| Other | Production | 1.28-1.31 | >= 3.11.0 | | |
79+
| | EOL | 1.25-1.27 | 3.9.0-3.10.0 | | |
80+
| | NotSupported | < 1.25 | < 3.8.0 | | |
6881

6982
[END_INJECT]: # (kubernetesVersionsTable)
7083

‎chart/kube-arangodb-arm64/templates/crd/cluster-role.yaml

+16
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,32 @@ metadata:
1313
app.kubernetes.io/instance: {{ .Release.Name }}
1414
release: {{ .Release.Name }}
1515
rules:
16+
{{ if .Values.operator.features.analytics -}}
1617
# analytics.arangodb.com
1718
- apiGroups: ["apiextensions.k8s.io"]
1819
resources: ["customresourcedefinitions"]
1920
verbs: ["get", "list", "watch", "update", "delete"]
2021
resourceNames:
2122
- "graphanalyticsengines.analytics.arangodb.com"
23+
{{- end }}
24+
{{ if .Values.operator.features.apps -}}
2225
# apps.arangodb.com
2326
- apiGroups: ["apiextensions.k8s.io"]
2427
resources: ["customresourcedefinitions"]
2528
verbs: ["get", "list", "watch", "update", "delete"]
2629
resourceNames:
2730
- "arangojobs.apps.arangodb.com"
31+
{{- end }}
32+
{{ if .Values.operator.features.backup -}}
2833
# backup.arangodb.com
2934
- apiGroups: ["apiextensions.k8s.io"]
3035
resources: ["customresourcedefinitions"]
3136
verbs: ["get", "list", "watch", "update", "delete"]
3237
resourceNames:
3338
- "arangobackuppolicies.backup.arangodb.com"
3439
- "arangobackups.backup.arangodb.com"
40+
{{- end }}
41+
{{ if .Values.operator.features.deployment -}}
3542
# database.arangodb.com
3643
- apiGroups: ["apiextensions.k8s.io"]
3744
resources: ["customresourcedefinitions"]
@@ -41,6 +48,8 @@ rules:
4148
- "arangodeployments.database.arangodb.com"
4249
- "arangomembers.database.arangodb.com"
4350
- "arangotasks.database.arangodb.com"
51+
{{- end }}
52+
{{ if .Values.operator.features.ml -}}
4453
# ml.arangodb.com
4554
- apiGroups: ["apiextensions.k8s.io"]
4655
resources: ["customresourcedefinitions"]
@@ -50,18 +59,24 @@ rules:
5059
- "arangomlcronjobs.ml.arangodb.com"
5160
- "arangomlextensions.ml.arangodb.com"
5261
- "arangomlstorages.ml.arangodb.com"
62+
{{- end }}
63+
{{ if .Values.operator.features.networking -}}
5364
# networking.arangodb.com
5465
- apiGroups: ["apiextensions.k8s.io"]
5566
resources: ["customresourcedefinitions"]
5667
verbs: ["get", "list", "watch", "update", "delete"]
5768
resourceNames:
5869
- "arangoroutes.networking.arangodb.com"
70+
{{- end }}
71+
{{ if .Values.operator.features.deploymentReplications -}}
5972
# replication.database.arangodb.com
6073
- apiGroups: ["apiextensions.k8s.io"]
6174
resources: ["customresourcedefinitions"]
6275
verbs: ["get", "list", "watch", "update", "delete"]
6376
resourceNames:
6477
- "arangodeploymentreplications.replication.database.arangodb.com"
78+
{{- end }}
79+
{{ if .Values.operator.features.scheduler -}}
6580
# scheduler.arangodb.com
6681
- apiGroups: ["apiextensions.k8s.io"]
6782
resources: ["customresourcedefinitions"]
@@ -72,6 +87,7 @@ rules:
7287
- "arangoschedulerdeploymets.scheduler.arangodb.com"
7388
- "arangoschedulerbatchjobs.scheduler.arangodb.com"
7489
- "arangoschedulercronjobs.scheduler.arangodb.com"
90+
{{- end }}
7591

7692
{{- end }}
7793
{{- end }}

‎chart/kube-arangodb-enterprise-arm64/templates/crd/cluster-role.yaml

+16
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,32 @@ metadata:
1313
app.kubernetes.io/instance: {{ .Release.Name }}
1414
release: {{ .Release.Name }}
1515
rules:
16+
{{ if .Values.operator.features.analytics -}}
1617
# analytics.arangodb.com
1718
- apiGroups: ["apiextensions.k8s.io"]
1819
resources: ["customresourcedefinitions"]
1920
verbs: ["get", "list", "watch", "update", "delete"]
2021
resourceNames:
2122
- "graphanalyticsengines.analytics.arangodb.com"
23+
{{- end }}
24+
{{ if .Values.operator.features.apps -}}
2225
# apps.arangodb.com
2326
- apiGroups: ["apiextensions.k8s.io"]
2427
resources: ["customresourcedefinitions"]
2528
verbs: ["get", "list", "watch", "update", "delete"]
2629
resourceNames:
2730
- "arangojobs.apps.arangodb.com"
31+
{{- end }}
32+
{{ if .Values.operator.features.backup -}}
2833
# backup.arangodb.com
2934
- apiGroups: ["apiextensions.k8s.io"]
3035
resources: ["customresourcedefinitions"]
3136
verbs: ["get", "list", "watch", "update", "delete"]
3237
resourceNames:
3338
- "arangobackuppolicies.backup.arangodb.com"
3439
- "arangobackups.backup.arangodb.com"
40+
{{- end }}
41+
{{ if .Values.operator.features.deployment -}}
3542
# database.arangodb.com
3643
- apiGroups: ["apiextensions.k8s.io"]
3744
resources: ["customresourcedefinitions"]
@@ -41,6 +48,8 @@ rules:
4148
- "arangodeployments.database.arangodb.com"
4249
- "arangomembers.database.arangodb.com"
4350
- "arangotasks.database.arangodb.com"
51+
{{- end }}
52+
{{ if .Values.operator.features.ml -}}
4453
# ml.arangodb.com
4554
- apiGroups: ["apiextensions.k8s.io"]
4655
resources: ["customresourcedefinitions"]
@@ -50,18 +59,24 @@ rules:
5059
- "arangomlcronjobs.ml.arangodb.com"
5160
- "arangomlextensions.ml.arangodb.com"
5261
- "arangomlstorages.ml.arangodb.com"
62+
{{- end }}
63+
{{ if .Values.operator.features.networking -}}
5364
# networking.arangodb.com
5465
- apiGroups: ["apiextensions.k8s.io"]
5566
resources: ["customresourcedefinitions"]
5667
verbs: ["get", "list", "watch", "update", "delete"]
5768
resourceNames:
5869
- "arangoroutes.networking.arangodb.com"
70+
{{- end }}
71+
{{ if .Values.operator.features.deploymentReplications -}}
5972
# replication.database.arangodb.com
6073
- apiGroups: ["apiextensions.k8s.io"]
6174
resources: ["customresourcedefinitions"]
6275
verbs: ["get", "list", "watch", "update", "delete"]
6376
resourceNames:
6477
- "arangodeploymentreplications.replication.database.arangodb.com"
78+
{{- end }}
79+
{{ if .Values.operator.features.scheduler -}}
6580
# scheduler.arangodb.com
6681
- apiGroups: ["apiextensions.k8s.io"]
6782
resources: ["customresourcedefinitions"]
@@ -72,6 +87,7 @@ rules:
7287
- "arangoschedulerdeploymets.scheduler.arangodb.com"
7388
- "arangoschedulerbatchjobs.scheduler.arangodb.com"
7489
- "arangoschedulercronjobs.scheduler.arangodb.com"
90+
{{- end }}
7591

7692
{{- end }}
7793
{{- end }}

0 commit comments

Comments
 (0)