update docs

jetoile · Nov 27, 2019 · 301a028 · 301a028
1 parent 70568de
commit 301a028
Show file tree

Hide file tree

Showing 4 changed files with 84 additions and 44 deletions.
diff --git a/README.md b/README.md
@@ -15,28 +15,29 @@ hadoop-unit-standalone:
 
 # Compatibility matrix
 
-| Hadoop Unit version  | Hadoop mini cluster version | HDP version |
-| ------------- | ------------- | ------------- |
-| 3.5 | 0.1.16 | HDP 2.6.5.0 |
-| 3.4 | 0.1.16 | HDP 2.6.5.0 |
-| 3.3 | 0.1.16 | HDP 2.6.5.0 |
-| 3.2 | 0.1.16 | HDP 2.6.5.0 |
-| 3.1 | 0.1.16 | HDP 2.6.5.0 |
-| 2.10.1 | 0.1.16 | HDP 2.6.5.0 |
-| 2.9 | 0.1.15 | HDP 2.6.3.0 |
-| 2.8 | 0.1.14 | HDP 2.6.2.0 |
-| 2.7 | 0.1.14 | HDP 2.6.2.0 |
-| 2.6 | 0.1.14 | HDP 2.6.2.0 |
-| 2.5 | 0.1.14 | HDP 2.6.2.0 |
-| 2.4 | 0.1.14 | HDP 2.6.2.0 |
-| 2.3 | 0.1.14 | HDP 2.6.2.0 |
-| 2.2 | 0.1.12 | HDP 2.6.1.0 |
-| 2.1 | 0.1.11 | HDP 2.5.3.0 |
-| 2.0 | 0.1.9 | HDP 2.5.3.0 |
-| 1.5 | 0.1.8 | HDP 2.5.0.0 |
-| 1.4 | 0.1.7 | HDP 2.4.2.0 |
-| 1.3 | 0.1.6 | HDP 2.4.0.0 |
-| 1.2 | 0.1.5 | HDP 2.4.0.0 |
+| Hadoop Unit version  | Hadoop mini cluster version | HDP version | Hadoop Version |
+| ------------- | ------------- | ------------- | ------------- |
+| 3.6 | 0.1.16 | HDP 2.6.5.0 | Hadoop 2.6.5 + Hadoop 3.2.1 |
+| 3.5 | 0.1.16 | HDP 2.6.5.0 | Hadoop 2.6.5 |
+| 3.4 | 0.1.16 | HDP 2.6.5.0 | Hadoop 2.6.5 |
+| 3.3 | 0.1.16 | HDP 2.6.5.0 | Hadoop 2.6.5 |
+| 3.2 | 0.1.16 | HDP 2.6.5.0 | Hadoop 2.6.5 |
+| 3.1 | 0.1.16 | HDP 2.6.5.0 | Hadoop 2.6.5 |
+| 2.10.1 | 0.1.16 | HDP 2.6.5.0 | Hadoop 2.6.5 |
+| 2.9 | 0.1.15 | HDP 2.6.3.0 | Hadoop 2.6.3 |
+| 2.8 | 0.1.14 | HDP 2.6.2.0 | Hadoop 2.6.2 |
+| 2.7 | 0.1.14 | HDP 2.6.2.0 | Hadoop 2.6.2 |
+| 2.6 | 0.1.14 | HDP 2.6.2.0 | Hadoop 2.6.2 |
+| 2.5 | 0.1.14 | HDP 2.6.2.0 | Hadoop 2.6.2 |
+| 2.4 | 0.1.14 | HDP 2.6.2.0 | Hadoop 2.6.2 |
+| 2.3 | 0.1.14 | HDP 2.6.2.0 | Hadoop 2.6.2 |
+| 2.2 | 0.1.12 | HDP 2.6.1.0 | Hadoop 2.6.1 |
+| 2.1 | 0.1.11 | HDP 2.5.3.0 | Hadoop 2.5.3 |
+| 2.0 | 0.1.9 | HDP 2.5.3.0 | Hadoop 2.5.3 |
+| 1.5 | 0.1.8 | HDP 2.5.0.0 | Hadoop 2.5.0 |
+| 1.4 | 0.1.7 | HDP 2.4.2.0 | Hadoop 2.4.2 |
+| 1.3 | 0.1.6 | HDP 2.4.0.0 | Hadoop 2.4.0 |
+| 1.2 | 0.1.5 | HDP 2.4.0.0 | Hadoop 2.4.0 |
 
 
 # [What is Hadoop Unit](https://blog.jetoile.fr/hadoop-unit/what-is-hadoop-unit.html)
