Merge pull request #5 from apecloud/support/update-databases-structures

chore: update pg and kafka structure

Author: shanshanying

docs/en/preview/kubeblocks-for-kafka/01-introduction.mdx

@@ -0,0 +1,33 @@
+---
+title: Kafka
+description: Kafka
+keywords: [Kafka]
+sidebar_position: 1
+---
+
+# Kafka
+
+Apache Kafka is a distributed streaming platform designed to build real-time pipelines and can be used as a message broker or as a replacement for a log aggregation solution for big data applications.
+
+- A broker is a Kafka server that stores data and handles requests from producers and consumers. Kafka clusters consist of multiple brokers, each identified by a unique ID. Brokers work together to distribute and replicate data across the cluster.
+- KRaft was introduced in Kafka 3.3.1 in October 2022 as an alternative to Zookeeper. A subset of brokers are designated as controllers, and these controllers provide the consensus services that used to be provided by Zookeeper.
+
+## Supported Features
+
+### Lifecycle Management
+
+| Topology | Horizontal<br/>scaling | Vertical <br/>scaling | Expand<br/>volume | Restart   | Stop/Start | Configure | Expose | Switchover |
+|----------|------------------------|-----------------------|-------------------|-----------|------------|-----------|--------|------------|
+| Combined/Separated | Yes          | Yes                   | Yes               | Yes       | Yes        | Yes       | Yes    | N/A   |
+
+- Combine Mode: KRaft (Controller) and Broker components are combined in the same pod.
+- Separated Mode: KRaft (Controller) and Broker components are deployed in different pods.
+
+### Versions
+
+| Versions |
+|----------|
+| 2.7 | 2.7.0|
+| 3.3 | 3.3.2|
+
+## Reference

…er-management/create-a-kafka-cluster.mdx …-for-kafka/02-create-a-kafka-cluster.mdxdocs/en/preview/kubeblocks-for-kafka/cluster-management/create-a-kafka-cluster.mdx renamed to docs/en/preview/kubeblocks-for-kafka/02-create-a-kafka-cluster.mdx docs/en/preview/kubeblocks-for-kafka/cluster-management/create-a-kafka-cluster.mdx renamed to docs/en/preview/kubeblocks-for-kafka/02-create-a-kafka-cluster.mdx

@@ -1,8 +1,8 @@
 ---
-title: Create a cluster for Kafka
+title: Provision
 description: Guide for cluster creation for kafka
 keywords: [kafka, cluster, management]
-sidebar_position: 1
+sidebar_position: 2
 sidebar_label: Create
 ---
 
@@ -37,7 +37,7 @@ This document shows how to create a Kafka cluster.
   ```bash
   kbcli addon list
   >
-  NAME                           TYPE   STATUS     EXTRAS         AUTO-INSTALL  
+  NAME                           TYPE   STATUS     EXTRAS         AUTO-INSTALL
   ...
   kafka                          Helm   Enabled                   true
   ...
@@ -119,7 +119,7 @@ This document shows how to create a Kafka cluster.
                  resources:
                    requests:
                      storage: 1Gi
-         - name: kafka-exporter 
+         - name: kafka-exporter
            replicas: 1
            resources:
              limits:

…s-for-kafka/cluster-management/scale.mdx …review/kubeblocks-for-kafka/03-scale.mdxdocs/en/preview/kubeblocks-for-kafka/cluster-management/scale.mdx renamed to docs/en/preview/kubeblocks-for-kafka/03-scale.mdx docs/en/preview/kubeblocks-for-kafka/cluster-management/scale.mdx renamed to docs/en/preview/kubeblocks-for-kafka/03-scale.mdx

@@ -1,5 +1,5 @@
 ---
-title: Scale for a Kafka cluster
+title: Scale
 description: How to scale a Kafka cluster, horizontal scaling, vertical scaling
 keywords: [kafka, horizontal scaling, vertical scaling]
 sidebar_position: 3
@@ -64,7 +64,7 @@ mycluster   demo        kafka                kafka-3.3.2   Delete
      namespace: demo
    spec:
      clusterRef: mycluster
-     type: VerticalScaling 
+     type: VerticalScaling
      verticalScaling:
      - componentName: broker
        requests:
@@ -175,7 +175,7 @@ mycluster   demo        kafka                kafka-3.3.2   Delete
 1. Configure the parameters `--components`, `--memory`, and `--cpu` and run the command.
 
    ```bash
-    kbcli cluster vscale mycluster -n demo --components="broker" --memory="4Gi" --cpu="2" 
+    kbcli cluster vscale mycluster -n demo --components="broker" --memory="4Gi" --cpu="2"
    ```
 
    - `--components` value can be `broker` or `controller`.
@@ -358,7 +358,7 @@ From v0.9.0, besides replicas, KubeBlocks also supports scaling in and out insta
    ...
    spec:
      clusterDefinitionRef: kafka
-     clusterVersionRef: kafka-3.3.2 
+     clusterVersionRef: kafka-3.3.2
      componentSpecs:
      - name: broker
        componentDefRef: broker
@@ -438,7 +438,7 @@ In the example below, a snapshot exception occurs.
 
 ```bash
 Status:
-  conditions: 
+  conditions:
   - lastTransitionTime: "2023-02-08T04:20:26Z"
     message: VolumeSnapshot/mycluster-kafka-scaling-dbqgp: Failed to set default snapshot
       class with error cannot find default snapshot class
@@ -472,7 +472,7 @@ This exception occurs because the `VolumeSnapshotClass` is not configured. This
 
    ```bash
    kubectl delete backup -l app.kubernetes.io/instance=mycluster -n demo
-   
+
    kubectl delete volumesnapshot -l app.kubernetes.io/instance=mycluster -n demo
 
    ```

…ster-management/start-stop-a-cluster.mdx …ks-for-kafka/04-start-stop-a-cluster.mdxdocs/en/preview/kubeblocks-for-kafka/cluster-management/start-stop-a-cluster.mdx renamed to docs/en/preview/kubeblocks-for-kafka/04-start-stop-a-cluster.mdx docs/en/preview/kubeblocks-for-kafka/cluster-management/start-stop-a-cluster.mdx renamed to docs/en/preview/kubeblocks-for-kafka/04-start-stop-a-cluster.mdx

@@ -1,8 +1,8 @@
 ---
-title: Stop/Start a Kafka cluster
+title: Stop/Start
 description: How to start/stop a Kafka cluster
 keywords: [kafka, stop a kafka cluster, start a kafka cluster]
-sidebar_position: 5
+sidebar_position: 4
 sidebar_label: Stop/Start
 ---
 
@@ -57,7 +57,7 @@ You can stop/start a cluster to save computing resources. When a cluster is stop
      componentSpecs:
      - name: kafka
        componentDefRef: kafka
-       disableExporter: true  
+       disableExporter: true
        replicas: 0 # Change this value
    ...
    ```
@@ -97,7 +97,7 @@ You can stop/start a cluster to save computing resources. When a cluster is stop
    </Tabs>
 
 ## Start a cluster
-  
+
 1. Configure the name of your cluster and run the command below to start this cluster.
 
    <Tabs>
@@ -116,7 +116,7 @@ You can stop/start a cluster to save computing resources. When a cluster is stop
    spec:
      clusterName: mycluster
      type: Start
-   EOF 
+   EOF
    ```
 
    </TabItem>
@@ -138,7 +138,7 @@ You can stop/start a cluster to save computing resources. When a cluster is stop
      componentSpecs:
      - name: kafka
        componentDefRef: kafka
-       disableExporter: true   
+       disableExporter: true
        replicas: 1 # Change this value
    ...
    ```

…r-management/restart-a-kafka-cluster.mdx …for-kafka/05-restart-a-kafka-cluster.mdxdocs/en/preview/kubeblocks-for-kafka/cluster-management/restart-a-kafka-cluster.mdx renamed to docs/en/preview/kubeblocks-for-kafka/05-restart-a-kafka-cluster.mdx docs/en/preview/kubeblocks-for-kafka/cluster-management/restart-a-kafka-cluster.mdx renamed to docs/en/preview/kubeblocks-for-kafka/05-restart-a-kafka-cluster.mdx

@@ -1,8 +1,8 @@
 ---
-title: Restart Kafka cluster
+title: Restart
 description: How to restart a Kafka cluster
 keywords: [kafka, restart]
-sidebar_position: 4
+sidebar_position: 5
 sidebar_label: Restart
 ---
 
@@ -36,7 +36,7 @@ The pod role may change after the cluster restarts.
       namespace: demo
     spec:
       clusterName: mycluster
-      type: Restart 
+      type: Restart
       restart:
       - componentName: broker
     EOF
@@ -63,7 +63,7 @@ The pod role may change after the cluster restarts.
 <TabItem value="kbcli" label="kbcli">
 
 1. Restart a cluster.
-  
+
    Configure the values of `components` and `ttlSecondsAfterSucceed` and run the command below to restart a specified cluster.
 
    ```bash

