This is an automated email from the ASF dual-hosted git repository.
szetszwo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ratis.git
The following commit(s) were added to refs/heads/master by this push:
new 848cd394c RATIS-2308. Remove the unused gRPC TLS confs. (#1271)
848cd394c is described below
commit 848cd394c4cc6ed4e1568bfa6c92a922dfe3f10e
Author: Tsz-Wo Nicholas Sze <[email protected]>
AuthorDate: Mon Jun 2 13:00:16 2025 -0700
RATIS-2308. Remove the unused gRPC TLS confs. (#1271)
---
.../java/org/apache/ratis/grpc/GrpcConfigKeys.java | 41 ++++++----------------
.../ratis/shell/cli/sh/TestSecureRatisShell.java | 2 --
2 files changed, 10 insertions(+), 33 deletions(-)
diff --git a/ratis-grpc/src/main/java/org/apache/ratis/grpc/GrpcConfigKeys.java
b/ratis-grpc/src/main/java/org/apache/ratis/grpc/GrpcConfigKeys.java
index a603960f1..f21a9b99f 100644
--- a/ratis-grpc/src/main/java/org/apache/ratis/grpc/GrpcConfigKeys.java
+++ b/ratis-grpc/src/main/java/org/apache/ratis/grpc/GrpcConfigKeys.java
@@ -54,50 +54,29 @@ public interface GrpcConfigKeys {
interface TLS {
String PREFIX = GrpcConfigKeys.PREFIX + ".tls";
- String ENABLED_KEY = PREFIX + ".enabled";
- boolean ENABLED_DEFAULT = false;
- static boolean enabled(RaftProperties properties) {
- return getBoolean(properties::getBoolean, ENABLED_KEY, ENABLED_DEFAULT,
getDefaultLog());
- }
+ @Deprecated
static void setEnabled(RaftProperties properties, boolean enabled) {
- setBoolean(properties::setBoolean, ENABLED_KEY, enabled);
+ LOG.warn("This method has no effect. Use setConf(Parameters,
GrpcTlsConfig) instead.");
}
- String MUTUAL_AUTHN_ENABLED_KEY = PREFIX + ".mutual_authn.enabled";
- boolean MUTUAL_AUTHN_ENABLED_DEFAULT = false;
- static boolean mutualAuthnEnabled(RaftProperties properties) {
- return getBoolean(properties::getBoolean,
- MUTUAL_AUTHN_ENABLED_KEY, MUTUAL_AUTHN_ENABLED_DEFAULT,
getDefaultLog());
- }
+ @Deprecated
static void setMutualAuthnEnabled(RaftProperties properties, boolean
mutualAuthnEnabled) {
- setBoolean(properties::setBoolean, MUTUAL_AUTHN_ENABLED_KEY,
mutualAuthnEnabled);
+ LOG.warn("This method has no effect. Use setConf(Parameters,
GrpcTlsConfig) instead.");
}
- String PRIVATE_KEY_FILE_NAME_KEY = PREFIX + ".private.key.file.name";
- String PRIVATE_KEY_FILE_NAME_DEFAULT = "private.pem";
- static String privateKeyFileName(RaftProperties properties) {
- return get(properties::get, PRIVATE_KEY_FILE_NAME_KEY,
PRIVATE_KEY_FILE_NAME_DEFAULT, getDefaultLog());
- }
+ @Deprecated
static void setPrivateKeyFileName(RaftProperties properties, String
privateKeyFileName) {
- set(properties::set, PRIVATE_KEY_FILE_NAME_KEY, privateKeyFileName);
+ LOG.warn("This method has no effect. Use setConf(Parameters,
GrpcTlsConfig) instead.");
}
- String CERT_CHAIN_FILE_NAME_KEY = PREFIX + ".cert.chain.file.name";
- String CERT_CHAIN_FILE_NAME_DEFAULT = "certificate.crt";
- static String certChainFileName(RaftProperties properties) {
- return get(properties::get, CERT_CHAIN_FILE_NAME_KEY,
CERT_CHAIN_FILE_NAME_DEFAULT, getDefaultLog());
- }
+ @Deprecated
static void setCertChainFileName(RaftProperties properties, String
certChainFileName) {
- set(properties::set, CERT_CHAIN_FILE_NAME_KEY, certChainFileName);
+ LOG.warn("This method has no effect. Use setConf(Parameters,
GrpcTlsConfig) instead.");
}
- String TRUST_STORE_KEY = PREFIX + ".trust.store";
- String TRUST_STORE_DEFAULT = "ca.crt";
- static String trustStore(RaftProperties properties) {
- return get(properties::get, TRUST_STORE_KEY, TRUST_STORE_DEFAULT,
getDefaultLog());
- }
+ @Deprecated
static void setTrustStore(RaftProperties properties, String trustStore) {
- set(properties::set, TRUST_STORE_KEY, trustStore);
+ LOG.warn("This method has no effect. Use setConf(Parameters,
GrpcTlsConfig) instead.");
}
String CONF_PARAMETER = PREFIX + ".conf";
diff --git
a/ratis-test/src/test/java/org/apache/ratis/shell/cli/sh/TestSecureRatisShell.java
b/ratis-test/src/test/java/org/apache/ratis/shell/cli/sh/TestSecureRatisShell.java
index 785cd2e82..7f1149067 100644
---
a/ratis-test/src/test/java/org/apache/ratis/shell/cli/sh/TestSecureRatisShell.java
+++
b/ratis-test/src/test/java/org/apache/ratis/shell/cli/sh/TestSecureRatisShell.java
@@ -75,8 +75,6 @@ public class TestSecureRatisShell extends BaseTest {
final String[] ids = {"s0"};
final RaftProperties properties = new RaftProperties();
RaftClientConfigKeys.Rpc.setRequestTimeout(properties,
TimeDuration.ONE_MINUTE);
- GrpcConfigKeys.TLS.setEnabled(properties, true);
- GrpcConfigKeys.TLS.setMutualAuthnEnabled(properties, true);
try(MiniRaftClusterWithGrpc cluster = new MiniRaftClusterWithGrpc(ids,
properties, SERVER_PARAMETERS)) {
cluster.start();