@@ -60,4 +61,6 @@ hadoop-unit-standalone:
 
 # [Focus](https://blog.jetoile.fr/hadoop-unit/focus.html)
 
+# [FAQ](https://blog.jetoile.fr/hadoop-unit/faq.html)
+
 # [Licence](https://blog.jetoile.fr/hadoop-unit/licence.html)
diff --git a/hadoop-unit-site/src/site/markdown/faq.md b/hadoop-unit-site/src/site/markdown/faq.md
@@ -0,0 +1,35 @@
+# FAQ
+
+* [Add jar to component's classpath](#add-jar)
+
+
+<div id="add-jar"/>
+# Add jar to component's classpath
+
+Because sometimes, a specific jar has to be added to a component (for example, an udf or a custom authentication), it is possible to add an extra configuration.
+
+* For the standalone mode, add `<component name>.extraClasspath=<groupId>:<artifactId>:<version>[,<groupId>:<artifactId>:<version>]` into file `hadoop-unit-default.properties` 
+
+ex: 
+
+```text
+pulsar.extraClasspath=com.clevercloud:biscuit-pulsar:1.0-SNAPSHOT,org.apache.logging.log4j:log4j-api:2.10.0 
+```
+
+* For maven plugin mode, add the property `<<component name>>.extraClasspath><groupId>:<artifactId>:<version>[,<groupId>:<artifactId>:<version>]</<component name>.extraClasspath>` into the component's declaration
+
+ex:
+
+```xml
+<componentArtifact implementation="fr.jetoile.hadoopunit.ComponentArtifact">
+    <componentName>PULSAR</componentName>
+    <artifactId>hadoop-unit-pulsar</artifactId>
+    <groupId>fr.jetoile.hadoop</groupId>
+    <version>${hadoop-unit.version}</version>
+    <mainClass>fr.jetoile.hadoopunit.component.PulsarBootstrap</mainClass>
+    <properties>
+        <pulsar.extraClasspath>com.clevercloud:biscuit-pulsar:1.0-SNAPSHOT</pulsar.extraClasspath>
+    </properties>
+</componentArtifact>
+
+```
diff --git a/hadoop-unit-site/src/site/markdown/what-is-hadoop-unit.md b/hadoop-unit-site/src/site/markdown/what-is-hadoop-unit.md
@@ -25,28 +25,29 @@ It offers different kinds of utilization:
 
 # Compatibility matrix
 
-| Hadoop Unit version  | Hadoop mini cluster version | HDP version |
-| ------------- | ------------- | ------------- |
-| 3.5 | 0.1.16 | HDP 2.6.5.0 |
-| 3.4 | 0.1.16 | HDP 2.6.5.0 |
-| 3.3 | 0.1.16 | HDP 2.6.5.0 |
-| 3.2 | 0.1.16 | HDP 2.6.5.0 |
-| 3.1 | 0.1.16 | HDP 2.6.5.0 |
-| 2.10.1 | 0.1.16 | HDP 2.6.5.0 |
-| 2.9 | 0.1.15 | HDP 2.6.3.0 |
-| 2.8 | 0.1.14 | HDP 2.6.2.0 |
-| 2.7 | 0.1.14 | HDP 2.6.2.0 |
-| 2.6 | 0.1.14 | HDP 2.6.2.0 |
-| 2.5 | 0.1.14 | HDP 2.6.2.0 |
-| 2.4 | 0.1.14 | HDP 2.6.2.0 |
-| 2.3 | 0.1.14 | HDP 2.6.2.0 |
-| 2.2 | 0.1.12 | HDP 2.6.1.0 |
-| 2.1 | 0.1.11 | HDP 2.5.3.0 |
-| 2.0 | 0.1.9 | HDP 2.5.3.0 |
-| 1.5 | 0.1.8 | HDP 2.5.0.0 |
-| 1.4 | 0.1.7 | HDP 2.4.2.0 |
-| 1.3 | 0.1.6 | HDP 2.4.0.0 |
-| 1.2 | 0.1.5 | HDP 2.4.0.0 |
+| Hadoop Unit version  | Hadoop mini cluster version | HDP version | Hadoop Version |
+| ------------- | ------------- | ------------- | ------------- |
+| 3.6 | 0.1.16 | HDP 2.6.5.0 | Hadoop 2.6.5 + Hadoop 3.2.1 |
+| 3.5 | 0.1.16 | HDP 2.6.5.0 | Hadoop 2.6.5 |
+| 3.4 | 0.1.16 | HDP 2.6.5.0 | Hadoop 2.6.5 |
+| 3.3 | 0.1.16 | HDP 2.6.5.0 | Hadoop 2.6.5 |
+| 3.2 | 0.1.16 | HDP 2.6.5.0 | Hadoop 2.6.5 |
+| 3.1 | 0.1.16 | HDP 2.6.5.0 | Hadoop 2.6.5 |
+| 2.10.1 | 0.1.16 | HDP 2.6.5.0 | Hadoop 2.6.5 |
+| 2.9 | 0.1.15 | HDP 2.6.3.0 | Hadoop 2.6.3 |
+| 2.8 | 0.1.14 | HDP 2.6.2.0 | Hadoop 2.6.2 |
+| 2.7 | 0.1.14 | HDP 2.6.2.0 | Hadoop 2.6.2 |
+| 2.6 | 0.1.14 | HDP 2.6.2.0 | Hadoop 2.6.2 |
+| 2.5 | 0.1.14 | HDP 2.6.2.0 | Hadoop 2.6.2 |
+| 2.4 | 0.1.14 | HDP 2.6.2.0 | Hadoop 2.6.2 |
+| 2.3 | 0.1.14 | HDP 2.6.2.0 | Hadoop 2.6.2 |
+| 2.2 | 0.1.12 | HDP 2.6.1.0 | Hadoop 2.6.1 |
+| 2.1 | 0.1.11 | HDP 2.5.3.0 | Hadoop 2.5.3 |
+| 2.0 | 0.1.9 | HDP 2.5.3.0 | Hadoop 2.5.3 |
+| 1.5 | 0.1.8 | HDP 2.5.0.0 | Hadoop 2.5.0 |
+| 1.4 | 0.1.7 | HDP 2.4.2.0 | Hadoop 2.4.2 |
+| 1.3 | 0.1.6 | HDP 2.4.0.0 | Hadoop 2.4.0 |
+| 1.2 | 0.1.5 | HDP 2.4.0.0 | Hadoop 2.4.0 |
 
 
 __Warning__: Major releases are breaking compatibility

diff --git a/hadoop-unit-site/src/site/site.xml b/hadoop-unit-site/src/site/site.xml
@@ -49,6 +49,7 @@
             <item name="Develop your own plugin" href="plugin-development.html"/>
             <item name="Howto build" href="howto-build.html"/>
             <item name="Focus" href="focus.html"/>
+            <item name="FAQ" href="faq.html"/>
             <item name="Licence" href="licence.html"/>
         </menu>