Skip to content

ticdc: correct the tiup cluster command #21135

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

ticdc: correct the tiup cluster command #21135

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions ticdc/deploy-ticdc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,15 +129,15 @@ This section describes how to use the [`tiup cluster edit-config`](/tiup/tiup-co

In the preceding command, `gc-ttl` is set to 48 hours.

3. Run the `tiup cluster reload -R cdc` command to reload the configuration.
3. Run the `tiup cluster reload <cluster-name> -R cdc` command to reload the configuration.
Copy link

Choose a reason for hiding this comment

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

low

Excellent correction! Adding the <cluster-name> placeholder is crucial for the command's accuracy and usability, directly benefiting users trying to follow these instructions. This change enhances the technical accuracy of the document, which is a key aspect of our style guide.1

Style Guide References

Footnotes

  1. The style guide emphasizes reviewing for technical accuracy and terminology consistency. (link) ↩


## Stop and start TiCDC using TiUP

You can use TiUP to easily stop and start TiCDC nodes. The commands are as follows:

- Stop TiCDC: `tiup cluster stop -R cdc`
- Start TiCDC: `tiup cluster start -R cdc`
- Restart TiCDC: `tiup cluster restart -R cdc`
- Stop TiCDC: `tiup cluster stop <cluster-name> -R cdc`
- Start TiCDC: `tiup cluster start <cluster-name> -R cdc`
- Restart TiCDC: `tiup cluster restart <cluster-name> -R cdc`
Comment on lines +138 to +140
Copy link

Choose a reason for hiding this comment

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

low

These corrections to include <cluster-name> in the stop, start, and restart commands are also very important for ensuring users can successfully manage their TiCDC nodes. This improves the clarity and correctness of the instructions, aligning with the style guide's principles.12

Style Guide References

Footnotes

  1. The style guide prioritizes clarity, simplicity, completeness, and readability. (link) ↩

  2. Technical accuracy is a key review aspect. (link) ↩


## Enable TLS for TiCDC

Expand Down