Skip to content

Commit

Permalink
Add druid quickstart guide
Browse files Browse the repository at this point in the history
Signed-off-by: Tapajit Chandra Paul <[email protected]>
  • Loading branch information
tapojit047 committed May 3, 2024
1 parent c7f117f commit 7b60bf4
Show file tree
Hide file tree
Showing 14 changed files with 914 additions and 6 deletions.
9 changes: 9 additions & 0 deletions docs/examples/druid/quickstart/minio-tenant-override.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
tenant:
pools:
- servers: 1
volumesPerServer: 1
size: 1Gi
certificate:
requestAutoCert: false
buckets:
- name: "druid"
18 changes: 18 additions & 0 deletions docs/examples/druid/quickstart/mysql-demo.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
apiVersion: kubedb.com/v1alpha2
kind: MySQL
metadata:
name: mysql-demo
namespace: druid
spec:
version: "8.0.35"
storage:
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 100Mi
init:
script:
configMap:
name: my-init-script
2 changes: 2 additions & 0 deletions docs/examples/druid/quickstart/mysql-init-script.sql
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
CREATE DATABASE druid;

16 changes: 16 additions & 0 deletions docs/examples/druid/quickstart/zk-demo.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
apiVersion: kubedb.com/v1alpha2
kind: ZooKeeper
metadata:
name: zk-demo
namespace: druid
spec:
version: "3.7.2"
replicas: 1
storage:
resources:
requests:
storage: "100Mi"
storageClassName: "standard"
accessModes:
- ReadWriteOnce
terminationPolicy: "WipeOut"
63 changes: 63 additions & 0 deletions docs/guides/druid/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: Druid
menu:
docs_{{ .version }}:
identifier: dr-readme-druid
name: Druid
parent: dr-druid-guides
weight: 10
menu_name: docs_{{ .version }}
section_menu_id: guides
url: /docs/{{ .version }}/guides/druid/
aliases:
- /docs/{{ .version }}/guides/druid/README/
---

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


| Features | Availability |
|--------------------------------------|:------------:|
| Clustering | &#10003; |
| Authentication | &#10003; |
| Custom Configuration | &#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; |
| Druid Web Console | &#10003; |

## Supported Druid Versions

KubeDB supports The following Druid versions.
- `25.0.0`
- `28.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.
## Lifecycle of Druid Object

<!---
ref : https://cacoo.com/diagrams/bbB63L6KRIbPLl95/9A5B0
--->

<p align="center">
<img alt="lifecycle" src="/docs/images/druid/Druid-CRD-Lifecycle.png">
</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.)

[//]: # (- Detail concepts of [Druid object]&#40;/docs/guides/druid/concepts/druid.md&#41;.)

[//]: # (- Want to hack on KubeDB? Check our [contribution guidelines]&#40;/docs/CONTRIBUTING.md&#41;.)
10 changes: 10 additions & 0 deletions docs/guides/druid/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Druid
menu:
docs_{{ .version }}:
identifier: dr-druid-guides
name: Druid
parent: guides
weight: 10
menu_name: docs_{{ .version }}
---
10 changes: 10 additions & 0 deletions docs/guides/druid/quickstart/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Druid Quickstart
menu:
docs_{{ .version }}:
identifier: dr-quickstart-druid
name: Quickstart
parent: dr-druid-guides
weight: 15
menu_name: docs_{{ .version }}
---
Binary file added docs/guides/druid/quickstart/overview/img.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 7b60bf4

Please sign in to comment.