Apache
/
hadoop
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

HADOOP-12470. In-page TOC of documentation should be automatically generated by doxia macro (iwasakims) 

(cherry picked from commit cbd31328a6)

 Conflicts:
	hadoop-common-project/hadoop-common/src/site/markdown/CommandsManual.md
	hadoop-common-project/hadoop-common/src/site/markdown/UnixShellGuide.md

(cherry picked from commit 722182fdfb)
This commit is contained in:
Masatake Iwasaki 2016-03-04 14:11:36 +09:00
parent c6e37f6782
commit 9d551a3adf
26 changed files with 30 additions and 264 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hadoop-common-project/hadoop-auth/src/site/site.xml
View File

@ -16,7 +16,7 @@
<skin>
<groupId>org.apache.maven.skins</groupId>
<artifactId>maven-stylus-skin</artifactId>
<version>1.2</version>
<version>${maven-stylus-skin.version}</version>
</skin>
<body>

5
hadoop-common-project/hadoop-common/src/site/markdown/CLIMiniCluster.md.vm
View File

@ -15,10 +15,7 @@
Hadoop: CLI MiniCluster.
========================
* [Hadoop: CLI MiniCluster.](#Hadoop:_CLI_MiniCluster.)
* [Purpose](#Purpose)
* [Hadoop Tarball](#Hadoop_Tarball)
* [Running the MiniCluster](#Running_the_MiniCluster)
<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
Purpose
-------

18
hadoop-common-project/hadoop-common/src/site/markdown/ClusterSetup.md
View File

@ -12,25 +12,11 @@
limitations under the License. See accompanying LICENSE file.
-->
* [Hadoop Cluster Setup](#Hadoop_Cluster_Setup)
* [Purpose](#Purpose)
* [Prerequisites](#Prerequisites)
* [Installation](#Installation)
* [Configuring Hadoop in Non-Secure Mode](#Configuring_Hadoop_in_Non-Secure_Mode)
* [Configuring Environment of Hadoop Daemons](#Configuring_Environment_of_Hadoop_Daemons)
* [Configuring the Hadoop Daemons](#Configuring_the_Hadoop_Daemons)
* [Monitoring Health of NodeManagers](#Monitoring_Health_of_NodeManagers)
* [Slaves File](#Slaves_File)
* [Hadoop Rack Awareness](#Hadoop_Rack_Awareness)
* [Logging](#Logging)
* [Operating the Hadoop Cluster](#Operating_the_Hadoop_Cluster)
* [Hadoop Startup](#Hadoop_Startup)
* [Hadoop Shutdown](#Hadoop_Shutdown)
* [Web Interfaces](#Web_Interfaces)
Hadoop Cluster Setup
====================
<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
Purpose
-------

21
hadoop-common-project/hadoop-common/src/site/markdown/CommandsManual.md
View File

@ -12,28 +12,11 @@
limitations under the License. See accompanying LICENSE file.
-->
* [Hadoop Commands Guide](#Hadoop_Commands_Guide)
* [Overview](#Overview)
* [Generic Options](#Generic_Options)
* [Hadoop Common Commands](#Hadoop_Common_Commands)
* [User Commands](#User_Commands)
* [archive](#archive)
* [checknative](#checknative)
* [classpath](#classpath)
* [credential](#credential)
* [distcp](#distcp)
* [fs](#fs)
* [jar](#jar)
* [key](#key)
* [trace](#trace)
* [version](#version)
* [CLASSNAME](#CLASSNAME)
* [Administration Commands](#Administration_Commands)
* [daemonlog](#daemonlog)
Hadoop Commands Guide
=====================
<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
Overview
--------

44
hadoop-common-project/hadoop-common/src/site/markdown/Compatibility.md
View File

@ -15,49 +15,7 @@
Apache Hadoop Compatibility
===========================
* [Apache Hadoop Compatibility](#Apache_Hadoop_Compatibility)
* [Purpose](#Purpose)
* [Compatibility types](#Compatibility_types)
* [Java API](#Java_API)
* [Use Cases](#Use_Cases)
* [Policy](#Policy)
* [Semantic compatibility](#Semantic_compatibility)
* [Policy](#Policy)
* [Wire compatibility](#Wire_compatibility)
* [Use Cases](#Use_Cases)
* [Policy](#Policy)
* [Java Binary compatibility for end-user applications i.e. Apache Hadoop ABI](#Java_Binary_compatibility_for_end-user_applications_i.e._Apache_Hadoop_ABI)
* [Use cases](#Use_cases)
* [Policy](#Policy)
* [REST APIs](#REST_APIs)
* [Policy](#Policy)
* [Metrics/JMX](#MetricsJMX)
* [Policy](#Policy)
* [File formats & Metadata](#File_formats__Metadata)
* [User-level file formats](#User-level_file_formats)
* [Policy](#Policy)
* [System-internal file formats](#System-internal_file_formats)
* [MapReduce](#MapReduce)
* [Policy](#Policy)
* [HDFS Metadata](#HDFS_Metadata)
* [Policy](#Policy)
* [Command Line Interface (CLI)](#Command_Line_Interface_CLI)
* [Policy](#Policy)
* [Web UI](#Web_UI)
* [Policy](#Policy)
* [Hadoop Configuration Files](#Hadoop_Configuration_Files)
* [Policy](#Policy)
* [Directory Structure](#Directory_Structure)
* [Policy](#Policy)
* [Java Classpath](#Java_Classpath)
* [Policy](#Policy)
* [Environment variables](#Environment_variables)
* [Policy](#Policy)
* [Build artifacts](#Build_artifacts)
* [Policy](#Policy)
* [Hardware/Software Requirements](#HardwareSoftware_Requirements)
* [Policies](#Policies)
* [References](#References)
<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
Purpose
-------

11
hadoop-common-project/hadoop-common/src/site/markdown/CredentialProviderAPI.md
View File

@ -15,16 +15,7 @@
CredentialProvider API Guide
=====================
---
- [Overview](#Overview)
- [Usage](#Usage)
- [Usage Overview](#Usage_Overview)
- [Supported Features](#Supported_Features)
- [Credential Management](#Credential_Management)
- [The hadoop credential Command](#The_hadoop_credential_Command)
---
<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
Overview
--------

45
hadoop-common-project/hadoop-common/src/site/markdown/FileSystemShell.md
View File

@ -12,50 +12,7 @@
limitations under the License. See accompanying LICENSE file.
-->
* [Overview](#Overview)
* [appendToFile](#appendToFile)
* [cat](#cat)
* [checksum](#checksum)
* [chgrp](#chgrp)
* [chmod](#chmod)
* [chown](#chown)
* [copyFromLocal](#copyFromLocal)
* [copyToLocal](#copyToLocal)
* [count](#count)
* [cp](#cp)
* [createSnapshot](#createSnapshot)
* [deleteSnapshot](#deleteSnapshot)
* [df](#df)
* [du](#du)
* [dus](#dus)
* [expunge](#expunge)
* [find](#find)
* [get](#get)
* [getfacl](#getfacl)
* [getfattr](#getfattr)
* [getmerge](#getmerge)
* [help](#help)
* [ls](#ls)
* [lsr](#lsr)
* [mkdir](#mkdir)
* [moveFromLocal](#moveFromLocal)
* [moveToLocal](#moveToLocal)
* [mv](#mv)
* [put](#put)
* [renameSnapshot](#renameSnapshot)
* [rm](#rm)
* [rmdir](#rmdir)
* [rmr](#rmr)
* [setfacl](#setfacl)
* [setfattr](#setfattr)
* [setrep](#setrep)
* [stat](#stat)
* [tail](#tail)
* [test](#test)
* [text](#text)
* [touchz](#touchz)
* [truncate](#truncate)
* [usage](#usage)
<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
Overview
========

4
hadoop-common-project/hadoop-common/src/site/markdown/HttpAuthentication.md
View File

@ -15,9 +15,7 @@
Authentication for Hadoop HTTP web-consoles
===========================================
* [Authentication for Hadoop HTTP web-consoles](#Authentication_for_Hadoop_HTTP_web-consoles)
* [Introduction](#Introduction)
* [Configuration](#Configuration)
<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
Introduction
------------

8
hadoop-common-project/hadoop-common/src/site/markdown/InterfaceClassification.md
View File

@ -15,13 +15,7 @@
Hadoop Interface Taxonomy: Audience and Stability Classification
================================================================
* [Hadoop Interface Taxonomy: Audience and Stability Classification](#Hadoop_Interface_Taxonomy:_Audience_and_Stability_Classification)
* [Motivation](#Motivation)
* [Interface Classification](#Interface_Classification)
* [Audience](#Audience)
* [Stability](#Stability)
* [How are the Classifications Recorded?](#How_are_the_Classifications_Recorded)
* [FAQ](#FAQ)
<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
Motivation
----------

24
hadoop-common-project/hadoop-common/src/site/markdown/Metrics.md
View File

@ -12,29 +12,7 @@
limitations under the License. See accompanying LICENSE file.
-->
* [Overview](#Overview)
* [jvm context](#jvm_context)
* [JvmMetrics](#JvmMetrics)
* [rpc context](#rpc_context)
* [rpc](#rpc)
* [RetryCache/NameNodeRetryCache](#RetryCacheNameNodeRetryCache)
* [rpcdetailed context](#rpcdetailed_context)
* [rpcdetailed](#rpcdetailed)
* [dfs context](#dfs_context)
* [namenode](#namenode)
* [FSNamesystem](#FSNamesystem)
* [JournalNode](#JournalNode)
* [datanode](#datanode)
* [yarn context](#yarn_context)
* [ClusterMetrics](#ClusterMetrics)
* [QueueMetrics](#QueueMetrics)
* [NodeManagerMetrics](#NodeManagerMetrics)
* [ugi context](#ugi_context)
* [UgiMetrics](#UgiMetrics)
* [metricssystem context](#metricssystem_context)
* [MetricsSystem](#MetricsSystem)
* [default context](#default_context)
* [StartupProgress](#StartupProgress)
<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
Overview
========

12
hadoop-common-project/hadoop-common/src/site/markdown/NativeLibraries.md.vm
View File

@ -15,17 +15,7 @@
Native Libraries Guide
======================
* [Native Libraries Guide](#Native_Libraries_Guide)
* [Overview](#Overview)
* [Native Hadoop Library](#Native_Hadoop_Library)
* [Usage](#Usage)
* [Components](#Components)
* [Supported Platforms](#Supported_Platforms)
* [Download](#Download)
* [Build](#Build)
* [Runtime](#Runtime)
* [Check](#Check)
* [Native Shared Libraries](#Native_Shared_Libraries)
<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
Overview
--------

4
hadoop-common-project/hadoop-common/src/site/markdown/RackAwareness.md
View File

@ -12,9 +12,7 @@
limitations under the License. See accompanying LICENSE file.
-->
* [Rack Awareness](#Rack_Awareness)
* [python Example](#python_Example)
* [bash Example](#bash_Example)
<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
Rack Awareness
==============

32
hadoop-common-project/hadoop-common/src/site/markdown/SecureMode.md
View File

@ -12,39 +12,11 @@
limitations under the License. See accompanying LICENSE file.
-->
* [Hadoop in Secure Mode](#Hadoop_in_Secure_Mode)
* [Introduction](#Introduction)
* [Authentication](#Authentication)
* [End User Accounts](#End_User_Accounts)
* [User Accounts for Hadoop Daemons](#User_Accounts_for_Hadoop_Daemons)
* [Kerberos principals for Hadoop Daemons](#Kerberos_principals_for_Hadoop_Daemons)
* [Mapping from Kerberos principals to OS user accounts](#Mapping_from_Kerberos_principals_to_OS_user_accounts)
* [Mapping from user to group](#Mapping_from_user_to_group)
* [Proxy user](#Proxy_user)
* [Secure DataNode](#Secure_DataNode)
* [Data confidentiality](#Data_confidentiality)
* [Data Encryption on RPC](#Data_Encryption_on_RPC)
* [Data Encryption on Block data transfer.](#Data_Encryption_on_Block_data_transfer.)
* [Data Encryption on HTTP](#Data_Encryption_on_HTTP)
* [Configuration](#Configuration)
* [Permissions for both HDFS and local fileSystem paths](#Permissions_for_both_HDFS_and_local_fileSystem_paths)
* [Common Configurations](#Common_Configurations)
* [NameNode](#NameNode)
* [Secondary NameNode](#Secondary_NameNode)
* [JournalNode](#JournalNode)
* [DataNode](#DataNode)
* [WebHDFS](#WebHDFS)
* [ResourceManager](#ResourceManager)
* [NodeManager](#NodeManager)
* [Configuration for WebAppProxy](#Configuration_for_WebAppProxy)
* [LinuxContainerExecutor](#LinuxContainerExecutor)
* [MapReduce JobHistory Server](#MapReduce_JobHistory_Server)
* [Multihoming](#Multihoming)
* [References](#References)
Hadoop in Secure Mode
=====================
<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
Introduction
------------

11
hadoop-common-project/hadoop-common/src/site/markdown/ServiceLevelAuth.md
View File

@ -15,16 +15,7 @@
Service Level Authorization Guide
=================================
* [Service Level Authorization Guide](#Service_Level_Authorization_Guide)
* [Purpose](#Purpose)
* [Prerequisites](#Prerequisites)
* [Overview](#Overview)
* [Configuration](#Configuration)
* [Enable Service Level Authorization](#Enable_Service_Level_Authorization)
* [Hadoop Services and Configuration Properties](#Hadoop_Services_and_Configuration_Properties)
* [Access Control Lists](#Access_Control_Lists)
* [Refreshing Service Level Authorization Configuration](#Refreshing_Service_Level_Authorization_Configuration)
* [Examples](#Examples)
<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
Purpose
-------

16
hadoop-common-project/hadoop-common/src/site/markdown/SingleCluster.md.vm
View File

@ -19,21 +19,7 @@
Hadoop: Setting up a Single Node Cluster.
=========================================
* [Hadoop: Setting up a Single Node Cluster.](#Hadoop:_Setting_up_a_Single_Node_Cluster.)
* [Purpose](#Purpose)
* [Prerequisites](#Prerequisites)
* [Supported Platforms](#Supported_Platforms)
* [Required Software](#Required_Software)
* [Installing Software](#Installing_Software)
* [Download](#Download)
* [Prepare to Start the Hadoop Cluster](#Prepare_to_Start_the_Hadoop_Cluster)
* [Standalone Operation](#Standalone_Operation)
* [Pseudo-Distributed Operation](#Pseudo-Distributed_Operation)
* [Configuration](#Configuration)
* [Setup passphraseless ssh](#Setup_passphraseless_ssh)
* [Execution](#Execution)
* [YARN on a Single Node](#YARN_on_a_Single_Node)
* [Fully-Distributed Operation](#Fully-Distributed_Operation)
<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
Purpose
-------

7
hadoop-common-project/hadoop-common/src/site/markdown/Superusers.md
View File

@ -15,12 +15,7 @@
Proxy user - Superusers Acting On Behalf Of Other Users
=======================================================
* [Proxy user - Superusers Acting On Behalf Of Other Users](#Proxy_user_-_Superusers_Acting_On_Behalf_Of_Other_Users)
* [Introduction](#Introduction)
* [Use Case](#Use_Case)
* [Code example](#Code_example)
* [Configurations](#Configurations)
* [Caveats](#Caveats)
<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
Introduction
------------

11
hadoop-common-project/hadoop-common/src/site/markdown/Tracing.md
View File

@ -15,16 +15,7 @@
Enabling Dapper-like Tracing in Hadoop
======================================
* [Enabling Dapper-like Tracing in Hadoop](#Enabling_Dapper-like_Tracing_in_Hadoop)
* [Dapper-like Tracing in Hadoop](#Dapper-like_Tracing_in_Hadoop)
* [HTrace](#HTrace)
* [SpanReceivers](#SpanReceivers)
* [Dynamic update of tracing configuration](#Dynamic_update_of_tracing_configuration)
* [Starting tracing spans by HTrace API](#Starting_tracing_spans_by_HTrace_API)
* [Sample code for tracing](#Sample_code_for_tracing)
* [Starting tracing spans by FileSystem Shell](#Starting_tracing_spans_by_FileSystem_Shell)
* [Starting tracing spans by configuration for HDFS client](#Starting_tracing_spans_by_configuration_for_HDFS_client)
<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
Dapper-like Tracing in Hadoop
-----------------------------

2
hadoop-common-project/hadoop-common/src/site/site.xml
View File

@ -16,7 +16,7 @@
<skin>
<groupId>org.apache.maven.skins</groupId>
<artifactId>maven-stylus-skin</artifactId>
<version>1.2</version>
<version>${maven-stylus-skin.version}</version>
</skin>
<body>

2
hadoop-common-project/hadoop-kms/src/site/site.xml
View File

@ -17,7 +17,7 @@
<skin>
<groupId>org.apache.maven.skins</groupId>
<artifactId>maven-stylus-skin</artifactId>
<version>1.2</version>
<version>${maven-stylus-skin.version}</version>
</skin>
<body>

2
hadoop-hdfs-project/hadoop-hdfs-httpfs/src/site/site.xml
View File

@ -17,7 +17,7 @@
<skin>
<groupId>org.apache.maven.skins</groupId>
<artifactId>maven-stylus-skin</artifactId>
<version>1.2</version>
<version>${maven-stylus-skin.version}</version>
</skin>
<body>

2
hadoop-hdfs-project/hadoop-hdfs/src/site/site.xml
View File

@ -16,7 +16,7 @@
<skin>
<groupId>org.apache.maven.skins</groupId>
<artifactId>maven-stylus-skin</artifactId>
<version>1.2</version>
<version>${maven-stylus-skin.version}</version>
</skin>
<body>

2
hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/site/site.xml
View File

@ -16,7 +16,7 @@
<skin>
<groupId>org.apache.maven.skins</groupId>
<artifactId>maven-stylus-skin</artifactId>
<version>1.2</version>
<version>${maven-stylus-skin.version}</version>
</skin>
<body>

2
hadoop-project/src/site/site.xml
View File

@ -32,7 +32,7 @@
<skin>
<groupId>org.apache.maven.skins</groupId>
<artifactId>maven-stylus-skin</artifactId>
<version>1.2</version>
<version>${maven-stylus-skin.version}</version>
</skin>
<body>

2
hadoop-tools/hadoop-openstack/src/site/site.xml
View File

@ -34,7 +34,7 @@
<skin>
<groupId>org.apache.maven.skins</groupId>
<artifactId>maven-stylus-skin</artifactId>
<version>1.2</version>
<version>${maven-stylus-skin.version}</version>
</skin>
<body>

2
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/site.xml
View File

@ -16,7 +16,7 @@
<skin>
<groupId>org.apache.maven.skins</groupId>
<artifactId>maven-stylus-skin</artifactId>
<version>1.2</version>
<version>${maven-stylus-skin.version}</version>
</skin>
<body>

3
pom.xml
View File

@ -92,7 +92,8 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xs
<!-- maven plugin versions -->
<maven-deploy-plugin.version>2.8.1</maven-deploy-plugin.version>
<maven-site-plugin.version>3.4</maven-site-plugin.version>
<maven-site-plugin.version>3.5</maven-site-plugin.version>
<maven-stylus-skin.version>1.5</maven-stylus-skin.version>
<maven-antrun-plugin.version>1.7</maven-antrun-plugin.version>
<maven-assembly-plugin.version>2.4</maven-assembly-plugin.version>
<maven-dependency-plugin.version>2.8</maven-dependency-plugin.version>