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 Quickstart #638

Merged
merged 4 commits into from
May 6, 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
15 changes: 15 additions & 0 deletions docs/examples/druid/quickstart/deep-storage-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
apiVersion: v1
kind: Secret
metadata:
name: deep-storage-config
namespace: demo
stringData:
druid.storage.type: "s3"
druid.storage.bucket: "druid"
druid.storage.baseKey: "druid/segments"
druid.s3.accessKey: "minio"
druid.s3.secretKey: "minio123"
druid.s3.protocol: "http"
druid.s3.endpoint.signingRegion: "us-east-1"
druid.s3.endpoint.url: "http://myminio-hl.demo.svc.cluster.local:9000/"

52 changes: 52 additions & 0 deletions docs/examples/druid/quickstart/druid-quickstart.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
apiVersion: kubedb.com/v1alpha2
kind: Druid
metadata:
name: druid-quickstart
namespace: demo
spec:
version: 28.0.1
deepStorage:
type: s3
configSecret:
name: deep-storage-config
metadataStorage:
name: mysql-demo
namespace: demo
createTables: true
zookeeperRef:
name: zk-demo
namespace: demo
topology:
coordinators:
replicas: 1
brokers:
replicas: 1
historicals:
replicas: 1
storage:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gi
storageClassName: standard
middleManagers:
replicas: 1
storage:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gi
storageClassName: standard
routers:
replicas: 1
storageType: Durable
terminationPolicy: Delete
serviceTemplates:
- alias: primary
spec:
type: LoadBalancer
ports:
- name: routers
port: 8888
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: demo
spec:
version: "8.0.35"
storage:
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 100Mi
init:
script:
configMap:
name: my-init-script
1 change: 1 addition & 0 deletions docs/examples/druid/quickstart/mysql-init-script.sql
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
CREATE DATABASE druid;
17 changes: 17 additions & 0 deletions docs/examples/druid/quickstart/zk-demo.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiVersion: kubedb.com/v1alpha2
kind: ZooKeeper
metadata:
name: zk-demo
namespace: demo
spec:
version: "3.7.2"
adminServerPort: 8080
replicas: 1
storage:
resources:
requests:
storage: "100Mi"
storageClassName: "standard"
accessModes:
- ReadWriteOnce
terminationPolicy: "WipeOut"
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.
- [Elasticsearch](/docs/guides/elasticsearch/README.md). Shows how to manage Elasticsearch & OpenSearch using KubeDB.
- [MariaDB](/docs/guides/mariadb). Shows how to manage MariaDB using KubeDB.
- [Memcached](/docs/guides/memcached/README.md). Shows how to manage Memcached using KubeDB.
Expand Down
62 changes: 62 additions & 0 deletions docs/guides/druid/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
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 | ✓ |
| Authentication & Authorization | ✓ |
| Custom Configuration | ✓ |
| Monitoring with Prometheus & Grafana | ✓ |
| Builtin Prometheus Discovery | ✓ |
| Using Prometheus operator | ✓ |
| Externally manageable Auth Secret | ✓ |
| Reconfigurable Health Checker | ✓ |
| Persistent volume | ✓ |
| Dashboard ( Druid Web Console ) | ✓ |

## Supported Druid Versions

KubeDB supports The following Druid versions.
- `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](/docs/guides/druid/concepts/druid.md).

[//]: # (- 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/concepts/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Druid Concepts
menu:
docs_{{ .version }}:
identifier: dr-concepts-druid
name: Concepts
parent: dr-druid-guides
weight: 20
menu_name: docs_{{ .version }}
---
Loading
Loading