Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
Signed-off-by: Tamal Saha <[email protected]>
  • Loading branch information
tamalsaha committed Mar 6, 2025
1 parent 48197ac commit ea26d64
Show file tree
Hide file tree
Showing 16 changed files with 351 additions and 15 deletions.
2 changes: 1 addition & 1 deletion config.dev.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ params:
domain_pharmer: https://pharmer-v1-hugo.web.app
domain_stash: https://stashed-v1-hugo.web.app
domain_voyagermesh: https://voyagermesh-v1-hugo.web.app
search_api_key: ee310e417cda9ef6db0e642af12875611bd6e7ad69fb08c80dbd8cef72d68ba4
search_api_key: 8fd610038d901dd16a111e6f1568343bb969b084a1952dafdcb1545fd8c35e96
learn_url: https://appscode.com/learn
docs_url: https://appscode.com/docs
blog_url: https://appscode.com/blog
Expand Down
2 changes: 1 addition & 1 deletion config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ params:
domain_pharmer: https://pharmer.dev
domain_stash: https://stash.run
domain_voyagermesh: https://voyagermesh.com
search_api_key: ee310e417cda9ef6db0e642af12875611bd6e7ad69fb08c80dbd8cef72d68ba4
search_api_key: 8fd610038d901dd16a111e6f1568343bb969b084a1952dafdcb1545fd8c35e96
learn_url: https://appscode.com/learn
docs_url: https://appscode.com/docs
blog_url: https://appscode.com/blog
Expand Down
2 changes: 1 addition & 1 deletion content/docs/v2025.2.19/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,6 @@ From here you can learn all about KubeDB's architecture and how to deploy and us

- [Guides](/docs/v2025.2.19/guides/). Guides to show you how to perform tasks with KubeDB.

- [Reference](/docs/v2025.2.19/reference/). Detailed exhaustive lists of command-line options, configuration options, API definitions, and procedures.
- Detailed exhaustive lists of command-line options, configuration options, API definitions, and procedures. Specially, [CLI](/docs/v2025.2.19/reference/cli/), [operator](/docs/v2025.2.19/reference/operator/) & [webhook-server](/docs/v2025.2.19/reference/webhook-server/).

We're always looking for help improving our documentation, so please don't hesitate to [file an issue](https://github.com/kubedb/project/issues/new) if you see some problem. Or better yet, submit your own [contributions](/docs/v2025.2.19/CONTRIBUTING) to help make our docs better.
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ $ kubectl get pod -n demo sample-mariadb-0 -o json | jq '.spec.containers[].reso
}
```

You can see the Pod has the default resources which is assigned by Kubedb operator.
You can see the Pod has the default resources which is assigned by KubeDB operator.

We are now ready to apply the `MariaDBOpsRequest` CR to update the resources of this database.

Expand Down
2 changes: 1 addition & 1 deletion content/docs/v2025.2.19/guides/mongodb/concepts/mongodb.md
Original file line number Diff line number Diff line change
Expand Up @@ -535,7 +535,7 @@ The `spec.podTemplate.spec.containers[].name` field used to specify the name of

Note that, KubeDB does not allow `MONGO_INITDB_ROOT_USERNAME` and `MONGO_INITDB_ROOT_PASSWORD` environment variables to set in `spec.podTemplate.spec.env`. If you want to use custom superuser and password, please use `spec.authSecret` instead described earlier.

If you try to set `MONGO_INITDB_ROOT_USERNAME` or `MONGO_INITDB_ROOT_PASSWORD` environment variable in MongoDB crd, Kubedb operator will reject the request with following error,
If you try to set `MONGO_INITDB_ROOT_USERNAME` or `MONGO_INITDB_ROOT_PASSWORD` environment variable in MongoDB crd, KubeDB operator will reject the request with following error,

```ini
Error from server (Forbidden): error when creating "./mongodb.yaml": admission webhook "mongodb.validators.kubedb.com" denied the request: environment variable MONGO_INITDB_ROOT_USERNAME is forbidden to use in MongoDB spec
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ $ kubectl get pod -n demo mg-replicaset-0 -o json | jq '.spec.containers[].resou
}
```

You can see the Pod has the default resources which is assigned by Kubedb operator.
You can see the Pod has the default resources which is assigned by KubeDB operator.

We are now ready to apply the `MongoDBOpsRequest` CR to update the resources of this database.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ $ kubectl get pod -n demo mg-sharding-shard0-0 -o json | jq '.spec.containers[].
}
```

You can see all the Pod of mongos, configserver and shard has default resources which is assigned by Kubedb operator.
You can see all the Pod of mongos, configserver and shard has default resources which is assigned by KubeDB operator.

We are now ready to apply the `MongoDBOpsRequest` CR to update the resources of mongos, configserver and shard nodes of this database.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ $ kubectl get pod -n demo mg-standalone-0 -o json | jq '.spec.containers[].resou
}
```

You can see the Pod has default resources which is assigned by the Kubedb operator.
You can see the Pod has default resources which is assigned by the KubeDB operator.

We are now ready to apply the `MongoDBOpsRequest` CR to update the resources of this database.

Expand Down
336 changes: 336 additions & 0 deletions content/docs/v2025.2.19/guides/mssqlserver/clustering/arbiter.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Scaling Microsoft SQL Server
menu:
docs_v2025.2.19:
identifier: ms-scaling
name: Scaling Microsoft SQL Server
name: Scaling SQL Server
parent: guides-mssqlserver
weight: 55
menu_name: docs_v2025.2.19
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ $ kubectl get pod -n demo sample-pxc-0 -o json | jq '.spec.containers[].resource
}
```

You can see the Pod has the default resources which is assigned by Kubedb operator.
You can see the Pod has the default resources which is assigned by KubeDB operator.

We are now ready to apply the `PerconaXtraDBOpsRequest` CR to update the resources of this database.

Expand Down
2 changes: 1 addition & 1 deletion content/docs/v2025.2.19/guides/postgres/arbiter/arbiter.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ info:

> New to KubeDB? Please start [here](/docs/v2025.2.19/README).
# Kubedb PostgreSQL - Arbiter node for PostgreSQL cluster with even nodes
# KubeDB PostgreSQL - Arbiter node for PostgreSQL cluster with even nodes

Here we will show how to use KubeDB to provision a PostgreSQL DB with Arbiter Node.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ $ kubectl get pod -n demo proxy-server-0 -o json | jq '.spec.containers[].resour
}
```

You can see the Pod has the default resources which is assigned by Kubedb operator.
You can see the Pod has the default resources which is assigned by KubeDB operator.

We are now ready to apply the `ProxySQLOpsRequest` CR to update the resources of this server.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ $ kubectl get pod -n demo rm-standalone-0 -o json | jq '.spec.containers[].resou
}
```

You can see the Pod has default resources which is assigned by the Kubedb operator.
You can see the Pod has default resources which is assigned by the KubeDB operator.

We are now ready to apply the `RabbitMQOpsRequest` CR to update the resources of this database.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ Here, we have to use the service `sample-redis` and secret `sample-redis-auth` t

### Insert Sample Data

Now, we are going to exec into the database pod and create some sample data. Kubedb has created a secret with access credentials. Let's find out the credentials from the Secret,
Now, we are going to exec into the database pod and create some sample data. KubeDB has created a secret with access credentials. Let's find out the credentials from the Secret,

```yaml
❯ kubectl get secret -n demo sample-redis-auth -o yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ $ kubectl get pod -n demo zk-quickstart-0 -o json | jq '.spec.containers[].resou
}
```

You can see the Pod has default resources which is assigned by the Kubedb operator.
You can see the Pod has default resources which is assigned by the KubeDB operator.

We are now ready to apply the `ZooKeeperOpsRequest` CR to update the resources of this database.

Expand Down

0 comments on commit ea26d64

Please sign in to comment.