docs: add tiup 「--ssh / ssh-type」 Document description
Open
Nobody has claimed this yet.
type/question
- Dominant language
- Go
- Stars
- 466
- Forks
- 338
- Avg merge
- 3d 7h
- Merged PRs (30d)
- 8
Description
General Question
使用 tiup cluster deploy nji --ssh=system 部署集群成功后，后续 start、stop、restart 等操作时；
tiup cluster start nji 等于 tiup cluster start nji --ssh=system ； 默认将使用 --ssh SSH type: system
此处行为可能有争议，建议补充文档说明
Starting component `cluster`: /root/.tiup/components/cluster/v1.2.3/tiup-cluster display nji
Cluster type: tidb
Cluster name: nji
Cluster version: nightly
SSH type: system
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the tiup cluster documentation covering deploy, start, stop, restart, and the --ssh option. Confirm the observed system SSH behavior, then document whether later operations inherit --ssh=system and show the relevant commands and output; done means users can understand the default behavior without relying on the issue thread.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100