aries-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cschnei...@apache.org
Subject aries-rsa git commit: Add documentation
Date Thu, 17 Mar 2016 17:15:12 GMT
Repository: aries-rsa
Updated Branches:
  refs/heads/master 5095444c6 -> 18afa459c


Add documentation


Project: http://git-wip-us.apache.org/repos/asf/aries-rsa/repo
Commit: http://git-wip-us.apache.org/repos/asf/aries-rsa/commit/18afa459
Tree: http://git-wip-us.apache.org/repos/asf/aries-rsa/tree/18afa459
Diff: http://git-wip-us.apache.org/repos/asf/aries-rsa/diff/18afa459

Branch: refs/heads/master
Commit: 18afa459cf998445440122bf913aa7da863f8b52
Parents: 5095444
Author: Christian Schneider <chris@die-schneider.net>
Authored: Thu Mar 17 18:15:04 2016 +0100
Committer: Christian Schneider <chris@die-schneider.net>
Committed: Thu Mar 17 18:15:04 2016 +0100

----------------------------------------------------------------------
 .gitignore                    |  1 +
 discovery/local/Readme.md     | 26 ++++++++++++++++++++++++++
 discovery/zookeeper/Readme.md | 34 ++++++++++++++++++++++++++++++++++
 3 files changed, 61 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/aries-rsa/blob/18afa459/.gitignore
----------------------------------------------------------------------
diff --git a/.gitignore b/.gitignore
index 9629ccf..5d4ddce 100644
--- a/.gitignore
+++ b/.gitignore
@@ -8,3 +8,4 @@
 .settings/
 target/
 velocity.log
+*.md.html

http://git-wip-us.apache.org/repos/asf/aries-rsa/blob/18afa459/discovery/local/Readme.md
----------------------------------------------------------------------
diff --git a/discovery/local/Readme.md b/discovery/local/Readme.md
new file mode 100644
index 0000000..c0e5303
--- /dev/null
+++ b/discovery/local/Readme.md
@@ -0,0 +1,26 @@
+# Local Discovery
+
+Scans bundles for endpoint descriptions in the path `OSGI-INF/remote-service/*.xml`. The
descriptions must
+use the namespace http://www.osgi.org/xmlns/rsa/v1.0.0 defined in the Remote Service Admin
Spec.  
+Each endpoint-description record in the file represents a remote endpoint. 
+
+The local discovery module will notify all interested EndpointListeners of each described
endpoint. 
+This will cause the TopologyManager to let the RemoteServiceAdmin create local proxy services
for 
+the remote endpoints.
+
+## Example
+
+```
+<endpoint-descriptions xmlns="http://www.osgi.org/xmlns/rsa/v1.0.0">
+  <endpoint-description>
+    <property name="objectClass">
+      <array>
+        <value>org.apache.aries.rsa.examples.echotcp.api.EchoService</value>
+      </array>
+    </property>
+    <property name="endpoint.id">tcp://localhost:3456</property>
+    <property name="service.imported.configs">aries.tcp</property>
+  </endpoint-description>
+</endpoint-descriptions>
+```
+

http://git-wip-us.apache.org/repos/asf/aries-rsa/blob/18afa459/discovery/zookeeper/Readme.md
----------------------------------------------------------------------
diff --git a/discovery/zookeeper/Readme.md b/discovery/zookeeper/Readme.md
new file mode 100644
index 0000000..d36dcf3
--- /dev/null
+++ b/discovery/zookeeper/Readme.md
@@ -0,0 +1,34 @@
+# Zookeeper Discovery
+
+Manages endpoint descriptions as zookeeper nodes. 
+
+* Local endpoints are published to zookeeper
+* Interests for services in the form of EndpointListener scopes are looked up in zookeper
and the listeners are informed about any changes
+on the matching endpoints
+
+## Discovery Configuration
+
+PID: org.apache.aries.rsa.discovery.zookeeper
+
+| Key               | Default       | Description                                  |
+| ------------------| ------------- | -------------------------------------------- |
+| zookeeper.host    | localhost     | Hostname or ipadress of the zookeeper server |
+| zookeeper.port    | 2181          | Client port of the zookeeper server          |
+| zookeeper.timeout | 3000          | Session timeout in ms                        |
+
+At least an empty config must be present to start the zookeeper discovery. The karaf feature
will install such a config by default.
+
+## Zookeeper Server Configuration
+
+PID: org.apache.aries.rsa.discovery.zookeeper.server
+
+| Key               | Default       | Description                                  
+| ------------------| -------------:| -------------------------------------------- 
+| clientPort        | 2181          | Port to listen on for client connections     
+| tickTime          | 2000          |                                              
+| initLimit         | 10            | 
+| syncLimit         | 5             |
+| dataDir           | zkdata        |
+
+At least an empty config must be created manually to start the zookeeper server.
+


Mime
View raw message