Skip to content

Adds zone and load-balancer configuration for eureka #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 12, 2024
Merged

Adds zone and load-balancer configuration for eureka #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3572d74
Supports zone-configuratin for eureka
kvmw Nov 7, 2024
09451c1
Detect runtime platform using CloudPlatform
kvmw Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 37 additions & 5 deletions .../main/java/org/springframework/cloud/bindings/boot/EurekaBindingsPropertiesProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,14 @@

package org.springframework.cloud.bindings.boot;

import org.springframework.boot.cloud.CloudPlatform;
import org.springframework.cloud.bindings.Binding;
import org.springframework.cloud.bindings.Bindings;
import org.springframework.core.env.Environment;
import org.springframework.cloud.bindings.boot.pem.PemSslStoreHelper;
import org.springframework.util.StringUtils;

import java.net.URI;
import java.nio.file.Path;
import java.util.Map;

Expand Down Expand Up @@ -51,24 +53,31 @@ public void process(Environment environment, Bindings bindings, Map<String, Obje
map.from("uri").to("eureka.client.serviceUrl.defaultZone",
(uri) -> String.format("%s/eureka/", uri)
);
map.from("uri").to("eureka.instance.metadata-map.zone",
this::hostnameFromUri
);
properties.put("eureka.client.region", "default");
properties.put("spring.cloud.loadbalancer.configurations", "zone-preference");

String caCert = secret.get("ca.crt");
if (caCert != null && !caCert.isEmpty()) {
// generally apps using TLS bindings will be running in k8s where the host name is not meaningful,

if (isKubernetesPlatform(environment)) {
// generally for apps running in k8s hostname is not meaningful,
// but we don't want to override the endpoint behavior the app has already set, in case they want to
// explicitly set eureka.instance.hostname to route traffic through normal ingress.
if (! environment.containsProperty("eureka.instance.preferIpAddress")) {
if (!environment.containsProperty("eureka.instance.preferIpAddress")) {
properties.put("eureka.instance.preferIpAddress", true);
}
}

String caCert = secret.get("ca.crt");
if (caCert != null && !caCert.isEmpty()) {
String generatedPassword = PemSslStoreHelper.generatePassword();

// Create a trust store from the CA cert
Path trustFilePath = PemSslStoreHelper.createKeyStoreFile("eureka-truststore", generatedPassword, caCert, null, "rootca");

properties.put("eureka.client.tls.enabled", true);
properties.put("eureka.client.tls.trust-store", "file:"+trustFilePath);
properties.put("eureka.client.tls.trust-store", "file:" + trustFilePath);
properties.put("eureka.client.tls.trust-store-type", PemSslStoreHelper.PKCS12_STORY_TYPE);
properties.put("eureka.client.tls.trust-store-password", generatedPassword);

Expand All @@ -91,4 +100,27 @@ public void process(Environment environment, Bindings bindings, Map<String, Obje
}
});
}

private boolean isKubernetesPlatform(Environment environment) {
return CloudPlatform.KUBERNETES == CloudPlatform.getActive(environment);
}

private String hostnameFromUri(String uri) {
if (!StringUtils.hasText(uri)) {
return "";
}

try {
URI u = URI.create(uri);
if (u.getHost() != null) {
return u.getHost();
}
if (u.getScheme() == null) {
return URI.create("ignore://" + uri).getHost();
}
} catch (IllegalArgumentException e) {
//ignore malformed uri
}
return "";
}
}
88 changes: 72 additions & 16 deletions ...t/java/org/springframework/cloud/bindings/boot/EurekaBindingsPropertiesProcessorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ final class EurekaBindingsPropertiesProcessorTest {
new Binding("test-name", Paths.get("test-path"),
new FluentMap()
.withEntry(Binding.TYPE, TYPE)
.withEntry("uri", "test-uri")
.withEntry("uri", "https://test-uri")
)
);
private final MockEnvironment environment = new MockEnvironment();
Expand All @@ -62,19 +62,11 @@ void testNoAuth() {
new EurekaBindingsPropertiesProcessor().process(environment, bindings, properties);

assertThat(properties)
.containsEntry("eureka.client.region", "default")
.containsEntry("eureka.client.serviceUrl.defaultZone", "test-uri/eureka/")
.doesNotContainKey("eureka.client.oauth2.client-id")
.doesNotContainKey("eureka.client.oauth2.access-token-uri")
.doesNotContainKey("eureka.client.tls.trust-store")
.doesNotContainKey("eureka.client.tls.trust-store-type")
.doesNotContainKey("eureka.client.tls.trust-store-password")
.doesNotContainKey("eureka.client.tls.key-alias")
.doesNotContainKey("eureka.client.tls.key-store")
.doesNotContainKey("eureka.client.tls.key-store-type")
.doesNotContainKey("eureka.client.tls.key-store-password")
.doesNotContainKey("eureka.client.tls.key-password")
.doesNotContainKey("eureka.instance.preferIpAddress");
.containsExactlyInAnyOrderEntriesOf(new FluentMap()
.withEntry("eureka.client.region", "default")
.withEntry("eureka.client.serviceUrl.defaultZone", "https://test-uri/eureka/")
.withEntry("spring.cloud.loadbalancer.configurations", "zone-preference")
.withEntry("eureka.instance.metadata-map.zone", "test-uri"));
}

