Skip to content

Commit

Permalink
Fix errors
Browse files Browse the repository at this point in the history
Signed-off-by: Tapajit Chandra Paul <[email protected]>
  • Loading branch information
tapojit047 committed Nov 1, 2024
1 parent 39e9d6c commit 7483261
Show file tree
Hide file tree
Showing 23 changed files with 36 additions and 35 deletions.
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
2 changes: 1 addition & 1 deletion docs/guides/druid/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ KubeDB supports The following Druid versions.
- `28.0.1`
- `30.0.0`

> 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 Down
6 changes: 3 additions & 3 deletions docs/guides/druid/autoscaler/compute/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Druid Topology Autoscaling
menu:
docs_{{ .version }}:
identifier: guides-druid-autoscaler-guide
name: Topology Cluster
parent: guides-druid-autoscaler
identifier: guides-druid-autoscaler-compute-guide
name: Guide
parent: guides-druid-autoscaler-compute
weight: 20
menu_name: docs_{{ .version }}
section_menu_id: guides
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/druid/autoscaler/storage/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Druid Topology Autoscaling
menu:
docs_{{ .version }}:
identifier: guides-druid-autoscaler-storage-guide
name: Topology Cluster
name: Guide
parent: guides-druid-autoscaler-storage
weight: 20
menu_name: docs_{{ .version }}
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/druid/autoscaler/storage/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Druid Storage Autoscaling Overview
menu:
docs_{{ .version }}:
identifier: guides-druid-autoscaler-storage-guide
identifier: guides-druid-autoscaler-storage-overview
name: Overview
parent: guides-druid-autoscaler-storage
weight: 10
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/druid/clustering/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -921,5 +921,5 @@ namespace "demo" deleted
## Next Steps

