RATIS-1589. Get ratis-shell resource from bin tarball#656
RATIS-1589. Get ratis-shell resource from bin tarball#656szetszwo merged 4 commits intoapache:masterfrom
Conversation
|
@szetszwo Can you help review this pull request, thank you! |
szetszwo
left a comment
szetszwo
left a comment
There was a problem hiding this comment.
@codings-dan , thanks a lot for working on this! Let add some subsections in the doc; see https://issues.apache.org/jira/secure/attachment/13044793/656_review.patch
ratis-docs/content/cli.md
Outdated
|
|
||
| You can get the ratis-shell from bin tarball as well: | ||
| Download the Ratis bin tarball from https://ratis.apache.org/downloads.html . | ||
| Note that ratis-shell is available starting from version 2.3.0 |
There was a problem hiding this comment.
2.3.0 (already released) does not have ratis-shell bin.
ratis-docs/content/cli.md
Outdated
| Note that ratis-shell is available starting from version 2.3.0 | ||
| Extract the bin tarball to a destination directory `<DST_DIR>` | ||
| ``` | ||
| $ tar -C <DST_DIR> -zxvf apache-ratis-<VERSION>-bin.tar.gz |
There was a problem hiding this comment.
We may select to extract only ratis-shell
$ tar -C <DST_DIR> -zxvf apache-ratis-<VERSION>-bin.tar.gz apache-ratis-<VERSION>/ratis-shell
$ cd <DST_DIR>
$ mv apache-ratis-<VERSION>/ratis-shell .
$ rmdir apache-ratis-<VERSION>/
There was a problem hiding this comment.
Good idea, I have change it.
|
@szetszwo PTAL again, thx! |
szetszwo
left a comment
szetszwo
left a comment
There was a problem hiding this comment.
@codings-dan , thanks for the update. Just a comment inlined.
Also, let's add a table right before "Setting up the ratis-shell".
## Availability
| Version | Available in src tarball? | Available in bin tarball? |
| :------: | :-----------------------: | :-----------------------: |
| < 2.3.0 | No | No |
| 2.3.0 | Yes | No |
| \> 2.3.0 | Yes | Yes |
## Setting up the ratis-shell
ratis-docs/content/cli.md
Outdated
|
|
||
| ### Setting up from a binary tarball | ||
| Download the Ratis bin tarball from https://ratis.apache.org/downloads.html . | ||
| Note that ratis-shell is available starting from version 2.3.0 (already released) does not have ratis-shell bin. |
There was a problem hiding this comment.
This sentence "... available ... does not have ..." is a little bit confusing. How about we rewrite it as below?
Note that the bin tarball of Ratis version 2.3.0 or earlier does not contain ratis-shell.
The bin tarball of later versions will contain ratis-shell.
Adding a table is great, now it's all clear. |
szetszwo
left a comment
szetszwo
left a comment
There was a problem hiding this comment.
+1 the change looks good.
|
Thanks @szetszwo help review the pull request! |
(cherry picked from commit aa77796)
2 participants
see https://issues.apache.org/jira/projects/RATIS/issues/RATIS-1589?filter=allissues