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

tiup: Update/fix no sudo mode docs #20437

Open
wants to merge 16 commits into
base: master
Choose a base branch
from
Open

Conversation

dveeden
Copy link
Contributor

@dveeden dveeden commented Mar 3, 2025

What is changed, added or deleted? (Required)

  1. Add hint about ssh-copy-id
  2. Use a variable for the user id in the systemctl command
  3. Add a note about the tar package
  4. important: replace the description for fixing things with a reference. The description contained changes like changing THP and disabling swap that were done in a way that is not persistent across reboots, basically boobytrapping the setup.

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.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 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)?

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

@dveeden dveeden requested review from hfxsd and qiancai March 3, 2025 09:33
@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 3, 2025
@dveeden dveeden requested a review from kaaaaaaang March 3, 2025 09:34
@dveeden
Copy link
Contributor Author

dveeden commented Mar 3, 2025

cc @Yujie-Xie

@hfxsd hfxsd added translation/doing This PR's assignee is translating this PR. needs-cherry-pick-release-8.1 Should cherry pick this PR to release-8.1 branch. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. and removed missing-translation-status This PR does not have translation status info. labels Mar 4, 2025
@hfxsd hfxsd self-assigned this Mar 4, 2025
Copy link

ti-chi-bot bot commented Mar 4, 2025

@Yujie-Xie: 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.

Copy link

ti-chi-bot bot commented Mar 4, 2025

[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 ask for approval from hfxsd, ensuring that each of them provides their approval before proceeding. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

@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 Mar 4, 2025
@hfxsd hfxsd added the area/tiup Indicates that the Issue or PR belongs to the area of the TiUP tool. label Mar 5, 2025
@@ -90,6 +105,10 @@ This document describes how to use the TiUP no-sudo mode to deploy a cluster.

## Manually repair failed check items

> **Note:**
>
> If you use a minimal install, make sure the `tar` package is installed. Otherwise the `tiup cluster check` command will fail.
Copy link
Collaborator

Choose a reason for hiding this comment

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

What does "minimal install" mean? Is there any reference link?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

https://docs.rockylinux.org/guides/installation/#software-selection

This is in the software selection during installation

A screenshot that I found with a Google search:
9-RockyLinux9-software-selection.jpg

@@ -90,6 +114,10 @@ This document describes how to use the TiUP no-sudo mode to deploy a cluster.

## Manually repair failed check items

> **Note:**
>
> If you use a minimal install, make sure the `tar` package is installed. Otherwise, the `tiup cluster check` command will fail.
Copy link
Collaborator

Choose a reason for hiding this comment

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

What does "minimal install" mean? Is there any reference link?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I answered this in another conversation

Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we need to update "If you use a minimal install" to "If your operation system uses a minimal install" for clarity?

Copy link
Collaborator

@qiancai qiancai left a comment

Choose a reason for hiding this comment

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

Rest LGTM

@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Mar 6, 2025
Copy link

ti-chi-bot bot commented Mar 6, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-03-06 03:39:13.544079267 +0000 UTC m=+499266.672999010: ☑️ agreed by qiancai.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/tiup Indicates that the Issue or PR belongs to the area of the TiUP tool. needs-1-more-lgtm Indicates a PR needs 1 more LGTM. needs-cherry-pick-release-8.1 Should cherry pick this PR to release-8.1 branch. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/L Denotes a PR that changes 100-499 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.

4 participants