├── .github ├── dependabot.yml └── workflows │ └── ci.yml ├── .gitignore ├── Jenkinsfile ├── LICENSE ├── README.adoc ├── pom.xml └── src ├── main └── java │ ├── mjson │ ├── Json.java │ └── package-info.java │ └── org │ └── jgroups │ └── protocols │ └── kubernetes │ ├── Client.java │ ├── KUBE_PING.java │ ├── Pod.java │ ├── Utils.java │ ├── pem │ ├── Asn1Object.java │ ├── DerParser.java │ ├── PEMReader.java │ └── PKCS1EncodedKeySpec.java │ └── stream │ ├── BaseStreamProvider.java │ ├── CertificateStreamProvider.java │ ├── DefaultStreamProvider.java │ ├── OpenStream.java │ ├── StreamProvider.java │ ├── TokenStreamProvider.java │ └── TrustManagers.java └── test ├── java └── org │ └── jgroups │ ├── ping │ └── kube │ │ └── test │ │ ├── CertsTest.java │ │ ├── ClientTest.java │ │ ├── JsonTest.java │ │ ├── RollingUpdateTest.java │ │ ├── StatusTest.java │ │ ├── TestClient.java │ │ └── util │ │ └── FreePortFinder.java │ └── protocols │ └── kubernetes │ ├── UtilsTest.java │ └── stream │ └── StreamProviderTest.java └── resources ├── certificates └── ca.crt ├── complex_pods.json ├── grant.yaml ├── openshift_rolling_update.json ├── pods.json ├── pods_without_ports.json ├── replicaset_rolling_update.json ├── statefulset_rolling_update.json └── unknown_pods.json /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: maven 4 | directory: "/" 5 | schedule: 6 | interval: daily 7 | open-pull-requests-limit: 10 8 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | push: 4 | branches: 5 | - '*' 6 | pull_request: 7 | branches: 8 | - '*' 9 | permissions: 10 | contents: read 11 | jobs: 12 | ci: 13 | runs-on: ${{ matrix.os }} 14 | strategy: 15 | matrix: 16 | os: 17 | - macos-latest 18 | - ubuntu-latest 19 | - windows-latest 20 | # Keep this list as: all supported LTS JDKs, the latest GA JDK, and optionally the latest EA JDK (if available). 21 | # Reference: https://adoptium.net/support/ 22 | java: 23 | - 11 24 | - 17 25 | - 21 26 | - 24 27 | - 25-ea 28 | steps: 29 | - name: Checkout 30 | uses: actions/checkout@v4 31 | - name: Set up JDK ${{ matrix.java }} 32 | uses: actions/setup-java@v4 33 | with: 34 | distribution: temurin 35 | java-version: ${{ matrix.java }} 36 | cache: maven 37 | - name: Build with Maven 38 | run: mvn --batch-mode --no-transfer-progress clean verify 39 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.iml 2 | *.ipr 3 | *.iws 4 | *~ 5 | .DS_Store 6 | .checkstyle 7 | .classpath 8 | .factorypath 9 | .fbExcludeFilterFile 10 | .idea/ 11 | .metadata/ 12 | .project 13 | .settings/ 14 | atlassian* 15 | dist/eap/docker/jboss-eap-openshift.zip 16 | dist/wildfly/docker/wildfly-openshift.zip 17 | hs_err_pid* 18 | target/ 19 | release.properties 20 | -------------------------------------------------------------------------------- /Jenkinsfile: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env groovy 2 | 3 | pipeline { 4 | agent any 5 | stages { 6 | stage('SCM Checkout') { 7 | steps { 8 | checkout scm 9 | } 10 | } 11 | 12 | stage('Build') { 13 | steps { 14 | script { 15 | env.JAVA_HOME = tool('JDK 11') 16 | def mvnHome = tool 'Maven' 17 | sh "${mvnHome}/bin/mvn clean install -Dmaven.test.failure.ignore=true" 18 | junit '**/target/*-reports/*.xml' 19 | } 20 | } 21 | } 22 | 23 | 24 | stage('Deploy SNAPSHOT') { 25 | when { 26 | branch 'main' 27 | } 28 | steps { 29 | configFileProvider([configFile(fileId: 'maven-settings-with-deploy-snapshot', variable: 'MAVEN_SETTINGS')]) { 30 | script { 31 | env.JAVA_HOME = tool('JDK 11') 32 | def mvnHome = tool 'Maven' 33 | sh "${mvnHome}/bin/mvn deploy -s $MAVEN_SETTINGS -DskipTests" 34 | } 35 | } 36 | } 37 | } 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.adoc: -------------------------------------------------------------------------------- 1 | = Kubernetes discovery protocol for JGroups 2 | 3 | `KUBE_PING` is a discovery protocol for JGroups cluster nodes managed by Kubernetes. 4 | 5 | NOTE: Another discovery protocol, which is container-agnostic (docker, openshift, kubernetes), is 6 | `DNS_PING` (http://www.jgroups.org/manual5/index.html#_dns_ping). This could be considered as an alternative. 7 | 8 | Since Kubernetes is in charge of launching nodes, it knows the IP addresses of all pods it started, and is therefore 9 | the best place to ask for cluster discovery. 10 | 11 | Discovery is therefore done by asking Kubernetes for a list of IP addresses of all cluster nodes. 12 | 13 | Combined with `bind_port` / `port_range`, the protocol will then send a discovery request to all instances and wait for 14 | the responses. 15 | 16 | A sample configuration looks like this: 17 | 18 | .Sample KUBE_PING config 19 | [source,xml] 20 | ---- 21 | 26 | 31 | ... 32 | ---- 33 | 34 | When a discovery is started, `KUBE_PING` asks Kubernetes for a list of the IP addresses of all pods which it launched, 35 | matching the given _namespace_ and _labels_ (see below). 36 | 37 | Let's say Kubernetes launched a cluster of 3 pods with IP addresses `172.17.0.2`, `172.17.0.3` and `172.17.0.5` (all 38 | launched into the same namespace and without any (or the same) labels). 39 | 40 | On a discovery request, Kubernetes returns a list of 3 IP addresses. JGroups now knows that the ports have been 41 | allocated from range [`7800` .. `7801`] (`bind_port` .. (`bind_port` + `port_range`) in `TCP`). 42 | 43 | KUBE_PING therefore sends discovery requests to members at addresses `172.17.0.2:7800`, `172.17.0.2:7801`, `172.17.0.3:7800`, 44 | `172.17.0.3:7801`, `172.17.0.5:7800` and `172.17.0.5:7801`. 45 | 46 | NOTE: Clients need permission to ask Kubernetes for a list of pod IPs. This is done by creating various policies e.g. 47 | with YAML. See the 3 example policies at the top of the <> section below. 48 | 49 | 50 | == Separating different clusters 51 | 52 | If pods with containers in different clusters are launched, we'd get a list of IP addresses of all nodes, not just the 53 | ones in the same cluster, as Kubernetes knows nothing about clusters. 54 | 55 | If we start multiple clusters, we need to separate them using namespaces and/or labels. If no namespaces or labels were 56 | used, things would still work, but we'd see warning messages in the logs about messages from different clusters that 57 | were discarded. 58 | 59 | 60 | === Namespaces 61 | 62 | Namespaces can be used to separate deployments, services and pods. The example below shows namespaces `default` 63 | (the default namespace) and `kube-system` (the name space used by Kubernetes for its own deployments, pods etc): 64 | 65 | ---- 66 | [belasmac] /Users/bela/IspnPerfTest$ kubectl get services,deployments,pods --all-namespaces 67 | NAMESPACE NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE 68 | default svc/ispn-perf-test 10.0.0.137 8090:32700/TCP 8h 69 | default svc/kubernetes 10.0.0.1 443/TCP 53d 70 | kube-system svc/kube-dns 10.0.0.10 53/UDP,53/TCP 53d 71 | kube-system svc/kubernetes-dashboard 10.0.0.30 80:30000/TCP 53d 72 | 73 | NAMESPACE NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE 74 | default deploy/ispn-perf-test2 3 3 3 3 8h 75 | 76 | NAMESPACE NAME READY STATUS RESTARTS AGE 77 | default po/ispn-perf-test2-2831437780-g07c5 1/1 Running 1 8h 78 | default po/ispn-perf-test2-2831437780-np83d 1/1 Running 0 6h 79 | default po/ispn-perf-test2-2831437780-szl60 1/1 Running 1 8h 80 | kube-system po/kube-addon-manager-minikube 1/1 Running 12 53d 81 | kube-system po/kube-dns-v20-b63lk 3/3 Running 34 53d 82 | kube-system po/kubernetes-dashboard-73c7v 1/1 Running 11 53d 83 | ---- 84 | 85 | The last section shows 6 pods that have been started, 3 in the `default` namespace and 3 by Kubernetes itself in the 86 | `kube-system` namespace. The following 3 namespaces exist: 87 | 88 | ---- 89 | [belasmac] /Users/bela$ kubectl get namespaces 90 | NAME STATUS AGE 91 | belaban Active 2d 92 | default Active 53d 93 | kube-system Active 53d 94 | ---- 95 | 96 | To create a new namespace `foo`, run `kubectl create namespace foo`. 97 | 98 | Namespaces have to be created and deleted manually via kubectl. 99 | 100 | When launching a new deployment in a pod, the namespace can be given with `-n ` or 101 | `--namespace=`. Alternatively, the namespace can be defined in the YAML or JSON config passed to 102 | `kubectl create -f `. 103 | 104 | In the JGroups configuration, attribute `namespace` is used to define the namespace to be used for discovery. The 105 | example above used `namespace="${KUBERNETES_NAMESPACE:production}"`. This means that the namespace is 106 | 107 | * the value of system property `KUBERNETES_NAMESPACE`, if set 108 | * the value of environment variable `KUBERNETES_NAMESPACE` if set, or 109 | * `"production"` if neither system property nor env var are set 110 | 111 | In the example above, Kubernetes will return only IP addresses of pods created in namespace `"production"`. 112 | 113 | 114 | === Labels 115 | 116 | Labels are similar to namespaces; different labels can separate clusters running inside the _same namespace_. 117 | 118 | Similarly to namespaces, labels also have to be defined when launching a pod, either via `--labels=