kube-arangodb/docs

ArangoDB Kubernetes Operator

• Intro
• Using the ArangoDB Kubernetes Operator
• Architecture overview
• Features description and usage
• Custom Resources API Reference
• Operator Metrics & Alerts
• Operator Actions
• Authentication
• Custom resources overview:
  • ArangoDeployment
  • ArangoDeploymentReplication
  • ArangoLocalStorage
  • Backup
  • BackupPolicy
  • ArangoMLExtension
• Configuration and secrets
• Configuring your driver for ArangoDB access
• Using Helm
• Collecting metrics
• Services & Load balancer
• Storage configuration
• Secure connections (TLS)
• Upgrading ArangoDB version
• Scaling your ArangoDB deployment
• Draining the Kubernetes nodes
• Known issues (TBD)
• Troubleshooting
• How-to ...

Intro

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
• 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 to create an ArangoDB database deployment.
• Use an ArangoMember resource to observe and adjust individual deployment members.
• Use an ArangoBackup and ArangoBackupPolicy resources to create ArangoDB backups.
• Use an ArangoLocalStorage resource to provide local PersistentVolumes for optimal I/O performance.
• Use an ArangoDeploymentReplication resource to configure ArangoDB Datacenter-to-Datacenter Replication.
• Use an ArangoMLExtension resource to configure ArangoML for your deployment.

Continue with Using the ArangoDB Kubernetes Operator to learn how to install the ArangoDB Kubernetes operator and create your first deployment.

For more information about the production readiness state, please refer to the main README file.