curator-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From randg...@apache.org
Subject [29/50] [abbrv] git commit: work on packaging and doc
Date Sat, 07 Jun 2014 18:19:27 GMT
work on packaging and doc


Project: http://git-wip-us.apache.org/repos/asf/curator/repo
Commit: http://git-wip-us.apache.org/repos/asf/curator/commit/73decc76
Tree: http://git-wip-us.apache.org/repos/asf/curator/tree/73decc76
Diff: http://git-wip-us.apache.org/repos/asf/curator/diff/73decc76

Branch: refs/heads/master
Commit: 73decc76a2c41aba30d8d87b6c6b74e52a6420ec
Parents: cb9d8dd
Author: randgalt <randgalt@apache.org>
Authored: Sat May 31 13:20:40 2014 -0500
Committer: randgalt <randgalt@apache.org>
Committed: Sat May 31 13:20:40 2014 -0500

----------------------------------------------------------------------
 curator-x-rpc/dependency-reduced-pom.xml        | 102 +++++++++++++++++++
 curator-x-rpc/pom.xml                           |  47 +++++++++
 .../src/main/resources/curator/help.txt         |  19 ----
 .../src/site/confluence/deploy.confluence       |  16 +++
 .../src/site/confluence/index.confluence        |  11 +-
 pom.xml                                         |   9 ++
 6 files changed, 181 insertions(+), 23 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/curator/blob/73decc76/curator-x-rpc/dependency-reduced-pom.xml
