Fix all broken schemas, resource-yamls & links (#629)

Signed-off-by: Arnob kumar saha <[email protected]>
kubedb · Apr 24, 2024 · 7da0065 · 7da0065
1 parent f77a1dd
commit 7da0065
Show file tree

Hide file tree

Showing 61 changed files with 203 additions and 150 deletions.
diff --git a/docs/examples/mongodb/autoscaling/storage/mg-as-rs.yaml b/docs/examples/mongodb/autoscaling/storage/mg-as-rs.yaml
@@ -8,6 +8,7 @@ spec:
     name: mg-rs
   storage:
     replicaSet:
+      expansionMode: "Online"
       trigger: "On"
       usageThreshold: 60
       scalingThreshold: 50
diff --git a/docs/examples/mongodb/autoscaling/storage/mg-as-sh.yaml b/docs/examples/mongodb/autoscaling/storage/mg-as-sh.yaml
@@ -8,6 +8,7 @@ spec:
     name: mg-sh
   storage:
     shard:
+      expansionMode: "Online"
       trigger: "On"
       usageThreshold: 60
       scalingThreshold: 50
diff --git a/docs/examples/mongodb/autoscaling/storage/mg-as-standalone.yaml b/docs/examples/mongodb/autoscaling/storage/mg-as-standalone.yaml
@@ -8,6 +8,7 @@ spec:
     name: mg-standalone
   storage:
     standalone:
+      expansionMode: "Online"
       trigger: "On"
       usageThreshold: 60
       scalingThreshold: 50
diff --git a/...e/mops-reconfigure-inline-replicaset.yaml → ...re/mops-reconfigure-apply-replicaset.yaml b/...e/mops-reconfigure-inline-replicaset.yaml → ...re/mops-reconfigure-apply-replicaset.yaml
@@ -9,6 +9,7 @@ spec:
     name: mg-replicaset
   configuration:
     replicaSet:
-      inlineConfig: |
-        net:
-          maxIncomingConnections: 30000
+      applyConfig:
+        mongod.conf: |-
+          net:
+            maxIncomingConnections: 30000
diff --git a/docs/examples/mongodb/reconfigure/mops-reconfigure-apply-shard.yaml b/docs/examples/mongodb/reconfigure/mops-reconfigure-apply-shard.yaml
@@ -0,0 +1,25 @@
+apiVersion: ops.kubedb.com/v1alpha1
+kind: MongoDBOpsRequest
+metadata:
+  name: mops-reconfigure-inline-shard
+  namespace: demo
+spec:
+  type: Reconfigure
+  databaseRef:
+    name: mg-sharding
+  configuration:
+    shard:
+      applyConfig:
+        mongod.conf: |-
+          net:
+            maxIncomingConnections: 30000
+    configServer:
+      applyConfig:
+        mongod.conf: |-
+          net:
+            maxIncomingConnections: 30000
+    mongos:
+      applyConfig:
+        mongod.conf: |-
+          net:
+            maxIncomingConnections: 30000
diff --git a/...e/mops-reconfigure-inline-standalone.yaml → ...re/mops-reconfigure-apply-standalone.yaml b/...e/mops-reconfigure-inline-standalone.yaml → ...re/mops-reconfigure-apply-standalone.yaml
@@ -9,6 +9,7 @@ spec:
     name: mg-standalone
   configuration:
     standalone:
-      inlineConfig: |
-        net:
-          maxIncomingConnections: 30000
+      applyConfig:
+        mongod.conf: |-
+          net:
+            maxIncomingConnections: 30000
diff --git a/docs/examples/mongodb/reconfigure/mops-reconfigure-inline-shard.yaml b/docs/examples/mongodb/reconfigure/mops-reconfigure-inline-shard.yaml
diff --git a/docs/examples/mongodb/volume-expansion/mops-volume-exp-replicaset.yaml b/docs/examples/mongodb/volume-expansion/mops-volume-exp-replicaset.yaml
@@ -8,4 +8,5 @@ spec:
   databaseRef:
     name: mg-replicaset
   volumeExpansion:
+    mode: "Online"
     replicaSet: 2Gi
diff --git a/docs/examples/mongodb/volume-expansion/mops-volume-exp-shard.yaml b/docs/examples/mongodb/volume-expansion/mops-volume-exp-shard.yaml
@@ -8,5 +8,6 @@ spec:
   databaseRef:
     name: mg-sharding
   volumeExpansion:
+    mode: "Online"
     shard: 2Gi
     configServer: 2Gi
diff --git a/docs/examples/mongodb/volume-expansion/mops-volume-exp-standalone.yaml b/docs/examples/mongodb/volume-expansion/mops-volume-exp-standalone.yaml
@@ -8,4 +8,5 @@ spec:
   databaseRef:
     name: mg-standalone
   volumeExpansion:
+    mode: "Online"
     standalone: 2Gi
diff --git a/docs/examples/redis/autoscaling/storage/rd-as.yaml b/docs/examples/redis/autoscaling/storage/rd-as.yaml
@@ -8,6 +8,7 @@ spec:
     name: rd-standalone
   storage:
     standalone:
+      expansionMode: "Online"
       trigger: "On"
       usageThreshold: 60
       scalingThreshold: 50
diff --git a/...is/reconfigure/rdops-inline-reconfig.yaml → ...dis/reconfigure/rdops-apply-reconfig.yaml b/...is/reconfigure/rdops-inline-reconfig.yaml → ...dis/reconfigure/rdops-apply-reconfig.yaml
@@ -8,4 +8,6 @@ spec:
   databaseRef:
     name: sample-redis
   configuration:
-    inlineConfig: maxclients 3000
+    applyConfig:
+      redis.conf: |-
+        maxclients 3000
diff --git a/docs/guides/elasticsearch/autoscaler/storage/combined/index.md b/docs/guides/elasticsearch/autoscaler/storage/combined/index.md
@@ -135,6 +135,7 @@ spec:
     name: es-combined
   storage:
     node:
+      expansionMode: "Online"
       trigger: "On"
       usageThreshold: 60
       scalingThreshold: 50

diff --git a/docs/guides/elasticsearch/autoscaler/storage/combined/yamls/es-combined-storage-as.yaml b/docs/guides/elasticsearch/autoscaler/storage/combined/yamls/es-combined-storage-as.yaml
@@ -8,6 +8,7 @@ spec:
     name: es-combined
   storage:
     node:
+      expansionMode: "Online"
       trigger: "On"
       usageThreshold: 60
       scalingThreshold: 50
diff --git a/docs/guides/elasticsearch/autoscaler/storage/topology/index.md b/docs/guides/elasticsearch/autoscaler/storage/topology/index.md
@@ -161,6 +161,7 @@ spec:
     name: es-topology
   storage:
     data:
+      expansionMode: "Online"
       trigger: "On"
       usageThreshold: 60
       scalingThreshold: 50

diff --git a/docs/guides/elasticsearch/autoscaler/storage/topology/yamls/es-topology-storage-as.yaml b/docs/guides/elasticsearch/autoscaler/storage/topology/yamls/es-topology-storage-as.yaml
@@ -8,6 +8,7 @@ spec:
     name: es-topology
   storage:
     data:
+      expansionMode: "Online"
       trigger: "On"
       usageThreshold: 60
       scalingThreshold: 50
diff --git a/docs/guides/elasticsearch/concepts/appbinding/index.md b/docs/guides/elasticsearch/concepts/appbinding/index.md
@@ -16,7 +16,7 @@ section_menu_id: guides
 
 ## What is AppBinding
 
-An `AppBinding` is a Kubernetes `CustomResourceDefinition`(CRD) which points to an application using either its URL (usually for a non-Kubernetes resident service instance) or a Kubernetes service object (if self-hosted in a Kubernetes cluster), some optional parameters and a credential secret. To learn more about AppBinding and the problems it solves, please read this blog post: [The case for AppBinding](https://blog.byte.builders/post/the-case-for-appbinding).
+An `AppBinding` is a Kubernetes `CustomResourceDefinition`(CRD) which points to an application using either its URL (usually for a non-Kubernetes resident service instance) or a Kubernetes service object (if self-hosted in a Kubernetes cluster), some optional parameters and a credential secret. To learn more about AppBinding and the problems it solves, please read this blog post: [The case for AppBinding](https://appscode.com/blog/post/the-case-for-appbinding).
 
 If you deploy a database using [KubeDB](https://kubedb.com/docs/latest/welcome/), the `AppBinding` object will be created automatically for it. Otherwise, you have to create an `AppBinding` object manually pointing to your desired database.
 

diff --git a/docs/guides/elasticsearch/concepts/autoscaler/index.md b/docs/guides/elasticsearch/concepts/autoscaler/index.md
@@ -53,6 +53,7 @@ spec:
       resourceDiffPercentage: 10
   storage:
     node:
+      expansionMode: "Online"
       trigger: "On"
       usageThreshold: 60
       scalingThreshold: 50
@@ -108,6 +109,7 @@ spec:
       resourceDiffPercentage: 10
   storage:
     data:
+      expansionMode: "Online"
       trigger: "On"
       usageThreshold: 60
       scalingThreshold: 50

diff --git a/docs/guides/elasticsearch/concepts/elasticsearch-dashboard/index.md b/docs/guides/elasticsearch/concepts/elasticsearch-dashboard/index.md
@@ -25,7 +25,7 @@ Suppose you have a KubeDB-managed [Elasticsearch](/docs/guides/elasticsearch/con
 As with all other Kubernetes objects, an `ElasticsearchDashboard` needs `apiVersion`, `kind`, and `metadata` fields. It also needs a `spec` section.
 
 ```yaml
-apiVersion: dashboard.kubedb.com/v1alpha1
+apiVersion: elasticsearch.kubedb.com/v1alpha1
 kind: ElasticsearchDashboard
 metadata:
   name: es-cluster-dashboard

diff --git a/docs/guides/elasticsearch/concepts/elasticsearch-ops-request/index.md b/docs/guides/elasticsearch/concepts/elasticsearch-ops-request/index.md
@@ -284,6 +284,7 @@ All of them refer to [Quantity](https://v1-22.docs.kubernetes.io/docs/reference/
     databaseRef:
       name: es
     volumeExpansion:
+      mode: "Online"
       node: 4Gi
   ```
 
@@ -300,6 +301,7 @@ All of them refer to [Quantity](https://v1-22.docs.kubernetes.io/docs/reference/
     databaseRef:
       name: es
     volumeExpansion:
+      mode: "Online"
       master: 2Gi
       data: 3Gi
       ingest: 4Gi
@@ -318,6 +320,7 @@ All of them refer to [Quantity](https://v1-22.docs.kubernetes.io/docs/reference/
     databaseRef:
       name: es
     volumeExpansion:
+      mode: "Online"
       data: 5Gi
   ```
 

diff --git a/docs/guides/elasticsearch/concepts/elasticsearch/index.md b/docs/guides/elasticsearch/concepts/elasticsearch/index.md
@@ -887,7 +887,7 @@ It defines the attributes for the health checker.
 - `spec.healthChecker.failureThreshold` specifies minimum consecutive failures for the healthChecker to be considered failed.
 - `spec.healthChecker.disableWriteCheck` specifies whether to disable the writeCheck or not.
 
-Know details about KubeDB Health checking from this [blog post](https://blog.byte.builders/post/kubedb-health-checker/).
+Know details about KubeDB Health checking from this [blog post](https://appscode.com/blog/post/kubedb-health-checker/).
 
 ## Next Steps
 

diff --git a/docs/guides/elasticsearch/elasticsearch-dashboard/kibana/index.md b/docs/guides/elasticsearch/elasticsearch-dashboard/kibana/index.md
@@ -420,7 +420,7 @@ persistentvolumeclaim/data-es-cluster-master-1   Bound    pvc-53fd7683-96a6-4737
 ## Deploy ElasticsearchDashboard
 
 ```yaml
-apiVersion: dashboard.kubedb.com/v1alpha1
+apiVersion: elasticsearch.kubedb.com/v1alpha1
 kind: ElasticsearchDashboard
 metadata:
   name: es-cluster-dashboard
@@ -441,7 +441,7 @@ Let's deploy the above yaml by the following command:
 
 ```bash
 $ kubectl apply -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/guides/elasticsearch/elasticsearch-dashboard/kibana/yamls/es-cluster-dashboard.yaml
-elasticsearchdashboard.dashboard.kubedb.com/es-cluster-dashboard created
+elasticsearchdashboard.elasticsearch.kubedb.com/es-cluster-dashboard created
 ```
 
 KubeDB will create the necessary resources to deploy the dashboard
@@ -450,7 +450,7 @@ KubeDB will create the necessary resources to deploy the dashboard
 ```bash
 $ watch kubectl get elasticsearchdashboard -n demo
 NAME                   TYPE                            DATABASE     STATUS   AGE
-es-cluster-dashboard   dashboard.kubedb.com/v1alpha1   es-cluster   Ready    9m
+es-cluster-dashboard   elasticsearch.kubedb.com/v1alpha1   es-cluster   Ready    9m
 ```
 Here, Elasticsearch Dashboard is in `Ready` state. 
 

diff --git a/docs/guides/elasticsearch/elasticsearch-dashboard/kibana/yamls/es-cluster-dashboard.yaml b/docs/guides/elasticsearch/elasticsearch-dashboard/kibana/yamls/es-cluster-dashboard.yaml
@@ -1,4 +1,4 @@
-apiVersion: dashboard.kubedb.com/v1alpha1
+apiVersion: elasticsearch.kubedb.com/v1alpha1
 kind: ElasticsearchDashboard
 metadata:
   name: es-cluster-dashboard

diff --git a/docs/guides/elasticsearch/elasticsearch-dashboard/opensearch-dashboards/index.md b/docs/guides/elasticsearch/elasticsearch-dashboard/opensearch-dashboards/index.md
@@ -408,7 +408,7 @@ persistentvolumeclaim/data-os-cluster-master-1   Bound    pvc-37783550-3c3a-4280
 ## Deploy ElasticsearchDashboard
 
 ```yaml
-apiVersion: dashboard.kubedb.com/v1alpha1
+apiVersion: elasticsearch.kubedb.com/v1alpha1
 kind: ElasticsearchDashboard
 metadata:
   name: os-cluster-dashboard
@@ -429,15 +429,15 @@ Let's deploy the above yaml by the following command:
 
 ```bash
 $ kubectl apply -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/guides/elasticsearch/elasticsearch-dashboard/opensearch/yamls/os-cluster-dashboard.yaml
-elasticsearchdashboard.dashboard.kubedb.com/os-cluster-dashboard created
+elasticsearchdashboard.elasticsearch.kubedb.com/os-cluster-dashboard created
 ```
 
 KubeDB will create the necessary resources to deploy the OpenSearch dashboard according to the above specification. Let’s wait until the dashboard to be ready to use,
 
 ```bash
 $ watch kubectl get elasticsearchdashboard -n demo
 NAME                   TYPE                            DATABASE     STATUS   AGE
-os-cluster-dashboard   dashboard.kubedb.com/v1alpha1   os-cluster   Ready    9m
+os-cluster-dashboard   elasticsearch.kubedb.com/v1alpha1   os-cluster   Ready    9m
 ```
 Here, OpenSearch Dashboard is in `Ready` state. 
 

diff --git a/...asticsearch/elasticsearch-dashboard/opensearch-dashboards/yamls/os-cluster-dashboard.yaml b/...asticsearch/elasticsearch-dashboard/opensearch-dashboards/yamls/os-cluster-dashboard.yaml
@@ -1,4 +1,4 @@
-apiVersion: dashboard.kubedb.com/v1alpha1
+apiVersion: elasticsearch.kubedb.com/v1alpha1
 kind: ElasticsearchDashboard
 metadata:
   name: os-cluster-dashboard

diff --git a/docs/guides/kafka/concepts/appbinding.md b/docs/guides/kafka/concepts/appbinding.md
@@ -16,7 +16,7 @@ section_menu_id: guides
 
 ## What is AppBinding
 
-An `AppBinding` is a Kubernetes `CustomResourceDefinition`(CRD) which points to an application using either its URL (usually for a non-Kubernetes resident service instance) or a Kubernetes service object (if self-hosted in a Kubernetes cluster), some optional parameters and a credential secret. To learn more about AppBinding and the problems it solves, please read this blog post: [The case for AppBinding](https://blog.byte.builders/post/the-case-for-appbinding).
+An `AppBinding` is a Kubernetes `CustomResourceDefinition`(CRD) which points to an application using either its URL (usually for a non-Kubernetes resident service instance) or a Kubernetes service object (if self-hosted in a Kubernetes cluster), some optional parameters and a credential secret. To learn more about AppBinding and the problems it solves, please read this blog post: [The case for AppBinding](https://appscode.com/blog/post/the-case-for-appbinding).
 
 If you deploy a database using [KubeDB](https://kubedb.com/docs/latest/welcome/), `AppBinding` object will be created automatically for it. Otherwise, you have to create an `AppBinding` object manually pointing to your desired database.
 

diff --git a/docs/guides/kafka/concepts/catalog.md b/docs/guides/kafka/concepts/catalog.md
@@ -45,6 +45,8 @@ metadata:
   resourceVersion: "472767"
   uid: 36a167a3-5218-4e32-b96d-d6b5b0c86125
 spec:
+  connectCluster:
+    image: ghcr.io/appscode-images/kafka-connect-cluster:3.6.1
   db:
     image: kubedb/kafka-kraft:3.4.0
   podSecurityPolicies:

diff --git a/docs/guides/kafka/concepts/kafka.md b/docs/guides/kafka/concepts/kafka.md
@@ -386,7 +386,7 @@ It defines the attributes for the health checker.
 - `spec.healthChecker.failureThreshold` specifies minimum consecutive failures for the healthChecker to be considered failed.
 - `spec.healthChecker.disableWriteCheck` specifies whether to disable the writeCheck or not.
 
-Know details about KubeDB Health checking from this [blog post](https://blog.byte.builders/post/kubedb-health-checker/).
+Know details about KubeDB Health checking from this [blog post](https://appscode.com/blog/post/kubedb-health-checker/).
 
 ## Next Steps
 

diff --git a/docs/guides/mariadb/concepts/appbinding/index.md b/docs/guides/mariadb/concepts/appbinding/index.md
@@ -16,7 +16,7 @@ section_menu_id: guides
 
 ## What is AppBinding
 
-An `AppBinding` is a Kubernetes `CustomResourceDefinition`(CRD) which points to an application using either its URL (usually for a non-Kubernetes resident service instance) or a Kubernetes service object (if self-hosted in a Kubernetes cluster), some optional parameters and a credential secret. To learn more about AppBinding and the problems it solves, please read this blog post: [The case for AppBinding](https://blog.byte.builders/post/the-case-for-appbinding).
+An `AppBinding` is a Kubernetes `CustomResourceDefinition`(CRD) which points to an application using either its URL (usually for a non-Kubernetes resident service instance) or a Kubernetes service object (if self-hosted in a Kubernetes cluster), some optional parameters and a credential secret. To learn more about AppBinding and the problems it solves, please read this blog post: [The case for AppBinding](https://appscode.com/blog/post/the-case-for-appbinding).
 
 If you deploy a database using [KubeDB](https://kubedb.com/docs/0.11.0/concepts/), `AppBinding` object will be created automatically for it. Otherwise, you have to create an `AppBinding` object manually pointing to your desired database.
 

diff --git a/docs/guides/mariadb/concepts/opsrequest/index.md b/docs/guides/mariadb/concepts/opsrequest/index.md
@@ -121,10 +121,11 @@ spec:
   type: Reconfigure
   databaseRef:
     name: sample-mariadb
-  configuration:   
-    inlineConfig: |
-      max_connections = 300
-      read_buffer_size = 1234567
+  configuration:
+    applyConfig:
+      my-apply.cnf: |-
+        max_connections = 300
+        read_buffer_size = 1234567
 status:
   conditions:
     - lastTransitionTime: "2020-08-25T18:22:38Z"
@@ -293,7 +294,7 @@ This will expand the volume size of all the mariadb nodes to 2 GB.
 
 If you want to reconfigure your Running MariaDB cluster with new custom configuration, you have to specify `spec.configuration` section. This field consists of the following sub-fields:
 - `configSecret` points to a secret in the same namespace of a MariaDB resource, which contains the new custom configurations. If there are any configSecret set before in the database, this secret will replace it.
-- `inlineConfig` contains the new custom config as a string which will be merged with the previous configuration.
+- `applyConfig` contains the new custom config as a string which will be merged with the previous configuration.
 - `removeCustomConfig` reomoves all the custom configs of the MariaDB server.
 
 ### spec.tls

diff --git a/docs/guides/memcached/concepts/appbinding.md b/docs/guides/memcached/concepts/appbinding.md
@@ -16,7 +16,7 @@ section_menu_id: guides
 
 ## What is AppBinding
 
-An `AppBinding` is a Kubernetes `CustomResourceDefinition`(CRD) which points to an application using either its URL (usually for a non-Kubernetes resident service instance) or a Kubernetes service object (if self-hosted in a Kubernetes cluster), some optional parameters and a credential secret. To learn more about AppBinding and the problems it solves, please read this blog post: [The case for AppBinding](https://blog.byte.builders/post/the-case-for-appbinding).
+An `AppBinding` is a Kubernetes `CustomResourceDefinition`(CRD) which points to an application using either its URL (usually for a non-Kubernetes resident service instance) or a Kubernetes service object (if self-hosted in a Kubernetes cluster), some optional parameters and a credential secret. To learn more about AppBinding and the problems it solves, please read this blog post: [The case for AppBinding](https://appscode.com/blog/post/the-case-for-appbinding).
 
 If you deploy a database using [KubeDB](https://kubedb.com/docs/0.11.0/concepts/), `AppBinding` object will be created automatically for it. Otherwise, you have to create an `AppBinding` object manually pointing to your desired database.
 

diff --git a/docs/guides/mongodb/autoscaler/storage/replicaset.md b/docs/guides/mongodb/autoscaler/storage/replicaset.md
@@ -133,6 +133,7 @@ spec:
     name: mg-rs
   storage:
     replicaSet:
+      expansionMode: "Online"
       trigger: "On"
       usageThreshold: 60
       scalingThreshold: 50

diff --git a/docs/guides/mongodb/autoscaler/storage/sharding.md b/docs/guides/mongodb/autoscaler/storage/sharding.md
@@ -149,6 +149,7 @@ spec:
     name: mg-sh
   storage:
     shard:
+      expansionMode: "Online"
       trigger: "On"
       usageThreshold: 60
       scalingThreshold: 50

diff --git a/docs/guides/mongodb/autoscaler/storage/standalone.md b/docs/guides/mongodb/autoscaler/storage/standalone.md
@@ -128,6 +128,7 @@ spec:
     name: mg-standalone
   storage:
     standalone:
+      expansionMode: "Online"
       trigger: "On"
       usageThreshold: 60
       scalingThreshold: 50