Skip to content

Commit

Permalink
added more figures
Browse files Browse the repository at this point in the history
Signed-off-by: obaydullahmhs <[email protected]>
  • Loading branch information
obaydullahmhs committed Aug 28, 2024
1 parent 484ac39 commit 9b7d413
Show file tree
Hide file tree
Showing 22 changed files with 508 additions and 51 deletions.
4 changes: 2 additions & 2 deletions docs/guides/kafka/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ KubeDB supports The following Kafka versions. Supported version are applicable f


## User Guide
- [Quickstart Kafka](/docs/guides/kafka/quickstart/overview/kafka/index.md) with KubeDB Operator.
- [Quickstart ConnectCluster](/docs/guides/kafka/quickstart/overview/connectcluster/index.md) with KubeDB Operator.
- [Quickstart Kafka](/docs/guides/kafka/quickstart/kafka/index.md) with KubeDB Operator.
- [Quickstart ConnectCluster](/docs/guides/kafka/quickstart/connectcluster/index.md) with KubeDB Operator.
- Kafka Clustering supported by KubeDB
- [Combined Clustering](/docs/guides/kafka/clustering/combined-cluster/index.md)
- [Topology Clustering](/docs/guides/kafka/clustering/topology-cluster/index.md)
Expand Down
8 changes: 4 additions & 4 deletions docs/guides/kafka/autoscaler/compute/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Kafka Compute Autoscaling Overview
menu:
docs_{{ .version }}:
identifier: mg-auto-scaling-overview
identifier: kf-auto-scaling-overview
name: Overview
parent: mg-compute-auto-scaling
parent: kf-compute-auto-scaling
weight: 10
menu_name: docs_{{ .version }}
section_menu_id: guides
Expand All @@ -19,7 +19,7 @@ This guide will give an overview on how KubeDB Autoscaler operator autoscales th
## Before You Begin

- You should be familiar with the following `KubeDB` concepts:
- [Kafka](/docs/guides/mongodb/concepts/mongodb.md)
- [Kafka](/docs/guides/kafka/concepts/kafka.md)
- [KafkaAutoscaler](/docs/guides/kafka/concepts/kafkaautoscaler.md)
- [KafkaOpsRequest](/docs/guides/kafka/concepts/kafkaopsrequest.md)

Expand All @@ -28,7 +28,7 @@ This guide will give an overview on how KubeDB Autoscaler operator autoscales th
The following diagram shows how KubeDB Autoscaler operator autoscales the resources of `Kafka` database components. Open the image in a new tab to see the enlarged version.

<figure align="center">
  <img alt="Compute Auto Scaling process of Kafka" src="/docs/images/mongodb/compute-process.svg">
  <img alt="Compute Auto Scaling process of Kafka" src="/docs/images/day-2-operation/kafka/kf-compute-autoscaling.svg">
<figcaption align="center">Fig: Compute Auto Scaling process of Kafka</figcaption>
</figure>

Expand Down
6 changes: 3 additions & 3 deletions docs/guides/kafka/autoscaler/storage/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Kafka Storage Autoscaling Overview
menu:
docs_{{ .version }}:
identifier: mg-storage-auto-scaling-overview
identifier: kf-storage-auto-scaling-overview
name: Overview
parent: mg-storage-auto-scaling
parent: kf-storage-auto-scaling
weight: 10
menu_name: docs_{{ .version }}
section_menu_id: guides
Expand All @@ -28,7 +28,7 @@ This guide will give an overview on how KubeDB Autoscaler operator autoscales th
The following diagram shows how KubeDB Autoscaler operator autoscales the resources of `Kafka` cluster components. Open the image in a new tab to see the enlarged version.

<figure align="center">
  <img alt="Storage Auto Scaling process of Kafka" src="/docs/images/mongodb/storage-process.svg">
  <img alt="Storage Auto Scaling process of Kafka" src="/docs/images/day-2-operation/kafka/kf-storage-autoscaling.svg">
<figcaption align="center">Fig: Storage Auto Scaling process of Kafka</figcaption>
</figure>

Expand Down
10 changes: 5 additions & 5 deletions docs/guides/kafka/cli/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,21 +23,21 @@ KubeDB comes with its own cli. It is called `kubedb` cli. `kubedb` can be used t
`kubectl create` creates a database CRD object in `default` namespace by default. Following command will create a Kafka object as specified in `kafka.yaml`.

```bash
$ kubectl create -f druid-quickstart.yaml
$ kubectl create -f kafka.yaml
kafka.kubedb.com/kafka created
```

You can provide namespace as a flag `--namespace`. Provided namespace should match with namespace specified in input file.

```bash
$ kubectl create -f druid-quickstart.yaml --namespace=kube-system
$ kubectl create -f kafka.yaml --namespace=kube-system
kafka.kubedb.com/kafka created
```

`kubectl create` command also considers `stdin` as input.

```bash
cat druid-quickstart.yaml | kubectl create -f -
cat kafka.yaml | kubectl create -f -
```

### How to List Objects
Expand Down Expand Up @@ -692,14 +692,14 @@ kafka.kubedb.com "kafka" deleted
You can also use YAML files to delete objects. The following command will delete an Kafka using the type and name specified in `kafka.yaml`.

```bash
$ kubectl delete -f druid-quickstart.yaml
$ kubectl delete -f kafka.yaml
kafka.kubedb.com "kafka" deleted
```

`kubectl delete` command also takes input from `stdin`.

```bash
cat druid-quickstart.yaml | kubectl delete -f -
cat kafka.yaml | kubectl delete -f -
```

To delete database with matching labels, use `--selector` flag. The following command will delete kafka with label `app.kubernetes.io/instance=kafka`.
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/kafka/concepts/connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,8 @@ Deletion policy `WipeOut` will delete the connector from the ConnectCluster when

## Next Steps

- Learn how to use KubeDB to run a Apache Kafka cluster [here](/docs/guides/kafka/quickstart/overview/kafka/index.md).
- Learn how to use KubeDB to run a Apache Kafka Connect cluster [here](/docs/guides/kafka/quickstart/overview/connectcluster/index.md).
- Learn how to use KubeDB to run a Apache Kafka cluster [here](/docs/guides/kafka/quickstart/kafka/index.md).
- Learn how to use KubeDB to run a Apache Kafka Connect cluster [here](/docs/guides/kafka/quickstart/connectcluster/index.md).
- Detail concepts of [KafkaConnectorVersion object](/docs/guides/kafka/concepts/kafkaconnectorversion.md).
- Learn to use KubeDB managed Kafka objects using [CLIs](/docs/guides/kafka/cli/cli.md).
- Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md).
2 changes: 1 addition & 1 deletion docs/guides/kafka/concepts/kafkaautoscaler.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ section_menu_id: guides

## What is KafkaAutoscaler

`KafkaAutoscaler` is a Kubernetes `Custom Resource Definitions` (CRD). It provides a declarative configuration for autoscaling [Kafka](https://www.mongodb.com/) compute resources and storage of database components in a Kubernetes native way.
`KafkaAutoscaler` is a Kubernetes `Custom Resource Definitions` (CRD). It provides a declarative configuration for autoscaling [Kafka](https://kafka.apache.org/) compute resources and storage of database components in a Kubernetes native way.

## KafkaAutoscaler CRD Specifications

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/kafka/concepts/kafkaconnectorversion.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,4 +88,4 @@ helm upgrade -i kubedb oci://ghcr.io/appscode-charts/kubedb \

- Learn about Kafka CRD [here](/docs/guides/kafka/concepts/kafka.md).
- Learn about ConnectCluster CRD [here](/docs/guides/kafka/concepts/connectcluster.md).
- Deploy your first ConnectCluster with KubeDB by following the guide [here](/docs/guides/kafka/quickstart/overview/connectcluster/index.md).
- Deploy your first ConnectCluster with KubeDB by following the guide [here](/docs/guides/kafka/quickstart/connectcluster/index.md).
2 changes: 1 addition & 1 deletion docs/guides/kafka/concepts/kafkaversion.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,4 @@ helm upgrade -i kubedb oci://ghcr.io/appscode-charts/kubedb \
## Next Steps

- Learn about Kafka CRD [here](/docs/guides/kafka/concepts/kafka.md).
- Deploy your first Kafka database with KubeDB by following the guide [here](/docs/guides/kafka/quickstart/overview/kafka/index.md).
- Deploy your first Kafka database with KubeDB by following the guide [here](/docs/guides/kafka/quickstart/kafka/index.md).
4 changes: 2 additions & 2 deletions docs/guides/kafka/connectcluster/connectcluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -502,8 +502,8 @@ If you are just testing some basic functionalities, you might want to avoid addi

## Next Steps

- [Quickstart Kafka](/docs/guides/kafka/quickstart/overview/kafka/index.md) with KubeDB Operator.
- [Quickstart ConnectCluster](/docs/guides/kafka/quickstart/overview/connectcluster/index.md) with KubeDB Operator.
- [Quickstart Kafka](/docs/guides/kafka/quickstart/kafka/index.md) with KubeDB Operator.
- [Quickstart ConnectCluster](/docs/guides/kafka/quickstart/connectcluster/index.md) with KubeDB Operator.
- Use [kubedb cli](/docs/guides/kafka/cli/cli.md) to manage databases like kubectl for Kubernetes.
- Detail concepts of [ConnectCluster object](/docs/guides/kafka/concepts/connectcluster.md).
- Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md).
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: ConnectCluster Quickstart
menu:
docs_{{ .version }}:
identifier: kf-kafka-overview-connectcluster
identifier: kf-kafka-quickstart-connectcluster
name: ConnectCluster
parent: kf-overview-kafka
parent: kf-quickstart-kafka
weight: 15
menu_name: docs_{{ .version }}
section_menu_id: guides
Expand Down Expand Up @@ -37,9 +37,9 @@ NAME STATUS AGE
demo Active 9s
```

> Note: YAML files used in this tutorial are stored in [guides/kafka/quickstart/overview/connectcluster/yamls](https://github.com/kubedb/docs/tree/{{< param "info.version" >}}/docs/guides/kafka/quickstart/overview/connectcluster/yamls) folder in GitHub repository [kubedb/docs](https://github.com/kubedb/docs).
> Note: YAML files used in this tutorial are stored in [guides/kafka/quickstart/connectcluster/yamls](https://github.com/kubedb/docs/tree/{{< param "info.version" >}}/docs/guides/kafka/quickstart/connectcluster/yamls) folder in GitHub repository [kubedb/docs](https://github.com/kubedb/docs).
> We have designed this tutorial to demonstrate a production setup of KubeDB managed Apache Kafka Connect Cluster. If you just want to try out KubeDB, you can bypass some safety features following the tips [here](/docs/guides/kafka/quickstart/overview/connectcluster/index.md#tips-for-testing).
> We have designed this tutorial to demonstrate a production setup of KubeDB managed Apache Kafka Connect Cluster. If you just want to try out KubeDB, you can bypass some safety features following the tips [here](/docs/guides/kafka/quickstart/connectcluster/index.md#tips-for-testing).
## Find Available ConnectCluster Versions

Expand Down Expand Up @@ -142,11 +142,11 @@ spec:
value: distributed
```

Before create ConnectCluster, you have to deploy a `Kafka` cluster first. To deploy kafka cluster, follow the [Kafka Quickstart](/docs/guides/kafka/quickstart/overview/kafka/index.md) guide. Let's assume `kafka-quickstart` is already deployed using KubeDB.
Before create ConnectCluster, you have to deploy a `Kafka` cluster first. To deploy kafka cluster, follow the [Kafka Quickstart](/docs/guides/kafka/quickstart/kafka/index.md) guide. Let's assume `kafka-quickstart` is already deployed using KubeDB.
Let's create the ConnectCluster CR that is shown above:

```bash
$ kubectl apply -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/guides/kafka/quickstart/overview/connectcluster/yamls/connectcluster.yaml
$ kubectl apply -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/guides/kafka/quickstart/connectcluster/yamls/connectcluster.yaml
connectcluster.kafka.kubedb.com/connectcluster-quickstart created
```

Expand Down Expand Up @@ -430,7 +430,7 @@ Here,
Now, create the `Connector` CR that is shown above:

```bash
$ kubectl apply -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/guides/kafka/quickstart/overview/connectcluster/yamls/mongodb-source-connector.yaml
$ kubectl apply -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/guides/kafka/quickstart/connectcluster/yamls/mongodb-source-connector.yaml
connector.kafka.kubedb.com/mongodb-source-connector created
```

Expand Down Expand Up @@ -514,8 +514,8 @@ If you are just testing some basic functionalities, you might want to avoid addi

## Next Steps

- [Quickstart Kafka](/docs/guides/kafka/quickstart/overview/kafka/index.md) with KubeDB Operator.
- [Quickstart ConnectCluster](/docs/guides/kafka/quickstart/overview/connectcluster/index.md) with KubeDB Operator.
- [Quickstart Kafka](/docs/guides/kafka/quickstart/kafka/index.md) with KubeDB Operator.
- [Quickstart ConnectCluster](/docs/guides/kafka/quickstart/connectcluster/index.md) with KubeDB Operator.
- Use [kubedb cli](/docs/guides/kafka/cli/cli.md) to manage databases like kubectl for Kubernetes.
- Detail concepts of [ConnectCluster object](/docs/guides/kafka/concepts/connectcluster.md).
- Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md).
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Kafka Quickstart
menu:
docs_{{ .version }}:
identifier: kf-kafka-overview-kafka
identifier: kf-kafka-quickstart-kafka
name: Kafka
parent: kf-overview-kafka
parent: kf-quickstart-kafka
weight: 10
menu_name: docs_{{ .version }}
section_menu_id: guides
Expand Down Expand Up @@ -37,9 +37,9 @@ NAME STATUS AGE
demo Active 9s
```

> Note: YAML files used in this tutorial are stored in [guides/kafka/quickstart/overview/yamls](https://github.com/kubedb/docs/tree/{{< param "info.version" >}}/docs/guides/kafka/quickstart/overview/yamls) folder in GitHub repository [kubedb/docs](https://github.com/kubedb/docs).
> Note: YAML files used in this tutorial are stored in [guides/kafka/quickstart/kafka/yamls](https://github.com/kubedb/docs/tree/{{< param "info.version" >}}/docs/guides/kafka/quickstart/kafka/yamls) folder in GitHub repository [kubedb/docs](https://github.com/kubedb/docs).
> We have designed this tutorial to demonstrate a production setup of KubeDB managed Apache Kafka. If you just want to try out KubeDB, you can bypass some safety features following the tips [here](/docs/guides/kafka/quickstart/overview/kafka/index.md#tips-for-testing).
> We have designed this tutorial to demonstrate a production setup of KubeDB managed Apache Kafka. If you just want to try out KubeDB, you can bypass some safety features following the tips [here](/docs/guides/kafka/quickstart/kafka/index.md#tips-for-testing).
## Find Available StorageClass

Expand Down Expand Up @@ -102,7 +102,7 @@ spec:
```
```bash
$ kubectl apply -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/guides/Kafka/quickstart/overview/kafka/yamls/kafka-v1.yaml
$ kubectl apply -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/guides/Kafka/quickstart/kafka/yamls/kafka-v1.yaml
kafka.kubedb.com/kafka-quickstart created
```

