Repository: hbase Updated Branches: refs/heads/hbase-12439 0de221a19 -> fc5e698c0
HBASE-14810 Update Hadoop support description to explain "not tested" vs "not supported" Project: http://git-wip-us.apache.org/repos/asf/hbase/repo Commit: http://git-wip-us.apache.org/repos/asf/hbase/commit/9cd48712 Tree: http://git-wip-us.apache.org/repos/asf/hbase/tree/9cd48712 Diff: http://git-wip-us.apache.org/repos/asf/hbase/diff/9cd48712 Branch: refs/heads/hbase-12439 Commit: 9cd487129d5a0048216ff00ef15fdb8effc525ae Parents: 0de221a Author: Misty Stanley-Jones <mstanleyjo...@cloudera.com> Authored: Thu Jan 28 09:54:21 2016 -0800 Committer: Misty Stanley-Jones <mstanleyjo...@cloudera.com> Committed: Fri Jan 29 14:34:22 2016 -0800 ---------------------------------------------------------------------- src/main/asciidoc/_chapters/configuration.adoc | 4 ++- .../asciidoc/_chapters/getting_started.adoc | 1 + src/main/asciidoc/_chapters/preface.adoc | 35 ++++++++++++++++++++ src/main/asciidoc/_chapters/upgrading.adoc | 2 +- 4 files changed, 40 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hbase/blob/9cd48712/src/main/asciidoc/_chapters/configuration.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/_chapters/configuration.adoc b/src/main/asciidoc/_chapters/configuration.adoc index 495232f..8e71cea 100644 --- a/src/main/asciidoc/_chapters/configuration.adoc +++ b/src/main/asciidoc/_chapters/configuration.adoc @@ -28,7 +28,9 @@ :experimental: 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 Apache HBase uses the same configuration system as Apache Hadoop. http://git-wip-us.apache.org/repos/asf/hbase/blob/9cd48712/src/main/asciidoc/_chapters/getting_started.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/_chapters/getting_started.adoc b/src/main/asciidoc/_chapters/getting_started.adoc index 1b38e6e..7ef91b0 100644 --- a/src/main/asciidoc/_chapters/getting_started.adoc +++ b/src/main/asciidoc/_chapters/getting_started.adoc @@ -19,6 +19,7 @@ */ //// +[[getting_started]] = Getting Started :doctype: book :numbered: http://git-wip-us.apache.org/repos/asf/hbase/blob/9cd48712/src/main/asciidoc/_chapters/preface.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/_chapters/preface.adoc b/src/main/asciidoc/_chapters/preface.adoc index 50df7ff..877508c 100644 --- a/src/main/asciidoc/_chapters/preface.adoc +++ b/src/main/asciidoc/_chapters/preface.adoc @@ -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 priv...@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: http://git-wip-us.apache.org/repos/asf/hbase/blob/9cd48712/src/main/asciidoc/_chapters/upgrading.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/_chapters/upgrading.adoc b/src/main/asciidoc/_chapters/upgrading.adoc index 6327c5a..d731542 100644 --- a/src/main/asciidoc/_chapters/upgrading.adoc +++ b/src/main/asciidoc/_chapters/upgrading.adoc @@ -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. -Review <<configuration>>, in particular <<hadoop>>. +Review <<configuration>>, in particular <<hadoop>>. Familiarize yourself with <<hbase_supported_tested_definitions>>. [[hbase.versioning]] == HBase version number and compatibility
