mirrors/kube-arangodb
1
0
Fork 0
mirror of https://github.com/arangodb/kube-arangodb.git synced 2024-12-14 11:57:37 +00:00
Code Activity
kube-arangodb/README.md

332 lines
33 KiB
Markdown
Raw Normal View History

Adding READMEs
2018-02-06 07:16:21 +00:00
# ArangoDB Kubernetes Operator
Add CircleCI status badge (#1556)
2024-01-09 20:57:06 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/arangodb/kube-arangodb.svg)](https://hub.docker.com/r/arangodb/kube-arangodb/) [![CircleCI](https://dl.circleci.com/status-badge/img/gh/arangodb/kube-arangodb/tree/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/arangodb/kube-arangodb/tree/master)
Added docker pulls badge
2018-09-11 13:03:30 +00:00
Improve documentation rendering for GitHub Pages (#1558)
2024-01-08 11:28:31 +00:00
The ArangoDB Kubernetes Operator (`kube-arangodb`) is a set of operators
that you deploy in your Kubernetes cluster to:
- Manage deployments of the [ArangoDB database](https://arangodb.com/)
- Manage backups
- Provide `PersistentVolumes` on local storage of your nodes for optimal storage performance.
- 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 [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.
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.
Adding READMEs
2018-02-06 07:16:21 +00:00
State update
2018-04-06 11:58:19 +00:00
## State
Update README
2022-03-24 23:19:51 +00:00
The ArangoDB Kubernetes Operator is Production ready.
Adding READMEs
2018-02-06 07:16:21 +00:00
Improve documentation rendering for GitHub Pages (#1558)
2024-01-08 11:28:31 +00:00
[Documentation](https://arangodb.github.io/kube-arangodb/)
Cleaning up deployment
2018-03-12 11:18:50 +00:00
[Feature] Generate feature list (#1362)
2023-07-24 15:10:59 +00:00
### Limits
(Documentation) Use Jekyll-compatible markers for section injection (#1462)
2023-10-25 07:34:01 +00:00
[START_INJECT]: # (limits)
[Feature] Generate feature list (#1362)
2023-07-24 15:10:59 +00:00
| Limit | Description | Community | Enterprise |
|:-------------------|:-----------------------------------------------------------------------------|:----------|:-----------|
| Cluster size limit | Limits of the nodes (DBServers & Coordinators) supported in the Cluster mode | 64 | 1024 |
(Documentation) Use Jekyll-compatible markers for section injection (#1462)
2023-10-25 07:34:01 +00:00
[END_INJECT]: # (limits)
[Feature] Generate feature list (#1362)
2023-07-24 15:10:59 +00:00
Updated State
2018-06-19 10:02:21 +00:00
### Production readiness state
Feature-wise production readiness.
2019-06-07 10:02:04 +00:00
Beginning with Version 0.3.11 we maintain a production readiness
state for individual new features, since we expect that new
features will first be released with an "alpha" or "beta" readiness
state and over time move to full "production readiness".
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
Operator will support Kubernetes versions supported on providers and maintained by Kubernetes.
[Feature] Pod Security Context (#601)
2020-07-22 12:24:22 +00:00
Once version is not supported anymore it will go into "Deprecating" state and will be marked as deprecated on Minor release.
Update README
2022-03-24 23:19:51 +00:00
Kubernetes versions starting from 1.18 are supported and tested, charts and manifests can use API Versions which are not present in older versions.
[Update] Deprecate K8S < 1.16 (#637)
2020-09-17 21:20:22 +00:00
Feature-wise production readiness.
2019-06-07 10:02:04 +00:00
The following table has the general readiness state, the table below
covers individual newer features separately.
(Documentation) Use Jekyll-compatible markers for section injection (#1462)
2023-10-25 07:34:01 +00:00
[START_INJECT]: # (kubernetesVersionsTable)
[Maintenance] Generate README Platforms (#1257)
2023-02-24 11:16:35 +00:00
| Platform | Kubernetes Version | ArangoDB Version | State | Remarks | Provider Remarks |
|:--------------------|:-------------------|:-----------------|:-----------|:------------------------------------------|:-----------------------------------|
[Maintenance] Update Documentation (#1570)
2024-01-09 18:21:13 +00:00
| 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 | | |
[Feature] Generate feature list (#1362)
2023-07-24 15:10:59 +00:00
(Documentation) Use Jekyll-compatible markers for section injection (#1462)
2023-10-25 07:34:01 +00:00
[END_INJECT]: # (kubernetesVersionsTable)
[Feature] Generate feature list (#1362)
2023-07-24 15:10:59 +00:00
#### Operator Features
(Documentation) Use Jekyll-compatible markers for section injection (#1462)
2023-10-25 07:34:01 +00:00
[START_INJECT]: # (featuresCommunityTable)
[Feature] Add --deployment.feature.init-containers-upscale-resources … (#1557)
2024-01-03 21:46:17 +00:00
| Feature | Operator Version | Introduced | ArangoDB Version | ArangoDB Edition | State | Enabled | Flag | Remarks |
|:------------------------------------------------------------------------------|:-----------------|:-----------|:-----------------|:----------------------|:-------------|:--------|:-------------------------------------------------------|:--------------------------------------------------------------------------------------|
| Upscale resources spec in init containers | 1.2.36 | 1.2.36 | >= 3.8.0 | Community, Enterprise | Production | True | --deployment.feature.init-containers-upscale-resources | Upscale resources spec to built-in init containers if they are not specified or lower |
| Create backups asynchronously | 1.2.35 | 1.2.35 | >= 3.8.0 | Community, Enterprise | Production | False | --deployment.feature.async-backup-creation | Create backups asynchronously to avoid blocking the operator and reaching the timeout |
| Enforced ResignLeadership | 1.2.34 | 1.2.34 | >= 3.8.0 | Community, Enterprise | Production | True | --deployment.feature.enforced-resign-leadership | Enforce ResignLeadership and ensure that Leaders are moved from restarted DBServer |
| Copy resources spec to init containers | 1.2.33 | 1.2.33 | >= 3.8.0 | Community, Enterprise | Production | True | --deployment.feature.init-containers-copy-resources | Copy resources spec to built-in init containers if they are not specified |
| [Rebalancer V2](docs/features/rebalancer_v2.md) | 1.2.31 | 1.2.31 | >= 3.10.0 | Community, Enterprise | Alpha | False | --deployment.feature.rebalancer-v2 | N/A |
| [Secured containers](docs/features/secured_containers.md) | 1.2.31 | 1.2.31 | >= 3.8.0 | Community, Enterprise | Alpha | False | --deployment.feature.secured-containers | If set to True Operator will run containers in secure mode |
| Version Check V2 | 1.2.31 | 1.2.31 | >= 3.8.0 | Community, Enterprise | Alpha | False | --deployment.feature.upgrade-version-check-V2 | N/A |
| [Operator Ephemeral Volumes](docs/features/ephemeral_volumes.md) | 1.2.31 | 1.2.2 | >= 3.8.0 | Community, Enterprise | Beta | False | --deployment.feature.ephemeral-volumes | N/A |
| [Force Rebuild Out Synced Shards](docs/features/rebuild_out_synced_shards.md) | 1.2.27 | 1.2.27 | >= 3.8.0 | Community, Enterprise | Production | False | --deployment.feature.force-rebuild-out-synced-shards | It should be used only if user is aware of the risks. |
| [Spec Default Restore](docs/features/deployment_spec_defaults.md) | 1.2.25 | 1.2.21 | >= 3.8.0 | Community, Enterprise | Beta | True | --deployment.feature.deployment-spec-defaults-restore | If set to False Operator will not change ArangoDeployment Spec |
| Version Check | 1.2.23 | 1.1.4 | >= 3.8.0 | Community, Enterprise | Production | True | --deployment.feature.upgrade-version-check | N/A |
| [Failover Leader service](docs/features/failover_leader_service.md) | 1.2.13 | 1.2.13 | >= 3.8.0 | Community, Enterprise | Production | False | --deployment.feature.failover-leadership | N/A |
| Graceful Restart | 1.2.5 | 1.0.7 | >= 3.8.0 | Community, Enterprise | Production | True | ---deployment.feature.graceful-shutdown | N/A |
| Optional Graceful Restart | 1.2.0 | 1.2.5 | >= 3.8.0 | Community, Enterprise | Production | False | --deployment.feature.optional-graceful-shutdown | N/A |
| Operator Internal Metrics Exporter | 1.2.0 | 1.2.0 | >= 3.8.0 | Community, Enterprise | Production | True | --deployment.feature.metrics-exporter | N/A |
| Operator Maintenance Management Support | 1.2.0 | 1.0.7 | >= 3.8.0 | Community, Enterprise | Production | True | --deployment.feature.maintenance | N/A |
| Encryption Key Rotation Support | 1.2.0 | 1.0.3 | >= 3.8.0 | Enterprise | NotSupported | False | --deployment.feature.encryption-rotation | N/A |
| TLS Runtime Rotation Support | 1.1.0 | 1.0.4 | >= 3.8.0 | Enterprise | Production | True | --deployment.feature.tls-rotation | N/A |
| JWT Rotation Support | 1.1.0 | 1.0.3 | >= 3.8.0 | Enterprise | Production | True | --deployment.feature.jwt-rotation | N/A |
| Operator Single Mode | 1.0.4 | 1.0.4 | >= 3.8.0 | Community, Enterprise | Production | False | --mode.single | Only 1 instance of Operator allowed in namespace when feature is enabled |
| TLS SNI Support | 1.0.3 | 1.0.3 | >= 3.8.0 | Enterprise | Production | True | --deployment.feature.tls-sni | N/A |
| Disabling of liveness probes | 0.3.11 | 0.3.10 | >= 3.8.0 | Community, Enterprise | Production | True | N/A | N/A |
| Pod Disruption Budgets | 0.3.11 | 0.3.10 | >= 3.8.0 | Community, Enterprise | Production | True | N/A | N/A |
| Prometheus Metrics Exporter | 0.3.11 | 0.3.10 | >= 3.8.0 | Community, Enterprise | Production | True | N/A | Prometheus required |
| Sidecar Containers | 0.3.11 | 0.3.10 | >= 3.8.0 | Community, Enterprise | Production | True | N/A | N/A |
| Volume Claim Templates | 0.3.11 | 0.3.10 | >= 3.8.0 | Community, Enterprise | Production | True | N/A | N/A |
| Volume Resizing | 0.3.11 | 0.3.10 | >= 3.8.0 | Community, Enterprise | Production | True | N/A | N/A |
[Feature] Generate feature list (#1362)
2023-07-24 15:10:59 +00:00
(Documentation) Use Jekyll-compatible markers for section injection (#1462)
2023-10-25 07:34:01 +00:00
[END_INJECT]: # (featuresCommunityTable)
[Feature] Generate feature list (#1362)
2023-07-24 15:10:59 +00:00
#### Operator Enterprise Only Features
To upgrade to the Enterprise Edition, you need to get in touch with the ArangoDB team. [Contact us](https://www.arangodb.com/contact/) for more details.
(Documentation) Use Jekyll-compatible markers for section injection (#1462)
2023-10-25 07:34:01 +00:00
[START_INJECT]: # (featuresEnterpriseTable)
[Feature] Generate feature list (#1362)
2023-07-24 15:10:59 +00:00
| Feature | Operator Version | Introduced | ArangoDB Version | ArangoDB Edition | State | Enabled | Flag | Remarks |
|:-------------------------------------------------------|:-----------------|:-----------|:-----------------|:-----------------|:-----------|:--------|:-----|:----------------------------------------------------------------------------|
[Feature] [ML] Add deployment fields to Extension spec (#1527)
2023-12-06 11:20:32 +00:00
| ArangoML integration | 1.2.36 | 1.2.36 | >= 3.8.0 | Enterprise | Alpha | True | N/A | Support for ArangoML CRDs |
[Feature] Generate feature list (#1362)
2023-07-24 15:10:59 +00:00
| AgencyCache | 1.2.30 | 1.2.30 | >= 3.8.0 | Enterprise | Production | True | N/A | Enable Agency Cache mechanism in the Operator (Increase limit of the nodes) |
| Member Maintenance Support | 1.2.25 | 1.2.16 | >= 3.8.0 | Enterprise | Production | True | N/A | Enable Member Maintenance during planned restarts |
Remove obsolete docs, restructure for better UX (#1447)
2023-10-19 07:14:14 +00:00
| [Rebalancer](docs/features/rebalancer.md) | 1.2.15 | 1.2.5 | >= 3.8.0 | Enterprise | Production | True | N/A | N/A |
[Feature] Generate feature list (#1362)
2023-07-24 15:10:59 +00:00
| [TopologyAwareness](docs/design/topology_awareness.md) | 1.2.4 | 1.2.4 | >= 3.8.0 | Enterprise | Production | True | N/A | N/A |
(Documentation) Use Jekyll-compatible markers for section injection (#1462)
2023-10-25 07:34:01 +00:00
[END_INJECT]: # (featuresEnterpriseTable)
Publish warning with README and revert instructions to 0.3.7.
2019-02-26 08:56:28 +00:00
[Maintenance] Update Features Description, Supported K8S Versions (#1563)
2024-01-08 15:58:01 +00:00
## 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)
```
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
## Installation and Usage
Preparations for 0.3.16. (#454) * Preparations for 0.3.16. * Document permissions needed. * Add note to README.md.
2019-09-25 10:38:10 +00:00
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
Docker images:
Updated to 1.2.37
2024-01-22 14:59:17 +00:00
- Community Edition: `arangodb/kube-arangodb:1.2.37`
- Enterprise Edition: `arangodb/kube-arangodb-enterprise:1.2.37`
Preparations for 0.3.16. (#454) * Preparations for 0.3.16. * Document permissions needed. * Add note to README.md.
2019-09-25 10:38:10 +00:00
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
### Installation of latest release using Kubectl
Improve installation and upgrade instructions.
2019-04-08 09:42:21 +00:00
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
This procedure can also be used for upgrades and will not harm any
running ArangoDB deployments.
##### Community Edition
Improve installation and upgrade instructions.
2019-04-08 09:42:21 +00:00
```bash
Updated to 1.2.37
2024-01-22 14:59:17 +00:00
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/1.2.37/manifests/arango-crd.yaml
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/1.2.37/manifests/arango-deployment.yaml
Improve installation and upgrade instructions.
2019-04-08 09:42:21 +00:00
# To use `ArangoLocalStorage`, also run
Updated to 1.2.37
2024-01-22 14:59:17 +00:00
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/1.2.37/manifests/arango-storage.yaml
Improve installation and upgrade instructions.
2019-04-08 09:42:21 +00:00
# To use `ArangoDeploymentReplication`, also run
Updated to 1.2.37
2024-01-22 14:59:17 +00:00
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/1.2.37/manifests/arango-deployment-replication.yaml
Improve installation and upgrade instructions.
2019-04-08 09:42:21 +00:00
```
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
##### Enterprise Edition
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
```bash
Updated to 1.2.37
2024-01-22 14:59:17 +00:00
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/1.2.37/manifests/enterprise-crd.yaml
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/1.2.37/manifests/enterprise-deployment.yaml
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
# To use `ArangoLocalStorage`, also run
Updated to 1.2.37
2024-01-22 14:59:17 +00:00
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/1.2.37/manifests/enterprise-storage.yaml
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
# To use `ArangoDeploymentReplication`, also run
Updated to 1.2.37
2024-01-22 14:59:17 +00:00
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/1.2.37/manifests/enterprise-deployment-replication.yaml
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
```
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
### Installation of latest release using kustomize
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
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.
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
It is recommended to use kustomization instead of handcrafting namespace in yaml files - kustomization will replace not only resource namespaces,
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
but also namespace references in resources like ClusterRoleBinding.
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
See `manifests/kustomize` directory for available combinations of installed features.
##### Community Edition example
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
```
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
namespace: my-custom-namespace
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
resources:
Fix operator versions in readme example (#1572)
2024-01-09 13:41:07 +00:00
- https://github.com/arangodb/kube-arangodb/manifests/kustomize/crd?ref=1.2.36
- https://github.com/arangodb/kube-arangodb/manifests/kustomize/deployment?ref=1.2.36
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
```
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
##### Enterprise Edition example
```
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
namespace: my-custom-namespace
resources:
Fix operator versions in readme example (#1572)
2024-01-09 13:41:07 +00:00
- https://github.com/arangodb/kube-arangodb/manifests/kustomize-enterprise/crd?ref=1.2.36
- https://github.com/arangodb/kube-arangodb/manifests/kustomize-enterprise/deployment?ref=1.2.36
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
```
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
### Installation of latest release using Helm
Only use this procedure for clean installation of the operator. For upgrades see next section
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
##### Community Edition
```bash
# The following will install the operator and basic CRDs resources.
Updated to 1.2.37
2024-01-22 14:59:17 +00:00
helm install --generate-name https://github.com/arangodb/kube-arangodb/releases/download/1.2.37/kube-arangodb-1.2.37.tgz
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
# To use `ArangoLocalStorage`, set field `operator.features.storage` to true
Updated to 1.2.37
2024-01-22 14:59:17 +00:00
helm install --generate-name https://github.com/arangodb/kube-arangodb/releases/download/1.2.37/kube-arangodb-1.2.37.tgz --set "operator.features.storage=true"
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
```
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
##### Enterprise Edition
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
```bash
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
# The following will install the operator and basic CRDs resources.
Updated to 1.2.37
2024-01-22 14:59:17 +00:00
helm install --generate-name https://github.com/arangodb/kube-arangodb/releases/download/1.2.37/kube-arangodb-1.2.37.tgz --set "operator.image=arangodb/kube-arangodb-enterprise:1.2.37"
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
# To use `ArangoLocalStorage`, set field `operator.features.storage` to true
Updated to 1.2.37
2024-01-22 14:59:17 +00:00
helm install --generate-name https://github.com/arangodb/kube-arangodb/releases/download/1.2.37/kube-arangodb-1.2.37.tgz --set "operator.image=arangodb/kube-arangodb-enterprise:1.2.37" --set "operator.features.storage=true"
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
```
### Upgrading the operator using Helm
To upgrade the operator to the latest version with Helm, you have to
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
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!
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
Therefore, you have to use `helm list` to find the deployments for the
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
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:
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
```
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
kube-arangodb-1-1696919877 default 1 2023-10-10 08:37:57.884783199 +0200 CEST deployed kube-arangodb-1.2.31
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
```
So here, you would have to do
```bash
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
helm delete kube-arangodb-1-1696919877
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
```
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
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.
Updated to 1.2.37
2024-01-22 14:59:17 +00:00
helm install --generate-name https://github.com/arangodb/kube-arangodb/releases/download/1.2.37/kube-arangodb-1.2.37.tgz
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
# To use `ArangoLocalStorage`, set field `operator.features.storage` to true
Updated to 1.2.37
2024-01-22 14:59:17 +00:00
helm install --generate-name https://github.com/arangodb/kube-arangodb/releases/download/1.2.37/kube-arangodb-1.2.37.tgz --set "operator.features.storage=true"
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
```
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
##### Enterprise Edition
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
```bash
[Maintenance] Simplify and update README file (#1430) * Simplify and update README file - remove duplicated information - fix typos - update information on Upgrade process - update helm commands to be compatible with latest Helm version
2023-10-17 07:43:02 +00:00
# The following will install the operator and basic CRDs resources.
Updated to 1.2.37
2024-01-22 14:59:17 +00:00
helm install --generate-name https://github.com/arangodb/kube-arangodb/releases/download/1.2.37/kube-arangodb-1.2.37.tgz --set "operator.image=arangodb/kube-arangodb-enterprise:1.2.37"
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
# To use `ArangoLocalStorage`, set field `operator.features.storage` to true
Updated to 1.2.37
2024-01-22 14:59:17 +00:00
helm install --generate-name https://github.com/arangodb/kube-arangodb/releases/download/1.2.37/kube-arangodb-1.2.37.tgz --set "operator.image=arangodb/kube-arangodb-enterprise:1.2.37" --set "operator.features.storage=true"
[Documentation] [1.3.0] EE & CE Definitions (#1142)
2022-10-26 21:44:21 +00:00
```
Cleaning up deployment
2018-03-12 11:18:50 +00:00
## Building
```bash
Made full compilation the default make target. (#409)
2019-06-25 11:55:48 +00:00
DOCKERNAMESPACE=<your dockerhub account> make
Splitting operator in two parts
2018-03-19 10:09:20 +00:00
kubectl apply -f manifests/arango-deployment-dev.yaml
# To use `ArangoLocalStorage`, also run
kubectl apply -f manifests/arango-storage-dev.yaml
Updated readme. Included deployment-replication manifest
2018-06-19 09:47:56 +00:00
# To use `ArangoDeploymentReplication`, also run
kubectl apply -f manifests/arango-deployment-replication-dev.yaml
Cleaning up deployment
2018-03-12 11:18:50 +00:00
```
Copy permalink