[Documentation] [1.3.0] EE & CE Definitions (#1142)

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## [master](https://github.com/arangodb/kube-arangodb/tree/master) (N/A)
 - (Improvement) Bump dependencies
+- (Documentation) (1.3.0) EE & CE Definitions
 
 ## [1.2.20](https://github.com/arangodb/kube-arangodb/tree/1.2.20) (2022-10-25)
 - (Feature) Add action progress

Makefile

@@ -61,7 +61,7 @@ HELM_OPTIONS = --set "operator.image=$(OPERATORIMAGE)" \
 	--set "operator.resources=null" \
 	--set "operator.debug=$(DEBUG)"
 
-ifeq ($(shell $(HELM) version --client --template '{{.Version}}' | cut -f 1 -d '.'),v3)
+ifeq ($(shell $(HELM) version --client --template '{{.Version}}' 2> /dev/null | cut -f 1 -d '.'),v3)
 	# Using helm v3
 	HELM_PACKAGE_CMD = $(HELM) package "$(ROOTDIR)/chart/$(CHART_NAME)" -d "$(ROOTDIR)/bin/charts" \
 		--version "$(VERSION_MAJOR_MINOR_PATCH)"
@@ -113,6 +113,8 @@ ifndef MANIFESTSUFFIX
 	MANIFESTSUFFIX := -dev
 endif
 endif
+
+ifeq ($(RELEASE_MODE),community)
 MANIFESTPATHCRD := manifests/arango-crd$(MANIFESTSUFFIX).yaml
 MANIFESTPATHDEPLOYMENT := manifests/arango-deployment$(MANIFESTSUFFIX).yaml
 MANIFESTPATHDEPLOYMENTREPLICATION := manifests/arango-deployment-replication$(MANIFESTSUFFIX).yaml
@@ -121,16 +123,33 @@ MANIFESTPATHAPPS := manifests/arango-apps$(MANIFESTSUFFIX).yaml
 MANIFESTPATHK2KCLUSTERSYNC := manifests/arango-k2kclustersync$(MANIFESTSUFFIX).yaml
 MANIFESTPATHSTORAGE := manifests/arango-storage$(MANIFESTSUFFIX).yaml
 MANIFESTPATHALL := manifests/arango-all$(MANIFESTSUFFIX).yaml
-MANIFESTPATHTEST := manifests/arango-test$(MANIFESTSUFFIX).yaml
 KUSTOMIZEPATHCRD := manifests/kustomize/crd/arango-crd$(MANIFESTSUFFIX).yaml
 KUSTOMIZEPATHDEPLOYMENT := manifests/kustomize/deployment/arango-deployment$(MANIFESTSUFFIX).yaml
 KUSTOMIZEPATHDEPLOYMENTREPLICATION := manifests/kustomize/deployment-replication/arango-deployment-replication$(MANIFESTSUFFIX).yaml
 KUSTOMIZEPATHBACKUP := manifests/kustomize/backup/arango-backup$(MANIFESTSUFFIX).yaml
 KUSTOMIZEPATHAPPS := manifests/kustomize/apps/arango-apps$(MANIFESTSUFFIX).yaml
-KUSTOMIZEPATHK2KCLUSTERSYNC := manifests/kustomize/apps/arango-k2kclustersync$(MANIFESTSUFFIX).yaml
+KUSTOMIZEPATHK2KCLUSTERSYNC := manifests/kustomize/k2kclustersync/arango-k2kclustersync$(MANIFESTSUFFIX).yaml
 KUSTOMIZEPATHSTORAGE := manifests/kustomize/storage/arango-storage$(MANIFESTSUFFIX).yaml
 KUSTOMIZEPATHALL := manifests/kustomize/all/arango-all$(MANIFESTSUFFIX).yaml
-KUSTOMIZEPATHTEST := manifests/kustomize/test/arango-test$(MANIFESTSUFFIX).yaml
+else
+MANIFESTPATHCRD := manifests/enterprise-crd$(MANIFESTSUFFIX).yaml
+MANIFESTPATHDEPLOYMENT := manifests/enterprise-deployment$(MANIFESTSUFFIX).yaml
+MANIFESTPATHDEPLOYMENTREPLICATION := manifests/enterprise-deployment-replication$(MANIFESTSUFFIX).yaml
+MANIFESTPATHBACKUP := manifests/enterprise-backup$(MANIFESTSUFFIX).yaml
+MANIFESTPATHAPPS := manifests/enterprise-apps$(MANIFESTSUFFIX).yaml
+MANIFESTPATHK2KCLUSTERSYNC := manifests/enterprise-k2kclustersync$(MANIFESTSUFFIX).yaml
+MANIFESTPATHSTORAGE := manifests/enterprise-storage$(MANIFESTSUFFIX).yaml
+MANIFESTPATHALL := manifests/enterprise-all$(MANIFESTSUFFIX).yaml
+KUSTOMIZEPATHCRD := manifests/kustomize-enterprise/crd/enterprise-crd$(MANIFESTSUFFIX).yaml
+KUSTOMIZEPATHDEPLOYMENT := manifests/kustomize-enterprise/deployment/enterprise-deployment$(MANIFESTSUFFIX).yaml
+KUSTOMIZEPATHDEPLOYMENTREPLICATION := manifests/kustomize-enterprise/deployment-replication/enterprise-deployment-replication$(MANIFESTSUFFIX).yaml
+KUSTOMIZEPATHBACKUP := manifests/kustomize-enterprise/backup/enterprise-backup$(MANIFESTSUFFIX).yaml
+KUSTOMIZEPATHAPPS := manifests/kustomize-enterprise/apps/enterprise-apps$(MANIFESTSUFFIX).yaml
+KUSTOMIZEPATHK2KCLUSTERSYNC := manifests/kustomize-enterprise/k2kclustersync/enterprise-k2kclustersync$(MANIFESTSUFFIX).yaml
+KUSTOMIZEPATHSTORAGE := manifests/kustomize-enterprise/storage/enterprise-storage$(MANIFESTSUFFIX).yaml
+KUSTOMIZEPATHALL := manifests/kustomize-enterprise/all/enterprise-all$(MANIFESTSUFFIX).yaml
+endif
+
 ifndef DEPLOYMENTNAMESPACE
 	DEPLOYMENTNAMESPACE := default
 endif
@@ -356,8 +375,6 @@ manifests:
 
 $(eval $(call manifest-generator, crd, kube-arangodb-crd))
 
-$(eval $(call manifest-generator, test, kube-arangodb-test))
-
 $(eval $(call manifest-generator, deployment, kube-arangodb, \
        --set "operator.features.deployment=true" \
 	   --set "operator.features.deploymentReplications=false" \
@@ -454,7 +471,7 @@ patch-examples:
 	$(ROOTDIR)/scripts/patch_examples.sh $(VERSION_MAJOR_MINOR_PATCH)
 
 .PHONY: patch-release
-patch-release: patch-readme patch-examples
+patch-release: patch-readme patch-examples patch-chart
 
 .PHONY: patch-chart
 patch-chart:

README.md

@@ -85,20 +85,11 @@ Feature-wise production readiness table:
 | Operator Internal Metrics Exporter      | 1.2.0            | >= 3.6.0         | Community, Enterprise | 1.2.0      | Production   | True    | --deployment.feature.metrics-exporter      | N/A                                                                      |
 | Operator Ephemeral Volumes              | 1.2.2            | >= 3.7.0         | Community, Enterprise | 1.2.2      | Alpha        | False   | --deployment.feature.ephemeral-volumes     | N/A                                                                      |
 
-## Release notes for 0.3.16
+## Operator Community Edition (CE)
 
-In this release we have reworked the Helm charts. One notable change is
-that we now create a new service account specifically for the operator.
-The actual deployment still runs by default under the `default` service
-account unless one changes that. Note that the service account under
-which the ArangoDB runs needs a small set of extra permissions. For
-the `default` service account we grant them when the operator is
-deployed. If you use another service account you have to grant these
-permissions yourself. See
-[here](docs/Manual/Deployment/Kubernetes/DeploymentResource.md#specgroupserviceaccountname-string)
-for details.
+Image: `arangodb/kube-arangodb:1.2.20`
 
-## Installation of latest release using Kubectl
+### Installation of latest CE release using Kubectl
 
 ```bash
 kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/1.2.20/manifests/arango-crd.yaml
@@ -112,7 +103,7 @@ kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/1.2.20
 This procedure can also be used for upgrades and will not harm any
 running ArangoDB deployments.
 
-## Installation of latest release using kustomize
+### Installation of latest CE release using kustomize
 
 Installation using [kustomize](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/) looks like installation from yaml files,
 but user is allowed to modify namespace or resource names without yaml modifications.
@@ -131,7 +122,7 @@ bases:
   - https://github.com/arangodb/kube-arangodb/manifests/kustomize/deployment/?ref=1.0.3
 ```
 
-## Installation of latest release using Helm
+### Installation of latest CE release using Helm
 
 Only use this procedure for a new install of the operator. See below for
 upgrades.
@@ -146,7 +137,7 @@ helm install https://github.com/arangodb/kube-arangodb/releases/download/1.2.20/
 helm install https://github.com/arangodb/kube-arangodb/releases/download/1.2.20/kube-arangodb-1.2.20.tgz --set "operator.features.storage=true"
 ```
 
-## Upgrading the operator using Helm
+### Upgrading the operator using Helm
 
 To upgrade the operator to the latest version with Helm, you have to
 delete the previous deployment and then install the latest. **HOWEVER**:
@@ -183,6 +174,95 @@ helm install https://github.com/arangodb/kube-arangodb/releases/download/1.2.20/
 helm install https://github.com/arangodb/kube-arangodb/releases/download/1.2.20/kube-arangodb-1.2.20.tgz --set "operator.features.storage=true"
 ```
 
+## Operator Enterprise Edition (EE)
+
+Image: `arangodb/kube-arangodb-enterprise:1.2.20`
+
+### Installation of latest EE release using Kubectl
+
+```bash
+kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/1.2.20/manifests/enterprise-crd.yaml
+kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/1.2.20/manifests/enterprise-deployment.yaml
+# To use `ArangoLocalStorage`, also run
+kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/1.2.20/manifests/enterprise-storage.yaml
+# To use `ArangoDeploymentReplication`, also run
+kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/1.2.20/manifests/enterprise-deployment-replication.yaml
+```
+
+This procedure can also be used for upgrades and will not harm any
+running ArangoDB deployments.
+
+### Installation of latest EE release using kustomize
+
+Installation using [kustomize](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/) looks like installation from yaml files,
+but user is allowed to modify namespace or resource names without yaml modifications.
+
+IT is recommended to use kustomization instead of handcrafting namespace in yaml files - kustomization will replace not only resource namespaces,
+but also namespace references in resources like ClusterRoleBinding.
+
+Example kustomization file:
+```
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+
+namespace: my-custom-namespace
+
+bases:
+  - https://github.com/arangodb/kube-arangodb/manifests/kustomize-enterprise/deployment/?ref=1.0.3
+```
+
+### Installation of latest EE release using Helm
+
+Only use this procedure for a new install of the operator. See below for
+upgrades.
+
+```bash
+# The following will install the custom resources required by the operators.
+helm install https://github.com/arangodb/kube-arangodb/releases/download/1.2.20/kube-arangodb-crd-1.2.20.tgz --set "operator.image=arangodb/kube-arangodb-enterprise:1.2.20"
+# The following will install the operator for `ArangoDeployment` &
+# `ArangoDeploymentReplication` resources.
+helm install https://github.com/arangodb/kube-arangodb/releases/download/1.2.20/kube-arangodb-1.2.20.tgz --set "operator.image=arangodb/kube-arangodb-enterprise:1.2.20"
+# To use `ArangoLocalStorage`, set field `operator.features.storage` to true
+helm install https://github.com/arangodb/kube-arangodb/releases/download/1.2.20/kube-arangodb-1.2.20.tgz --set "operator.image=arangodb/kube-arangodb-enterprise:1.2.20" --set "operator.features.storage=true"
+```
+
+### Upgrading the operator using Helm
+
+To upgrade the operator to the latest version with Helm, you have to
+delete the previous deployment and then install the latest. **HOWEVER**:
+You *must not delete* the deployment of 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 of the storage operator
+(`kube-arangodb-storage`) and use `helm delete` to delete them using the
+automatically generated deployment names. Here is an example of a `helm
+list` output:
+
+```
+% helm list
+NAME            	REVISION	UPDATED                 	STATUS  	CHART                               	APP VERSION	NAMESPACE
+steely-mule     	1       	Sun Mar 31 21:11:07 2019	DEPLOYED	kube-arangodb-crd-0.3.9             	           	default  
+vetoed-ladybird 	1       	Mon Apr  8 11:36:58 2019	DEPLOYED	kube-arangodb-0.3.10-preview        	           	default  
+```
+
+So here, you would have to do
+
+```bash
+helm delete vetoed-ladybird
+```
+
+but **not delete `steely-mule`**. Then you could install the new version
+with `helm install` as normal:
+
+```bash
+# The following will install the operator for `ArangoDeployment` &
+# `ArangoDeploymentReplication` resources.
+helm install https://github.com/arangodb/kube-arangodb/releases/download/1.2.20/kube-arangodb-1.2.20.tgz --set "operator.image=arangodb/kube-arangodb-enterprise:1.2.20"
+# To use `ArangoLocalStorage`, set field `operator.features.storage` to true
+helm install https://github.com/arangodb/kube-arangodb/releases/download/1.2.20/kube-arangodb-1.2.20.tgz --set "operator.image=arangodb/kube-arangodb-enterprise:1.2.20" --set "operator.features.storage=true"
+```
+
 ## Building
 
 ```bash
@@ -193,11 +273,3 @@ kubectl apply -f manifests/arango-storage-dev.yaml
 # To use `ArangoDeploymentReplication`, also run
 kubectl apply -f manifests/arango-deployment-replication-dev.yaml
 ```
-
-## ArangoExporter
-
-[ArangoExporter](https://github.com/arangodb-helper/arangodb-exporter) project has been merged with ArangoOperator.
-Starting from ArangoDB 3.6 Servers expose metrics endpoint with prometheus compatible format. From this point Exporter
-is used only for TLS and/or Authentication termination to be compatible with all Prometheus installations.
-
-ArangoExporter documentation can be found [here](./docs/design/exporter.md)