-
Notifications
You must be signed in to change notification settings - Fork 501
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
Add tkctl user manual #452
Conversation
Signed-off-by: Aylei <rayingecho@gmail.com>
Signed-off-by: Aylei <rayingecho@gmail.com>
/run-e2e-tests |
Signed-off-by: Aylei <rayingecho@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
rest lgtm
``` | ||
$ tkctl get tikv | ||
NAME READY STATUS MEMORY CPU RESTARTS AGE NODE | ||
demo-cluster-tikv-0 2/2 Running 2098Mi/4196Mi 0 3m19s 172.16.4.155 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the CPU
column is empty now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this example the CPU request and limit is not set.
Of course a <none>/<none>
is more clear for user, I will open a new issue for this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[root@172.16.4.149 ~]# tkctl get tikv
NAME READY STATUS MEMORY CPU RESTARTS AGE NODE
cluster-restore-tikv-0 2/2 Running 2098Mi/8292Mi 0 5m22s 172.16.4.150
cluster-restore-tikv-1 2/2 Running 2098Mi/8292Mi 0 5m22s 172.16.4.154
cluster-restore-tikv-2 2/2 Running 2098Mi/8292Mi 0 5m22s 172.16.4.149
I try it on many clusters, but they are all empty.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
emmm... that's a bug
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will amend the manual along with the fix #465
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
* Add basic documents for CLI tool Signed-off-by: Aylei <rayingecho@gmail.com> * Add TOC for manual Signed-off-by: Aylei <rayingecho@gmail.com> * Document about installation and shell completion Signed-off-by: Aylei <rayingecho@gmail.com> * Address review comments * Fix toc anchor link
Add version command for tkctl (pingcap#456) * Add version command for tkctl Signed-off-by: Aylei <rayingecho@gmail.com> Add tkctl user manual (pingcap#452) * Add basic documents for CLI tool Signed-off-by: Aylei <rayingecho@gmail.com> * Add TOC for manual Signed-off-by: Aylei <rayingecho@gmail.com> * Document about installation and shell completion Signed-off-by: Aylei <rayingecho@gmail.com> * Address review comments * Fix toc anchor link modify code and add cli add tools code and modify code Add tkctl user manual (pingcap#452) * Add basic documents for CLI tool Signed-off-by: Aylei <rayingecho@gmail.com> * Add TOC for manual Signed-off-by: Aylei <rayingecho@gmail.com> * Document about installation and shell completion Signed-off-by: Aylei <rayingecho@gmail.com> * Address review comments * Fix toc anchor link add tools code and modify code
* use shareinformer without copy * fix bug use shareinformer without copy in kv pd and svc add webhook Add version command for tkctl (pingcap#456) * Add version command for tkctl Signed-off-by: Aylei <rayingecho@gmail.com> Add tkctl user manual (pingcap#452) * Add basic documents for CLI tool Signed-off-by: Aylei <rayingecho@gmail.com> * Add TOC for manual Signed-off-by: Aylei <rayingecho@gmail.com> * Document about installation and shell completion Signed-off-by: Aylei <rayingecho@gmail.com> * Address review comments * Fix toc anchor link modify code and add cli add tools code and modify code Add tkctl user manual (pingcap#452) * Add basic documents for CLI tool Signed-off-by: Aylei <rayingecho@gmail.com> * Add TOC for manual Signed-off-by: Aylei <rayingecho@gmail.com> * Document about installation and shell completion Signed-off-by: Aylei <rayingecho@gmail.com> * Address review comments * Fix toc anchor link add tools code and modify code use shareinformer without copy fix bug use shareinformer without copy in kv pd and svc add webhook Add tkctl user manual (pingcap#452) * Add basic documents for CLI tool Signed-off-by: Aylei <rayingecho@gmail.com> * Add TOC for manual Signed-off-by: Aylei <rayingecho@gmail.com> * Document about installation and shell completion Signed-off-by: Aylei <rayingecho@gmail.com> * Address review comments * Fix toc anchor link modify code and add cli add tools code and modify code Add tkctl user manual (pingcap#452) * Add basic documents for CLI tool Signed-off-by: Aylei <rayingecho@gmail.com> * Add TOC for manual Signed-off-by: Aylei <rayingecho@gmail.com> * Document about installation and shell completion Signed-off-by: Aylei <rayingecho@gmail.com> * Address review comments * Fix toc anchor link modify code and add cli add tools code and modify code
* en: update access-dashboard * Update en/access-dashboard.md * Apply suggestions from code review Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> Co-authored-by: DanielZhangQD <36026334+DanielZhangQD@users.noreply.github.com> Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
What problem does this PR solve?
Add user manual for
tkctl
Preview: https://github.com/aylei/tidb-operator/blob/issue-305-doc/docs/cli-manual.md
@tennix @onlymellb @gregwebs @weekface @cofyc PTAL
Todo
Support tkctl as kubectl plugin(postpone)