Expand All @@ -127,7 +127,7 @@ spec:
```
```bash
$ kubectl apply -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/guides/Kafka/quickstart/overview/kafka/yamls/kafka-v1alpha2.yaml
$ kubectl apply -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/guides/Kafka/quickstart/kafka/yamls/kafka-v1alpha2.yaml
kafka.kubedb.com/kafka-quickstart created
```

Expand Down Expand Up @@ -434,8 +434,8 @@ If you are just testing some basic functionalities, you might want to avoid addi

## Next Steps

- [Quickstart Kafka](/docs/guides/kafka/quickstart/overview/kafka/index.md) with KubeDB Operator.
- [Quickstart ConnectCluster](/docs/guides/kafka/quickstart/overview/connectcluster/index.md) with KubeDB Operator.
- [Quickstart Kafka](/docs/guides/kafka/quickstart/kafka/index.md) with KubeDB Operator.
- [Quickstart ConnectCluster](/docs/guides/kafka/quickstart/connectcluster/index.md) with KubeDB Operator.
- Kafka Clustering supported by KubeDB
- [Combined Clustering](/docs/guides/kafka/clustering/combined-cluster/index.md)
- [Topology Clustering](/docs/guides/kafka/clustering/topology-cluster/index.md)
Expand Down
10 changes: 0 additions & 10 deletions docs/guides/kafka/quickstart/overview/_index.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/guides/kafka/scaling/vertical-scaling/combined.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ $ kubectl create ns demo
namespace/demo created
```

> **Note:** YAML files used in this tutorial are stored in [docs/examples/mongodb](/docs/examples/kafka) directory of [kubedb/docs](https://github.com/kubedb/docs) repository.
> **Note:** YAML files used in this tutorial are stored in [docs/examples/kafka](/docs/examples/kafka) directory of [kubedb/docs](https://github.com/kubedb/docs) repository.
## Apply Vertical Scaling on Combined Cluster

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/kafka/scaling/vertical-scaling/topology.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ $ kubectl create ns demo
namespace/demo created
```

> **Note:** YAML files used in this tutorial are stored in [docs/examples/mongodb](/docs/examples/kafka) directory of [kubedb/docs](https://github.com/kubedb/docs) repository.
> **Note:** YAML files used in this tutorial are stored in [docs/examples/kafka](/docs/examples/kafka) directory of [kubedb/docs](https://github.com/kubedb/docs) repository.
## Apply Vertical Scaling on Topology Cluster

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/kafka/volume-expansion/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This guide will give an overview on how KubeDB Ops-manager operator expand the v
The following diagram shows how KubeDB Ops-manager operator expand the volumes of `Kafka` database components. Open the image in a new tab to see the enlarged version.

<figure align="center">
  <img alt="Volume Expansion process of Kafka" src="/docs/images/day-2-operation/mongodb/mg-volume-expansion.svg">
  <img alt="Volume Expansion process of Kafka" src="/docs/images/day-2-operation/kafka/kf-volume-expansion.svg">
<figcaption align="center">Fig: Volume Expansion process of Kafka</figcaption>
</figure>

Expand Down
Loading

0 comments on commit 9b7d413

Please sign in to comment.