From 05b7236db09db1f5e6e6ef3a9c06f9dec33e7213 Mon Sep 17 00:00:00 2001 From: Maxim Muzafarov Date: Tue, 14 Jun 2022 16:46:12 +0300 Subject: [PATCH] IGNITE-17137 Move ignite-cloud IP finder to the Ignite Extensions project (#157) --- modules/cloud-ext/README.txt | 32 ++ modules/cloud-ext/assembly/cloud-ext.xml | 34 ++ modules/cloud-ext/licenses/apache-2.0.txt | 202 ++++++++ modules/cloud-ext/pom.xml | 117 +++++ .../cloud/TcpDiscoveryCloudIpFinder.java | 481 ++++++++++++++++++ .../tcp/ipfinder/cloud/package-info.java | 22 + .../TcpDiscoveryCloudIpFinderSelfTest.java | 119 +++++ .../tcp/ipfinder/cloud/package-info.java | 23 + .../testsuites/IgniteCloudTestSuite.java | 103 ++++ pom.xml | 1 + 10 files changed, 1134 insertions(+) create mode 100644 modules/cloud-ext/README.txt create mode 100644 modules/cloud-ext/assembly/cloud-ext.xml create mode 100644 modules/cloud-ext/licenses/apache-2.0.txt create mode 100644 modules/cloud-ext/pom.xml create mode 100644 modules/cloud-ext/src/main/java/org/apache/ignite/spi/discovery/tcp/ipfinder/cloud/TcpDiscoveryCloudIpFinder.java create mode 100644 modules/cloud-ext/src/main/java/org/apache/ignite/spi/discovery/tcp/ipfinder/cloud/package-info.java create mode 100644 modules/cloud-ext/src/test/java/org/apache/ignite/spi/discovery/tcp/ipfinder/cloud/TcpDiscoveryCloudIpFinderSelfTest.java create mode 100644 modules/cloud-ext/src/test/java/org/apache/ignite/spi/discovery/tcp/ipfinder/cloud/package-info.java create mode 100644 modules/cloud-ext/src/test/java/org/apache/ignite/testsuites/IgniteCloudTestSuite.java diff --git a/modules/cloud-ext/README.txt b/modules/cloud-ext/README.txt new file mode 100644 index 000000000..015aad9c7 --- /dev/null +++ b/modules/cloud-ext/README.txt @@ -0,0 +1,32 @@ +Apache Ignite Cloud Module +------------------------ + +Apache Ignite Cloud module provides Apache jclouds implementations of IP finder for TCP discovery. + +To enable Cloud module when starting a standalone node, move 'ignite-cloud' folder to +'libs' folder before running 'ignite.{sh|bat}' script. The content of the module folder will +be added to classpath in this case. + +Importing Cloud Module In Maven Project +------------------------------------- + +If you are using Maven to manage dependencies of your project, you can add Cloud module +dependency like this (replace '${ignite.version}' with actual Ignite version you are +interested in): + + + ... + + ... + + org.apache.ignite + ignite-cloud-ext + 1.0.0 + + ... + + ... + diff --git a/modules/cloud-ext/assembly/cloud-ext.xml b/modules/cloud-ext/assembly/cloud-ext.xml new file mode 100644 index 000000000..0c28f4c44 --- /dev/null +++ b/modules/cloud-ext/assembly/cloud-ext.xml @@ -0,0 +1,34 @@ + + + + + + bin + false + + + zip + + + + ../../assembly/bin-component-shared.xml + + diff --git a/modules/cloud-ext/licenses/apache-2.0.txt b/modules/cloud-ext/licenses/apache-2.0.txt new file mode 100644 index 000000000..d64569567 --- /dev/null +++ b/modules/cloud-ext/licenses/apache-2.0.txt @@ -0,0 +1,202 @@ + + 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. diff --git a/modules/cloud-ext/pom.xml b/modules/cloud-ext/pom.xml new file mode 100644 index 000000000..80062232e --- /dev/null +++ b/modules/cloud-ext/pom.xml @@ -0,0 +1,117 @@ + + + + + + + 4.0.0 + + + org.apache.ignite + ignite-parent-ext-internal + 1 + ../../parent-internal/pom.xml + + + ignite-cloud-ext + 1.0.0-SNAPSHOT + + https://ignite.apache.org + + + 2.0.0 + + + + + ${project.groupId} + ignite-core + + + + org.apache.jclouds + jclouds-allcompute + ${jcloud.version} + + + + org.apache.jclouds.labs + google-compute-engine + 1.9.3 + + + + org.apache.jclouds.labs + docker + 1.9.3 + + + + org.apache.jclouds.provider + cloudsigma-zrh + 1.8.0 + + + + ${project.groupId} + ignite-core + test-jar + test + + + + org.springframework + spring-beans + ${spring.version} + test + + + + log4j + log4j + test + + + + org.springframework + spring-context + ${spring.version} + test + + + + org.springframework + spring-core + ${spring.version} + test + + + + + + + org.apache.maven.plugins + maven-deploy-plugin + 2.8.2 + + false + + + + + diff --git a/modules/cloud-ext/src/main/java/org/apache/ignite/spi/discovery/tcp/ipfinder/cloud/TcpDiscoveryCloudIpFinder.java b/modules/cloud-ext/src/main/java/org/apache/ignite/spi/discovery/tcp/ipfinder/cloud/TcpDiscoveryCloudIpFinder.java new file mode 100644 index 000000000..57e8c50de --- /dev/null +++ b/modules/cloud-ext/src/main/java/org/apache/ignite/spi/discovery/tcp/ipfinder/cloud/TcpDiscoveryCloudIpFinder.java @@ -0,0 +1,481 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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. + */ + +package org.apache.ignite.spi.discovery.tcp.ipfinder.cloud; + +import java.io.File; +import java.io.IOException; +import java.net.InetSocketAddress; +import java.util.Collection; +import java.util.HashSet; +import java.util.Iterator; +import java.util.LinkedList; +import java.util.Properties; +import java.util.Set; +import java.util.TreeSet; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.atomic.AtomicBoolean; +import com.google.common.base.Charsets; +import com.google.common.base.Predicate; +import com.google.common.base.Supplier; +import com.google.common.io.Files; +import org.apache.ignite.internal.IgniteInterruptedCheckedException; +import org.apache.ignite.internal.util.tostring.GridToStringExclude; +import org.apache.ignite.internal.util.typedef.F; +import org.apache.ignite.internal.util.typedef.internal.S; +import org.apache.ignite.internal.util.typedef.internal.U; +import org.apache.ignite.spi.IgniteSpiConfiguration; +import org.apache.ignite.spi.IgniteSpiException; +import org.apache.ignite.spi.discovery.tcp.TcpDiscoverySpi; +import org.apache.ignite.spi.discovery.tcp.ipfinder.TcpDiscoveryIpFinderAdapter; +import org.jclouds.Constants; +import org.jclouds.ContextBuilder; +import org.jclouds.compute.ComputeService; +import org.jclouds.compute.ComputeServiceContext; +import org.jclouds.compute.domain.ComputeMetadata; +import org.jclouds.compute.domain.NodeMetadata; +import org.jclouds.domain.Credentials; +import org.jclouds.domain.Location; +import org.jclouds.googlecloud.GoogleCredentialsFromJson; +import org.jclouds.location.reference.LocationConstants; + +/** + * IP finder for automatic lookup of nodes running in a cloud. + *

+ * Implementation is based on Apache jclouds multi-cloud toolkit. + * For information about jclouds visit jclouds.apache.org. + *

Configuration

+ *

Mandatory

+ * + *

Optional

+ * + *

+ *

+ * The finder forms nodes addresses, that possibly running Ignite, by getting private and public IPs of all + * VMs in a cloud and adding a port number to them. + * The port is either the one that is set with {@link TcpDiscoverySpi#setLocalPort(int)} or + * {@link TcpDiscoverySpi#DFLT_PORT}. + * Make sure that all VMs start Ignite instances on the same port, otherwise they will not be able to discover each + * other using this IP finder. + *

+ *

+ * Both {@link #registerAddresses(Collection)} and {@link #unregisterAddresses(Collection)} has no effect. + *

+ *

+ * Note, this finder is only workable when it used directly by cloud VM. + * Choose another implementation of {@link org.apache.ignite.spi.discovery.tcp.ipfinder.TcpDiscoveryIpFinder} for local + * or home network tests. + *

+ *

Java Example

+ * 
+ * String accountId = "your_account_id";
+ * String accountKey = "your_account_key";
+ *
+ * TcpDiscoveryCloudIpFinder ipFinder = new TcpDiscoveryCloudIpFinder();
+ *
+ * ipFinder.setProvider("aws-ec2");
+ * ipFinder.setIdentity(accountId);
+ * ipFinder.setCredential(accountKey);
+ * ipFinder.setRegions(Collections.emptyList().add("us-east-1"));
+ * ipFinder.setZones(Arrays.asList("us-east-1b", "us-east-1e"));
+ *
+ *

Spring Example

+ * TcpDiscoveryCloudIpFinder can be configured from Spring XML configuration file: + * 
+ * <bean id="grid.custom.cfg" class="org.apache.ignite.configuration.IgniteConfiguration" singleton="true">
+ *         ...
+ *         <property name="discoverySpi">
+ *             <bean class="org.apache.ignite.spi.discovery.tcp.TcpDiscoverySpi">
+ *                 <property name="ipFinder">
+ *                     <bean class="org.apache.ignite.spi.discovery.tcp.ipfinder.cloud.TcpDiscoveryCloudIpFinder"/>
+ *                         <property name="provider" value="google-compute-engine"/>
+ *                         <property name="identity" value="your_service_account_email"/>
+ *                         <property name="credentialPath" value="path_to_json_key"/>
+ *                         <property name="zones">
+ *                             <list>
+ *                                 <value>us-central1-a</value>
+ *                                 <value>asia-east1-a</value>
+ *                             </list>
+ *                         </property>
+ *                     </bean>
+ *                 </property>
+ *
+ *                 <property name="socketTimeout" value="400"/>
+ *             </bean>
+ *         </property>
+ *         ...
+ * </bean>
+ *
+ *

+ * + *
+ * For information about Spring framework visit www.springframework.org + */ +public class TcpDiscoveryCloudIpFinder extends TcpDiscoveryIpFinderAdapter { + /** JCloud default connection timeout. */ + private static final String JCLOUD_CONNECTION_TIMEOUT = "10000"; //10 secs + + /** Cloud provider. */ + private String provider; + + /** Cloud specific identity (user name, email address, etc.). */ + private String identity; + + /** Cloud specific credential (password, access key, etc.). */ + @GridToStringExclude + private String credential; + + /** Path to a cloud specific credential. */ + @GridToStringExclude + private String credentialPath; + + /** Regions where VMs are located. */ + private TreeSet regions; + + /** Zones where VMs are located. */ + private TreeSet zones; + + /** Nodes filter by regions and zones. */ + private Predicate nodesFilter; + + /** Init guard. */ + @GridToStringExclude + private final AtomicBoolean initGuard = new AtomicBoolean(); + + /** Init latch. */ + @GridToStringExclude + private final CountDownLatch initLatch = new CountDownLatch(1); + + /** JCloud compute service. */ + private ComputeService computeService; + + /** + * Constructor. + */ + public TcpDiscoveryCloudIpFinder() { + setShared(true); + } + + /** {@inheritDoc} */ + @Override public Collection getRegisteredAddresses() throws IgniteSpiException { + initComputeService(); + + Collection addresses = new LinkedList<>(); + + try { + Set nodes; + + if (nodesFilter != null) + nodes = (Set)computeService.listNodesDetailsMatching(nodesFilter); + else { + nodes = new HashSet<>(); + + for (ComputeMetadata metadata : computeService.listNodes()) + nodes.add(computeService.getNodeMetadata(metadata.getId())); + } + + for (NodeMetadata metadata : nodes) { + if (metadata.getStatus() != NodeMetadata.Status.RUNNING) + continue; + + for (String addr : metadata.getPrivateAddresses()) + addresses.add(new InetSocketAddress(addr, 0)); + + for (String addr : metadata.getPublicAddresses()) + addresses.add(new InetSocketAddress(addr, 0)); + } + } + catch (Exception e) { + throw new IgniteSpiException("Failed to get registered addresses for the provider: " + provider, e); + } + + return addresses; + } + + /** {@inheritDoc} */ + @Override public void registerAddresses(Collection addrs) throws IgniteSpiException { + // No-op + } + + /** {@inheritDoc} */ + @Override public void unregisterAddresses(Collection addrs) throws IgniteSpiException { + // No-op + } + + /** + * Sets the cloud provider to use. + * + * Apache jclouds providers list from + * ComputeService section contains names of all supported providers. + * + * @param provider Provider name. + * @return {@code this} for chaining. + */ + @IgniteSpiConfiguration(optional = false) + public TcpDiscoveryCloudIpFinder setProvider(String provider) { + this.provider = provider; + + return this; + } + + /** + * Sets the identity that is used as a user name during a connection to the cloud. + * Depending on a cloud platform it can be an email address, user name, etc. + * + * Refer to Apache jclouds guide to get concrete information on + * what is used as an identity for a particular cloud platform. + * + * @param identity Identity to use during authentication on the cloud. + * @return {@code this} for chaining. + */ + @IgniteSpiConfiguration(optional = false) + public TcpDiscoveryCloudIpFinder setIdentity(String identity) { + this.identity = identity; + + return this; + } + + /** + * Sets credential that is used during authentication on the cloud. + * Depending on a cloud platform it can be a password or access key. + * + * Refer to Apache jclouds guide to get concrete information on + * what is used as an credential for a particular cloud platform. + * + * @param credential Credential to use during authentication on the cloud. + * @return {@code this} for chaining. + */ + @IgniteSpiConfiguration(optional = true) + public TcpDiscoveryCloudIpFinder setCredential(String credential) { + this.credential = credential; + + return this; + } + + /** + * Sets the path to a credential that is used during authentication on the cloud. + * + * This method should be used when an access key or private key is stored in a file. + * Content of the file, referred by @{code credentialPath}, is fully read and used as a access key or private key + * during authentication. + * + * Refer to Apache jclouds guide to get concrete information on + * what is used as an credential for a particular cloud platform. + * + * @param credentialPath Path to the credential to use during authentication on the cloud. + * @return {@code this} for chaining. + */ + @IgniteSpiConfiguration(optional = true) + public TcpDiscoveryCloudIpFinder setCredentialPath(String credentialPath) { + this.credentialPath = credentialPath; + + return this; + } + + /** + * Sets list of zones where VMs are located. + * + * If the zones are not set then every zone from regions, set by {@link #setRegions(Collection)}}, will be + * taken into account. + * + * Note, that some cloud providers, like Rackspace, doesn't have a notion of a zone. For such + * providers a call to this method is redundant. + * + * @param zones Zones where VMs are located or null if to take every zone into account. + * @return {@code this} for chaining. + */ + @IgniteSpiConfiguration(optional = true) + public TcpDiscoveryCloudIpFinder setZones(Collection zones) { + if (!F.isEmpty(zones)) + this.zones = new TreeSet<>(zones); + + return this; + } + + /** + * Sets list of regions where VMs are located. + * + * If the regions are not set then every region, that a cloud provider has, will be investigated. This could lead + * to significant performance degradation. + * + * Note, that some cloud providers, like Google Compute Engine, doesn't have a notion of a region. For such + * providers a call to this method is redundant. + * + * @param regions Regions where VMs are located or null if to check every region a provider has. + * @return {@code this} for chaining. + */ + @IgniteSpiConfiguration(optional = true) + public TcpDiscoveryCloudIpFinder setRegions(Collection regions) { + if (!F.isEmpty(regions)) + this.regions = new TreeSet<>(regions); + + return this; + } + + /** + * Initializes Apache jclouds compute service. + */ + private void initComputeService() { + if (initGuard.compareAndSet(false, true)) + try { + if (provider == null) + throw new IgniteSpiException("Cloud provider is not set."); + + if (identity == null) + throw new IgniteSpiException("Cloud identity is not set."); + + if (credential != null && credentialPath != null) + throw new IgniteSpiException("Both credential and credentialPath are set. Use only one method."); + + if (credentialPath != null) + credential = getCredentialFromFile(); + + try { + ContextBuilder ctxBuilder = ContextBuilder.newBuilder(provider); + + ctxBuilder.credentials(identity, credential); + + Properties properties = new Properties(); + properties.setProperty(Constants.PROPERTY_SO_TIMEOUT, JCLOUD_CONNECTION_TIMEOUT); + properties.setProperty(Constants.PROPERTY_CONNECTION_TIMEOUT, JCLOUD_CONNECTION_TIMEOUT); + + if (!F.isEmpty(regions)) + properties.setProperty(LocationConstants.PROPERTY_REGIONS, keysSetToStr(regions)); + + if (!F.isEmpty(zones)) + properties.setProperty(LocationConstants.PROPERTY_ZONES, keysSetToStr(zones)); + + ctxBuilder.overrides(properties); + + computeService = ctxBuilder.buildView(ComputeServiceContext.class).getComputeService(); + + if (!F.isEmpty(zones) || !F.isEmpty(regions)) { + nodesFilter = new Predicate() { + @Override public boolean apply(ComputeMetadata computeMetadata) { + String region = null; + String zone = null; + + Location location = computeMetadata.getLocation(); + + while (location != null) { + switch (location.getScope()) { + case ZONE: + zone = location.getId(); + break; + + case REGION: + region = location.getId(); + break; + } + + location = location.getParent(); + } + + if (regions != null && region != null && !regions.contains(region)) + return false; + + if (zones != null && zone != null && !zones.contains(zone)) + return false; + + return true; + } + }; + } + } + catch (Exception e) { + throw new IgniteSpiException("Failed to connect to the provider: " + provider, e); + } + } + finally { + initLatch.countDown(); + } + else { + try { + U.await(initLatch); + } + catch (IgniteInterruptedCheckedException e) { + throw new IgniteSpiException("Thread has been interrupted.", e); + } + + if (computeService == null) + throw new IgniteSpiException("Ip finder has not been initialized properly."); + } + } + + /** + * Reads credential info from {@link #credentialPath} and returns in a string format. + * + * @return Credential in {@code String} representation. + * @throws IgniteSpiException In case of error. + */ + private String getCredentialFromFile() throws IgniteSpiException { + try { + String fileContents = Files.toString(new File(credentialPath), Charsets.UTF_8); + + if (provider.equals("google-compute-engine")) { + Supplier credentialSupplier = new GoogleCredentialsFromJson(fileContents); + + return credentialSupplier.get().credential; + } + + return fileContents; + } + catch (IOException e) { + throw new IgniteSpiException("Failed to retrieve the private key from the file: " + credentialPath, e); + } + } + + /** + * Converts set keys to string. + * + * @param set Set. + * @return String where keys delimited by ','. + */ + private String keysSetToStr(Set set) { + Iterator iter = set.iterator(); + StringBuilder builder = new StringBuilder(); + + while (iter.hasNext()) { + builder.append(iter.next()); + + if (iter.hasNext()) + builder.append(','); + } + + return builder.toString(); + } + + /** {@inheritDoc} */ + @Override public TcpDiscoveryCloudIpFinder setShared(boolean shared) { + super.setShared(shared); + + return this; + } + + /** {@inheritDoc} */ + @Override public String toString() { + return S.toString(TcpDiscoveryCloudIpFinder.class, this); + } +} diff --git a/modules/cloud-ext/src/main/java/org/apache/ignite/spi/discovery/tcp/ipfinder/cloud/package-info.java b/modules/cloud-ext/src/main/java/org/apache/ignite/spi/discovery/tcp/ipfinder/cloud/package-info.java new file mode 100644 index 000000000..039ca9dfd --- /dev/null +++ b/modules/cloud-ext/src/main/java/org/apache/ignite/spi/discovery/tcp/ipfinder/cloud/package-info.java @@ -0,0 +1,22 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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. + */ +/** + * + * Contains Apache jclouds based IP finder. + */ + +package org.apache.ignite.spi.discovery.tcp.ipfinder.cloud; diff --git a/modules/cloud-ext/src/test/java/org/apache/ignite/spi/discovery/tcp/ipfinder/cloud/TcpDiscoveryCloudIpFinderSelfTest.java b/modules/cloud-ext/src/test/java/org/apache/ignite/spi/discovery/tcp/ipfinder/cloud/TcpDiscoveryCloudIpFinderSelfTest.java new file mode 100644 index 000000000..378769c10 --- /dev/null +++ b/modules/cloud-ext/src/test/java/org/apache/ignite/spi/discovery/tcp/ipfinder/cloud/TcpDiscoveryCloudIpFinderSelfTest.java @@ -0,0 +1,119 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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. + */ + +package org.apache.ignite.spi.discovery.tcp.ipfinder.cloud; + +import java.net.InetSocketAddress; +import java.util.Collection; +import com.google.common.collect.ImmutableList; +import org.apache.ignite.spi.discovery.tcp.TcpDiscoverySpi; +import org.apache.ignite.spi.discovery.tcp.ipfinder.TcpDiscoveryIpFinderAbstractSelfTest; +import org.apache.ignite.testsuites.IgniteCloudTestSuite; +import org.junit.Ignore; +import org.junit.Test; + +/** + * TcpDiscoveryCloudIpFinder test. + */ +public class TcpDiscoveryCloudIpFinderSelfTest extends + TcpDiscoveryIpFinderAbstractSelfTest { + /** + * Constructor. + * + * @throws Exception If any error occurs. + */ + public TcpDiscoveryCloudIpFinderSelfTest() throws Exception { + // No-op. + } + + /** {@inheritDoc} */ + @Override protected void beforeTest() throws Exception { + // No-op. + } + + /** {@inheritDoc} */ + @Override protected TcpDiscoveryCloudIpFinder ipFinder() throws Exception { + // No-op. + return null; + } + + /** {@inheritDoc} */ + @Test + @Override public void testIpFinder() throws Exception { + // No-op + } + + /** + * Tests GCE. + * + * @throws Exception If any error occurs. + */ + @Ignore("https://issues.apache.org/jira/browse/IGNITE-1585") + @Test + public void testGoogleComputeEngine() throws Exception { + testCloudProvider("google-compute-engine"); + } + + /** + * Tests Rackspace. + * + * @throws Exception If any error occurs. + */ + @Ignore("https://issues.apache.org/jira/browse/IGNITE-9444") + @Test + public void testRackspace() throws Exception { + testCloudProvider("rackspace-cloudservers-us"); + } + + /** + * Tests a given provider. + * + * @param provider Provider name. + * @throws Exception If any error occurs. + */ + private void testCloudProvider(String provider) throws Exception { + info("Testing provider: " + provider); + + TcpDiscoveryCloudIpFinder ipFinder = new TcpDiscoveryCloudIpFinder(); + + injectLogger(ipFinder); + + ipFinder.setProvider(provider); + ipFinder.setIdentity(IgniteCloudTestSuite.getAccessKey(provider)); + ipFinder.setRegions(IgniteCloudTestSuite.getRegions(provider)); + ipFinder.setZones(IgniteCloudTestSuite.getZones(provider)); + + if (provider.equals("google-compute-engine")) + ipFinder.setCredentialPath(IgniteCloudTestSuite.getSecretKey(provider)); + else + ipFinder.setCredential(IgniteCloudTestSuite.getSecretKey(provider)); + + Collection addresses = ipFinder.getRegisteredAddresses(); + + for (InetSocketAddress addr : addresses) + info("Registered instance: " + addr.getAddress().getHostAddress() + ":" + addr.getPort()); + + ipFinder.unregisterAddresses(addresses); + + assert addresses.size() == ipFinder.getRegisteredAddresses().size(); + + ipFinder.registerAddresses(ImmutableList.of( + new InetSocketAddress("192.168.0.1", TcpDiscoverySpi.DFLT_PORT))); + + assert addresses.size() == ipFinder.getRegisteredAddresses().size(); + } +} diff --git a/modules/cloud-ext/src/test/java/org/apache/ignite/spi/discovery/tcp/ipfinder/cloud/package-info.java b/modules/cloud-ext/src/test/java/org/apache/ignite/spi/discovery/tcp/ipfinder/cloud/package-info.java new file mode 100644 index 000000000..ec314a56f --- /dev/null +++ b/modules/cloud-ext/src/test/java/org/apache/ignite/spi/discovery/tcp/ipfinder/cloud/package-info.java @@ -0,0 +1,23 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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. + */ + +/** + * + * Contains internal tests or test related classes and interfaces. + */ + +package org.apache.ignite.spi.discovery.tcp.ipfinder.cloud; diff --git a/modules/cloud-ext/src/test/java/org/apache/ignite/testsuites/IgniteCloudTestSuite.java b/modules/cloud-ext/src/test/java/org/apache/ignite/testsuites/IgniteCloudTestSuite.java new file mode 100644 index 000000000..f8780f40e --- /dev/null +++ b/modules/cloud-ext/src/test/java/org/apache/ignite/testsuites/IgniteCloudTestSuite.java @@ -0,0 +1,103 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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. + */ + +package org.apache.ignite.testsuites; + +import java.util.Collection; +import java.util.LinkedList; +import org.apache.ignite.spi.discovery.tcp.ipfinder.cloud.TcpDiscoveryCloudIpFinderSelfTest; +import org.junit.runner.RunWith; +import org.junit.runners.Suite; + +/** + * Ignite Cloud integration test. + */ +@RunWith(Suite.class) +@Suite.SuiteClasses({TcpDiscoveryCloudIpFinderSelfTest.class}) +public class IgniteCloudTestSuite { + /** + * Service Account email for GCE. + * Access Key ID for Amazon. + * Username for Rackspace. + * + * @return Access key. + */ + public static String getAccessKey(String provider) { + String key = System.getenv("test." + provider + ".access.key"); + + assert key != null : "Environment variable 'test." + provider + ".access.key' is not set"; + + return key; + } + + /** + * Path to pkcs12 file for GCE. + * Access Key for Amazon. + * API key for Rackspace. + * + * @return Secret key. + */ + public static String getSecretKey(String provider) { + String key = System.getenv("test." + provider + ".secret.key"); + + assert key != null : "Environment variable 'test." + provider + ".secret.key' is not set"; + + return key; + } + + /** + * Zones where VMs are located. + * + * @return Zones list or null. + */ + public static Collection getZones(String provider) { + String zonesStr = System.getenv("test." + provider + ".zones.list"); + + if (zonesStr == null) + return null; + + String[] zonesArr = zonesStr.split(","); + + LinkedList list = new LinkedList<>(); + + for (String zone : zonesArr) + list.add(zone.trim()); + + return list; + } + + /** + * Regions where VMs are located. + * + * @return Zones list or null. + */ + public static Collection getRegions(String provider) { + String regionStr = System.getenv("test." + provider + ".regions.list"); + + if (regionStr == null) + return null; + + String[] zonesArr = regionStr.split(","); + + LinkedList list = new LinkedList<>(); + + for (String zone : zonesArr) + list.add(zone.trim()); + + return list; + } +} diff --git a/pom.xml b/pom.xml index 93863ed96..4c3ad1aec 100644 --- a/pom.xml +++ b/pom.xml @@ -60,6 +60,7 @@ modules/spark-ext modules/mesos-ext modules/yarn-ext + modules/cloud-ext