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

tiproxy: improve deployment instructions for deploying TiProxy #19415

Merged
merged 3 commits into from
Jan 7, 2025

Conversation

djshow832
Copy link
Contributor

@djshow832 djshow832 commented Dec 30, 2024

What is changed, added or deleted? (Required)

Currently, I received some confusion about deploying TiProxy. The main reason is that the documents are spread everywhere.

Some of the confusion:

  • I can't find the deployment sample of TiUP
  • Are the TLS configs in the sample mandatory?
  • How can I customize the deploy directory?
  • The description of some configs is unclear
  • What's the sample of configuring VIP?

One of the complaints: https://asktug.com/t/topic/1037753

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 (in Chinese).

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 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)
  • v5.3 (TiDB 5.3 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

@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Dec 30, 2024
@hfxsd hfxsd self-assigned this Dec 30, 2024
@hfxsd hfxsd added translation/doing This PR’s assignee is translating this PR. and removed missing-translation-status This PR does not have translation status info. labels Dec 30, 2024
@hfxsd hfxsd self-requested a review December 30, 2024 03:11
@hfxsd hfxsd added needs-cherry-pick-release-8.1 Should cherry pick this PR to release-8.1 branch. needs-cherry-pick-release-8.2 needs-cherry-pick-release-8.3 Should cherry pick this PR to release-8.3 branch. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. needs-cherry-pick-release-8.4 Should cherry pick this PR to release-8.4 branch. labels Dec 30, 2024
@qiancai
Copy link
Collaborator

qiancai commented Dec 30, 2024

Removed the needs-cherry-pick-release-8.2 label because the v8.2 docs have been archived at https://docs-archive.pingcap.com/zh/tidb/v8.2 and will no longer receive new updates.

tiproxy/tiproxy-overview.md Outdated Show resolved Hide resolved
Copy link

ti-chi-bot bot commented Jan 2, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-01-02 00:14:48.557941684 +0000 UTC m=+568623.913946224: ☑️ agreed by hfxsd.

@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jan 2, 2025
tiproxy/tiproxy-overview.md Outdated Show resolved Hide resolved
@hfxsd hfxsd added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR’s assignee is translating this PR. labels Jan 6, 2025
Copy link

ti-chi-bot bot commented Jan 6, 2025

@joey-yez: 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.

@hfxsd hfxsd added the lgtm label Jan 7, 2025
@hfxsd
Copy link
Collaborator

hfxsd commented Jan 7, 2025

/approve

Copy link

ti-chi-bot bot commented Jan 7, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hfxsd

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

The pull request process is described here

Needs approval from an approver in each of these files:

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 ti-chi-bot bot added the approved label Jan 7, 2025
@hfxsd hfxsd closed this Jan 7, 2025
@hfxsd hfxsd reopened this Jan 7, 2025
@ti-chi-bot ti-chi-bot bot merged commit 11499c9 into pingcap:master Jan 7, 2025
8 of 10 checks passed
@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-8.3: #19477.

@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-8.5: #19478.

@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-8.4: #19479.

@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-8.1: #19480.

ti-chi-bot pushed a commit to ti-chi-bot/docs-cn that referenced this pull request Jan 7, 2025
@hfxsd hfxsd removed needs-cherry-pick-release-8.1 Should cherry pick this PR to release-8.1 branch. needs-cherry-pick-release-8.3 Should cherry pick this PR to release-8.3 branch. needs-cherry-pick-release-8.4 Should cherry pick this PR to release-8.4 branch. labels Jan 7, 2025
@djshow832 djshow832 deleted the tiproxy_status branch January 7, 2025 02:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants