hardware-and-software-requirements: add tiproxy

[dveeden]

First-time contributors' checklist

• I've signed the Contributor License Agreement, which is required for the repository owners to accept my contribution.

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

• master (the latest development version)
• v9.0 (TiDB 9.0 versions)
• v8.5 (TiDB 8.5 versions)
• v8.1 (TiDB 8.1 versions)
• v7.5 (TiDB 7.5 versions)
• v7.1 (TiDB 7.1 versions)
• v6.5 (TiDB 6.5 versions)
• v6.1 (TiDB 6.1 versions)
• v5.4 (TiDB 5.4 versions)

What is the related PR or file link(s)?

• This PR is translated from:
• Other reference link(s):

Do your changes match any of the following descriptions?

• Delete files
• Change aliases
• Need modification after applied to another branch
• Might cause conflicts after applied to another branch

[gemini-code-assist]

Summary of Changes

Hello @dveeden, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request updates the documentation by incorporating the necessary hardware and software specifications for the TiProxy component. This ensures that users have comprehensive guidelines for deploying TiProxy, covering both development/testing and production scenarios, thereby enhancing the clarity and completeness of the system requirements.

Highlights

• TiProxy Requirements Added: Introduced the hardware and software requirements for TiProxy into the hardware-and-software-requirements.md document.
• Development and Test Environment: Specified minimum requirements for TiProxy in development and test environments: 4 core+ CPU, 8 GB+ Memory, SAS local storage, Gigabit network card, and 1 instance.
• Production Environment: Defined minimum requirements for TiProxy in production environments: 8 core+ CPU, 16 GB+ Memory, SAS hard disk type, 10 Gigabit network card (2 preferred), and 2 instances.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[dveeden]

/cc @kissmydb

[ti-chi-bot]

@dveeden: GitHub didn't allow me to request PR reviews from the following users: kissmydb.

Note that only pingcap members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/cc @kissmydb

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[dveeden]

Note that TiProxy is an optional component, just like TiFlash.

[gemini-code-assist]

Code Review

This pull request adds hardware and software requirements for TiProxy to the documentation. The changes are accurate and align with the information in other TiProxy-related documents. I've added a couple of minor suggestions to specify the storage size for TiProxy for better consistency and clarity. Overall, a good addition to the documentation.

[gemini-code-assist]

For consistency with other components in the table, consider specifying a minimum storage size. Since TiProxy is a stateless proxy, its storage is mainly for logs and binaries. A size such as 30 GB+ would be appropriate for development and test environments, similar to TiDB's log disk requirement.

Suggested change

	| TiProxy | 4 core+ | 8 GB+ | SAS | Gigabit network card | 1 |
	| TiProxy | 4 core+ | 8 GB+ | SAS, 30 GB+ | Gigabit network card | 1 |

[gemini-code-assist]

For consistency with other components in this table, consider specifying a storage size for TiProxy. For a production environment, a size like 100 GB+ would be a safe recommendation to account for logs and potential traffic capture files.

Suggested change

	| TiProxy | 8 core+ | 16 GB+ | SAS | 10 Gigabit network card (2 preferred) | 2 |
	| TiProxy | 8 core+ | 16 GB+ | SAS, 100 GB+ | 10 Gigabit network card (2 preferred) | 2 |

[ti-chi-bot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign tangenta for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[ti-chi-bot]

@mjonss: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.