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

Update the doc for resources page as per the updated UI changes #174

Open
wants to merge 7 commits into
base: Release-1.3.0
Choose a base branch
from
Open
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/resources_pgbouncer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/resources_proxies_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/resources_routers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 25 additions & 1 deletion docs/use/db_provision.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,31 @@ To provision a new database:

5. On the **Resources** page, select the **Number of nodes**. Also, set the resources per node by selecting one of the predefined presets or by specifying the CPU, Memory, and Disk. For more information on resources, see the [Scale database deployment](../use/scaling.md) section.

6. On the **Scheduled Backups** page, set up a schedule if you wish to run backup jobs for your new database.
Additionally, based on the database technology you’re working with, select the following:

- MySQL: On the **Proxies** panel, select the **Number of proxies** and **Resource size per proxy**.

!!! info
Proxies are used primarily to ensure high availability, load balancing, and database failover management. They act as intermediaries, ensuring client requests are directed to the appropriate database instances.

![!image](../images/resources_proxies_page.png)

- MongoDB: On the **Routers** panel, select the **Number of routers** and **Resource size per router**.

!!! info
The query router directs the client queries to the proper shard(s).

![!image](../images/resources_routers.png)

Comment on lines +52 to +58
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have a bug that's showing this panel all the time but it should only show it if sharding has been enabled. Maybe we should remove this 🙂

Suggested change
- MongoDB: On the **Routers** panel, select the **Number of routers** and **Resource size per router**.
!!! info
The query router directs the client queries to the proper shard(s).
![!image](../images/resources_routers.png)

- PostgreSQL: On the **PG Bouncers** panel, select the **Number of PG Bouncers** and **Resource size per PG Bouncer**.

!!! info
[PgBouncer](https://www.pgbouncer.org/) manages PostgreSQL connections, particularly in high traffic environments.

![!image](../images/resources_pgbouncer.png)


6. On the **Scheduled Backups** page, set up a schedule to run backup jobs for your new database.

Click **Create backup schedule**. The backup schedule pop-up is displayed.

Expand Down
Loading