RATIS-1581. Add ratis-shell compile and command document #646
Conversation
|
@szetszwo Can you help review this patch, thanks! |
There was a problem hiding this comment.
@codings-dan , thanks a lot for working on this.
It is a good idea to have a section discussing how to setup ratis-shell. We should point the user to download the src tarball and describe how to build from it.
How about the bin tarball? How could we make ratis-shell work from the bin tarball without building it from the source?
| Get the ratis-shell source and Configure environment variables | ||
|
|
||
| ``` | ||
| $ mvn -DskipTests -Prelease -Papache-release clean package assembly:single |
There was a problem hiding this comment.
We should discuss how to run it from a release. Let's ask the user to download the src tarball from https://ratis.apache.org/downloads.html and mention that ratis shell is available starting from 2.3.0.
ratis-docs/content/cli.md
Outdated
| $ tar -C /tmp -xzf ratis-assembly/target/apache-ratis-2.3.0-SNAPSHOT-src.tar.gz | ||
|
|
||
| $ cd /tmp/apache-ratis-2.3.0-SNAPSHOT |
There was a problem hiding this comment.
- /tmp seems not a good location since the files could be deleted by the system.
- Let's do not hardcode the version number.
$ tar -C <DST_DIR> -xzf ratis-assembly/target/apache-ratis-*-src.tar.gz
$ cd <DST_DIR>/apache-ratis-<VERSION>
| @@ -23,6 +23,24 @@ Ratis-shell is the command line interface of Ratis. | |||
| > Ratis-shell is currently only **experimental**. | |||
| > The compatibility story is not considered for the time being. | |||
|
|
|||
|
|
|||
There was a problem hiding this comment.
Let's add a section title.
## Setting up ratis-shell
Sure, we could make user download the src tarball and executethe following command to build and get the ratis-shell
Good idea! User can get the ratis-shell from bin tarball without building it. Am I not authorized to change the contents of the bin tarball right now? Is there anything that I can do to support user getting ratis-shell directly from the bin tarball? |
There was a problem hiding this comment.
@codings-dan , thanks a lot for the update! Some comments inlined. See also https://issues.apache.org/jira/secure/attachment/13043803/646_review.patch
ratis-docs/content/cli.md
Outdated
| @@ -23,6 +23,37 @@ Ratis-shell is the command line interface of Ratis. | |||
| > Ratis-shell is currently only **experimental**. | |||
| > The compatibility story is not considered for the time being. | |||
|
|
|||
|
|
|||
| ## Get the ratis-shell source | |||
There was a problem hiding this comment.
Since this section is quite short. Let's call it "Setting up the ratis-shell" for including the entire setup and don't have any subsections.
ratis-docs/content/cli.md
Outdated
| ... | ||
| [INFO] BUILD SUCCESS | ||
|
|
||
| $ tar -C <DST_DIR>/ratis-shell -xzf ratis-assembly/target/apache-ratis-2.3.0-SNAPSHOT-src.tar.gz |
There was a problem hiding this comment.
It should use the shell.tar.gz but not src.tar.gz.
$ tar -C <DST_DIR>/ratis-shell -xzf ratis-assembly/target/apache-ratis-<VERSION>-shell.tar.gz
ratis-docs/content/cli.md
Outdated
|
|
||
| $ tar -C <DST_DIR>/ratis-shell -xzf ratis-assembly/target/apache-ratis-2.3.0-SNAPSHOT-src.tar.gz | ||
|
|
||
| $ cd <DST_DIR>/ratis-shell/apache-ratis-2.3.0-SNAPSHOT |
There was a problem hiding this comment.
Replace "2.3.0-SNAPSHOT" with <VERSION>.
ratis-docs/content/cli.md
Outdated
|
|
||
| $ cd <DST_DIR>/ratis-shell/apache-ratis-2.3.0-SNAPSHOT | ||
| ``` | ||
| TODO(codings-dan): Get `ratis-shell` from bin tarball directly |
There was a problem hiding this comment.
Let's remove this TODO. Otherwise, it will show up in the doc.
There was a problem hiding this comment.
I have remove this TODO. I will add this part in the future. What can I do to make user get ratis-shell from bin tarball directly, I'd love to take this task and complete it!
|
@szetszwo Thanks for helping change the document, PTAL again, thanks! |
|
Thanks @szetszwo for reviewing the code! |
see https://issues.apache.org/jira/browse/RATIS-1581