HBASE-14810 Update Hadoop support description to explain "not tested" vs "not supported"

This commit is contained in:
Misty Stanley-Jones 2016-01-28 09:54:21 -08:00
parent 0de221a19d
commit 9cd487129d
4 changed files with 40 additions and 2 deletions

View File

@ -28,7 +28,9 @@
:experimental: :experimental:
This chapter expands upon the <<getting_started>> chapter to further explain configuration of Apache HBase. This chapter expands upon the <<getting_started>> chapter to further explain configuration of Apache HBase.
Please read this chapter carefully, especially the <<basic.prerequisites,Basic Prerequisites>> to ensure that your HBase testing and deployment goes smoothly, and prevent data loss. Please read this chapter carefully, especially the <<basic.prerequisites,Basic Prerequisites>>
to ensure that your HBase testing and deployment goes smoothly, and prevent data loss.
Familiarize yourself with <<hbase_supported_tested_definitions>> as well.
== Configuration Files == Configuration Files
Apache HBase uses the same configuration system as Apache Hadoop. Apache HBase uses the same configuration system as Apache Hadoop.

View File

@ -19,6 +19,7 @@
*/ */
//// ////
[[getting_started]]
= Getting Started = Getting Started
:doctype: book :doctype: book
:numbered: :numbered:

View File

@ -70,4 +70,39 @@ Please use link:https://issues.apache.org/jira/browse/hbase[JIRA] to report non-
To protect existing HBase installations from new vulnerabilities, please *do not* use JIRA to report security-related bugs. Instead, send your report to the mailing list private@apache.org, which allows anyone to send messages, but restricts who can read them. Someone on that list will contact you to follow up on your report. To protect existing HBase installations from new vulnerabilities, please *do not* use JIRA to report security-related bugs. Instead, send your report to the mailing list private@apache.org, which allows anyone to send messages, but restricts who can read them. Someone on that list will contact you to follow up on your report.
[hbase_supported_tested_definitions]
.Support and Testing Expectations
The phrases /supported/, /not supported/, /tested/, and /not tested/ occur several
places throughout this guide. In the interest of clarity, here is a brief explanation
of what is generally meant by these phrases, in the context of HBase.
NOTE: Commercial technical support for Apache HBase is provided by many Hadoop vendors.
This is not the sense in which the term /support/ is used in the context of the
Apache HBase project. The Apache HBase team assumes no responsibility for your
HBase clusters, your configuration, or your data.
Supported::
In the context of Apache HBase, /supported/ means that HBase is designed to work
in the way described, and deviation from the defined behavior or functionality should
be reported as a bug.
Not Supported::
In the context of Apache HBase, /not supported/ means that a use case or use pattern
is not expected to work and should be considered an antipattern. If you think this
designation should be reconsidered for a given feature or use pattern, file a JIRA
or start a discussion on one of the mailing lists.
Tested::
In the context of Apache HBase, /tested/ means that a feature is covered by unit
or integration tests, and has been proven to work as expected.
Not Tested::
In the context of Apache HBase, /not tested/ means that a feature or use pattern
may or may notwork in a given way, and may or may not corrupt your data or cause
operational issues. It is an unknown, and there are no guarantees. If you can provide
proof that a feature designated as /not tested/ does work in a given way, please
submit the tests and/or the metrics so that other users can gain certainty about
such features or use patterns.
:numbered: :numbered:

View File

@ -31,7 +31,7 @@ You cannot skip major versions when upgrading. If you are upgrading from version
NOTE: It may be possible to skip across versions -- for example go from 0.92.2 straight to 0.98.0 just following the 0.96.x upgrade instructions -- but these scenarios are untested. NOTE: It may be possible to skip across versions -- for example go from 0.92.2 straight to 0.98.0 just following the 0.96.x upgrade instructions -- but these scenarios are untested.
Review <<configuration>>, in particular <<hadoop>>. Review <<configuration>>, in particular <<hadoop>>. Familiarize yourself with <<hbase_supported_tested_definitions>>.
[[hbase.versioning]] [[hbase.versioning]]
== HBase version number and compatibility == HBase version number and compatibility