[Feature] Improve Charts and Upgrade Documentation (#1862)

Author: ajanikow

CHANGELOG.md

@@ -6,6 +6,7 @@
 - (Feature) Add ArangoMember Args
 - (Maintenance) Unify References via golangci-linter
 - (Feature) Add Default Container Mods
+- (Documentation) Improve Charts and Upgrade Documentation
 
 ## [1.2.47](https://github.com/arangodb/kube-arangodb/tree/1.2.47) (2025-03-28)
 - (Bugfix) Use Profile Annotations

README.md

@@ -10,11 +10,12 @@ that you deploy in your Kubernetes cluster to:
 - Configure ArangoDB Datacenter-to-Datacenter Replication
 
 Each of these uses involves a different custom resource:
-- Use an [ArangoDeployment resource](docs/deployment-resource-reference.md) to create an ArangoDB database deployment.
-- Use an [ArangoMember resource](docs/api/ArangoMember.V1.md) to observe and adjust individual deployment members.
+- Use an [ArangoDeployment](docs/deployment-resource-reference.md) resource to create an ArangoDB database deployment.
+- Use an [ArangoMember](docs/api/ArangoMember.V1.md) resource to observe and adjust individual deployment members.
 - Use an [ArangoBackup](docs/backup-resource.md) and [ArangoBackupPolicy](docs/backuppolicy-resource.md) resources to create ArangoDB backups.
-- Use an [ArangoLocalStorage resource](docs/storage-resource.md) to provide local `PersistentVolumes` for optimal I/O performance.
-- Use an [ArangoDeploymentReplication resource](docs/deployment-replication-resource-reference.md) to configure ArangoDB Datacenter-to-Datacenter Replication.
+- Use an [ArangoLocalStorage](docs/storage-resource.md) resource to provide local `PersistentVolumes` for optimal I/O performance.
+- Use an [ArangoDeploymentReplication](docs/deployment-replication-resource-reference.md) resource to configure ArangoDB Datacenter-to-Datacenter Replication.
+- Use an [ArangoPlatformChart](docs/arango-platform-chart-resource.md) and [ArangoProfile](docs/arango-profile-resource.md) resources to customize [ArangoDB Platform](docs/platform.md) deployments.
 
 Continue with [Using the ArangoDB Kubernetes Operator](docs/using-the-operator.md)
 to learn how to install the ArangoDB Kubernetes operator and create your first deployment.
@@ -350,14 +351,7 @@ helm install --generate-name https://github.com/arangodb/kube-arangodb/releases/
 
 ### Upgrading the operator using Helm
 
-To upgrade the operator to the latest version with Helm, you have to
-delete the previous operator deployment and then install the latest. **HOWEVER**:
-You *must not delete* the custom resource definitions (CRDs),
-or your ArangoDB deployments will be deleted!
-
-Therefore, you have to use `helm list` to find the deployments for the
-operator (`kube-arangodb`) and use `helm delete` to delete them using the
-automatically generated deployment names. Here is an example of a `helm list` output:
+To upgrade the operator to the latest version with Helm, you have to run `helm upgrade` with the `--install` flag to enable CRD installation.
 
 ```
 NAME                      	NAMESPACE	REVISION	UPDATED                                 	STATUS  	CHART               	APP VERSION
@@ -366,25 +360,23 @@ kube-arangodb-1-1696919877	default  	1       	2023-10-10 08:37:57.884783199 +020
 
 So here, you would have to do
 ```bash
-helm delete kube-arangodb-1-1696919877
+helm upgrade --install kube-arangodb-1-1696919877 https://github.com/arangodb/kube-arangodb/releases/download/1.2.47/kube-arangodb-1.2.47.tgz
 ```
 
-Then you can install the new version with `helm install` as normal:
-
 ##### Community Edition
 ```bash
 # The following will install the operator and basic CRDs resources.
-helm install --generate-name https://github.com/arangodb/kube-arangodb/releases/download/1.2.47/kube-arangodb-1.2.47.tgz
+helm upgrade --install <NAME> https://github.com/arangodb/kube-arangodb/releases/download/1.2.47/kube-arangodb-1.2.47.tgz
 # To use `ArangoLocalStorage`, set field `operator.features.storage` to true
-helm install --generate-name https://github.com/arangodb/kube-arangodb/releases/download/1.2.47/kube-arangodb-1.2.47.tgz --set "operator.features.storage=true"
+helm upgrade --install <NAME> https://github.com/arangodb/kube-arangodb/releases/download/1.2.47/kube-arangodb-1.2.47.tgz --set "operator.features.storage=true"
 ```
 
 ##### Enterprise Edition
 ```bash
 # The following will install the operator and basic CRDs resources.
-helm install --generate-name https://github.com/arangodb/kube-arangodb/releases/download/1.2.47/kube-arangodb-enterprise-1.2.47.tgz
+helm upgrade --install <NAME> https://github.com/arangodb/kube-arangodb/releases/download/1.2.47/kube-arangodb-enterprise-1.2.47.tgz
 # To use `ArangoLocalStorage`, set field `operator.features.storage` to true
-helm install --generate-name https://github.com/arangodb/kube-arangodb/releases/download/1.2.47/kube-arangodb-enterprise-1.2.47.tgz --set "operator.features.storage=true"
+helm upgrade --install <NAME> https://github.com/arangodb/kube-arangodb/releases/download/1.2.47/kube-arangodb-enterprise-1.2.47.tgz --set "operator.features.storage=true"
 ```
 
 ## Building

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

@@ -17,23 +17,23 @@ rules:
 # analytics.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "graphanalyticsengines.analytics.arangodb.com"
 {{- end }}
 {{ if .Values.operator.features.apps -}}
 # apps.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangojobs.apps.arangodb.com"
 {{- end }}
 {{ if .Values.operator.features.backup -}}
 # backup.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangobackuppolicies.backup.arangodb.com"
       - "arangobackups.backup.arangodb.com"
@@ -42,7 +42,7 @@ rules:
 # database.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangoclustersynchronizations.database.arangodb.com"
       - "arangodeployments.database.arangodb.com"
@@ -53,7 +53,7 @@ rules:
 # ml.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangomlbatchjobs.ml.arangodb.com"
       - "arangomlcronjobs.ml.arangodb.com"
@@ -64,30 +64,39 @@ rules:
 # networking.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangoroutes.networking.arangodb.com"
 {{- end }}
 {{ if .Values.operator.features.deploymentReplications -}}
 # replication.database.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangodeploymentreplications.replication.database.arangodb.com"
 {{- end }}
 {{ if .Values.operator.features.scheduler -}}
 # scheduler.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangoprofiles.scheduler.arangodb.com"
       - "arangoschedulerpods.scheduler.arangodb.com"
       - "arangoschedulerdeploymets.scheduler.arangodb.com"
       - "arangoschedulerbatchjobs.scheduler.arangodb.com"
       - "arangoschedulercronjobs.scheduler.arangodb.com"
 {{- end }}
+{{ if .Values.operator.features.platform -}}
+# platform.arangodb.com
+  - apiGroups: ["apiextensions.k8s.io"]
+    resources: ["customresourcedefinitions"]
+    verbs: ["get", "list", "watch", "update"]
+    resourceNames:
+      - "arangoplatformcharts.platform.arangodb.com"
+      - "arangoplatformstorages.platform.arangodb.com"
+{{- end }}
 
 {{- end }}
 {{- end }}

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

@@ -17,23 +17,23 @@ rules:
 # analytics.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "graphanalyticsengines.analytics.arangodb.com"
 {{- end }}
 {{ if .Values.operator.features.apps -}}
 # apps.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangojobs.apps.arangodb.com"
 {{- end }}
 {{ if .Values.operator.features.backup -}}
 # backup.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangobackuppolicies.backup.arangodb.com"
       - "arangobackups.backup.arangodb.com"
@@ -42,7 +42,7 @@ rules:
 # database.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangoclustersynchronizations.database.arangodb.com"
       - "arangodeployments.database.arangodb.com"
@@ -53,7 +53,7 @@ rules:
 # ml.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangomlbatchjobs.ml.arangodb.com"
       - "arangomlcronjobs.ml.arangodb.com"
@@ -64,30 +64,39 @@ rules:
 # networking.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangoroutes.networking.arangodb.com"
 {{- end }}
 {{ if .Values.operator.features.deploymentReplications -}}
 # replication.database.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangodeploymentreplications.replication.database.arangodb.com"
 {{- end }}
 {{ if .Values.operator.features.scheduler -}}
 # scheduler.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangoprofiles.scheduler.arangodb.com"
       - "arangoschedulerpods.scheduler.arangodb.com"
       - "arangoschedulerdeploymets.scheduler.arangodb.com"
       - "arangoschedulerbatchjobs.scheduler.arangodb.com"
       - "arangoschedulercronjobs.scheduler.arangodb.com"
 {{- end }}
+{{ if .Values.operator.features.platform -}}
+# platform.arangodb.com
+  - apiGroups: ["apiextensions.k8s.io"]
+    resources: ["customresourcedefinitions"]
+    verbs: ["get", "list", "watch", "update"]
+    resourceNames:
+      - "arangoplatformcharts.platform.arangodb.com"
+      - "arangoplatformstorages.platform.arangodb.com"
+{{- end }}
 
 {{- end }}
 {{- end }}

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

@@ -17,23 +17,23 @@ rules:
 # analytics.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "graphanalyticsengines.analytics.arangodb.com"
 {{- end }}
 {{ if .Values.operator.features.apps -}}
 # apps.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangojobs.apps.arangodb.com"
 {{- end }}
 {{ if .Values.operator.features.backup -}}
 # backup.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangobackuppolicies.backup.arangodb.com"
       - "arangobackups.backup.arangodb.com"
@@ -42,7 +42,7 @@ rules:
 # database.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangoclustersynchronizations.database.arangodb.com"
       - "arangodeployments.database.arangodb.com"
@@ -53,7 +53,7 @@ rules:
 # ml.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangomlbatchjobs.ml.arangodb.com"
       - "arangomlcronjobs.ml.arangodb.com"
@@ -64,30 +64,39 @@ rules:
 # networking.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangoroutes.networking.arangodb.com"
 {{- end }}
 {{ if .Values.operator.features.deploymentReplications -}}
 # replication.database.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangodeploymentreplications.replication.database.arangodb.com"
 {{- end }}
 {{ if .Values.operator.features.scheduler -}}
 # scheduler.arangodb.com
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
-    verbs: ["get", "list", "watch", "update", "delete"]
+    verbs: ["get", "list", "watch", "update"]
     resourceNames:
       - "arangoprofiles.scheduler.arangodb.com"
       - "arangoschedulerpods.scheduler.arangodb.com"
       - "arangoschedulerdeploymets.scheduler.arangodb.com"
       - "arangoschedulerbatchjobs.scheduler.arangodb.com"
       - "arangoschedulercronjobs.scheduler.arangodb.com"
 {{- end }}
+{{ if .Values.operator.features.platform -}}
+# platform.arangodb.com
+  - apiGroups: ["apiextensions.k8s.io"]
+    resources: ["customresourcedefinitions"]
+    verbs: ["get", "list", "watch", "update"]
+    resourceNames:
+      - "arangoplatformcharts.platform.arangodb.com"
+      - "arangoplatformstorages.platform.arangodb.com"
+{{- end }}
 
 {{- end }}
 {{- end }}