Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Druid Complete Docs #699

Merged
merged 16 commits into from
Nov 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ aliases:
# Guides

Guides to show you how to perform tasks with KubeDB:
- [Druid](/docs/guides/kafka/README.md). Shows how to manage Druid using KubeDB.
- [Druid](/docs/guides/druid/README.md). Shows how to manage Druid using KubeDB.
- [Elasticsearch](/docs/guides/elasticsearch/README.md). Shows how to manage Elasticsearch & OpenSearch using KubeDB.
- [Kafka](/docs/guides/kafka/README.md). Shows how to manage Kafka using KubeDB.
- [FerretDB](/docs/guides/ferretdb/README.md). Shows how to manage FerretDB using KubeDB.
Expand Down
60 changes: 35 additions & 25 deletions docs/guides/druid/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,31 +15,43 @@ aliases:

> New to KubeDB? Please start [here](/docs/README.md).

## Overview

Apache Druid is a real-time analytics database designed for fast slice-and-dice analytics ("OLAP" queries) on large data sets. Druid is most often used as a database for powering use cases where real-time ingest, fast query performance, and high uptime are important. As such, Druid is commonly used for powering GUIs of analytical applications, or as a backend for highly-concurrent APIs that need fast aggregations. Druid works best with event-oriented data.

## Supported Druid Features


| Features | Availability |
|----------------------------------------------------------------------------|:------------:|
| Clustering | ✓ |
| Druid Dependency Management (MySQL, PostgreSQL and ZooKeeper) | ✓ |
| Authentication & Authorization | ✓ |
| Custom Configuration | ✓ |
| Backup/Recovery: Instant, Scheduled ( [KubeStash](https://kubestash.com/)) | ✓ |
| Monitoring with Prometheus & Grafana | ✓ |
| Builtin Prometheus Discovery | ✓ |
| Using Prometheus operator | ✓ |
| Externally manageable Auth Secret | ✓ |
| Reconfigurable Health Checker | ✓ |
| Persistent volume | ✓ |
| Dashboard ( Druid Web Console ) | ✓ |
| Features | Availability |
|------------------------------------------------------------------------------------|:-----:|
| Clustering | ✓ |
| Druid Dependency Management (MySQL, PostgreSQL and ZooKeeper) | ✓ |
| Authentication & Authorization | ✓ |
| Custom Configuration | ✓ |
| Backup/Recovery: Instant, Scheduled ( [KubeStash](https://kubestash.com/)) | ✓ |
| Monitoring with Prometheus & Grafana | ✓ |
| Builtin Prometheus Discovery | ✓ |
| Using Prometheus operator | ✓ |
| Externally manageable Auth Secret | ✓ |
| Reconfigurable Health Checker | ✓ |
| Persistent volume | ✓ |
| Dashboard ( Druid Web Console ) | ✓ |
| Automated Version Update | ✓ |
| Automatic Vertical Scaling | ✓ |
| Automated Horizontal Scaling | ✓ |
| Automated db-configure Reconfiguration | ✓ |
| TLS: Add, Remove, Update, Rotate ( [Cert Manager](https://cert-manager.io/docs/) ) | ✓ |
| Automated Reprovision | ✓ |
| Automated Volume Expansion | ✓ |
| Autoscaling (vertically) | ✓ |

## Supported Druid Versions

KubeDB supports The following Druid versions.
- `28.0.1`
- `30.0.1`

> The listed DruidVersions are tested and provided as a part of the installation process (ie. catalog chart), but you are open to create your own [DruidVersion](/docs/guides/druid/concepts/catalog.md) object with your custom Druid image.
> The listed DruidVersions are tested and provided as a part of the installation process (ie. catalog chart), but you are open to create your own [DruidVersion](/docs/guides/druid/concepts/druidversion.md) object with your custom Druid image.

## Lifecycle of Druid Object

Expand All @@ -52,14 +64,12 @@ ref : https://cacoo.com/diagrams/bbB63L6KRIbPLl95/9A5B0
</p>

## User Guide
- [Quickstart Druid](/docs/guides/druid/quickstart/overview/index.md) with KubeDB Operator.

[//]: # (- Druid Clustering supported by KubeDB)

[//]: # ( - [Topology Clustering]&#40;/docs/guides/druid/clustering/topology-cluster/index.md&#41;)

[//]: # (- Use [kubedb cli]&#40;/docs/guides/druid/cli/cli.md&#41; to manage databases like kubectl for Kubernetes.)

- [Quickstart Druid](/docs/guides/druid/quickstart/guide/index.md) with KubeDB Operator.
- [Druid Clustering](/docs/guides/druid/clustering/overview/index.md) with KubeDB Operator.
- [Backup & Restore](/docs/guides/druid/backup/overview/index.md) Druid databases using KubeStash.
- Start [Druid with Custom Config](/docs/guides/druid/configuration/_index.md).
- Monitor your Druid database with KubeDB using [out-of-the-box Prometheus operator](/docs/guides/druid/monitoring/using-prometheus-operator.md).
- Monitor your Druid database with KubeDB using [out-of-the-box builtin-Prometheus](/docs/guides/druid/monitoring/using-builtin-prometheus.md).
- Detail concepts of [Druid object](/docs/guides/druid/concepts/druid.md).

[//]: # (- Want to hack on KubeDB? Check our [contribution guidelines]&#40;/docs/CONTRIBUTING.md&#41;.)
- Detail concepts of [DruidVersion object](/docs/guides/druid/concepts/druidversion.md).
- Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md).
10 changes: 10 additions & 0 deletions docs/guides/druid/autoscaler/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Autoscaling
menu:
docs_{{ .version }}:
identifier: guides-druid-autoscaler
name: Autoscaling
parent: guides-druid
weight: 100
menu_name: docs_{{ .version }}
---
10 changes: 10 additions & 0 deletions docs/guides/druid/autoscaler/compute/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Compute Autoscaling
menu:
docs_{{ .version }}:
identifier: guides-druid-autoscaler-compute
name: Compute Autoscaling
parent: guides-druid-autoscaler
weight: 46
menu_name: docs_{{ .version }}
---
Loading
Loading