You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kudu.apache.org by al...@apache.org on 2019/10/31 00:13:04 UTC
[kudu] branch branch-1.11.x updated: [docs] fix broken links
reported by 'site_tool proof'
This is an automated email from the ASF dual-hosted git repository.
alexey pushed a commit to branch branch-1.11.x
in repository https://gitbox.apache.org/repos/asf/kudu.git
The following commit(s) were added to refs/heads/branch-1.11.x by this push:
new e6e07be [docs] fix broken links reported by 'site_tool proof'
e6e07be is described below
commit e6e07be75e259d3f32de9ccf6e382fc7f875091a
Author: Alexey Serbin <al...@apache.org>
AuthorDate: Wed Oct 30 13:27:47 2019 -0700
[docs] fix broken links reported by 'site_tool proof'
While preparing to update the contents of the project site for 1.11.0
release, I found that the 'site_tool proof' reports many broken links.
This patch fixes that, so 'site_tool proof' returns clean.
I also updated the installation.adoc, moving the information on API
documentaion into developing.adoc. By my understanding, that piece
doesn't belong to installation-related topics. I also updated the
JDK requirements to reflect the fact of dropping support of Java 7
in prior release (i.e. 1.10.0).
Change-Id: I8c8e3a477dacf7dc304d138de7efedc1e6d93b65
Reviewed-on: http://gerrit.cloudera.org:8080/14591
Reviewed-by: Grant Henke <gr...@apache.org>
Tested-by: Alexey Serbin <as...@cloudera.com>
(cherry picked from commit 9f01e7632d912b635caf8073a3e63fb8b8407b2a)
Reviewed-on: http://gerrit.cloudera.org:8080/14594
Reviewed-by: Alexey Serbin <as...@cloudera.com>
---
docs/developing.adoc | 26 ++++++++++++++++++++++---
docs/hive_metastore.adoc | 11 +++++++----
docs/installation.adoc | 41 +++++++--------------------------------
docs/kudu_impala_integration.adoc | 8 +++++---
docs/schema_design.adoc | 4 +++-
docs/security.adoc | 1 +
6 files changed, 46 insertions(+), 45 deletions(-)
diff --git a/docs/developing.adoc b/docs/developing.adoc
index a147de0..a0e590a 100644
--- a/docs/developing.adoc
+++ b/docs/developing.adoc
@@ -15,7 +15,6 @@
// specific language governing permissions and limitations
// under the License.
-[[developing]]
= Developing Applications With Apache Kudu
:author: Kudu Team
@@ -34,8 +33,28 @@ their use.
WARNING: Use of server-side or private interfaces is not supported, and interfaces
which are not part of public APIs have no stability guarantees.
+[[view_api]]
== Viewing the API Documentation
-include::installation.adoc[tags=view_api]
+
+.C++ API Documentation
+You can view the link:../cpp-client-api/index.html[C++ client API documentation]
+online. Alternatively, after
+<<installation.adoc#build_from_source,building Kudu from source>>, you can
+additionally build the `doxygen` target (e.g., run `make doxygen` if using
+make) and use the locally generated API documentation by opening
+`docs/doxygen/client_api/html/index.html` file in your favorite Web browser.
+
+NOTE: In order to build the `doxygen` target, it's necessary to have
+doxygen with Dot (graphviz) support installed at your build machine. If
+you installed doxygen after building Kudu from source, you will need to run
+`cmake` again to pick up the doxygen location and generate appropriate
+targets.
+
+.Java API Documentation
+You can view the link:../apidocs/index.html[Java API documentation] online.
+Alternatively, after <<installation.adoc#build_java_client,building
+the Java client>>, Java API documentation is available in
+`java/kudu-client/target/apidocs/index.html`.
== Working Examples
@@ -306,7 +325,8 @@ host is patched._
=== System Requirements
The binary test JAR must be run on one of the
-<<installation.adoc#,supported Kudu platforms>>, which includes:
+<<installation.adoc#prerequisites_and_requirements,supported Kudu platforms>>,
+which includes:
- macOS El Capitan (10.11) or later;
- CentOS 6.6+, Ubuntu 14.04+, or another recent distribution of Linux
diff --git a/docs/hive_metastore.adoc b/docs/hive_metastore.adoc
index a8a1dc7..ed49ea4 100644
--- a/docs/hive_metastore.adoc
+++ b/docs/hive_metastore.adoc
@@ -15,7 +15,6 @@
// specific language governing permissions and limitations
// under the License.
-[[hive_metastore]]
= Using the Hive Metastore with Kudu
:author: Kudu Team
@@ -28,6 +27,9 @@
:sectlinks:
:experimental:
+[[hive_metastore]]
+## Overview
+
Kudu has an optional feature which allows it to integrate its own catalog with
the Hive Metastore (HMS). The HMS is the de-facto standard catalog and metadata
provider in the Hadoop ecosystem. When the HMS integration is enabled, Kudu
@@ -87,6 +89,7 @@ multiple Kudu tables exist whose names only differ by case, the Kudu master(s)
will fail to start up. Be sure to rename such conflicting tables before
enabling the Hive Metastore integration.
+[[metadata_sync]]
### Metadata Synchronization
When the Hive Metastore integration is enabled, Kudu will automatically
synchronize metadata changes to Kudu tables between Kudu and the HMS. As such,
@@ -108,10 +111,10 @@ those stored in Kudu. Additionally, multiple external tables may refer to the
same underlying Kudu table. Thus, since external tables may not map one-to-one
with Kudu tables, the Hive Metastore integration and tooling will only
automatically synchronize metadata for internal tables. See the
-<<kudu_impala_integration.adoc#using-apache-kudu-with-apache-impala,Kudu Impala
-integration documentation>> for more
-information about table types in Impala
+<<kudu_impala_integration.adoc#kudu_impala,Kudu Impala integration documentation>>
+for more information about table types in Impala
+[[enabling-the-hive-metastore-integration]]
## Enabling the Hive Metastore Integration
WARNING: Before enabling the Hive Metastore integration on an existing cluster,
diff --git a/docs/installation.adoc b/docs/installation.adoc
index 13e8672..f7dc39f 100644
--- a/docs/installation.adoc
+++ b/docs/installation.adoc
@@ -31,6 +31,7 @@
The Apache Kudu project only publishes source code releases, to deploy Kudu on a
cluster follow the steps below to build Kudu from source.
+[[prerequisites_and_requirements]]
== Prerequisites and Requirements
.Hardware
- One or more hosts to run Kudu masters. It is recommended to have either one master (no fault
@@ -67,7 +68,7 @@ media may significantly improve latency when Kudu is configured for its highest
durability levels.
.Java
-- JDK 7 or JDK 8 is required to build Kudu, but a JRE is not required at runtime
+- JDK 8 is required to build Kudu, but a JRE is not required at runtime
except for tests.
[[build_from_source]]
@@ -584,46 +585,18 @@ Other libraries and headers are internal to Kudu and have no stability guarantee
== Build the Java Client
.Requirements
-- JDK 7 or JDK 8
+- JDK 8
-WARNING: Support for Java 7 is deprecated as of Kudu 1.5.0 and may be removed in
-the next major release.
-
-To build the Java client, clone the Kudu Git
-repository, change to the `java` directory, and issue the following command:
+To build the Java client, clone the Kudu Git repository, change to the `java`
+directory, and issue the following command:
[source,bash]
----
$ ./gradlew assemble
----
-For more information about building the Java API, as well as Eclipse integration,
-see `java/README.md`.
-
-[[view_api]]
-== View API Documentation
-
-// tag::view_api[]
-.C++ API Documentation
-You can view the link:../cpp-client-api/index.html[C++ client API
-documentation] online. Alternatively, after
-link:installation.html#build_from_source[building Kudu from source], you can
-additionally build the `doxygen` target (e.g., run `make doxygen` if using
-make) and use the locally generated API documentation by opening
-`docs/doxygen/client_api/html/index.html` file in your favorite Web browser.
-
-NOTE: In order to build the `doxygen` target, it's necessary to have
-doxygen with Dot (graphviz) support installed at your build machine. If
-you installed doxygen after building Kudu from source, you will need to run
-`cmake` again to pick up the doxygen location and generate appropriate
-targets.
-
-.Java API Documentation
-You can view the link:../apidocs/index.html[Java API documentation] online.
-Alternatively, after link:installation.html#build_java_client[building the Java
-client], Java API documentation is available in
-`java/kudu-client/target/apidocs/index.html`.
-// end::view_api[]
+For more information on building the Java parts of the Kudu project, as well
+as Eclipse integration, see `java/README.md`.
[[upgrade]]
== Upgrade from a Previous Version of Kudu
diff --git a/docs/kudu_impala_integration.adoc b/docs/kudu_impala_integration.adoc
index 6a5e49c..1c7d923 100755
--- a/docs/kudu_impala_integration.adoc
+++ b/docs/kudu_impala_integration.adoc
@@ -15,7 +15,6 @@
// specific language governing permissions and limitations
// under the License.
-[[kudu_impala]]
= Using Apache Kudu with Apache Impala
:author: Kudu Team
:imagesdir: ./images
@@ -27,9 +26,12 @@
:sectlinks:
:experimental:
+[[kudu_impala]]
+== Overview
+
Kudu has tight integration with Apache Impala, allowing you to use Impala
to insert, query, update, and delete data from Kudu tablets using Impala's SQL
-syntax, as an alternative to using the link:installation.html#view_api[Kudu APIs]
+syntax, as an alternative to using the <<developing.adoc#view_api,Kudu APIs>>
to build a custom Kudu application. In addition, you can use JDBC or ODBC to connect
existing or new applications written in any language, framework, or business intelligence
tool to your Kudu data, using Impala as the broker.
@@ -772,7 +774,7 @@ The examples above have only explored a fraction of what you can do with Impala
- Read the link:https://impala.apache.org/impala-docs.html[Impala documentation].
- View the link:https://impala.apache.org/docs/build/html/topics/impala_langref.html[Impala SQL reference].
- Read about Impala internals or learn how to contribute to Impala on the link:https://cwiki.apache.org/confluence/display/IMPALA/Impala+Home[Impala Wiki].
-- Read about the native link:installation.html#view_api[Kudu APIs].
+- Read about the native <<developing.adoc#view_api,Kudu APIs>>.
=== Known Issues and Limitations
diff --git a/docs/schema_design.adoc b/docs/schema_design.adoc
index 305a4e3..a0c8405 100644
--- a/docs/schema_design.adoc
+++ b/docs/schema_design.adoc
@@ -15,7 +15,6 @@
// specific language governing permissions and limitations
// under the License.
-[[schema_design]]
= Apache Kudu Schema Design
:author: Kudu Team
:imagesdir: ./images
@@ -27,6 +26,9 @@
:sectlinks:
:experimental:
+[[schema_design]]
+== Overview
+
Kudu tables have a structured data model similar to tables in a traditional
RDBMS. Schema design is critical for achieving the best performance and
operational stability from Kudu. Every workload is unique, and there is no
diff --git a/docs/security.adoc b/docs/security.adoc
index 91017af..27842e9 100644
--- a/docs/security.adoc
+++ b/docs/security.adoc
@@ -151,6 +151,7 @@ to only those users who are able to successfully authenticate via Kerberos.
Unauthenticated users on the same network as the Kudu servers will be unable
to access the cluster.
+[[fine_grained_authz]]
== Fine-Grained Authorization
As of Kudu 1.10.0, Kudu can be configured to enforce fine-grained authorization