@Test
Expand Down Expand Up @@ -118,8 +110,7 @@ void testTls() {
.containsEntry("eureka.client.region", "default")
.containsKey("eureka.client.tls.trust-store")
.containsEntry("eureka.client.tls.trust-store-type", "PKCS12")
.containsKey("eureka.client.tls.trust-store-password")
.containsEntry("eureka.instance.preferIpAddress", true);
.containsKey("eureka.client.tls.trust-store-password");
assertDoesNotThrow(() -> {
String path = properties.get("eureka.client.tls.trust-store").toString().substring(5);
File f = new File(path);
Expand Down Expand Up @@ -226,6 +217,7 @@ void testBadMtls() {
new EurekaBindingsPropertiesProcessor().process(environment, bindings, properties);
});
}

@Test
@DisplayName("throws when tls.crt is set but tls.key isn't")
void testNoTlsKey() {
Expand All @@ -243,6 +235,7 @@ void testNoTlsKey() {
new EurekaBindingsPropertiesProcessor().process(environment, bindings, properties);
});
}

@Test
@DisplayName("throws when tls.key is set but tls.crt isn't")
void testNoTlsCrt() {
Expand All @@ -261,6 +254,69 @@ void testNoTlsCrt() {
});
}

@Test
@DisplayName("handles eureka zone for uri without scheme")
void zoneFromUriWithoutScheme() {
bindings = new Bindings(
new Binding("test-name", Paths.get("test-path"),
new FluentMap()
.withEntry(Binding.TYPE, TYPE)
.withEntry("uri", "test-uri")
)
);
new EurekaBindingsPropertiesProcessor().process(environment, bindings, properties);

assertThat(properties)
.containsExactlyInAnyOrderEntriesOf(new FluentMap()
.withEntry("eureka.client.region", "default")
.withEntry("eureka.client.serviceUrl.defaultZone", "test-uri/eureka/")
.withEntry("spring.cloud.loadbalancer.configurations", "zone-preference")
.withEntry("eureka.instance.metadata-map.zone", "test-uri")
);
}

@Test
@DisplayName("handles eureka zone for malformed uri")
void zoneFromMalformedUri() {
bindings = new Bindings(
new Binding("test-name", Paths.get("test-path"),
new FluentMap()
.withEntry(Binding.TYPE, TYPE)
.withEntry("uri", "http:")
)
);
new EurekaBindingsPropertiesProcessor().process(environment, bindings, properties);

assertThat(properties)
.containsExactlyInAnyOrderEntriesOf(new FluentMap()
.withEntry("eureka.client.region", "default")
.withEntry("eureka.client.serviceUrl.defaultZone", "http:/eureka/")
.withEntry("spring.cloud.loadbalancer.configurations", "zone-preference")
.withEntry("eureka.instance.metadata-map.zone", "")
);
}

@Test
@DisplayName("prefers ip address in kubernetes")
void preferIpAddressInKubernetes() {
environment.setProperty("spring.main.cloud-platform", "kubernetes");

new EurekaBindingsPropertiesProcessor().process(environment, bindings, properties);

assertThat(properties).containsEntry("eureka.instance.preferIpAddress", true);
}

@Test
@DisplayName("prefers ip address in kubernetes")
void doesNotOverridePreferIpAddressInKubernetes() {
environment.setProperty("eureka.instance.preferIpAddress", "false");
environment.setProperty("spring.main.cloud-platform", "kubernetes");

new EurekaBindingsPropertiesProcessor().process(environment, bindings, properties);

assertThat(properties).doesNotContainKey("eureka.instance.preferIpAddress");
}

@Test
@DisplayName("can be disabled")
void disabled() {
Expand Down