…fka/cluster-management/expand-volume.mdx …ubeblocks-for-kafka/06-expand-volume.mdxdocs/en/preview/kubeblocks-for-kafka/cluster-management/expand-volume.mdx renamed to docs/en/preview/kubeblocks-for-kafka/06-expand-volume.mdx docs/en/preview/kubeblocks-for-kafka/cluster-management/expand-volume.mdx renamed to docs/en/preview/kubeblocks-for-kafka/06-expand-volume.mdx

@@ -2,7 +2,7 @@
 title: Expand volume
 description: How to expand the volume of a kafka cluster
 keywords: [kafka, expand volume, volume expansion]
-sidebar_position: 4
+sidebar_position: 6
 sidebar_label: Expand volume
 ---
 
@@ -107,12 +107,12 @@ mycluster   demo        kafka                kafka-3.3.2   Delete
    kind: Cluster
    metadata:
      name: mycluster
-     namespace: demo 
+     namespace: demo
    spec:
      clusterDefinitionRef: kafka
      clusterVersionRef: kafka-3.3.2
      componentSpecs:
-     - name: kafka 
+     - name: kafka
        componentDefRef: kafka
        volumeClaimTemplates:
        - name: data
@@ -148,7 +148,7 @@ mycluster   demo        kafka                kafka-3.3.2   Delete
 1. Configure the resources according to your needs and run the command to expand the volume.
 
    ```bash
-   kbcli cluster volume-expand mycluster -n demo --storage=30Gi --components=kafka --volume-claim-templates=data 
+   kbcli cluster volume-expand mycluster -n demo --storage=30Gi --components=kafka --volume-claim-templates=data
    ```
 
    - `--components` describes the component name for volume expansion.

…or-kafka/configuration/configuration.mdx …/kubeblocks-for-kafka/07-reconfigure.mdxdocs/en/preview/kubeblocks-for-kafka/configuration/configuration.mdx renamed to docs/en/preview/kubeblocks-for-kafka/07-reconfigure.mdx docs/en/preview/kubeblocks-for-kafka/configuration/configuration.mdx renamed to docs/en/preview/kubeblocks-for-kafka/07-reconfigure.mdx

@@ -1,14 +1,14 @@
 ---
-title: Configure cluster parameters
+title: Reconfigure
 description: Configure cluster parameters
 keywords: [kafka, parameter, configuration, reconfiguration]
-sidebar_position: 1
+sidebar_position: 7
 ---
 
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-# Configure cluster parameters
+# Reconfigure cluster parameters
 
 The KubeBlocks configuration function provides a set of consistent default configuration generation strategies for all the databases running on KubeBlocks and also provides a unified parameter configuration interface to facilitate managing parameter configuration, searching the parameter user guide, and validating parameter effectiveness.
 
@@ -158,7 +158,7 @@ You can also view the details of this configuration file and parameters.
   ```
 
 * View the user guide of a specified parameter.
-  
+
   ```bash
   kbcli cluster explain-config mycluster -n demo --param=log.cleanup.policy
   ```
@@ -177,9 +177,9 @@ You can also view the details of this configuration file and parameters.
     Scope:              Global
     Dynamic:            false
     Type:               string
-    Description:        The default cleanup policy for segments beyond the retention window. A comma separated list of valid policies. 
+    Description:        The default cleanup policy for segments beyond the retention window. A comma separated list of valid policies.
   ```
-  
+
   </details>
 
   * Allowed Values: It defines the valid value range of this parameter.
@@ -314,7 +314,7 @@ After the configuration is completed, you can search the configuration history a
 View the parameter configuration history.
 
 ```bash
-kbcli cluster describe-config mycluster -n demo                 
+kbcli cluster describe-config mycluster -n demo
 ```
 
 From the above results, there are three parameter modifications.

…ster-management/connect-to-a-cluster.mdx …ks-for-kafka/08-connect-to-a-cluster.mdxdocs/en/preview/kubeblocks-for-kafka/cluster-management/connect-to-a-cluster.mdx renamed to docs/en/preview/kubeblocks-for-kafka/08-connect-to-a-cluster.mdx docs/en/preview/kubeblocks-for-kafka/cluster-management/connect-to-a-cluster.mdx renamed to docs/en/preview/kubeblocks-for-kafka/08-connect-to-a-cluster.mdx

@@ -1,8 +1,8 @@
 ---
-title: Connect to a Kafka cluster 
+title: Connect
 description: Guide for cluster creation for kafka
 keywords: [kafka, cluster, connect, network]
-sidebar_position: 2
+sidebar_position: 8
 sidebar_label: Connect
 ---
 
@@ -28,7 +28,7 @@ Within the same Kubernetes cluster, you can directly access the Kafka cluster wi
 
    ```bash
    kubectl get svc -n demo
-   > 
+   >
    NAME                                      TYPE        CLUSTER-IP    EXTERNAL-IP   PORT(S)                               AGE
    kubernetes                                ClusterIP   10.43.0.1     <none>        443/TCP                               9d
    mycluster-kafka-cluster-broker-headless   ClusterIP   None          <none>        9092/TCP,9093/TCP,9094/TCP,5556/TCP   7d16h
@@ -61,7 +61,7 @@ Within the same Kubernetes cluster, you can directly access the Kafka cluster wi
    4. Create producer.
 
        ```bash
-       kafka-console-producer.sh --topic quickstart-events --bootstrap-server xxx-broker:9092 
+       kafka-console-producer.sh --topic quickstart-events --bootstrap-server xxx-broker:9092
        ```
 
    5. Enter："Hello, KubeBlocks" and press Enter.
@@ -120,7 +120,7 @@ If you use AWS EKS, you may want to access to the Kafka cluster from EC2 instanc
            memory: 1Gi
        serviceAccountName: kb-sa-kafka
        services:
-       - annotations: 
+       - annotations:
            service.beta.kubernetes.io/aws-load-balancer-type: nlb
            service.beta.kubernetes.io/aws-load-balancer-internal: "true"
          name: vpc
@@ -206,7 +206,7 @@ The current version only supports Kafka broker with a single replica (combined:
            memory: 1Gi
        serviceAccountName: kb-sa-kafka
        services:
-       - annotations: 
+       - annotations:
            service.beta.kubernetes.io/aws-load-balancer-type: nlb
            service.beta.kubernetes.io/aws-load-balancer-internal: "false"
          name: vpc

…ndations-for-production-environments.mdx …ndations-for-production-environments.mdxdocs/en/preview/kubeblocks-for-kafka/configuration-recommendations-for-production-environments.mdx renamed to docs/en/preview/kubeblocks-for-kafka/09-configuration-recommendations-for-production-environments.mdx docs/en/preview/kubeblocks-for-kafka/configuration-recommendations-for-production-environments.mdx renamed to docs/en/preview/kubeblocks-for-kafka/09-configuration-recommendations-for-production-environments.mdx

@@ -2,7 +2,7 @@
 title: Resource description
 description: Kafka resource description
 keywords: [kafka, java heap, hardware resource]
-sidebar_position: 3
+sidebar_position: 9
 sidebar_label: Resource description
 ---
 

…ster-management/delete-kafka-cluster.mdx …ks-for-kafka/10-delete-kafka-cluster.mdxdocs/en/preview/kubeblocks-for-kafka/cluster-management/delete-kafka-cluster.mdx renamed to docs/en/preview/kubeblocks-for-kafka/10-delete-kafka-cluster.mdx docs/en/preview/kubeblocks-for-kafka/cluster-management/delete-kafka-cluster.mdx renamed to docs/en/preview/kubeblocks-for-kafka/10-delete-kafka-cluster.mdx

@@ -1,8 +1,8 @@
 ---
-title: Delete a kafka Cluster
+title: Delete
 description: How to delete a kafka Cluster
 keywords: [kafka, delete a cluster, delete protection]
-sidebar_position: 7
+sidebar_position: 10
 sidebar_label: Delete protection
 ---