This is an automated email from the ASF dual-hosted git repository.
fanningpj pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-pekko-samples.git
The following commit(s) were added to refs/heads/main by this push:
new 431b97f pekko 287: Add pekko-cluster-docker-compose-java sample (#36)
431b97f is described below
commit 431b97ffd368e7c3ea09fc162b7761f80b4dd9e0
Author: Sam Byng <[email protected]>
AuthorDate: Tue Apr 25 17:54:27 2023 +0100
pekko 287: Add pekko-cluster-docker-compose-java sample (#36)
* Add akka-sample-cluster-docker-compose-java files for conversion:
java: git commit ref: 6501f62e6c79140fd623c167f90eb464bee66ec6
* 287: Change java dirname to pekko and update build-test.yml to run the
test script that was in the old travis CI
Note: this requires docker-compose to be installed on the test image.
* Docker-compose-java: Update test and docker-compose files to use pekko
image
* Update built.sbt and src files to use pekko
* Bump to Java 11 and use latest native-packager and sbt versions
* Run scalafmt
* Fix issue with the logging so that output logs go to the appender and
therefore show up in docker logs
* Fix issue: Use the correct path to the SplitBrainResolverProvider
* Update README akka refs -> pekko
---------
Co-authored-by: sb5 <[email protected]>
---
.github/workflows/build-test.yml | 3 +
pekko-sample-cluster-docker-compose-java/LICENSE | 206 +++++++++++++++++++++
pekko-sample-cluster-docker-compose-java/README.md | 12 ++
pekko-sample-cluster-docker-compose-java/build.sbt | 34 ++++
.../docker-compose.yml | 28 +++
.../project/build.properties | 1 +
.../project/plugins.sbt | 1 +
.../scripts/test.sh | 24 +++
.../src/main/java/com/example/ClusterListener.java | 42 +++++
.../src/main/java/com/example/ClusteringApp.java | 16 ++
.../src/main/resources/application.conf | 36 ++++
.../src/main/resources/logback.xml | 24 +++
12 files changed, 427 insertions(+)
diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml
index 8c7236a..76d9280 100644
--- a/.github/workflows/build-test.yml
+++ b/.github/workflows/build-test.yml
@@ -71,5 +71,8 @@ jobs:
- name: Test pekko-sample-kafka-to-sharding-scala
run: cd pekko-sample-kafka-to-sharding-scala && sbt test
+ - name: Test pekko-sample-cluster-docker-compose-java
+ run: cd pekko-sample-cluster-docker-compose-java && ./scripts/test.sh
+
- name: Test docs gen
run: cd docs-gen && sbt paradox
diff --git a/pekko-sample-cluster-docker-compose-java/LICENSE
b/pekko-sample-cluster-docker-compose-java/LICENSE
new file mode 100644
index 0000000..345e2ad
--- /dev/null
+++ b/pekko-sample-cluster-docker-compose-java/LICENSE
@@ -0,0 +1,206 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed 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.
+
+---------------
+
+Licenses for dependency projects can be found here:
+[http://akka.io/docs/akka/snapshot/project/licenses.html]
diff --git a/pekko-sample-cluster-docker-compose-java/README.md
b/pekko-sample-cluster-docker-compose-java/README.md
new file mode 100644
index 0000000..c37a2c1
--- /dev/null
+++ b/pekko-sample-cluster-docker-compose-java/README.md
@@ -0,0 +1,12 @@
+pekko-docker-cluster-example
+===========================
+
+An example pekko-cluster project with docker support. See [the blog
post](http://blog.michaelhamrah.com/2014/11/clustering-akka-applications-with-docker-version-3/).
Uses [SBT Native Packager](https://github.com/sbt/sbt-native-packager).
+
+### How to Run
+
+In SBT, just run `docker:publishLocal` to create a local docker container.
+
+To run the cluster, run `docker-compose up`. This will create 3 nodes, a seed
and two regular members, called `seed`, `c1`, and `c2` respectively.
+
+While running, try opening a new terminal and (from the same directory) try
things like `docker-compose down seed` and watch the cluster nodes respond.
diff --git a/pekko-sample-cluster-docker-compose-java/build.sbt
b/pekko-sample-cluster-docker-compose-java/build.sbt
new file mode 100644
index 0000000..2536988
--- /dev/null
+++ b/pekko-sample-cluster-docker-compose-java/build.sbt
@@ -0,0 +1,34 @@
+organization := "org.apache.pekko"
+
+/* scala versions and options */
+scalaVersion := "2.13.8"
+
+// These options will be used for *all* versions.
+scalacOptions ++= Seq(
+ "-deprecation",
+ "-unchecked",
+ "-encoding", "UTF-8",
+ "-Xlint")
+
+val pekkoVersion = "0.0.0+26617-325e2156-SNAPSHOT"
+// allow access to snapshots
+resolvers += "Apache
Snapshots".at("https://repository.apache.org/content/repositories/snapshots/";)
+
+/* dependencies */
+libraryDependencies ++= Seq(
+ // -- Logging --
+ "ch.qos.logback" % "logback-classic" % "1.2.3",
+ // -- Akka --
+ "org.apache.pekko" %% "pekko-actor-typed" % pekkoVersion,
+ "org.apache.pekko" %% "pekko-cluster-typed" % pekkoVersion)
+
+version in Docker := "latest"
+
+dockerExposedPorts in Docker := Seq(1600)
+
+dockerEntrypoint in Docker := Seq("sh", "-c", "bin/clustering $*")
+
+dockerRepository := Some("pekko")
+
+dockerBaseImage := "eclipse-temurin:11"
+enablePlugins(JavaAppPackaging)
diff --git a/pekko-sample-cluster-docker-compose-java/docker-compose.yml
b/pekko-sample-cluster-docker-compose-java/docker-compose.yml
new file mode 100644
index 0000000..af509bb
--- /dev/null
+++ b/pekko-sample-cluster-docker-compose-java/docker-compose.yml
@@ -0,0 +1,28 @@
+version: '2'
+services:
+ seed:
+ container_name: pekko-sample-cluster-docker-compose-java_seed_1
+ image: pekko/pekko-sample-cluster-docker-compose-java:latest
+ ports:
+ - '1600:1600'
+ environment:
+ CLUSTER_PORT: 1600
+ CLUSTER_IP: seed
+ SEED_PORT_1600_TCP_ADDR: seed
+ c1:
+ image: pekko/pekko-sample-cluster-docker-compose-java:latest
+ ports:
+ - '1601:1601'
+ environment:
+ CLUSTER_PORT: 1601
+ CLUSTER_IP: c1
+ SEED_PORT_1600_TCP_ADDR: seed
+ c2:
+ image: pekko/pekko-sample-cluster-docker-compose-java:latest
+ ports:
+ - '1602:1602'
+ environment:
+ CLUSTER_PORT: 1602
+ CLUSTER_IP: c2
+ SEED_PORT_1600_TCP_ADDR: seed
+
diff --git a/pekko-sample-cluster-docker-compose-java/project/build.properties
b/pekko-sample-cluster-docker-compose-java/project/build.properties
new file mode 100644
index 0000000..46e43a9
--- /dev/null
+++ b/pekko-sample-cluster-docker-compose-java/project/build.properties
@@ -0,0 +1 @@
+sbt.version=1.8.2
diff --git a/pekko-sample-cluster-docker-compose-java/project/plugins.sbt
b/pekko-sample-cluster-docker-compose-java/project/plugins.sbt
new file mode 100644
index 0000000..dc31bbb
--- /dev/null
+++ b/pekko-sample-cluster-docker-compose-java/project/plugins.sbt
@@ -0,0 +1 @@
+addSbtPlugin("com.github.sbt" % "sbt-native-packager" % "1.9.6")
diff --git a/pekko-sample-cluster-docker-compose-java/scripts/test.sh
b/pekko-sample-cluster-docker-compose-java/scripts/test.sh
new file mode 100755
index 0000000..7993fba
--- /dev/null
+++ b/pekko-sample-cluster-docker-compose-java/scripts/test.sh
@@ -0,0 +1,24 @@
+#!/bin/bash
+
+set -x
+
+sbt docker:publishLocal
+
+docker-compose up -d
+
+docker logs pekko-sample-cluster-docker-compose-java_seed_1
+
+for i in {1..10}
+do
+ echo "Checking for MemberUp logging..."
+ docker logs pekko-sample-cluster-docker-compose-java_seed_1 | grep "Member
is Up" | wc -l || true
+ [ `docker logs pekko-sample-cluster-docker-compose-java_seed_1 | grep
"Member is Up" | wc -l` -eq 3 ] && break
+ sleep 4
+done
+
+if [ $i -eq 10 ]
+then
+ echo "No 3 MemberUp log events found:"
+ docker logs pekko-sample-cluster-docker-compose-java_seed_1
+ exit -1
+fi
diff --git
a/pekko-sample-cluster-docker-compose-java/src/main/java/com/example/ClusterListener.java
b/pekko-sample-cluster-docker-compose-java/src/main/java/com/example/ClusterListener.java
new file mode 100644
index 0000000..5812e5f
--- /dev/null
+++
b/pekko-sample-cluster-docker-compose-java/src/main/java/com/example/ClusterListener.java
@@ -0,0 +1,42 @@
+package com.example;
+
+import org.apache.pekko.actor.typed.Behavior;
+import org.apache.pekko.actor.typed.javadsl.AbstractBehavior;
+import org.apache.pekko.actor.typed.javadsl.ActorContext;
+import org.apache.pekko.actor.typed.javadsl.Behaviors;
+import org.apache.pekko.actor.typed.javadsl.Receive;
+import org.apache.pekko.cluster.ClusterEvent;
+import org.apache.pekko.cluster.typed.Cluster;
+import org.apache.pekko.cluster.typed.Subscribe;
+
+public final class ClusterListener extends
AbstractBehavior<ClusterEvent.ClusterDomainEvent> {
+
+ public static Behavior<ClusterEvent.ClusterDomainEvent> create() {
+ return Behaviors.setup(ClusterListener::new);
+ }
+
+ private ClusterListener(ActorContext<ClusterEvent.ClusterDomainEvent>
context) {
+ super(context);
+ context.getLog().debug("starting up cluster listener...");
+ final Cluster cluster = Cluster.get(context.getSystem());
+ cluster.subscriptions().tell(Subscribe.create(context.getSelf(),
ClusterEvent.ClusterDomainEvent.class));
+ }
+
+ @Override
+ public Receive<ClusterEvent.ClusterDomainEvent> createReceive() {
+ return newReceiveBuilder()
+ .onMessage(ClusterEvent.MemberUp.class, event -> {
+ getContext().getLog().info("Member is Up: {}",
event.member().address());
+ return this;
+ }).onMessage(ClusterEvent.UnreachableMember.class, event -> {
+ getContext().getLog().info("Member detected as unreachable: {}",
event.member().address());
+ return this;
+ }).onMessage(ClusterEvent.MemberRemoved.class, event -> {
+ getContext().getLog().info("Member is Removed: {} after {}",
event.member().address(), event.previousStatus());
+ return this;
+ }).onMessage(ClusterEvent.MemberRemoved.class, event -> {
+ getContext().getLog().info("Member Event: " + event.toString());
+ return this;
+ }).build();
+ }
+}
diff --git
a/pekko-sample-cluster-docker-compose-java/src/main/java/com/example/ClusteringApp.java
b/pekko-sample-cluster-docker-compose-java/src/main/java/com/example/ClusteringApp.java
new file mode 100644
index 0000000..8d5fbe7
--- /dev/null
+++
b/pekko-sample-cluster-docker-compose-java/src/main/java/com/example/ClusteringApp.java
@@ -0,0 +1,16 @@
+package com.example;
+
+import org.apache.pekko.actor.typed.ActorSystem;
+import com.typesafe.config.Config;
+import com.typesafe.config.ConfigFactory;
+
+public class ClusteringApp {
+
+ public static void main(String[] args) {
+ Config config = ConfigFactory.load();
+ String clusterName = config.getString("clustering.cluster.name");
+
+ ActorSystem<?> system = ActorSystem.create(ClusterListener.create(),
clusterName);
+ }
+
+}
diff --git
a/pekko-sample-cluster-docker-compose-java/src/main/resources/application.conf
b/pekko-sample-cluster-docker-compose-java/src/main/resources/application.conf
new file mode 100644
index 0000000..afe70a5
--- /dev/null
+++
b/pekko-sample-cluster-docker-compose-java/src/main/resources/application.conf
@@ -0,0 +1,36 @@
+pekko {
+ loglevel = debug
+ actor {
+ provider = "cluster"
+ debug {
+ receive = off
+ lifecycle = off
+ }
+ }
+ remote {
+ log-remote-lifecycle-events = on
+ artery.canonical {
+ hostname = ${clustering.ip}
+ port = ${clustering.port}
+ }
+ }
+ cluster {
+ seed-nodes = [
+
"pekko://"${clustering.cluster.name}"@"${clustering.seed-ip}":"${clustering.seed-port}
+ ]
+ downing-provider-class =
org.apache.pekko.cluster.sbr.SplitBrainResolverProvider
+ }
+}
+
+clustering {
+ ip = "127.0.0.1"
+ ip = ${?CLUSTER_IP}
+ port = 1600
+ port = ${?CLUSTER_PORT}
+ seed-ip = "127.0.0.1"
+ seed-ip = ${?CLUSTER_IP}
+ seed-ip = ${?SEED_PORT_1600_TCP_ADDR}
+ seed-port = 1600
+ seed-port = ${?SEED_PORT_1600_TCP_PORT}
+ cluster.name = clustering-cluster
+}
diff --git
a/pekko-sample-cluster-docker-compose-java/src/main/resources/logback.xml
b/pekko-sample-cluster-docker-compose-java/src/main/resources/logback.xml
new file mode 100644
index 0000000..16c2cb1
--- /dev/null
+++ b/pekko-sample-cluster-docker-compose-java/src/main/resources/logback.xml
@@ -0,0 +1,24 @@
+<configuration>
+
+ <!-- This is a development logging configuration that logs to standard out,
for an example of a production
+ logging config, see the Apache Pekko docs:
https://pekko.apache.org/docs/pekko/current/typed/logging.html#logback -->
+ <appender name="console" target="System.out"
class="ch.qos.logback.core.ConsoleAppender">
+ <encoder>
+ <pattern>[%date{ISO8601}] [%level] [%X{pekkoAddress}] [%logger]
[%thread] [%X{pekkoSource}] - %msg%n</pattern>
+ </encoder>
+ </appender>
+
+ <logger name="com.example" level="debug" additivity="false">
+ <appender-ref ref="console" />
+ </logger>
+
+ <logger name="pekko" level="info" additivity="false">
+ <appender-ref ref="console" />
+ </logger>
+
+ <root level="warn">
+ <appender-ref ref="console"/>
+ </root>
+
+</configuration>
+
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
