Github user ljainpivotalio commented on a diff in the pull request:
https://github.com/apache/incubator-hawq/pull/857#discussion_r76179421
--- Diff: contrib/hawq-ambari-plugin/README.md ---
@@ -0,0 +1,97 @@
+# HAWQ Ambari Plugin
+
+hawq-ambari-plugin helps users install HAWQ and PXF using Ambari.
+
+To ensure that Ambari recognizes HAWQ and PXF as services that can be
installed for a specific stack, the following manual steps are required:
+ * Add HAWQ and PXF metainfo.xml files (containing metadata about the
service) under the stack to be installed.
+ * Add repositories where HAWQ and PXF rpms reside, so that Ambari can use
it during installation. This requires updating repoinfo.xml under the stack
HAWQ and PXF is to be added.
+ * If a stack is already installed using Ambari, add repositories to the
existing stack using the Ambari REST API.
+
+
+## Source Code
+Source code directory structure of the hawq-ambari-plugin is as follows:
+```
+hawq-ambari-plugin
++-- README.md
++-- build.properties
++-- pom.xml
++-- src
+ +-- main
+ +-- resources
+ +-- services
+ ¦ +-- HAWQ
+ ¦ ¦ +-- metainfo.xml
+ ¦ +-- PXF
+ ¦ +-- metainfo.xml
+ +-- utils
+ +-- add-hawq.py
+```
+
+### build.properties
+[build.properties](build.properties) contains properties required for
building the plugin.
+
+### metainfo.xml
+[metainfo.xml](src/main/resources/services/HAWQ/metainfo.xml) contains the
metadata about the service. The metainfo.xml specifies that the service
definition is to be inherited from Ambari common-services. HAWQ and PXF
common-services code can be found under [Apache Ambari
repository](https://github.com/apache/ambari/tree/trunk/ambari-server/src/main/resources/common-services/).
+
+### add-hawq<i></i>.py
+[add-hawq.py](src/main/resources/utils/add-hawq.py) deploys HAWQ and PXF
metainfo.xml files under the stack and adds the repositories to Ambari.
+
+
+## Building the plugin
+***Build Environment***: centos6 is the typical operating system used for
building.
+
+Properties specified in the [build.properties](build.properties) file:
+
+| Property | Description | Value |
+| --- | --- | --- |
+| hawq.release.version | Release version of HAWQ | 2.0.1 |
+| hawq.common.services.version | HAWQ common services code in Ambari to be
inherited | 2.0.0 |
+| pxf.release.version | Release version of PXF | 3.0.1 |
+| pxf.common.services.version | PXF common services code in Ambari to be
inherited | 3.0.0 |
+| hawq.repo.prefix | Repository name for HAWQ core repository | hawq |
+| hawq.addons.repo.prefix | Repository name for HAWQ Add Ons repository |
hawq-add-ons |
+| repository.version | Repository Version to be used in repository
information | 2.0.1<i></i>.0 |
+| default.stack | Default stack under which, metainfo.xml and repositories
have to be added | HDP-2.4 |
+
+To build the rpm for hawq-ambari-plugin, change the
[build.properties](build.properties) file with the required parameters and run
```mvn install``` command under hawq-ambari-plugin directory:
+```
+$ pwd
+incubator-hawq/contrib/hawq-ambari-plugin
+$ mvn install
--- End diff --
mvn clean resources:copy-resources rpm:rpm -Dbuild_number="${BUILD_NUMBER}"
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
