You are looking at the documentation of a prior release. To read the documentation of the latest release, please
visit here.
New to KubeDB? Please start here.
Supported Elasticsearch Features
| Features | Availability |
|---|---|
| Clustering | ✓ |
| Authentication (using Search Guard) | ✓ |
| Authorization (using Search Guard) | ✓ |
| TLS certificates (using Search Guard) | ✓ |
| Persistent Volume | ✓ |
| Instant Backup | ✓ |
| Scheduled Backup | ✓ |
| Initialization from Script | ✗ |
| Initialization from Snapshot | ✓ |
| Builtin Prometheus Discovery | ✓ |
| Using CoreOS Prometheus Operator | ✓ |
| Custom Configuration | ✓ |
| Using Custom Docker Image | ✓ |
Life Cycle of an Elasticsearch Object
Supported Elasticsearch Version
| KubeDB Version | Elasticsearch:2.3 | Elasticsearch:5.6 | Elasticsearch:6.2 | Elasticsearch:6.3 | Elasticsearch:6.4 |
|---|---|---|---|---|---|
| 0.1.0 - 0.7.0 | ✓ | ✗ | ✗ | ✗ | ✗ |
| 0.8.0 | ✗ | ✓ | ✓ | ✗ | ✗ |
| 0.9.0 | ✗ | ✓ | ✓ | ✓ | ✓ |
| 0.10.0 | ✗ | ✓ | ✓ | ✓ | ✓ |
| 0.11.0 | ✗ | ✓ | ✓ | ✓ | ✓ |
| 0.12.0 | ✗ | ✓ | ✓ | ✓ | ✓ |
| v0.13.0-rc.0 | ✗ | ✓ | ✓ | ✓ | ✓ |
Supported ElasticsearchVersion CRD
Here, ✓ means supported and ✗ means deprecated.
| NAME | VERSION | KubeDB: 0.9.0 | KubeDB: 0.10.0 | KubeDB: 0.11.0 | KubeDB: 0.12.0 | KubeDB: v0.13.0-rc.0 |
|---|---|---|---|---|---|---|
| 5.6 | 5.6 | ✗ | ✗ | ✗ | ✗ | ✗ |
| 5.6-v1 | 5.6 | ✓ | ✓ | ✓ | ✓ | ✓ |
| 5.6.4 | 5.6.4 | ✗ | ✗ | ✗ | ✗ | ✗ |
| 5.6.4-v1 | 5.6.4 | ✓ | ✓ | ✓ | ✓ | ✓ |
| 6.2 | 6.2 | ✗ | ✗ | ✗ | ✗ | ✗ |
| 6.2-v1 | 6.2 | ✓ | ✓ | ✓ | ✓ | ✓ |
| 6.2.4 | 6.2.4 | ✗ | ✗ | ✗ | ✗ | ✗ |
| 6.2.4-v1 | 6.2.4 | ✓ | ✓ | ✓ | ✓ | ✓ |
| 6.3 | 6.3 | ✗ | ✗ | ✗ | ✗ | ✗ |
| 6.3-v1 | 6.3 | ✓ | ✓ | ✓ | ✓ | ✓ |
| 6.3.0 | 6.3.0 | ✗ | ✗ | ✗ | ✗ | ✗ |
| 6.3.0-v1 | 6.3.0 | ✓ | ✓ | ✓ | ✓ | ✓ |
| 6.4 | 6.4 | ✓ | ✓ | ✓ | ✓ | ✓ |
| 6.4.0 | 6.4.0 | ✓ | ✓ | ✓ | ✓ | ✓ |
External tools dependency
| Tool | Version |
|---|---|
| Search Guard | 5.6.4-18 and 6.2.4-22.1 |
| Elasticdump | 3.3.1 and 3.3.14 |
| osm | 0.9.1 |
| yq | 2.1.1 |
User Guide
- Quickstart Elasticsearch with KubeDB Operator.
- Take instant backup of Elasticsearch database using KubeDB.
- Schedule backup of Elasticsearch database.
- Initialize Elasticsearch with Snapshot.
- Elasticsearch Topology supported by KubeDB
- Monitor your Elasticsearch database with KubeDB using
out-of-the-boxbuiltin-Prometheus. - Monitor your Elasticsearch database with KubeDB using
out-of-the-boxCoreOS Prometheus Operator. - Use private Docker registry to deploy Elasticsearch with KubeDB.
- Use kubedb cli to manage databases like kubectl for Kubernetes.
- Detail concepts of Elasticsearch object.
- Detail concepts of Snapshot object.
- Want to hack on KubeDB? Check our contribution guidelines.