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

Add tkctl user manual #452

Merged
merged 9 commits into from
May 8, 2019
Merged

Add tkctl user manual #452

merged 9 commits into from
May 8, 2019

Conversation

aylei
Copy link
Contributor

@aylei aylei commented May 5, 2019

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

Signed-off-by: Aylei <rayingecho@gmail.com>
Signed-off-by: Aylei <rayingecho@gmail.com>
@shuijing198799
Copy link
Contributor

/run-e2e-tests

Signed-off-by: Aylei <rayingecho@gmail.com>
@aylei aylei marked this pull request as ready for review May 6, 2019 10:22
tennix
tennix previously approved these changes May 8, 2019
Copy link
Member

@tennix tennix left a comment

Choose a reason for hiding this comment

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

LGTM

@tennix tennix added the area/doc label May 8, 2019
Copy link
Contributor

@weekface weekface 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

docs/cli-manual.md Outdated Show resolved Hide resolved
```
$ 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
Copy link
Contributor

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.

Copy link
Contributor Author

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.

Copy link
Contributor

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.

Copy link
Contributor Author

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

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 will amend the manual along with the fix #465

docs/cli-manual.md Outdated Show resolved Hide resolved
docs/cli-manual.md Outdated Show resolved Hide resolved
docs/cli-manual.md Outdated Show resolved Hide resolved
.gitignore Outdated Show resolved Hide resolved
@aylei aylei requested review from weekface and cofyc and removed request for weekface and cofyc May 8, 2019 07:07
Copy link
Contributor

@onlymellb onlymellb left a comment

Choose a reason for hiding this comment

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

LGTM

@tennix tennix merged commit c64b384 into pingcap:master May 8, 2019
shuijing198799 pushed a commit to shuijing198799/tidb-operator that referenced this pull request May 9, 2019
* 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
shuijing198799 added a commit to shuijing198799/tidb-operator that referenced this pull request May 9, 2019
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
shuijing198799 added a commit to shuijing198799/tidb-operator that referenced this pull request May 9, 2019
* 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
yahonda pushed a commit that referenced this pull request Dec 27, 2021
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants