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

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

Merged
merged 1 commit into from
Apr 24, 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
1 change: 1 addition & 0 deletions docs/examples/mongodb/autoscaling/storage/mg-as-rs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ spec:
name: mg-rs
storage:
replicaSet:
expansionMode: "Online"
trigger: "On"
usageThreshold: 60
scalingThreshold: 50
1 change: 1 addition & 0 deletions docs/examples/mongodb/autoscaling/storage/mg-as-sh.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ spec:
name: mg-sh
storage:
shard:
expansionMode: "Online"
trigger: "On"
usageThreshold: 60
scalingThreshold: 50
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ spec:
name: mg-standalone
storage:
standalone:
expansionMode: "Online"
trigger: "On"
usageThreshold: 60
scalingThreshold: 50
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ spec:
name: mg-replicaset
configuration:
replicaSet:
inlineConfig: |
net:
maxIncomingConnections: 30000
applyConfig:
mongod.conf: |-
net:
maxIncomingConnections: 30000
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ spec:
name: mg-standalone
configuration:
standalone:
inlineConfig: |
net:
maxIncomingConnections: 30000
applyConfig:
mongod.conf: |-
net:
maxIncomingConnections: 30000

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ spec:
databaseRef:
name: mg-replicaset
volumeExpansion:
mode: "Online"
replicaSet: 2Gi
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ spec:
databaseRef:
name: mg-sharding
volumeExpansion:
mode: "Online"
shard: 2Gi
configServer: 2Gi
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ spec:
databaseRef:
name: mg-standalone
volumeExpansion:
mode: "Online"
standalone: 2Gi
1 change: 1 addition & 0 deletions docs/examples/redis/autoscaling/storage/rd-as.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ spec:
name: rd-standalone
storage:
standalone:
expansionMode: "Online"
trigger: "On"
usageThreshold: 60
scalingThreshold: 50
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,6 @@ spec:
databaseRef:
name: sample-redis
configuration:
inlineConfig: maxclients 3000
applyConfig:
redis.conf: |-
maxclients 3000
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ spec:
name: es-combined
storage:
node:
expansionMode: "Online"
trigger: "On"
usageThreshold: 60
scalingThreshold: 50
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ spec:
name: es-combined
storage:
node:
expansionMode: "Online"
trigger: "On"
usageThreshold: 60
scalingThreshold: 50
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ spec:
name: es-topology
storage:
data:
expansionMode: "Online"
trigger: "On"
usageThreshold: 60
scalingThreshold: 50
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ spec:
name: es-topology
storage:
data:
expansionMode: "Online"
trigger: "On"
usageThreshold: 60
scalingThreshold: 50
2 changes: 1 addition & 1 deletion docs/guides/elasticsearch/concepts/appbinding/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions docs/guides/elasticsearch/concepts/autoscaler/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ spec:
resourceDiffPercentage: 10
storage:
node:
expansionMode: "Online"
trigger: "On"
usageThreshold: 60
scalingThreshold: 50
Expand Down Expand Up @@ -108,6 +109,7 @@ spec:
resourceDiffPercentage: 10
storage:
data:
expansionMode: "Online"
trigger: "On"
usageThreshold: 60
scalingThreshold: 50
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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
Expand All @@ -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
```

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/elasticsearch/concepts/elasticsearch/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
apiVersion: dashboard.kubedb.com/v1alpha1
apiVersion: elasticsearch.kubedb.com/v1alpha1
kind: ElasticsearchDashboard
metadata:
name: es-cluster-dashboard
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
apiVersion: dashboard.kubedb.com/v1alpha1
apiVersion: elasticsearch.kubedb.com/v1alpha1
kind: ElasticsearchDashboard
metadata:
name: os-cluster-dashboard
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/kafka/concepts/appbinding.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions docs/guides/kafka/concepts/catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/kafka/concepts/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/mariadb/concepts/appbinding/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
11 changes: 6 additions & 5 deletions docs/guides/mariadb/concepts/opsrequest/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/memcached/concepts/appbinding.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
1 change: 1 addition & 0 deletions docs/guides/mongodb/autoscaler/storage/replicaset.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ spec:
name: mg-rs
storage:
replicaSet:
expansionMode: "Online"
trigger: "On"
usageThreshold: 60
scalingThreshold: 50
Expand Down
1 change: 1 addition & 0 deletions docs/guides/mongodb/autoscaler/storage/sharding.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,7 @@ spec:
name: mg-sh
storage:
shard:
expansionMode: "Online"
trigger: "On"
usageThreshold: 60
scalingThreshold: 50
Expand Down
1 change: 1 addition & 0 deletions docs/guides/mongodb/autoscaler/storage/standalone.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ spec:
name: mg-standalone
storage:
standalone:
expansionMode: "Online"
trigger: "On"
usageThreshold: 60
scalingThreshold: 50
Expand Down
Loading
Loading