FALCON-785 Document upgrade path from 0.5 to 0.6. Contributed by Venkatesh Seetharam
diff --git a/CHANGES.txt b/CHANGES.txt
index e0baa7a..c37a9a4 100755
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -2,6 +2,7 @@
Release Version: 0.6-incubating
+ FALCON-785 Document upgrade path from 0.5 to 0.6 (Venkatesh Seetharam)
FALCON-784 Update release notes in CHANGES.txt in branch and trunk (Venkatesh Seetharam)
FALCON-783 Create branch-0.6 and update version to 0.6-incubating (Venkatesh Seetharam)
diff --git a/Installation-steps.txt b/Installation-steps.txt
index 85eabed..8d8622a 100644
--- a/Installation-steps.txt
+++ b/Installation-steps.txt
@@ -32,7 +32,7 @@
a. Building falcon from the source release
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-* tar -xzvf falcon-${project.version}-source.tar.gz
+* tar -xzvf apache-falcon-${project.version}-source.tar.gz
* cd falcon-sources-${project.version}
* export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=256m" && mvn clean install
@@ -58,9 +58,9 @@
Once the build successfully completes, artifacts can be packaged for deployment.
By default the falcon is built for embedded mode.
-* mvn clean assembly:assembly -DskipTests
+* mvn clean assembly:assembly -DskipTests -DskipITs
-Tar can be found in {project dir}/target/falcon-${project.version}-bin.tar.gz
+Tar can be found in {project dir}/target/apache-falcon-${project.version}-bin.tar.gz
Tar is structured as follows
@@ -97,7 +97,7 @@
a. Installing falcon
~~~~~~~~~~~~~~~~~~~~
-* tar -xzvf falcon-${project.version}-bin.tar.gz
+* tar -xzvf apache-falcon-${project.version}-bin.tar.gz
* cd falcon-${project.version}
b. Starting Falcon Server
diff --git a/docs/src/site/twiki/Appendix.twiki b/docs/src/site/twiki/Appendix.twiki
new file mode 100644
index 0000000..1346a2b
--- /dev/null
+++ b/docs/src/site/twiki/Appendix.twiki
@@ -0,0 +1,55 @@
+---+ Appendix
+
+---++ 0.6-incubating Version Compatibility Matrix
+
+ * Hadoop 2.5.0 and above
+ * Oozie 4.0.0 and above
+ * Hive 0.11.0 and above
+ * HCatalog 0.11.0 and above
+ * Active MQ 5.4.3 and above
+ * Titan 0.4.2 and above but below 0.5
+
+
+---++ 0.6-incubating Tested Compatibility
+
+ * Hadoop 2.6.0
+ * Oozie 4.1.0
+ * Hive 0.14.0
+ * HCatalog 0.14.0
+ * Active MQ 5.4.3
+ * Titan 0.4.2
+ * Java 1.6, Java 1.7
+
+
+---++ 0.6-incubating Release Notes
+
+Major additions are listed below. Refer to CHANGES.txt for detailed issues addressed in this release.
+
+ * Security - Authorization, SSL
+ * Lineage - More complete with better API
+ * Recipes
+ * Usability improvements - Dry run, entity summary, Pagination, etc.
+ * Operability - Alerts, Audits, etc.
+ * Refactoring - Messaging, Orchestration of workflows, etc.
+ * Extension points for developers
+ * Many bug fixes
+
+
+---++ 0.6-incubating Upgrade Instructions
+
+Please follow these instructions when upgrading from an older release.
+
+---+++ Upgrading from 0.5-incubating
+
+0.6-incubating is backwards incompatible with 0.5-incubating. However, there are some minor changes
+to be aware of. The entity schemas can be migrated from 0.5 to 0.6 by adding ACLs. Lineage resource
+has changed in 0.6.
+
+---+++ Upgrading from 0.4-incubating
+
+It is not possible to upgrade to 0.6-incubating from 0.4-incubating. Please migrate the falcon
+entities from config store manually.
+
+---+++ Upgrading from 0.3-incubating
+
+It is not possible to upgrade to 0.6-incubating from 0.3-incubating.
diff --git a/docs/src/site/twiki/FalconDocumentation.twiki b/docs/src/site/twiki/FalconDocumentation.twiki
index 17dc25c..c413338 100644
--- a/docs/src/site/twiki/FalconDocumentation.twiki
+++ b/docs/src/site/twiki/FalconDocumentation.twiki
@@ -15,6 +15,7 @@
* <a href="#Security">Security</a>
* <a href="#Recipes">Recipes</a>
* <a href="#Monitoring">Monitoring</a>
+ * <a href="#Appendix">Appendix</a>
---++ Architecture
@@ -710,3 +711,5 @@
--++ Monitoring
Monitoring and Operationalizing Falcon is detailed in [[Operability][Operability]].
+
+--++ [[Appendix][Appendix]]
diff --git a/docs/src/site/twiki/InstallationSteps.twiki b/docs/src/site/twiki/InstallationSteps.twiki
index 88f3226..726dd9b 100644
--- a/docs/src/site/twiki/InstallationSteps.twiki
+++ b/docs/src/site/twiki/InstallationSteps.twiki
@@ -26,7 +26,7 @@
</verbatim>
-Tar can be found in {project dir}/target/falcon-${project.version}-bin.tar.gz
+Tar can be found in {project dir}/target/apache-falcon-${project.version}-bin.tar.gz
Tar is structured as follows
@@ -67,7 +67,7 @@
</verbatim>
-Tar can be found in {project dir}/target/falcon-distributed-${project.version}-server.tar.gz
+Tar can be found in {project dir}/target/apache-falcon-distributed-${project.version}-server.tar.gz
Tar is structured as follows
@@ -252,7 +252,7 @@
>> ex. src/bin/package.sh 1.1.2 4.0.1 or src/bin/package.sh 0.20.2-cdh3u5 4.0.1
>> ex. src/bin/package.sh 2.5.0 4.0.0
->> Falcon package is available in <<falcon home>>/target/falcon-<<version>>-bin.tar.gz
+>> Falcon package is available in <<falcon home>>/target/apache-falcon-<<version>>-bin.tar.gz
>> Oozie package is available in <<falcon home>>/target/oozie-4.0.1-distro.tar.gz
</verbatim>
