[Maintenance] Update Features Description, Supported K8S Versions (#1563

)

.circleci/continue_config.yml

@@ -82,7 +82,7 @@ jobs:
               echo "This is not a pull request. Skipping..."
               exit 0
             fi
-            make verify-generated synchronize-v2alpha1-with-v1 generate-internal fmt yamlfmt
+            make update-generated synchronize-v2alpha1-with-v1 generate-internal fmt yamlfmt
             if [ ! -z "$(git status --porcelain)" ]; then
               echo "There are uncommited changes!"
               git status

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## [master](https://github.com/arangodb/kube-arangodb/tree/master) (N/A)
 - (Documentation) Improve documentation rendering for GitHub Pages
 - (Maintenance) Reduce binary size
+- (Maintenance) Update Features Description, Supported K8S Versions and K8S Dependency to 1.28.5
 
 ## [1.2.36](https://github.com/arangodb/kube-arangodb/tree/1.2.36) (2024-01-08)
 - (Documentation) Improvements and fixes for rendered documentation (GH pages)

Makefile

@@ -9,8 +9,8 @@ ifeq ($(shell uname),Darwin)
 	REALPATH ?= grealpath
 endif
 
-KUBERNETES_VERSION_MINOR:=25
-KUBERNETES_VERSION_PATCH:=13
+KUBERNETES_VERSION_MINOR:=28
+KUBERNETES_VERSION_PATCH:=5
 
 PROJECT := arangodb_operator
 SCRIPTDIR := $(shell pwd)
@@ -261,7 +261,7 @@ PROTOSOURCES := $(shell find ./ -type f  -name '*.proto' $(foreach EXCLUDE_DIR,$
 
 .DEFAULT_GOAL := all
 .PHONY: all
-all: check-vars verify-generated build
+all: check-vars build
 
 .PHONY: compile
 compile: check-vars build
@@ -394,7 +394,7 @@ update-generated:
 	@ln -s -f $(SCRIPTDIR) $(ORGDIR)/kube-arangodb
 	@$(SED) -e 's/^/\/\/ /' -e 's/ *$$//' $(ROOTDIR)/tools/codegen/license-header.txt > $(ROOTDIR)/tools/codegen/boilerplate.go.txt
 	GOPATH=$(GOBUILDDIR) $(VENDORDIR)/k8s.io/code-generator/generate-groups.sh  \
-			"all" \
+			"client lister informer deepcopy" \
 			"github.com/arangodb/kube-arangodb/pkg/generated" \
 			"github.com/arangodb/kube-arangodb/pkg/apis" \
 			"deployment:v1 replication:v1 storage:v1alpha backup:v1 deployment:v2alpha1 replication:v2alpha1 apps:v1 ml:v1alpha1" \
@@ -408,10 +408,6 @@ update-generated:
 			--go-header-file "./tools/codegen/boilerplate.go.txt" \
 			$(VERIFYARGS)
 
-.PHONY: verify-generated
-verify-generated:
-	@${MAKE} -B -s VERIFYARGS=--verify-only update-generated
-
 dashboard/assets.go:
 	cd $(DASHBOARDDIR) && docker build -t $(DASHBOARDBUILDIMAGE) -f Dockerfile.build $(DASHBOARDDIR)
 	@mkdir -p $(DASHBOARDDIR)/build

README.md

@@ -19,7 +19,6 @@ Each of these uses involves a different custom resource:
 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.
 
-
 ## State
 
 The ArangoDB Kubernetes Operator is Production ready.
@@ -121,6 +120,85 @@ To upgrade to the Enterprise Edition, you need to get in touch with the ArangoDB
 
 [END_INJECT]: # (featuresEnterpriseTable)
 
+## Flags
+
+```
+Flags:
+      --action.PVCResize.concurrency int                       Define limit of concurrent PVC Resizes on the cluster (default 32)
+      --agency.refresh-delay duration                          The Agency refresh delay (0 = no delay) (default 500ms)
+      --agency.refresh-interval duration                       The Agency refresh interval (0 = do not refresh)
+      --agency.retries int                                     The Agency retries (0 = no retries) (default 1)
+      --api.enabled                                            Enable operator HTTP and gRPC API (default true)
+      --api.grpc-port int                                      gRPC API port to listen on (default 8728)
+      --api.http-port int                                      HTTP API port to listen on (default 8628)
+      --api.jwt-key-secret-name string                         Name of secret containing key used to sign JWT. If there is no such secret present, value will be saved here (default "arangodb-operator-api-jwt-key")
+      --api.jwt-secret-name string                             Name of secret which will contain JWT to authenticate API requests. (default "arangodb-operator-api-jwt")
+      --api.tls-secret-name string                             Name of secret containing tls.crt & tls.key for HTTPS API (if empty, self-signed certificate is used)
+      --backup-concurrent-uploads int                          Number of concurrent uploads per deployment (default 4)
+      --chaos.allowed                                          Set to allow chaos in deployments. Only activated when allowed and enabled in deployment
+      --crd.install                                            Install missing CRD if access is possible (default true)
+      --crd.validation-schema stringArray                      Overrides default set of CRDs which should have validation schema enabled <crd-name>=<true/false>.
+      --deployment.feature.agency-poll                         Enable Agency Poll for Enterprise deployments - Required ArangoDB 3.8.0 or higher (default true)
+      --deployment.feature.all                                 Enable ALL Features
+      --deployment.feature.async-backup-creation               Create backups asynchronously to avoid blocking the operator and reaching the timeout - Required ArangoDB 3.8.0 or higher
+      --deployment.feature.deployment-spec-defaults-restore    Restore defaults from last accepted state of deployment - Required ArangoDB 3.8.0 or higher (default true)
+      --deployment.feature.enforced-resign-leadership          Enforce ResignLeadership and ensure that Leaders are moved from restarted DBServer - Required ArangoDB 3.8.0 or higher (default true)
+      --deployment.feature.ephemeral-volumes                   Enables ephemeral volumes for apps and tmp directory - Required ArangoDB 3.8.0 or higher
+      --deployment.feature.failover-leadership                 Support for leadership in fail-over mode - Required ArangoDB 3.8.0 or higher
+      --deployment.feature.init-containers-copy-resources      Copy resources spec to built-in init containers if they are not specified - Required ArangoDB 3.8.0 or higher (default true)
+      --deployment.feature.init-containers-upscale-resources   Copy resources spec to built-in init containers if they are not specified or lower - Required ArangoDB 3.8.0 or higher (default true)
+      --deployment.feature.local-storage.pass-reclaim-policy   [LocalStorage] Pass ReclaimPolicy from StorageClass instead of using hardcoded Retain - Required ArangoDB 3.8.0 or higher
+      --deployment.feature.local-volume-replacement-check      Replace volume for local-storage if volume is unschedulable (ex. node is gone) - Required ArangoDB 3.8.0 or higher
+      --deployment.feature.random-pod-names                    Enables generating random pod names - Required ArangoDB 3.8.0 or higher
+      --deployment.feature.rebalancer-v2                       Rebalancer V2 feature - Required ArangoDB 3.10.0 or higher
+      --deployment.feature.restart-policy-always               Allow to restart containers with always restart policy - Required ArangoDB 3.8.0 or higher
+      --deployment.feature.secured-containers                  Create server's containers with non root privileges. It enables 'ephemeral-volumes' feature implicitly - Required ArangoDB 3.8.0 or higher
+      --deployment.feature.sensitive-information-protection    Hide sensitive information from metrics and logs - Required ArangoDB 3.8.0 or higher
+      --deployment.feature.short-pod-names                     Enable Short Pod Names - Required ArangoDB 3.8.0 or higher
+      --deployment.feature.timezone-management                 Enable timezone management for pods - Required ArangoDB 3.8.0 or higher
+      --deployment.feature.tls-sni                             TLS SNI Support - Required ArangoDB EE 3.8.0 or higher (default true)
+      --deployment.feature.upgrade-version-check               Enable initContainer with pre version check - Required ArangoDB 3.8.0 or higher (default true)
+      --deployment.feature.upgrade-version-check-v2            Enable initContainer with pre version check based by Operator - Required ArangoDB 3.8.0 or higher
+      --features-config-map-name string                        Name of the Feature Map ConfigMap (default "arangodb-operator-feature-config-map")
+  -h, --help                                                   help for arangodb_operator
+      --internal.scaling-integration                           Enable Scaling Integration
+      --kubernetes.burst int                                   Burst for the k8s API (default 30)
+      --kubernetes.max-batch-size int                          Size of batch during objects read (default 256)
+      --kubernetes.qps float32                                 Number of queries per second for k8s API (default 15)
+      --log.format string                                      Set log format. Allowed values: 'pretty', 'JSON'. If empty, default format is used (default "pretty")
+      --log.level stringArray                                  Set log levels in format <level> or <logger>=<level>. Possible loggers: action, agency, api-server, assertion, backup-operator, chaos-monkey, crd, deployment, deployment-ci, deployment-reconcile, deployment-replication, deployment-resilience, deployment-resources, deployment-storage, deployment-storage-pc, deployment-storage-service, http, inspector, k8s-client, ml-batchjob-operator, ml-cronjob-operator, ml-extension-operator, ml-extension-shutdown, ml-storage-operator, monitor, operator, operator-arangojob-handler, operator-v2, operator-v2-event, operator-v2-worker, panics, pod_compare, root, root-event-recorder, server, server-authentication (default [debug])
+      --memory-limit uint                                      Define memory limit for hard shutdown and the dump of goroutines. Used for testing
+      --metrics.excluded-prefixes stringArray                  List of the excluded metrics prefixes
+      --mode.single                                            Enable single mode in Operator. WARNING: There should be only one replica of Operator, otherwise Operator can take unexpected actions
+      --operator.apps                                          Enable to run the ArangoApps operator
+      --operator.backup                                        Enable to run the ArangoBackup operator
+      --operator.deployment                                    Enable to run the ArangoDeployment operator
+      --operator.deployment-replication                        Enable to run the ArangoDeploymentReplication operator
+      --operator.ml                                            Enable to run the ArangoML operator
+      --operator.reconciliation.retry.count int                Count of retries during Object Update operations in the Reconciliation loop (default 25)
+      --operator.reconciliation.retry.delay duration           Delay between Object Update operations in the Reconciliation loop (default 1s)
+      --operator.storage                                       Enable to run the ArangoLocalStorage operator
+      --operator.version                                       Enable only version endpoint in Operator
+      --reconciliation.delay duration                          Delay between reconciliation loops (<= 0 -> Disabled)
+      --scope string                                           Define scope on which Operator works. Legacy - pre 1.1.0 scope with limited cluster access (default "legacy")
+      --server.admin-secret-name string                        Name of secret containing username + password for login to the dashboard (default "arangodb-operator-dashboard")
+      --server.allow-anonymous-access                          Allow anonymous access to the dashboard
+      --server.host string                                     Host to listen on (default "0.0.0.0")
+      --server.port int                                        Port to listen on (default 8528)
+      --server.tls-secret-name string                          Name of secret containing tls.crt & tls.key for HTTPS server (if empty, self-signed certificate is used)
+      --shutdown.delay duration                                The delay before running shutdown handlers (default 2s)
+      --shutdown.timeout duration                              Timeout for shutdown handlers (default 30s)
+      --timeout.agency duration                                The Agency read timeout (default 10s)
+      --timeout.arangod duration                               The request timeout to the ArangoDB (default 5s)
+      --timeout.arangod-check duration                         The version check request timeout to the ArangoDB (default 2s)
+      --timeout.backup-arangod duration                        The request timeout to the ArangoDB during backup calls (default 30s)
+      --timeout.backup-upload duration                         The request timeout to the ArangoDB during uploading files (default 5m0s)
+      --timeout.k8s duration                                   The request timeout to the kubernetes (default 2s)
+      --timeout.reconciliation duration                        The reconciliation timeout to the ArangoDB CR (default 1m0s)
+      --timeout.shard-rebuild duration                         Timeout after which particular out-synced shard is considered as failed and rebuild is triggered (default 1h0m0s)
+      --timeout.shard-rebuild-retry duration                   Timeout after which rebuild shards retry flow is triggered (default 4h0m0s)
+```
+
 ## Installation and Usage
 
 Docker images: