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

HBASE-24106 Update getting started documentation after HBASE-24086 #1422

Merged
merged 1 commit into from
Apr 6, 2020

Conversation

ndimiduk
Copy link
Member

@ndimiduk ndimiduk commented Apr 2, 2020

Updates documentation according to change in HBASE-24086 / #1408 .

@Apache-HBase
Copy link

🎊 +1 overall

Vote Subsystem Runtime Comment
+0 🆗 reexec 0m 35s Docker mode activated.
-0 ⚠️ yetus 0m 3s Unprocessed flag(s): --brief-report-file --spotbugs-strict-precheck --whitespace-eol-ignore-list --whitespace-tabs-ignore-list --quick-hadoopcheck
_ Prechecks _
_ master Compile Tests _
_ Patch Compile Tests _
_ Other Tests _
1m 45s
Subsystem Report/Notes
Docker Client=19.03.8 Server=19.03.8 base: https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-1422/1/artifact/yetus-jdk11-hadoop3-check/output/Dockerfile
GITHUB PR #1422
Optional Tests
uname Linux 4d5ade16f92d 4.15.0-58-generic #64-Ubuntu SMP Tue Aug 6 11:12:41 UTC 2019 x86_64 x86_64 x86_64 GNU/Linux
Build tool maven
Personality dev-support/hbase-personality.sh
git revision master / b2c9a06
Max. process+thread count 59 (vs. ulimit of 10000)
modules C: . U: .
Console output https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-1422/1/console
versions git=2.17.1 maven=2018-06-17T18:33:14Z)
Powered by Apache Yetus 0.11.1 https://yetus.apache.org

This message was automatically generated.

@Apache-HBase
Copy link

🎊 +1 overall

Vote Subsystem Runtime Comment
+0 🆗 reexec 0m 36s Docker mode activated.
-0 ⚠️ yetus 0m 3s Unprocessed flag(s): --brief-report-file --spotbugs-strict-precheck --whitespace-eol-ignore-list --whitespace-tabs-ignore-list --quick-hadoopcheck
_ Prechecks _
_ master Compile Tests _
_ Patch Compile Tests _
_ Other Tests _
1m 47s
Subsystem Report/Notes
Docker Client=19.03.8 Server=19.03.8 base: https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-1422/1/artifact/yetus-jdk8-hadoop2-check/output/Dockerfile
GITHUB PR #1422
Optional Tests
uname Linux 55da4dacfbaa 4.15.0-58-generic #64-Ubuntu SMP Tue Aug 6 11:12:41 UTC 2019 x86_64 x86_64 x86_64 GNU/Linux
Build tool maven
Personality dev-support/hbase-personality.sh
git revision master / b2c9a06
Max. process+thread count 46 (vs. ulimit of 10000)
modules C: . U: .
Console output https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-1422/1/console
versions git=2.17.1 maven=2018-06-17T18:33:14Z)
Powered by Apache Yetus 0.11.1 https://yetus.apache.org

This message was automatically generated.

@Apache-HBase
Copy link

🎊 +1 overall

Vote Subsystem Runtime Comment
+0 🆗 reexec 0m 30s Docker mode activated.
_ Prechecks _
+1 💚 dupname 0m 0s No case conflicting files found.
+1 💚 @author 0m 0s The patch does not contain any @author tags.
_ master Compile Tests _
+1 💚 mvninstall 5m 28s master passed
+0 🆗 refguide 5m 2s branch has no errors when building the reference guide. See footer for rendered docs, which you should manually inspect.
_ Patch Compile Tests _
+1 💚 mvninstall 4m 58s the patch passed
+1 💚 whitespace 0m 0s The patch has no whitespace issues.
+0 🆗 refguide 4m 54s patch has no errors when building the reference guide. See footer for rendered docs, which you should manually inspect.
_ Other Tests _
+1 💚 asflicense 0m 18s The patch does not generate ASF License warnings.
22m 39s
Subsystem Report/Notes
Docker Client=19.03.8 Server=19.03.8 base: https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-1422/1/artifact/yetus-general-check/output/Dockerfile
GITHUB PR #1422
Optional Tests dupname asflicense refguide
uname Linux ff1defb2ff4e 4.15.0-60-generic #67-Ubuntu SMP Thu Aug 22 16:55:30 UTC 2019 x86_64 x86_64 x86_64 GNU/Linux
Build tool maven
Personality dev-support/hbase-personality.sh
git revision master / b2c9a06
refguide https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-1422/1/artifact/yetus-general-check/output/branch-site/book.html
refguide https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-1422/1/artifact/yetus-general-check/output/patch-site/book.html
Max. process+thread count 76 (vs. ulimit of 10000)
modules C: . U: .
Console output https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-1422/1/console
versions git=2.17.1 maven=2018-06-17T18:33:14Z)
Powered by Apache Yetus 0.11.1 https://yetus.apache.org

This message was automatically generated.

@ndimiduk ndimiduk force-pushed the 24106-getting-started branch from c9c164e to 27e6663 Compare April 2, 2020 22:06
@Apache-HBase
Copy link

🎊 +1 overall

Vote Subsystem Runtime Comment
+0 🆗 reexec 1m 37s Docker mode activated.
-0 ⚠️ yetus 0m 2s Unprocessed flag(s): --brief-report-file --spotbugs-strict-precheck --whitespace-eol-ignore-list --whitespace-tabs-ignore-list --quick-hadoopcheck
_ Prechecks _
_ master Compile Tests _
_ Patch Compile Tests _
_ Other Tests _
2m 33s
Subsystem Report/Notes
Docker Client=19.03.8 Server=19.03.8 base: https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-1422/2/artifact/yetus-jdk8-hadoop2-check/output/Dockerfile
GITHUB PR #1422
Optional Tests
uname Linux a91033ffc55e 4.15.0-91-generic #92-Ubuntu SMP Fri Feb 28 11:09:48 UTC 2020 x86_64 x86_64 x86_64 GNU/Linux
Build tool maven
Personality dev-support/hbase-personality.sh
git revision master / 37aa669
Max. process+thread count 46 (vs. ulimit of 10000)
modules C: . U: .
Console output https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-1422/2/console
versions git=2.17.1 maven=2018-06-17T18:33:14Z)
Powered by Apache Yetus 0.11.1 https://yetus.apache.org

This message was automatically generated.

@Apache-HBase
Copy link

🎊 +1 overall

Vote Subsystem Runtime Comment
+0 🆗 reexec 1m 37s Docker mode activated.
-0 ⚠️ yetus 0m 3s Unprocessed flag(s): --brief-report-file --spotbugs-strict-precheck --whitespace-eol-ignore-list --whitespace-tabs-ignore-list --quick-hadoopcheck
_ Prechecks _
_ master Compile Tests _
_ Patch Compile Tests _
_ Other Tests _
2m 31s
Subsystem Report/Notes
Docker Client=19.03.8 Server=19.03.8 base: https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-1422/2/artifact/yetus-jdk11-hadoop3-check/output/Dockerfile
GITHUB PR #1422
Optional Tests
uname Linux 2a7e75fec215 4.15.0-91-generic #92-Ubuntu SMP Fri Feb 28 11:09:48 UTC 2020 x86_64 x86_64 x86_64 GNU/Linux
Build tool maven
Personality dev-support/hbase-personality.sh
git revision master / 37aa669
Max. process+thread count 49 (vs. ulimit of 10000)
modules C: . U: .
Console output https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-1422/2/console
versions git=2.17.1 maven=2018-06-17T18:33:14Z)
Powered by Apache Yetus 0.11.1 https://yetus.apache.org

This message was automatically generated.

@Apache-HBase
Copy link

🎊 +1 overall

Vote Subsystem Runtime Comment
+0 🆗 reexec 2m 31s Docker mode activated.
_ Prechecks _
+1 💚 dupname 0m 0s No case conflicting files found.
+1 💚 @author 0m 0s The patch does not contain any @author tags.
_ master Compile Tests _
+1 💚 mvninstall 5m 58s master passed
+0 🆗 refguide 5m 28s branch has no errors when building the reference guide. See footer for rendered docs, which you should manually inspect.
_ Patch Compile Tests _
+1 💚 mvninstall 5m 32s the patch passed
+1 💚 whitespace 0m 1s The patch has no whitespace issues.
+0 🆗 refguide 5m 21s patch has no errors when building the reference guide. See footer for rendered docs, which you should manually inspect.
_ Other Tests _
+1 💚 asflicense 0m 15s The patch does not generate ASF License warnings.
26m 19s
Subsystem Report/Notes
Docker Client=19.03.8 Server=19.03.8 base: https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-1422/2/artifact/yetus-general-check/output/Dockerfile
GITHUB PR #1422
Optional Tests dupname asflicense refguide
uname Linux a36a63a37e87 4.15.0-74-generic #84-Ubuntu SMP Thu Dec 19 08:06:28 UTC 2019 x86_64 x86_64 x86_64 GNU/Linux
Build tool maven
Personality dev-support/hbase-personality.sh
git revision master / 37aa669
refguide https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-1422/2/artifact/yetus-general-check/output/branch-site/book.html
refguide https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-1422/2/artifact/yetus-general-check/output/patch-site/book.html
Max. process+thread count 63 (vs. ulimit of 10000)
modules C: . U: .
Console output https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-1422/2/console
versions git=2.17.1 maven=2018-06-17T18:33:14Z)
Powered by Apache Yetus 0.11.1 https://yetus.apache.org

This message was automatically generated.

Copy link
Contributor

@bharathv bharathv left a comment

Choose a reason for hiding this comment

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

Thanks for cleaning this up.. A nit about versioning, lgtm otherwise..

which HBase stores its data. You can specify values for this configuration directly, as you'll see
in the subsequent sections.
+
NOTE: In this example, HBase is running on Hadoop's `LocalFileSystem`. That abstraction doesn't
Copy link
Contributor

Choose a reason for hiding this comment

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

Given this change is only going into specific versions, should we add a note for users on older versions? Something like...

if you are on v < 2.3, disable stream enforcement by setting this flag.. later versions Hbase takes care of it automatically.....

Copy link
Contributor

Choose a reason for hiding this comment

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

Generally, documentation changes are merged to master and cherry-picked to appropriate branches. In this case the commit should be backported to branch-2 and branch-2.3 but not to branch-2.2.

Copy link
Contributor

Choose a reason for hiding this comment

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

True..but I think most people refer to the ref-guide here https://hbase.apache.org/book.html rather than version specific one because it shows up in search results.. hence my comment.

Copy link
Member Author

Choose a reason for hiding this comment

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

We've never really solved challenges of the branch-specific documentation.

I didn't try older versions of 2.x... let me see where they stand.

Copy link
Member Author

Choose a reason for hiding this comment

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

The book says HBase 2.1 and 2.2 are "untested" with Hadoop 2.10. branch-2.2 builds with -Dhadoop-two.version=2.10.0 and produces a similar error at runtime:

java.lang.IllegalStateException: The procedure WAL relies on the ability to hsync for proper operation during component failures, but the underlying filesystem does not support doing so. Please check th
e config value of 'hbase.procedure.store.wal.use.hsync' to set the desired level of robustness and ensure the config value of 'hbase.wal.dir' points to a FileSystem mount that can provide it.
        at org.apache.hadoop.hbase.procedure2.store.wal.WALProcedureStore.rollWriter(WALProcedureStore.java:1092)
        at org.apache.hadoop.hbase.procedure2.store.wal.WALProcedureStore.recoverLease(WALProcedureStore.java:424)
        at org.apache.hadoop.hbase.procedure2.ProcedureExecutor.init(ProcedureExecutor.java:586)
        at org.apache.hadoop.hbase.master.HMaster.createProcedureExecutor(HMaster.java:1522)
        at org.apache.hadoop.hbase.master.HMaster.lambda$run$0(HMaster.java:579)
        at java.lang.Thread.run(Thread.java:748)

branch-2.1 does not build with hadoop-2.10.0,

[INFO] --- maven-enforcer-plugin:3.0.0-M2:enforce (banned-jsr305) @ hbase-client ---
[WARNING] Rule 0: org.apache.maven.plugins.enforcer.BannedDependencies failed with message:
We don't allow the JSR305 jar from the Findbugs project, see HBASE-16321.
Found Banned Dependency: com.google.code.findbugs:jsr305:jar:1.3.9

Copy link
Member Author

Choose a reason for hiding this comment

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

Given this change is only going into specific versions, should we add a note for users on older versions? Something like...

if you are on v < 2.3, disable stream enforcement by setting this flag.. later versions Hbase takes care of it automatically.....

This is tricky. My understanding is that HBase has never had these durability guarantees when running on LocalFileSystem because no version of Hadoop has ever provided an implementation that provides hflush or hsync on that class. Thus this warning is applicable everywhere, to everyone.

Now as far as HBase's behavior in the presence of a LocalFileSystem, that's a little different. On Hadoop-2.8.x, we had no way to ask Hadoop if the OutputStream supported these characteristics, so we simply move forward with a warning. It's not clear to me when we first exposed hbase.unsafe.stream.capability.enforce (on first glance, all the places that config is referenced appear to have been changed since its inception) or what our behavior was before then. Let me look into this further and see if I can make a recommendation.

If we back port the parent issue to branch-2.2, then I think the behavior will be the same on all branch-2 derivatives.

Copy link
Member Author

Choose a reason for hiding this comment

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

HBASE-19289 has some nice history here...

Copy link
Member

Choose a reason for hiding this comment

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

My understanding is that HBase has never had these durability guarantees when running on LocalFileSystem because no version of Hadoop has ever provided an implementation that provides hflush or hsync on that class

Yeah, agree on this point. Just driving by to also mention that there is the RawLocalFileSystem implementation which works with the local filesystem and does implement hflush/hsync. There's just some more trickery to get it set up for file:// instead of LocalFileSystem. I don't think we have this configured for HBase at all (I remember Accumulo used to do a bunch with it for UT's).

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, agree on this point. Just driving by to also mention that there is the RawLocalFileSystem implementation which works with the local filesystem and does implement hflush/hsync. There's just some more trickery to get it set up for file:// instead of LocalFileSystem. I don't think we have this configured for HBase at all (I remember Accumulo used to do a bunch with it for UT's).

Thanks for the pointer @joshelser . I'm not up to speed on the differences between the two. I looked long enough to see that they follow different inheritance hierarchies.

If we could converge the majority of our small and medium test suite onto some equivalent to LocalFileSystem, it would make a huge difference in the runtime and resource usage of tests...

which HBase stores its data. You can specify values for this configuration directly, as you'll see
in the subsequent sections.
+
NOTE: In this example, HBase is running on Hadoop's `LocalFileSystem`. That abstraction doesn't
Copy link
Contributor

Choose a reason for hiding this comment

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

Generally, documentation changes are merged to master and cherry-picked to appropriate branches. In this case the commit should be backported to branch-2 and branch-2.3 but not to branch-2.2.

@ndimiduk ndimiduk requested review from busbey, joshelser and madrob April 3, 2020 19:31
@ndimiduk
Copy link
Member Author

ndimiduk commented Apr 3, 2020

Pinging some other reviewers who were involved in earlier discussions around filesystem capabilities. Please see the parent issue to this one.

(cc @busbey @joshelser @madrob @steveloughran)

Copy link
Member

@joshelser joshelser left a comment

Choose a reason for hiding this comment

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

Nice little improvement!

Signed-off-by: Josh Elser <elserj@apache.org>
Signed-off-by: Bharath Vissapragada <bharathv@apache.org>
Signed-off-by: Peter Somogyi <psomogyi@apache.org>
@ndimiduk ndimiduk force-pushed the 24106-getting-started branch from 27e6663 to b409d17 Compare April 6, 2020 20:53
@ndimiduk ndimiduk merged commit 7de861b into apache:master Apr 6, 2020
@ndimiduk ndimiduk deleted the 24106-getting-started branch April 6, 2020 20:54
@ndimiduk
Copy link
Member Author

ndimiduk commented Apr 6, 2020

Applied to master. Patch does not cherry-pick cleanly to branch-2, so I'll look into a more whole-sale documentation update for branch-2 when I do the same for branch-2.3.

Thanks for the reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants