├── .gitignore ├── LICENSE ├── README.adoc ├── pom.xml └── src └── main └── java └── com └── github └── pires └── ignite └── kubernetes └── KubernetesPodIpFinder.java /.gitignore: -------------------------------------------------------------------------------- 1 | *.class 2 | target 3 | bin 4 | 5 | # Package Files # 6 | *.jar 7 | *.war 8 | *.ear 9 | 10 | # IDE files # 11 | .settings 12 | .project 13 | .classpath 14 | .idea 15 | *.iml 16 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /README.adoc: -------------------------------------------------------------------------------- 1 | :sectnums: 2 | :numbered: 3 | :toc: macro 4 | :toc-title: 5 | :toclevels: 99 6 | 7 | # apache-ignite-discovery-kubernetes 8 | 9 | Apache Ignite discovery for Kubernetes. 10 | 11 | toc::[] 12 | 13 | ## Requirements 14 | 15 | * Kubernetes cluster with DNS integration enabled 16 | 17 | If you want to build the plug-in yourself, you'll need: 18 | 19 | * Java compiler able to compile Java 7 code 20 | * Maven 3.3.x or newer 21 | 22 | ## Usage 23 | 24 | First, declare the following in your project's `pom.xml`: 25 | ```xml 26 | 27 | com.github.pires 28 | apache-ignite-discovery-kubernetes 29 | 1.0_1 30 | 31 | ``` 32 | 33 | Now, let's configure Apache Ignite discovery based on the following service descriptor: 34 | ```yaml 35 | apiVersion: v1 36 | kind: Service 37 | metadata: 38 | name: MY-SERVICE 39 | labels: 40 | component: my-svc 41 | spec: 42 | selector: 43 | component: my-svc 44 | clusterIP: None 45 | ports: 46 | - name: MY-CONTAINER-PORT 47 | port: 47500 48 | protocol: TCP 49 | ``` 50 | 51 | ### XML 52 | 53 | ```xml 54 | 55 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | ``` 82 | 83 | ### Java 84 | 85 | ```java 86 | // ... 87 | 88 | // Headless service name that exposes Ignite cluster, embedded or not. 89 | // See http://kubernetes.io/docs/user-guide/services/#headless-services 90 | final String serviceName = "MY-SERVICE"; 91 | final String containerPortName = "MY-CONTAINER-PORT"; 92 | 93 | final KubernetesPodIpFinder podIpFinder = new KubernetesPodIpFinder(); 94 | podIpFinder.setContainerPortName(containerPortName); 95 | podIpFinder.setServiceName(serviceName); 96 | 97 | final TcpDiscoverySpi discovery = new TcpDiscoverySpi(); 98 | discovery.setIpFinder(podIpFinder); 99 | 100 | final IgniteConfiguration igniteConfig = new IgniteConfiguration(); 101 | igniteConfig.setDiscoverySpi(discovery); 102 | 103 | Ignition.start(igniteConfig); 104 | 105 | // ... 106 | ``` 107 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | 5 | 6 | org.sonatype.oss 7 | oss-parent 8 | 9 9 | 10 | 11 | com.github.pires 12 | apache-ignite-discovery-kubernetes 13 | 1.1-SNAPSHOT 14 | 15 | Apache Ignite Discovery (Kubernetes) 16 | 17 | 18 | UTF-8 19 | UTF-8 20 | 1.7 21 | ${java.version} 22 | ${java.version} 23 | 24 | 1.6.0 25 | 1.3.175 26 | 3.1.1 27 | 28 | 2.10.4 29 | 1.6 30 | 31 | 32 | 33 | 34 | 35 | org.apache.ignite 36 | ignite-core 37 | ${ignite.version} 38 | 39 | 40 | org.apache.ignite 41 | ignite-indexing 42 | ${ignite.version} 43 | 44 | 45 | com.h2database 46 | h2 47 | ${h2.version} 48 | 49 | 50 | com.spotify 51 | dns 52 | ${spotify.dns.version} 53 | 54 | 55 | com.google.guava 56 | guava 57 | 19.0 58 | 59 | 60 | 61 | 62 | 63 | 64 | org.apache.maven.plugins 65 | maven-enforcer-plugin 66 | 67 | 68 | enforce-java 69 | 70 | enforce 71 | 72 | 73 | 74 | 75 | [3.3,) 76 | 77 | 78 | [1.8,) 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | maven-release-plugin 87 | 88 | true 89 | true 90 | true 91 | false 92 | 93 | 94 | 95 | org.apache.maven.plugins 96 | maven-javadoc-plugin 97 | ${plugin.javadoc.version} 98 | 99 | 100 | 101 | jar 102 | aggregate 103 | 104 | 105 | false 106 | -Xdoclint:none 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | release-sign-artifacts 117 | 118 | 119 | performRelease 120 | true 121 | 122 | 123 | 124 | 125 | 126 | org.apache.maven.plugins 127 | maven-javadoc-plugin 128 | ${plugin.javadoc.version} 129 | 130 | 131 | 132 | jar 133 | aggregate 134 | 135 | 136 | false 137 | -Xdoclint:none 138 | 139 | 140 | 141 | 142 | 143 | org.apache.maven.plugins 144 | maven-gpg-plugin 145 | ${plugin.gpg.version} 146 | 147 | 148 | sign-artifacts 149 | verify 150 | 151 | sign 152 | 153 | 154 | F92B72C4 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | The Apache Software License, Version 2.0 167 | http://www.apache.org/licenses/LICENSE-2.0.txt 168 | repo 169 | 170 | 171 | 172 | 173 | scm:git:git@github.com:pires/apache-ignite-discovery-kubernetes.git 174 | scm:git:git@github.com:pires/apache-ignite-discovery-kubernetes.git 175 | git@github.com:pires/apache-ignite-discovery-kubernetes.git 176 | HEAD 177 | 178 | 179 | 180 | 181 | pjpires 182 | Paulo Pires 183 | pjpires@gmail.com 184 | 185 | developer 186 | 187 | 188 | 189 | 190 | 191 | 192 | sonatype-nexus-staging 193 | Sonatype OSS Staging 194 | https://oss.sonatype.org/service/local/staging/deploy/maven2 195 | 196 | 197 | sonatype-nexus-snapshot 198 | Sonatype OSS Snapshots 199 | https://oss.sonatype.org/content/repositories/snapshots 200 | 201 | 202 | 203 | 204 | -------------------------------------------------------------------------------- /src/main/java/com/github/pires/ignite/kubernetes/KubernetesPodIpFinder.java: -------------------------------------------------------------------------------- 1 | package com.github.pires.ignite.kubernetes; 2 | 3 | import com.spotify.dns.DnsSrvResolver; 4 | import com.spotify.dns.DnsSrvResolvers; 5 | import com.spotify.dns.LookupResult; 6 | import org.apache.ignite.IgniteLogger; 7 | import org.apache.ignite.internal.util.tostring.GridToStringInclude; 8 | import org.apache.ignite.internal.util.typedef.internal.S; 9 | import org.apache.ignite.resources.LoggerResource; 10 | import org.apache.ignite.spi.IgniteSpiConfiguration; 11 | import org.apache.ignite.spi.IgniteSpiException; 12 | import org.apache.ignite.spi.discovery.tcp.ipfinder.vm.TcpDiscoveryVmIpFinder; 13 | 14 | import java.net.InetSocketAddress; 15 | import java.util.Collection; 16 | import java.util.List; 17 | import java.util.concurrent.CopyOnWriteArrayList; 18 | 19 | /** 20 | * Apache Ignite usage on Kubernetes requires that each node (Pod in the Kubernetes lingo) 21 | * is able to access other pods directly. Proxies will not work. 22 | *