- Detail concepts of [Druid object](/docs/guides/druid/concepts/database/index.md).
- Detail concepts of [DruidDBVersion object](/docs/guides/druid/concepts/catalog/index.md).
- Detail concepts of [DruidDBVersion object](/docs/guides/druid/concepts/druidversion.md).
- Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md).
4 changes: 2 additions & 2 deletions docs/guides/druid/clustering/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Data servers divide operations between Historical and MiddleManager services.
[Historical](https://druid.apache.org/docs/latest/design/historical/) services handle storage and querying on historical data, including any streaming data that has been in the system long enough to be committed. Historical services download segments from deep storage and respond to queries about these segments. They don't accept writes.

#### MiddleManager service
[MiddleManager](https://druid.apache.org/docs/latest/design/middleManager) services handle ingestion of new data into the cluster. They are responsible for reading from external data sources and publishing new Druid segments.
[MiddleManager](https://druid.apache.org/docs/latest/design/middlemanager) services handle ingestion of new data into the cluster. They are responsible for reading from external data sources and publishing new Druid segments.

## External dependencies
In addition to its built-in service types, Druid also has three external dependencies. These are intended to be able to leverage existing infrastructure, where present.
Expand Down Expand Up @@ -111,5 +111,5 @@ For more details, please see the [ZooKeeper](https://druid.apache.org/docs/lates

## Next Steps

- [Deploy Druid Group Replication](/docs/guides/druid/clustering/group-replication/index.md) using KubeDB.
- [Deploy Druid Cluster](/docs/guides/druid/clustering/overview/index.md) using KubeDB.
- Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md)
4 changes: 2 additions & 2 deletions docs/guides/druid/concepts/druid.md
Original file line number Diff line number Diff line change
Expand Up @@ -522,8 +522,8 @@ Know details about KubeDB Health checking from this [blog post](https://appscode

- Learn how to use KubeDB to run Apache Druid cluster [here](/docs/guides/druid/README.md).
- Deploy [dedicated topology cluster](/docs/guides/druid/clustering/guide/index.md) for Apache Druid
- Deploy [combined cluster](/docs/guides/druid/clustering/combined-cluster/index.md) for Apache Druid
- Monitor your Druid cluster with KubeDB using [`out-of-the-box` Prometheus operator](/docs/guides/druid/monitoring/using-prometheus-operator.md).
- Detail concepts of [DruidVersion object](/docs/guides/druid/concepts/druidversion.md).
- Learn to use KubeDB managed Druid objects using [CLIs](/docs/guides/druid/cli/cli.md).

[//]: # (- Learn to use KubeDB managed Druid objects using [CLIs]&#40;/docs/guides/druid/cli/cli.md&#41;.)
- Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md).
2 changes: 1 addition & 1 deletion docs/guides/druid/concepts/druidversion.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,4 +99,4 @@ helm upgrade -i kubedb oci://ghcr.io/appscode-charts/kubedb \
## Next Steps

- Learn about Druid CRD [here](/docs/guides/druid/concepts/druid.md).
- Deploy your first Druid database with KubeDB by following the guide [here](/docs/guides/druid/quickstart/druid/index.md).
- Deploy your first Druid database with KubeDB by following the guide [here](/docs/guides/druid/quickstart/guide/index.md).
6 changes: 3 additions & 3 deletions docs/guides/druid/monitoring/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,8 @@ Here, we have specified that we are going to monitor this server using Prometheu
## Next Steps

- Learn how to use KubeDB to run a Apache Druid cluster [here](/docs/guides/druid/README.md).
- Deploy [dedicated topology cluster](/docs/guides/druid/clustering/topology-cluster/index.md) for Apache Druid
- Deploy [combined cluster](/docs/guides/druid/clustering/combined-cluster/index.md) for Apache Druid
- Deploy [dedicated topology cluster](/docs/guides/druid/clustering/overview/index.md) for Apache Druid
- Detail concepts of [DruidVersion object](/docs/guides/druid/concepts/druidversion.md).
- Learn to use KubeDB managed Druid objects using [CLIs](/docs/guides/druid/cli/cli.md).

[//]: # (- Learn to use KubeDB managed Druid objects using [CLIs]&#40;/docs/guides/druid/cli/cli.md&#41;.)
- Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md).
2 changes: 1 addition & 1 deletion docs/guides/druid/monitoring/using-builtin-prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,6 @@ kubectl delete ns monitoring

## Next Steps

- Learn how to configure [Druid Topology](/docs/guides/druid/clustering/topology-cluster/index.md).
- Learn how to configure [Druid Topology](/docs/guides/druid/clustering/overview/index.md).
- Monitor your Druid database with KubeDB using [`out-of-the-box` Prometheus operator](/docs/guides/druid/monitoring/using-prometheus-operator.md).
- Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md).
10 changes: 5 additions & 5 deletions docs/guides/druid/monitoring/using-prometheus-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ Forwarding from [::1]:9090 -> 9090
Now, we can access the dashboard at `localhost:9090`. Open [http://localhost:9090](http://localhost:9090) in your browser. You should see `metrics` endpoint of `druid-with-monitoring-stats` service as one of the targets.

<p align="center">
  <img alt="Prometheus Target" src="/docs/guides/druid/monitoring/images/druid-promethues.png" style="padding:10px">
  <img alt="Prometheus Target" src="/docs/guides/druid/monitoring/images/druid-prometheus.png" style="padding:10px">
</p>

Check the `endpoint` and `service` labels. It verifies that the target is our expected database. Now, you can view the collected metrics and create a graph from homepage of this Prometheus dashboard. You can also use this Prometheus server as data source for [Grafana](https://grafana.com/) and create a beautiful dashboard with collected metrics.
Expand All @@ -335,9 +335,9 @@ kubectl delete ns demo

## Next Steps

- Learn how to use KubeDB to run a Apache Druid cluster [here](/docs/guides/druid/README.md).
- Deploy [dedicated topology cluster](/docs/guides/druid/clustering/topology-cluster/index.md) for Apache Druid
- Deploy [combined cluster](/docs/guides/druid/clustering/combined-cluster/index.md) for Apache Druid
- Learn how to use KubeDB to run Apache Druid cluster [here](/docs/guides/druid/README.md).
- Deploy [dedicated cluster](/docs/guides/druid/clustering/overview/index.md) for Apache Druid
[//]: # (- Deploy [combined cluster]&#40;/docs/guides/druid/clustering/combined-cluster/index.md&#41; for Apache Druid)
- Detail concepts of [DruidVersion object](/docs/guides/druid/concepts/druidversion.md).
- Learn to use KubeDB managed Druid objects using [CLIs](/docs/guides/druid/cli/cli.md).
[//]: # (- Learn to use KubeDB managed Druid objects using [CLIs]&#40;/docs/guides/druid/cli/cli.md&#41;.)
- Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md).
2 changes: 1 addition & 1 deletion docs/guides/druid/quickstart/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Here, we have `standard` StorageClass in our cluster from [Local Path Provisione

## Find Available DruidVersion

When you install the KubeDB operator, it registers a CRD named [DruidVersion](/docs/guides/druid/concepts/catalog.md). The installation process comes with a set of tested DruidVersion objects. Let's check available DruidVersions by,
When you install the KubeDB operator, it registers a CRD named [DruidVersion](/docs/guides/druid/concepts/druidversion.md). The installation process comes with a set of tested DruidVersion objects. Let's check available DruidVersions by,

```bash
$ kubectl get druidversion
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/druid/reconfigure/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Reconfigure Druid Topology
menu:
docs_{{ .version }}:
identifier: guides-druid-reconfigure-guide
name: Topology
name: Guide
parent: guides-druid-reconfigure
weight: 30
menu_name: docs_{{ .version }}
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/druid/scaling/horizontal-scaling/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This guide will show you how to use `KubeDB` Ops-manager operator to scale the D

- You should be familiar with the following `KubeDB` concepts:
- [Druid](/docs/guides/druid/concepts/druid.md)
- [Topology](/docs/guides/druid/clustering/topology-cluster/index.md)
- [Topology](/docs/guides/druid/clustering/overview/index.md)
- [DruidOpsRequest](/docs/guides/druid/concepts/druidopsrequest.md)
- [Horizontal Scaling Overview](/docs/guides/druid/scaling/horizontal-scaling/overview.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/druid/scaling/horizontal-scaling/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Druid Horizontal Scaling Overview
menu:
docs_{{ .version }}:
identifier: guides-druid-scaling-horizontal-scaling-guide
identifier: guides-druid-scaling-horizontal-scaling-overview
name: Overview
parent: guides-druid-scaling-horizontal-scaling
weight: 10
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/druid/scaling/vertical-scaling/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Vertical Scaling Druid Cluster
menu:
docs_{{ .version }}:
identifier: guides-druid-scaling-vertical-scaling-guide
name: Topology Cluster
name: Guide
parent: guides-druid-scaling-vertical-scaling
weight: 30
menu_name: docs_{{ .version }}
Expand All @@ -24,7 +24,7 @@ This guide will show you how to use `KubeDB` Ops-manager operator to update the

- You should be familiar with the following `KubeDB` concepts:
- [Druid](/docs/guides/druid/concepts/druid.md)
- [Topology](/docs/guides/druid/clustering/topology-cluster/index.md)
- [Topology](/docs/guides/druid/clustering/overview/index.md)
- [DruidOpsRequest](/docs/guides/druid/concepts/druidopsrequest.md)
- [Vertical Scaling Overview](/docs/guides/druid/scaling/vertical-scaling/overview.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/druid/scaling/vertical-scaling/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Druid Vertical Scaling Overview
menu:
docs_{{ .version }}:
identifier: guides-druid-scaling-vertical-scaling-guide
identifier: guides-druid-scaling-vertical-scaling-overview
name: Overview
parent: guides-druid-scaling-vertical-scaling
weight: 10
Expand Down
3 changes: 2 additions & 1 deletion docs/guides/druid/tls/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,7 @@ kubectl delete ns demo
- Detail concepts of [Druid object](/docs/guides/druid/concepts/druid.md).
- Monitor your Druid cluster with KubeDB using [out-of-the-box Prometheus operator](/docs/guides/druid/monitoring/using-prometheus-operator.md).
- Monitor your Druid cluster with KubeDB using [out-of-the-box builtin-Prometheus](/docs/guides/druid/monitoring/using-builtin-prometheus.md).
- Use [kubedb cli](/docs/guides/druid/cli/cli.md) to manage databases like kubectl for Kubernetes.

[//]: # (- 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](/docs/CONTRIBUTING.md).
2 changes: 1 addition & 1 deletion docs/guides/druid/tls/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Druid TLS/SSL Encryption Overview
menu:
docs_{{ .version }}:
identifier: guides-druid-tls-guide
identifier: guides-druid-tls-overview
name: Overview
parent: guides-druid-tls
weight: 10
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/druid/update-version/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Update Version Overview
menu:
docs_{{ .version }}:
identifier: guides-druid-update-version-guide
identifier: guides-druid-update-version-overview
name: Overview
parent: guides-druid-update-version
weight: 10
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/druid/volume-expansion/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Druid Topology Volume Expansion
menu:
docs_{{ .version }}:
identifier: guides-druid-volume-expansion-guide
name: Topology
name: Guide
parent: guides-druid-volume-expansion
weight: 30
menu_name: docs_{{ .version }}
Expand All @@ -26,7 +26,7 @@ This guide will show you how to use `KubeDB` Ops-manager operator to expand the

- You should be familiar with the following `KubeDB` concepts:
- [Druid](/docs/guides/druid/concepts/druid.md)
- [Topology](/docs/guides/druid/clustering/topology-cluster/index.md)
- [Topology](/docs/guides/druid/clustering/overview/index.md)
- [DruidOpsRequest](/docs/guides/druid/concepts/druidopsrequest.md)
- [Volume Expansion Overview](/docs/guides/druid/volume-expansion/overview.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/druid/volume-expansion/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Druid Volume Expansion Overview
menu:
docs_{{ .version }}:
identifier: guides-druid-volume-expansion-guide
identifier: guides-druid-volume-expansion-overview
name: Overview
parent: guides-druid-volume-expansion
weight: 10
Expand Down

0 comments on commit 7483261

Please sign in to comment.