Add SubnetAddressTranslator #2013
+561
−69
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| /* | ||
| * 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 com.datastax.oss.driver.internal.core.addresstranslation; | ||
|
|
||
| import static com.datastax.oss.driver.api.core.config.DefaultDriverOption.ADDRESS_TRANSLATOR_DEFAULT_ADDRESS; | ||
| import static com.datastax.oss.driver.api.core.config.DefaultDriverOption.ADDRESS_TRANSLATOR_RESOLVE_ADDRESSES; | ||
| import static com.datastax.oss.driver.api.core.config.DefaultDriverOption.ADDRESS_TRANSLATOR_SUBNET_ADDRESSES; | ||
|
|
||
| import com.datastax.oss.driver.api.core.addresstranslation.AddressTranslator; | ||
| import com.datastax.oss.driver.api.core.context.DriverContext; | ||
| import com.datastax.oss.driver.internal.core.util.AddressUtils; | ||
| import edu.umd.cs.findbugs.annotations.NonNull; | ||
| import edu.umd.cs.findbugs.annotations.Nullable; | ||
| import inet.ipaddr.IPAddress; | ||
| import inet.ipaddr.IPAddressString; | ||
| import java.net.InetSocketAddress; | ||
| import java.util.List; | ||
| import java.util.Optional; | ||
| import java.util.stream.Collectors; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * This translator returns the proxy address of the private subnet containing the Cassandra node IP, | ||
| * or default address if no matching subnets, or passes through the original node address if no | ||
| * default configured. | ||
| * | ||
| * <p>The translator can be used for scenarios when all nodes are behind some kind of proxy, and | ||
| * that proxy is different for nodes located in different subnets (eg. when Cassandra is deployed in | ||
| * multiple datacenters/regions). One can use this, for example, for Cassandra on Kubernetes with | ||
| * different Cassandra datacenters deployed to different Kubernetes clusters. | ||
| */ | ||
| public class SubnetAddressTranslator implements AddressTranslator { | ||
| private static final Logger LOG = LoggerFactory.getLogger(SubnetAddressTranslator.class); | ||
|
|
||
| private final List<SubnetAddress> subnetAddresses; | ||
|
|
||
| @SuppressWarnings("OptionalUsedAsFieldOrParameterType") | ||
| private final Optional<InetSocketAddress> defaultAddress; | ||
jahstreet marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| private final String logPrefix; | ||
|
|
||
| public SubnetAddressTranslator(@NonNull DriverContext context) { | ||
| logPrefix = context.getSessionName(); | ||
| boolean resolveAddresses = | ||
| context | ||
| .getConfig() | ||
| .getDefaultProfile() | ||
| .getBoolean(ADDRESS_TRANSLATOR_RESOLVE_ADDRESSES, false); | ||
| this.subnetAddresses = | ||
| context.getConfig().getDefaultProfile().getStringMap(ADDRESS_TRANSLATOR_SUBNET_ADDRESSES) | ||
| .entrySet().stream() | ||
| .map( | ||
| e -> { | ||
| // Quoted and/or containing forward slashes map keys in reference.conf are read to | ||
| // strings with additional quotes, eg. 100.64.0.0/15 -> '100.64.0."0/15"' or | ||
| // "100.64.0.0/15" -> '"100.64.0.0/15"' | ||
jahstreet marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| String subnetCIDR = e.getKey().replaceAll("\"", ""); | ||
| String address = e.getValue(); | ||
| return new SubnetAddress(subnetCIDR, parseAddress(address, resolveAddresses)); | ||
| }) | ||
| .collect(Collectors.toList()); | ||
| this.defaultAddress = | ||
| Optional.ofNullable( | ||
| context | ||
| .getConfig() | ||
| .getDefaultProfile() | ||
| .getString(ADDRESS_TRANSLATOR_DEFAULT_ADDRESS, null)) | ||
| .map(address -> parseAddress(address, resolveAddresses)); | ||
|
|
||
| validateSubnetsAreNotOverlapping(this.subnetAddresses); | ||
| } | ||
|
|
||
| @NonNull | ||
| @Override | ||
| public InetSocketAddress translate(@NonNull InetSocketAddress address) { | ||
| InetSocketAddress translatedAddress = null; | ||
| for (SubnetAddress subnetAddress : subnetAddresses) { | ||
| if (subnetAddress.contains(address)) { | ||
| translatedAddress = subnetAddress.address; | ||
| } | ||
| } | ||
| if (translatedAddress == null && defaultAddress.isPresent()) { | ||
| translatedAddress = defaultAddress.get(); | ||
| } | ||
| if (translatedAddress == null) { | ||
| translatedAddress = address; | ||
| } | ||
| LOG.debug("[{}] Translated {} to {}", logPrefix, address, translatedAddress); | ||
| return translatedAddress; | ||
| } | ||
|
|
||
| @Override | ||
| public void close() {} | ||
|
|
||
| @Nullable | ||
| private InetSocketAddress parseAddress(String address, boolean resolve) { | ||
| try { | ||
| InetSocketAddress parsedAddress = AddressUtils.extract(address, resolve).iterator().next(); | ||
| LOG.debug("[{}] Parsed {} to {}", logPrefix, address, parsedAddress); | ||
| return parsedAddress; | ||
| } catch (RuntimeException e) { | ||
| throw new IllegalArgumentException( | ||
| String.format("Invalid address %s (%s)", address, e.getMessage()), e); | ||
| } | ||
| } | ||
|
|
||
| private static void validateSubnetsAreNotOverlapping(List<SubnetAddress> subnetAddresses) { | ||
| for (int i = 0; i < subnetAddresses.size() - 1; i++) { | ||
jahstreet marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| for (int j = i + 1; j < subnetAddresses.size(); j++) { | ||
| SubnetAddress subnetAddress1 = subnetAddresses.get(i); | ||
| SubnetAddress subnetAddress2 = subnetAddresses.get(j); | ||
| if (subnetAddress1.isOverlapping(subnetAddress2)) { | ||
| throw new IllegalArgumentException( | ||
| String.format( | ||
| "Configured subnets are overlapping: %s, %s", | ||
| subnetAddress1.subnet, subnetAddress2.subnet)); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private static class SubnetAddress { | ||
| private final IPAddress subnet; | ||
| private final InetSocketAddress address; | ||
|
|
||
| private SubnetAddress(String subnetCIDR, InetSocketAddress address) { | ||
| this.subnet = parseSubnet(subnetCIDR); | ||
| this.address = address; | ||
| } | ||
|
|
||
| private static IPAddress parseSubnet(String subnetCIDR) { | ||
| IPAddress subnet = new IPAddressString(subnetCIDR).getAddress(); | ||
| if (subnet == null) { | ||
| throw new IllegalArgumentException("Invalid subnet: " + subnetCIDR); | ||
| } | ||
| if (!subnet.isPrefixBlock()) { | ||
| throw new IllegalArgumentException( | ||
| String.format( | ||
| "Subnet %s must be represented as a network prefix block %s", | ||
| subnet, subnet.toPrefixBlock())); | ||
| } | ||
| return subnet; | ||
| } | ||
|
|
||
| private boolean isOverlapping(SubnetAddress other) { | ||
| IPAddress thisSubnet = this.subnet; | ||
| IPAddress otherSubnet = other.subnet; | ||
| return thisSubnet.contains(otherSubnet.getLower()) | ||
| || thisSubnet.contains(otherSubnet.getUpper()) | ||
| || otherSubnet.contains(thisSubnet.getLower()) | ||
| || otherSubnet.contains(thisSubnet.getUpper()); | ||
| } | ||
|
|
||
| private boolean contains(InetSocketAddress address) { | ||
| IPAddress ipAddress = new IPAddressString(address.getAddress().getHostAddress()).getAddress(); | ||
| if (subnet.isIPv4() && ipAddress.isIPv4Convertible()) { | ||
| ipAddress = ipAddress.toIPv4(); | ||
| } else if (subnet.isIPv6() && ipAddress.isIPv6Convertible()) { | ||
| ipAddress = ipAddress.toIPv6(); | ||
| } | ||
| return subnet.contains(ipAddress); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I really don't love the inclusion of another dependency here, even if it's an optional one. It's only used in one class (near as I can tell)... is there really no way to get the functionality we need without adding this in?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
First thing that comes to mind is implementing it ourselves (or in other words copying it over from the library). Lemme evaluate how much of the util code is needed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need at least the following functionality to work with subnets here:
The library is quite big, so copying over its parts is an overkill.
Then the alternative is to implement these functions ourselves.
Looking into it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A bit of vibe-coding and we can have it with around 100 lines of code. Will work on integrating a change.