23 | * In order to find the desired pods IP addresses, one could query the Kubernetes API for 24 | * endpoints of a Service but that may prove too much of a hurdle to maintain. Since DNS integration 25 | * is a common best-practice when assembling Kubernetes clusters, we will rely on SRV lookups. 26 | */ 27 | public class KubernetesPodIpFinder extends TcpDiscoveryVmIpFinder { 28 | 29 | private static final int DNS_LOOKUP_TIMEOUT_MILLIS = 1000; 30 | 31 | /** 32 | * Grid logger. 33 | */ 34 | @LoggerResource 35 | private IgniteLogger log; 36 | 37 | @GridToStringInclude 38 | private String containerPortName; 39 | 40 | @GridToStringInclude 41 | private String serviceName; 42 | 43 | public KubernetesPodIpFinder() { 44 | super(true); 45 | } 46 | 47 | public KubernetesPodIpFinder(boolean shared) { 48 | super(shared); 49 | } 50 | 51 | /** 52 | * Parses provided container port name. 53 | * 54 | * @param containerPortName the container port name to use in lookup queries. 55 | * @throws IgniteSpiException 56 | */ 57 | @IgniteSpiConfiguration(optional = true) 58 | public synchronized void setContainerPortName(String containerPortName) throws IgniteSpiException { 59 | this.containerPortName = containerPortName; 60 | } 61 | 62 | /** 63 | * Parses provided service name. 64 | * 65 | * @param serviceName the service name to use in lookup queries. 66 | * @throws IgniteSpiException 67 | */ 68 | @IgniteSpiConfiguration(optional = true) 69 | public synchronized void setServiceName(String serviceName) throws IgniteSpiException { 70 | this.serviceName = serviceName; 71 | } 72 | 73 | /** 74 | * {@inheritDoc} 75 | */ 76 | @Override 77 | public synchronized Collection getRegisteredAddresses() { 78 | // provision DNS resolver for usage with SRV records 79 | final DnsSrvResolver resolver = DnsSrvResolvers.newBuilder() 80 | .retainingDataOnFailures(true) 81 | .dnsLookupTimeoutMillis(DNS_LOOKUP_TIMEOUT_MILLIS) 82 | .build(); 83 | // resolve configured addresses 84 | final Collection inets = new CopyOnWriteArrayList<>(); 85 | final String fqdn = "_" + containerPortName + "._tcp." + serviceName; 86 | log.debug("Looking up SRV records with FQDN [" + fqdn + "]."); 87 | final List nodes = resolver.resolve(fqdn); 88 | for (LookupResult node : nodes) { 89 | inets.add(InetSocketAddress.createUnresolved(node.host(), node.port())); 90 | } 91 | log.debug("Found " + nodes.size() + " nodes."); 92 | 93 | return inets; 94 | } 95 | 96 | /** 97 | * {@inheritDoc} 98 | */ 99 | @Override 100 | public String toString() { 101 | return S.toString(KubernetesPodIpFinder.class, this, "super", super.toString()); 102 | } 103 | 104 | } 105 | --------------------------------------------------------------------------------