Skip to content
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.

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

[nat] Allowing either CLI option or /var/run/secrets/kubernetes.io/serviceaccount/namespace detection #11

Open
wants to merge 1 commit into
base: kaleido-besu-release-24.5.2-nat-patch
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 1 addition & 13 deletions besu/src/main/java/org/hyperledger/besu/RunnerBuilder.java
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,6 @@ public class RunnerBuilder {
private int p2pListenPort;
private NatMethod natMethod = NatMethod.AUTO;
private String natManagerServiceName;
private String natManagerServiceNamespace;
private boolean natMethodFallbackEnabled;
private EthNetworkConfig ethNetworkConfig;
private EthstatsOptions ethstatsOptions;
Expand Down Expand Up @@ -345,17 +344,6 @@ public RunnerBuilder natManagerServiceName(final String natManagerServiceName) {
return this;
}

/**
* Add Nat manager service namespace.
*
* @param natManagerServiceNamespace the nat manager service namespace
* @return the runner builder
*/
public RunnerBuilder natManagerServiceNamespace(final String natManagerServiceNamespace) {
this.natManagerServiceNamespace = natManagerServiceNamespace;
return this;
}

/**
* Enable Nat method fallback.
*
Expand Down Expand Up @@ -1172,7 +1160,7 @@ private Optional<NatManager> buildNatManager(final NatMethod natMethod) {
new DockerNatManager(p2pAdvertisedHost, p2pListenPort, jsonRpcConfiguration.getPort()));
case KUBERNETES:
return Optional.of(
new KubernetesNatManager(natManagerServiceName, natManagerServiceNamespace));
new KubernetesNatManager(natManagerServiceName));
case NONE:
default:
return Optional.empty();
Expand Down
11 changes: 0 additions & 11 deletions besu/src/main/java/org/hyperledger/besu/cli/BesuCommand.java
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@
import static org.hyperledger.besu.metrics.prometheus.MetricsConfiguration.DEFAULT_METRICS_PORT;
import static org.hyperledger.besu.metrics.prometheus.MetricsConfiguration.DEFAULT_METRICS_PUSH_PORT;
import static org.hyperledger.besu.nat.kubernetes.KubernetesNatManager.DEFAULT_BESU_SERVICE_NAME;
import static org.hyperledger.besu.nat.kubernetes.KubernetesNatManager.DEFAULT_BESU_SERVICE_NAMESPACE;

import org.hyperledger.besu.BesuInfo;
import org.hyperledger.besu.Runner;
Expand Down Expand Up @@ -1581,15 +1580,6 @@ private void validateNatParams() {
"The `--Xnat-kube-service-name` parameter is only used in kubernetes mode. Either remove --Xnat-kube-service-name"
+ " or select the KUBERNETES mode (via --nat-method=KUBERNETES)");
}

if (!unstableNatOptions
.getNatManagerServiceNamespace()
.equals(DEFAULT_BESU_SERVICE_NAMESPACE)) {
throw new ParameterException(
this.commandLine,
"The `--Xnat-kube-service-namespace` parameter is only used in kubernetes mode. Either remove --Xnat-kube-service-namespace"
+ " or select the KUBERNETES mode (via --nat-method=KUBERNETES)");
}
}
if (natMethod.equals(NatMethod.AUTO) && !unstableNatOptions.getNatMethodFallbackEnabled()) {
throw new ParameterException(
Expand Down Expand Up @@ -2265,7 +2255,6 @@ private Runner synchronize(
.p2pEnabled(p2pEnabled)
.natMethod(natMethod)
.natManagerServiceName(unstableNatOptions.getNatManagerServiceName())
.natManagerServiceNamespace(unstableNatOptions.getNatManagerServiceNamespace())
.natMethodFallbackEnabled(unstableNatOptions.getNatMethodFallbackEnabled())
.discovery(peerDiscoveryEnabled)
.ethNetworkConfig(ethNetworkConfig)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,6 @@ public class NatOptions {
"Specify the name of the service that will be used by the nat manager in Kubernetes. (default: ${DEFAULT-VALUE})")
private String natManagerServiceName = DEFAULT_BESU_SERVICE_NAME;

@SuppressWarnings({"FieldCanBeFinal", "FieldMayBeFinal"}) // PicoCLI requires non-final Strings.
@CommandLine.Option(
hidden = true,
names = {"--Xnat-kube-service-namespace"},
description =
"Specify the namespace of the service that will be used by the nat manager in Kubernetes. (default: ${DEFAULT-VALUE})")
private String natManagerServiceNamespace = DEFAULT_BESU_SERVICE_NAMESPACE;

@CommandLine.Option(
hidden = true,
names = {"--Xnat-method-fallback-enabled"},
Expand Down Expand Up @@ -67,15 +59,6 @@ public String getNatManagerServiceName() {
return natManagerServiceName;
}

/**
* Gets nat manager service namespace.
*
* @return the nat manager service namespace
*/
public String getNatManagerServiceNamespace() {
return natManagerServiceNamespace;
}

/**
* Whether nat method fallback is enabled.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@
import org.hyperledger.besu.nat.kubernetes.service.KubernetesServiceType;
import org.hyperledger.besu.nat.kubernetes.service.LoadBalancerBasedDetector;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
Expand Down Expand Up @@ -53,6 +57,8 @@ public class KubernetesNatManager extends AbstractNatManager {

public static final String DEFAULT_BESU_SERVICE_NAMESPACE = "besu";

private static final Path KUBERNETES_NAMESPACE_FILE = Paths.get("var/run/secrets/kubernetes.io/serviceaccount/namespace");

private String internalAdvertisedHost;
private final String besuServiceName;
private final String besuServiceNamespace;
Expand All @@ -62,12 +68,17 @@ public class KubernetesNatManager extends AbstractNatManager {
* Instantiates a new Kubernetes nat manager.
*
* @param besuServiceName the besu service name
* @param besuServiceNamespace the besu service namespace
*/
public KubernetesNatManager(final String besuServiceName, final String besuServiceNamespace) {
public KubernetesNatManager(final String besuServiceName) {
super(NatMethod.KUBERNETES);
this.besuServiceName = besuServiceName;
this.besuServiceNamespace = besuServiceNamespace;
String ns = DEFAULT_BESU_SERVICE_NAMESPACE;
try {
ns = Files.readString(KUBERNETES_NAMESPACE_FILE);
} catch (IOException ex) {
LOG.info("Failed to determine namespace via serviceaccount folder");
}
this.besuServiceNamespace = ns;
}

@Override
Expand Down