From 48e5a48849b09693801f5940e949b4e069c3a3b6 Mon Sep 17 00:00:00 2001 From: Scott Lewis Date: Fri, 18 Jun 2021 12:22:22 -0700 Subject: [PATCH 1/4] Update README.md --- README.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a80fadb..224dd54 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,29 @@ This project contains an OSGi bundle implementing an ECF Discovery Provider for discovering [OSGi Remote Services](https://wiki.eclipse.org/OSGi_Remote_Services_and_ECF) based upon [Etcd](https://etcd.io/) version 3. -Etcd3 provides a popular server/service to reliably store, retrieve, and watch key-value pairs and is used in [Kubernetes](https://kubernetes.io/). +ECF discovery provider that uses etcd3 service to publish and discover remote service endpoint descriptions. See https://github.com/coreos/etcd to download, install, and configure the etcd server. -This discovery provider allows an Etcd3 server to be used to publish and discover OSGi Remote Service endpoints via Etcd3 client->server protocols. +This provider used an etcd server to publish and discover Remote Services. It's necessary to install the provider bundle: org.eclipse.ecf.provider.etcd3, and configure it so that it points to a running etcd server/service. -With this bundle OSGi Remote Services will automatically be published to an Etcd3 server and discovered by other OSGi Remote Service consumers that are using the same Etcd3 server. +For this provider to work, an etcd server must be running at some available hostname and port before the process using the etcd provider is started. Note that when the provider is started, it will immediately attempt to connect to the etcd server. If that connection cannot be made it will result in an ERROR to the OSGi log. + +The entire list of configurable properties for the etcd provider is in [this class](https://github.com/ECF/etcd-provider/blob/master/bundles/org.eclipse.ecf.provider.etcd/src/org/eclipse/ecf/provider/etcd/EtcdDiscoveryContainerConfig.java) + +The most important properties are: + +| Property Name | Default Value | +| --- | --- | +| ecf.discovery.etcd3.hostname | 127.0.0.1 | +| ecf.discovery.etcd3.port | 2379 | +| ecf.discovery.etcd3.containerId | org.eclipse.ecf.provider.etcd.EtcdDiscoveryContainer | +| ecf.discovery.etcd3.usePlaintext | false | + +For example, to set the etcd server to: 'disco.ecf-project.org' set the java system propery...e.g. + + -Decf.discovery.etcd.hostname=disco.ecf-project.org + +LICENSE +======= + +The ECF etcd3 discovery provider is distributed with the Apache 2 license. See LICENSE in this directory for more +information. From d1916b99d0c1b6cac4a7ed48cc92940a72455fca Mon Sep 17 00:00:00 2001 From: Scott Lewis Date: Fri, 18 Jun 2021 12:29:47 -0700 Subject: [PATCH 2/4] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 224dd54..62f4402 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,14 @@ The most important properties are: | Property Name | Default Value | | --- | --- | +| ecf.discovery.etcd3.disabled | false | +| ecf.discovery.etcd3.protocol | http | | ecf.discovery.etcd3.hostname | 127.0.0.1 | | ecf.discovery.etcd3.port | 2379 | -| ecf.discovery.etcd3.containerId | org.eclipse.ecf.provider.etcd.EtcdDiscoveryContainer | +| ecf.discovery.etcd3.keyPrefix | org.eclipse.ecf.provider.etcd3.EtcdDiscoveryContainer | | ecf.discovery.etcd3.usePlaintext | false | +| ecf.discovery.etcd3.ttl | 30 (seconds) | +| ecf.discovery.etcd3.retry | false | For example, to set the etcd server to: 'disco.ecf-project.org' set the java system propery...e.g. From 6de654189485ae5a97c7fac883fd84ad5a2c1100 Mon Sep 17 00:00:00 2001 From: Scott Lewis Date: Sat, 3 Jul 2021 15:19:35 -0700 Subject: [PATCH 3/4] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 62f4402..66da781 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ ECF discovery provider that uses etcd3 service to publish and discover remote se This provider used an etcd server to publish and discover Remote Services. It's necessary to install the provider bundle: org.eclipse.ecf.provider.etcd3, and configure it so that it points to a running etcd server/service. +Released versions of this bundle are available at Maven Central [here](https://github.com/ECF/etcd3-discovery-provider) + For this provider to work, an etcd server must be running at some available hostname and port before the process using the etcd provider is started. Note that when the provider is started, it will immediately attempt to connect to the etcd server. If that connection cannot be made it will result in an ERROR to the OSGi log. The entire list of configurable properties for the etcd provider is in [this class](https://github.com/ECF/etcd-provider/blob/master/bundles/org.eclipse.ecf.provider.etcd/src/org/eclipse/ecf/provider/etcd/EtcdDiscoveryContainerConfig.java) From a77f896e59c04459b22f4bd600569455aec5575e Mon Sep 17 00:00:00 2001 From: Scott Lewis Date: Sat, 3 Jul 2021 15:20:29 -0700 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 66da781..815967e 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ ECF discovery provider that uses etcd3 service to publish and discover remote se This provider used an etcd server to publish and discover Remote Services. It's necessary to install the provider bundle: org.eclipse.ecf.provider.etcd3, and configure it so that it points to a running etcd server/service. -Released versions of this bundle are available at Maven Central [here](https://github.com/ECF/etcd3-discovery-provider) +Released versions of this bundle are available at [Maven Central](https://search.maven.org/search?q=a:org.eclipse.ecf.provider.etcd3) For this provider to work, an etcd server must be running at some available hostname and port before the process using the etcd provider is started. Note that when the provider is started, it will immediately attempt to connect to the etcd server. If that connection cannot be made it will result in an ERROR to the OSGi log.