Add Druid Complete Docs (#699)

* Add druid concepts Signed-off-by: Tapajit Chandra Paul <[email protected]>
kubedb · Nov 14, 2024 · 4fec952 · 4fec952
1 parent c684c32
commit 4fec952
Show file tree

Hide file tree

Showing 130 changed files with 12,370 additions and 595 deletions.
diff --git a/docs/guides/README.md b/docs/guides/README.md
@@ -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.

diff --git a/docs/guides/druid/README.md b/docs/guides/druid/README.md
@@ -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                                                                 |   &#10003;   |
-| Druid Dependency Management (MySQL, PostgreSQL and ZooKeeper)              |   &#10003;   |
-| Authentication & Authorization                                             |   &#10003;   |
-| Custom Configuration                                                       |   &#10003;   |
-| Backup/Recovery: Instant, Scheduled ( [KubeStash](https://kubestash.com/)) |   &#10003;   |
-| Monitoring with Prometheus & Grafana                                       |   &#10003;   |
-| Builtin Prometheus Discovery                                               |   &#10003;   |
-| Using Prometheus operator                                                  |   &#10003;   |
-| Externally manageable Auth Secret                                          |   &#10003;   |
-| Reconfigurable Health Checker                                              |   &#10003;   |
-| Persistent volume                                                          |   &#10003;   | 
-| Dashboard ( Druid Web Console )                                            |   &#10003;   |
+| Features                                                                           | Availability |
+|------------------------------------------------------------------------------------|:-----:|
+| Clustering                                                                         |   &#10003; |
+| Druid Dependency Management (MySQL, PostgreSQL and ZooKeeper)                      |   &#10003; |
+| Authentication & Authorization                                                     |   &#10003; |
+| Custom Configuration                                                               |   &#10003; |
+| Backup/Recovery: Instant, Scheduled ( [KubeStash](https://kubestash.com/))         |   &#10003; |
+| Monitoring with Prometheus & Grafana                                               |   &#10003; |
+| Builtin Prometheus Discovery                                                       |   &#10003; |
+| Using Prometheus operator                                                          |   &#10003; |
+| Externally manageable Auth Secret                                                  |   &#10003; |
+| Reconfigurable Health Checker                                                      |   &#10003; |
+| Persistent volume                                                                  |   &#10003; | 
+| Dashboard ( Druid Web Console )                                                    |   &#10003; |
+| Automated Version Update                                                           |  &#10003;  |
+| Automatic Vertical Scaling                                                         |  &#10003;  |
+| Automated Horizontal Scaling                                                       |  &#10003;  |
+| Automated db-configure Reconfiguration                                             |  &#10003;  |
+| TLS: Add, Remove, Update, Rotate ( [Cert Manager](https://cert-manager.io/docs/) ) |  &#10003;  |
+| Automated Reprovision                                                              |  &#10003;  |
+| Automated Volume Expansion                                                         |  &#10003;  |
+| Autoscaling (vertically)                                                           |  &#10003;  |
 
 ## 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
 
@@ -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).
diff --git a/docs/guides/druid/autoscaler/_index.md b/docs/guides/druid/autoscaler/_index.md
@@ -0,0 +1,10 @@
+---
+title: Autoscaling
+menu:
+  docs_{{ .version }}:
+    identifier: guides-druid-autoscaler
+    name: Autoscaling
+    parent: guides-druid
+    weight: 100
+menu_name: docs_{{ .version }}
+---
diff --git a/docs/guides/druid/autoscaler/compute/_index.md b/docs/guides/druid/autoscaler/compute/_index.md
@@ -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 }}
+---