----------------------------------------------------------------------
diff --git a/curator-x-rpc/dependency-reduced-pom.xml b/curator-x-rpc/dependency-reduced-pom.xml
new file mode 100644
index 0000000..abb20c7
--- /dev/null
+++ b/curator-x-rpc/dependency-reduced-pom.xml
@@ -0,0 +1,102 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+  <parent>
+    <artifactId>apache-curator</artifactId>
+    <groupId>org.apache.curator</groupId>
+    <version>2.5.1-SNAPSHOT</version>
+  </parent>
+  <modelVersion>4.0.0</modelVersion>
+  <artifactId>curator-x-rpc</artifactId>
+  <version>2.5.1-SNAPSHOT</version>
+  <build>
+    <resources>
+      <resource>
+        <directory>${project.basedir}/src/main/resources</directory>
+        <includes>
+          <include>curator/help.txt</include>
+        </includes>
+      </resource>
+    </resources>
+    <plugins>
+      <plugin>
+        <artifactId>maven-shade-plugin</artifactId>
+        <executions>
+          <execution>
+            <phase>package</phase>
+            <goals>
+              <goal>shade</goal>
+            </goals>
+            <configuration>
+              <transformers>
+                <transformer />
+                <transformer>
+                  <mainClass>org.apache.curator.x.rpc.CuratorProjectionServer</mainClass>
+                </transformer>
+              </transformers>
+            </configuration>
+          </execution>
+        </executions>
+        <configuration>
+          <createDependencyReducedPom>true</createDependencyReducedPom>
+          <filters>
+            <filter>
+              <artifact>*:*</artifact>
+              <excludes>
+                <exclude>META-INF/*.SF</exclude>
+                <exclude>META-INF/*.DSA</exclude>
+                <exclude>META-INF/*.RSA</exclude>
+              </excludes>
+            </filter>
+          </filters>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+  <dependencies>
+    <dependency>
+      <groupId>org.apache.curator</groupId>
+      <artifactId>curator-test</artifactId>
+      <version>2.5.1-SNAPSHOT</version>
+      <scope>test</scope>
+      <exclusions>
+        <exclusion>
+          <artifactId>log4j-over-slf4j</artifactId>
+          <groupId>org.slf4j</groupId>
+        </exclusion>
+        <exclusion>
+          <artifactId>slf4j-log4j12</artifactId>
+          <groupId>org.slf4j</groupId>
+        </exclusion>
+        <exclusion>
+          <artifactId>log4j</artifactId>
+          <groupId>log4j</groupId>
+        </exclusion>
+        <exclusion>
+          <artifactId>javassist</artifactId>
+          <groupId>org.javassist</groupId>
+        </exclusion>
+        <exclusion>
+          <artifactId>commons-math</artifactId>
+          <groupId>org.apache.commons</groupId>
+        </exclusion>
+      </exclusions>
+    </dependency>
+    <dependency>
+      <groupId>org.testng</groupId>
+      <artifactId>testng</artifactId>
+      <version>6.8.8</version>
+      <scope>test</scope>
+      <exclusions>
+        <exclusion>
+          <artifactId>bsh</artifactId>
+          <groupId>org.beanshell</groupId>
+        </exclusion>
+        <exclusion>
+          <artifactId>jcommander</artifactId>
+          <groupId>com.beust</groupId>
+        </exclusion>
+      </exclusions>
+    </dependency>
+  </dependencies>
+</project>
+

http://git-wip-us.apache.org/repos/asf/curator/blob/73decc76/curator-x-rpc/pom.xml
----------------------------------------------------------------------
diff --git a/curator-x-rpc/pom.xml b/curator-x-rpc/pom.xml
index 3f13a81..de9bfb0 100644
--- a/curator-x-rpc/pom.xml
+++ b/curator-x-rpc/pom.xml
@@ -90,4 +90,51 @@
             <scope>test</scope>
         </dependency>
     </dependencies>
+
+    <build>
+        <resources>
+            <resource>
+                <directory>${project.basedir}/src/main/resources</directory>
+                <includes>
+                    <include>curator/help.txt</include>
+                </includes>
+            </resource>
+        </resources>
+
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-shade-plugin</artifactId>
+                <configuration>
+                    <createDependencyReducedPom>true</createDependencyReducedPom>
+                    <filters>
+                        <filter>
+                            <artifact>*:*</artifact>
+                            <excludes>
+                                <exclude>META-INF/*.SF</exclude>
+                                <exclude>META-INF/*.DSA</exclude>
+                                <exclude>META-INF/*.RSA</exclude>
+                            </excludes>
+                        </filter>
+                    </filters>
+                </configuration>
+                <executions>
+                    <execution>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>shade</goal>
+                        </goals>
+                        <configuration>
+                            <transformers>
+                                <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
+                                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
+                                    <mainClass>org.apache.curator.x.rpc.CuratorProjectionServer</mainClass>
+                                </transformer>
+                            </transformers>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
 </project>

http://git-wip-us.apache.org/repos/asf/curator/blob/73decc76/curator-x-rpc/src/main/resources/curator/help.txt
----------------------------------------------------------------------
diff --git a/curator-x-rpc/src/main/resources/curator/help.txt b/curator-x-rpc/src/main/resources/curator/help.txt
index ad6484f..53e751f 100644
--- a/curator-x-rpc/src/main/resources/curator/help.txt
+++ b/curator-x-rpc/src/main/resources/curator/help.txt
@@ -1,22 +1,3 @@
-====
-    Licensed to the Apache Software Foundation (ASF) under one
-    or more contributor license agreements.  See the NOTICE file
-    distributed with this work for additional information
-    regarding copyright ownership.  The ASF licenses this file
-    to you under the Apache License, Version 2.0 (the
-    "License"); you may not use this file except in compliance
-    with the License.  You may obtain a copy of the License at
-
-      http://www.apache.org/licenses/LICENSE-2.0
-
-    Unless required by applicable law or agreed to in writing,
-    software distributed under the License is distributed on an
-    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-    KIND, either express or implied.  See the License for the
-    specific language governing permissions and limitations
-    under the License.
-====
-
 Curator RPC - an RPC server for using Apache Curator APIs and recipes from non JVM languages.
 
 Arguments:

http://git-wip-us.apache.org/repos/asf/curator/blob/73decc76/curator-x-rpc/src/site/confluence/deploy.confluence
----------------------------------------------------------------------
diff --git a/curator-x-rpc/src/site/confluence/deploy.confluence b/curator-x-rpc/src/site/confluence/deploy.confluence
new file mode 100644
index 0000000..20c3ace
--- /dev/null
+++ b/curator-x-rpc/src/site/confluence/deploy.confluence
@@ -0,0 +1,16 @@
+[[Curator RPC Proxy|index.html]] / Deployment
+
+h1. Deployment
+
+Curator RPC is designed to have an instance of its Thrift Server co\-located on each client
instance that needs to connect to ZooKeeper.
+Each Curator RPC instance is configured (see [[Configuration|configuration.html]]) to connect
to one or more ZooKeeper clusters. The Curator
+Framework instances are maintained inside of the Curator RPC instances and RPC clients reference
these instances by ID.
+
+!images/topology.png!
+
+How you configure your server to launch depends on your environment and other needs. Here
are some suggestions:
+
+* [Airlift Launcher|https://github.com/airlift/airlift/tree/master/launcher]
+* [Docker|https://www.docker.io/]
+* [One-JAR|http://one-jar.sourceforge.net/]
+* [Capsule|https://github.com/puniverse/capsule]

http://git-wip-us.apache.org/repos/asf/curator/blob/73decc76/curator-x-rpc/src/site/confluence/index.confluence
----------------------------------------------------------------------
diff --git a/curator-x-rpc/src/site/confluence/index.confluence b/curator-x-rpc/src/site/confluence/index.confluence
index d8d7185..ece5769 100644
--- a/curator-x-rpc/src/site/confluence/index.confluence
+++ b/curator-x-rpc/src/site/confluence/index.confluence
@@ -1,10 +1,13 @@
 h1. Curator RPC Proxy
 
-NOTE: Curator REST Proxy is in its own package in Maven Central: curator\-x\-rpc
+NOTE: Curator RPC Proxy is in its own package in Maven Central: curator\-x\-rpc
 
-The Curator REST module implements a proxy that bridges non-java environments with the Curator
framework and recipes. Every major language
-today has a REST library available. With the Curator REST Proxy, you can now take advantage
of the Curator framework and its recipes in
-any language or environment.
+The Curator RPC module implements a proxy that bridges non-java environments with the Curator
framework and recipes. It uses
+[[Apache Thrift|http://thrift.apache.org]] which supports a large set of languages and environments.
+
+h2. Thrift File
+The current Curator RPC Thrift File can be found here: [[https://raw.githubusercontent.com/apache/curator/master/curator-x-rpc/src/main/thrift/curator.thrift]].
Use
+this to generate code for the language/environment you need.
 
 h2. Building and Packaging
 

http://git-wip-us.apache.org/repos/asf/curator/blob/73decc76/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 137155b..ec3e374 100644
--- a/pom.xml
+++ b/pom.xml
@@ -86,6 +86,7 @@
         <testng-version>6.8.8</testng-version>
         <swift-version>0.12.0</swift-version>
         <dropwizard-version>0.7.0</dropwizard-version>
+        <maven-shade-plugin-version>2.3</maven-shade-plugin-version>
 
         <!-- OSGi Properties -->
         <osgi.export.package />
@@ -551,6 +552,12 @@
                     <artifactId>apache-rat-plugin</artifactId>
                     <version>${apache-rat-plugin-version}</version>
                 </plugin>
+
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-shade-plugin</artifactId>
+                    <version>${maven-shade-plugin-version}</version>
+                </plugin>
             </plugins>
         </pluginManagement>
 
@@ -693,6 +700,7 @@
                     <header>src/etc/header.txt</header>
                     <excludes>
                         <exclude>**/*.confluence</exclude>
+                        <exclude>**/help.txt</exclude>
                         <exclude>**/*.rdf</exclude>
                         <exclude>**/.gitignore</exclude>
                         <exclude>**/.idea/**</exclude>
@@ -736,6 +744,7 @@
                     <excludes>
                         <exclude>**/*.confluence</exclude>
                         <exclude>**/*.rdf</exclude>
+                        <exclude>**/help.txt</exclude>
                         <exclude>**/.gitignore</exclude>
                         <exclude>**/.idea/**</exclude>
                         <exclude>**/DISCLAIMER</exclude>


Mime
View raw message