You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by ri...@apache.org on 2021/12/16 19:06:15 UTC

[geode] 01/01: Remove geode-for-redis properties from gfsh options

This is an automated email from the ASF dual-hosted git repository.

ringles pushed a commit to branch GEODE-9869-Remove-Radish-GFSH-commands
in repository https://gitbox.apache.org/repos/asf/geode.git

commit 37c42658ef6f18fa3daaf30f137b123839e3c18b
Author: Ray Ingles <ri...@vmware.com>
AuthorDate: Thu Dec 16 12:35:42 2021 -0500

    Remove geode-for-redis properties from gfsh options
---
 ci/scripts/execute_redis_tests.sh                  | 10 +++----
 .../geode/management/internal/i18n/CliStrings.java | 14 ----------
 .../tools_modules/geode_for_redis.html.md.erb      | 11 ++++----
 geode-for-redis/README.md                          | 14 +++++-----
 ...eRedisServerStartupUsingGfshAcceptanceTest.java |  8 +++---
 .../src/performanceTest/environment-setup.sh       |  4 +--
 .../internal/cli/commands/StartServerCommand.java  | 31 +++-------------------
 7 files changed, 28 insertions(+), 64 deletions(-)

diff --git a/ci/scripts/execute_redis_tests.sh b/ci/scripts/execute_redis_tests.sh
index 911c783..9cc63a6 100755
--- a/ci/scripts/execute_redis_tests.sh
+++ b/ci/scripts/execute_redis_tests.sh
@@ -33,9 +33,9 @@ export JAVA_HOME=${JAVA_TEST_PATH}
 ../geode-assembly/build/install/apache-geode/bin/gfsh start server \
   --J=-Denable-unsupported-commands=true \
   --name=server1 \
-  --geode-for-redis-port=6380 \
-  --geode-for-redis-bind-address=127.0.0.1 \
-  --geode-for-redis-username=foobar \
+  --J=-Dgemfire.geode-for-redis-port=6380 \
+  --J=-Dgemfire.geode-for-redis-bind-address=127.0.0.1 \
+  --J=-Dgemfire.geode-for-redis-username=foobar \
   --server-port=0 \
   --J=-Dgemfire.security-manager=org.apache.geode.examples.SimpleSecurityManager \
   --J=-Dgemfire.jmx-manager=true \
@@ -58,8 +58,8 @@ failCount=0
   --J=-Denable-unsupported-commands=true \
   --name=server2 \
   --server-port=0 \
-  --geode-for-redis-port=6379 \
-  --geode-for-redis-bind-address=127.0.0.1 \
+  --J=-Dgemfire.geode-for-redis-port=6379 \
+  --J=-Dgemfire.geode-for-redis-bind-address=127.0.0.1 \
   --J=-Dgemfire.jmx-manager=true \
   --J=-Dgemfire.jmx-manager-start=true \
   --J=-Dgemfire.jmx-manager-port=1099
diff --git a/geode-core/src/main/java/org/apache/geode/management/internal/i18n/CliStrings.java b/geode-core/src/main/java/org/apache/geode/management/internal/i18n/CliStrings.java
index 0e1950d..2372aeb 100644
--- a/geode-core/src/main/java/org/apache/geode/management/internal/i18n/CliStrings.java
+++ b/geode-core/src/main/java/org/apache/geode/management/internal/i18n/CliStrings.java
@@ -2626,20 +2626,6 @@ public class CliStrings {
   public static final String START_SERVER__PROPERTIES = "properties-file";
   public static final String START_SERVER__PROPERTIES__HELP =
       "The gemfire.properties file for configuring the Cache Server's distributed system. The file's path can be absolute or relative to the gfsh working directory.";
-  public static final String START_SERVER__REDIS_BIND_ADDRESS =
-      ConfigurationProperties.GEODE_FOR_REDIS_BIND_ADDRESS;
-  public static final String START_SERVER__REDIS_BIND_ADDRESS__HELP =
-      "Specifies the address on which the Redis API for Geode is listening. "
-          + "If set to the empty string or this property is not specified, the server listens on all local addresses.";
-  public static final String START_SERVER__REDIS_USERNAME =
-      ConfigurationProperties.GEODE_FOR_REDIS_USERNAME;
-  public static final String START_SERVER__REDIS_USERNAME__HELP =
-      "Specifies the username that the server uses when a client attempts to authenticate using only a password."
-          + " This option also requires a SecurityManager to be configured.";
-  public static final String START_SERVER__REDIS_PORT =
-      ConfigurationProperties.GEODE_FOR_REDIS_PORT;
-  public static final String START_SERVER__REDIS_PORT__HELP =
-      "Specifies the port on which the server listens for Redis API for Geode connections. A value of 0 selects a random port.  Default is 6379.";
   public static final String START_SERVER__SECURITY_PROPERTIES = "security-properties-file";
   public static final String START_SERVER__SECURITY_PROPERTIES__HELP =
       "The gfsecurity.properties file for configuring the Server's security configuration in the distributed system. The file's path can be absolute or relative to gfsh directory.";
diff --git a/geode-docs/tools_modules/geode_for_redis.html.md.erb b/geode-docs/tools_modules/geode_for_redis.html.md.erb
index 06d9d8d..adb32f2 100644
--- a/geode-docs/tools_modules/geode_for_redis.html.md.erb
+++ b/geode-docs/tools_modules/geode_for_redis.html.md.erb
@@ -35,13 +35,14 @@ Use gfsh to start at least one server with a command of the form:
 start server \
   --name=<serverName> \
   --locators=<locatorPort> \
-  --geode-for-redis-port=<geodeForRedisPort> \
-  --geode-for-redis-bind-address=<geodeForRedisBindAddress> \
-  --geode-for-redis-password=<geodeForRedisPassword>
+  --J=-Dgemfire.geode-for-redis-enabled=true \
+  --J=-Dgemfire.geode-for-redis-port=<geodeForRedisPort> \
+  --J=-Dgemfire.geode-for-redis-bind-address=<geodeForRedisBindAddress> \
+  --J=-Dgemfire.geode-for-redis-password=<geodeForRedisPassword>
 ```
 
-If any of the options `geode-for-redis-bind-address`, `geode-for-redis-password`, or `geode-for-redis-port`
-are included, a <%=vars.product_name%> server with <%=vars.product_name%> for Redis will be started.
+If the option `geode-for-redis-enabled`, is set to `true`, a <%=vars.product_name%> server with
+<%=vars.product_name%> for Redis will be started.
 
 Replace `<serverName>` with the name of your server.
 
diff --git a/geode-for-redis/README.md b/geode-for-redis/README.md
index 1f4d70f..4ad0476 100644
--- a/geode-for-redis/README.md
+++ b/geode-for-redis/README.md
@@ -34,11 +34,12 @@ Once the locator has started, start at least one server with a command of the fo
 gfsh> start server \
   --name=<serverName> \
   --locators=localhost[<locatorPort>] \
-  --geode-for-redis-port=<geodeForRedisPort> \
-  --geode-for-redis-bind-address=<geodeForRedisBindAddress>
+  --J=-Dgemfire.geode-for-redis-enabled=true \
+  --J=-Dgemfire.geode-for-redis-port=<geodeForRedisPort> \
+  --J=-Dgemfire.geode-for-redis-bind-address=<geodeForRedisBindAddress>
 ```
 
-If any of the options `geode-for-redis-bind-address`, `geode-for-redis-username`, or `geode-for-redis-port` are included, a Geode server with Geode for Redis will be started.
+If the option `geode-for-redis-enabled` is set to `true`, a Geode server with Geode for Redis will be started.
 
 - Replace `<serverName>` with the name of your server.
 
@@ -105,9 +106,10 @@ The following gfsh command will configure a `SimpleSecurityManager`:
 gfsh> start server \
   --name=<serverName> \
   --locators=<locatorPort> \
-  --geode-for-redis-port=<geodeForRedisPort> \
-  --geode-for-redis-bind-address=<geodeForRedisBindAddress> \
-  --geode-for-redis-username=<geodeForRedisUsername> \
+  --J=-Dgemfire.geode-for-redis-enabled=true \
+  --J=-Dgemfire.geode-for-redis-port=<geodeForRedisPort> \
+  --J=-Dgemfire.geode-for-redis-bind-address=<geodeForRedisBindAddress> \
+  --J=-Dgemfire.geode-for-redis-username=<geodeForRedisUsername> \
   --J=-Dgemfire.security-manager=org.apache.geode.examples.SimpleSecurityManager
 ```
 
diff --git a/geode-for-redis/src/acceptanceTest/java/org/apache/geode/redis/internal/commands/executor/GeodeRedisServerStartupUsingGfshAcceptanceTest.java b/geode-for-redis/src/acceptanceTest/java/org/apache/geode/redis/internal/commands/executor/GeodeRedisServerStartupUsingGfshAcceptanceTest.java
index bcb7e01..4c16417 100644
--- a/geode-for-redis/src/acceptanceTest/java/org/apache/geode/redis/internal/commands/executor/GeodeRedisServerStartupUsingGfshAcceptanceTest.java
+++ b/geode-for-redis/src/acceptanceTest/java/org/apache/geode/redis/internal/commands/executor/GeodeRedisServerStartupUsingGfshAcceptanceTest.java
@@ -43,8 +43,8 @@ public class GeodeRedisServerStartupUsingGfshAcceptanceTest {
         "start server",
         "--server-port", "0",
         "--name", "same-port-and-address-server",
-        "--geode-for-redis-bind-address", "localhost",
-        "--geode-for-redis-port", String.valueOf(port));
+        "--J=-Dgemfire.geode-for-redis-bind-address", "localhost",
+        "--J=-Dgemfire.geode-for-redis-port", String.valueOf(port));
     GfshExecution execution;
 
     try (ServerSocket interferingSocket = new ServerSocket()) {
@@ -66,7 +66,7 @@ public class GeodeRedisServerStartupUsingGfshAcceptanceTest {
         "start server",
         "--server-port", "0",
         "--name", "same-port-all-addresses-server",
-        "--geode-for-redis-port", String.valueOf(port));
+        "--J=-Dgemfire.geode-for-redis-port", String.valueOf(port));
     GfshExecution execution;
 
     try (ServerSocket interferingSocket = new ServerSocket()) {
@@ -86,7 +86,7 @@ public class GeodeRedisServerStartupUsingGfshAcceptanceTest {
         "start server",
         "--server-port", "0",
         "--name", "invalid-bind-server",
-        "--geode-for-redis-bind-address", "1.1.1.1");
+        "--J=-Dgemfire.geode-for-redis-bind-address", "1.1.1.1");
     GfshExecution execution;
 
     execution = GfshScript.of(startServerCommand)
diff --git a/geode-for-redis/src/performanceTest/environment-setup.sh b/geode-for-redis/src/performanceTest/environment-setup.sh
index 4c29006..2dddbbe 100755
--- a/geode-for-redis/src/performanceTest/environment-setup.sh
+++ b/geode-for-redis/src/performanceTest/environment-setup.sh
@@ -101,8 +101,8 @@ if [ ${SERVER_TYPE} == "geode" ]; then
           --log-level=none
           --locators=localhost[10334]
           --server-port=0
-          --geode-for-redis-port=6379
-          --geode-for-redis-bind-address=127.0.0.1"
+          --J=-Dgemfire.geode-for-redis-port=6379
+          --J=-Dgemfire.geode-for-redis-bind-address=127.0.0.1"
 else
   if [ ${SERVER_NOT_FOUND} -eq 1 ]; then
     echo "No server compatible with Redis detected on host '${REDIS_HOST}' at port '${REDIS_PORT}'"
diff --git a/geode-gfsh/src/main/java/org/apache/geode/management/internal/cli/commands/StartServerCommand.java b/geode-gfsh/src/main/java/org/apache/geode/management/internal/cli/commands/StartServerCommand.java
index 2d96cab..c6ebb98 100644
--- a/geode-gfsh/src/main/java/org/apache/geode/management/internal/cli/commands/StartServerCommand.java
+++ b/geode-gfsh/src/main/java/org/apache/geode/management/internal/cli/commands/StartServerCommand.java
@@ -132,12 +132,6 @@ public class StartServerCommand extends OfflineGfshCommand {
           help = CliStrings.START_SERVER__MEMCACHED_PROTOCOL__HELP) final String memcachedProtocol,
       @CliOption(key = CliStrings.START_SERVER__MEMCACHED_BIND_ADDRESS,
           help = CliStrings.START_SERVER__MEMCACHED_BIND_ADDRESS__HELP) final String memcachedBindAddress,
-      @CliOption(key = CliStrings.START_SERVER__REDIS_PORT,
-          help = CliStrings.START_SERVER__REDIS_PORT__HELP) final Integer redisPort,
-      @CliOption(key = CliStrings.START_SERVER__REDIS_BIND_ADDRESS,
-          help = CliStrings.START_SERVER__REDIS_BIND_ADDRESS__HELP) final String redisBindAddress,
-      @CliOption(key = CliStrings.START_SERVER__REDIS_USERNAME,
-          help = CliStrings.START_SERVER__REDIS_USERNAME__HELP) final String redisUsername,
       @CliOption(key = CliStrings.START_SERVER__MESSAGE__TIME__TO__LIVE,
           help = CliStrings.START_SERVER__MESSAGE__TIME__TO__LIVE__HELP) final Integer messageTimeToLive,
       @CliOption(key = CliStrings.START_SERVER__OFF_HEAP_MEMORY_SIZE,
@@ -210,8 +204,8 @@ public class StartServerCommand extends OfflineGfshCommand {
         evictionOffHeapPercentage, force, group, hostNameForClients, jmxManagerHostnameForClients,
         includeSystemClasspath, initialHeap, jvmArgsOpts, locators, locatorWaitTime, lockMemory,
         logLevel, maxConnections, maxHeap, maxMessageCount, maxThreads, mcastBindAddress, mcastPort,
-        memcachedPort, memcachedProtocol, memcachedBindAddress, redisPort, redisBindAddress,
-        redisUsername, messageTimeToLive, offHeapMemorySize, gemfirePropertiesFile, rebalance,
+        memcachedPort, memcachedProtocol, memcachedBindAddress, messageTimeToLive,
+        offHeapMemorySize, gemfirePropertiesFile, rebalance,
         gemfireSecurityPropertiesFile, serverBindAddress, serverPort, socketBufferSize,
         springXmlLocation, statisticsArchivePathname, requestSharedConfiguration, startRestApi,
         httpServicePort, httpServiceBindAddress, userName, passwordToUse, redirectOutput);
@@ -227,7 +221,7 @@ public class StartServerCommand extends OfflineGfshCommand {
       Integer locatorWaitTime, Boolean lockMemory, String logLevel, Integer maxConnections,
       String maxHeap, Integer maxMessageCount, Integer maxThreads, String mcastBindAddress,
       Integer mcastPort, Integer memcachedPort, String memcachedProtocol,
-      String memcachedBindAddress, Integer redisPort, String redisBindAddress, String redisUsername,
+      String memcachedBindAddress,
       Integer messageTimeToLive, String offHeapMemorySize, File gemfirePropertiesFile,
       Boolean rebalance, File gemfireSecurityPropertiesFile, String serverBindAddress,
       Integer serverPort, Integer socketBufferSize, String springXmlLocation,
@@ -287,14 +281,6 @@ public class StartServerCommand extends OfflineGfshCommand {
     StartMemberUtils.setPropertyIfNotNull(gemfireProperties,
         ConfigurationProperties.MEMCACHED_BIND_ADDRESS, memcachedBindAddress);
     StartMemberUtils.setPropertyIfNotNull(gemfireProperties,
-        ConfigurationProperties.GEODE_FOR_REDIS_PORT,
-        redisPort);
-    StartMemberUtils.setPropertyIfNotNull(gemfireProperties,
-        ConfigurationProperties.GEODE_FOR_REDIS_BIND_ADDRESS, redisBindAddress);
-    StartMemberUtils.setPropertyIfNotNull(gemfireProperties,
-        ConfigurationProperties.GEODE_FOR_REDIS_USERNAME,
-        redisUsername);
-    StartMemberUtils.setPropertyIfNotNull(gemfireProperties,
         ConfigurationProperties.STATISTIC_ARCHIVE_FILE, statisticsArchivePathname);
     StartMemberUtils.setPropertyIfNotNull(gemfireProperties,
         ConfigurationProperties.USE_CLUSTER_CONFIGURATION, requestSharedConfiguration);
@@ -309,17 +295,6 @@ public class StartServerCommand extends OfflineGfshCommand {
     StartMemberUtils.setPropertyIfNotNull(gemfireProperties,
         ConfigurationProperties.HTTP_SERVICE_BIND_ADDRESS, httpServiceBindAddress);
 
-    // if geode-for-redis-port, geode-for-redis-bind-address, or
-    // geode-for-redis-username are specified in the command line, REDIS_ENABLED should be set
-    // to true
-    String stringRedisPort;
-    stringRedisPort = redisPort == null ? "" : redisPort.toString();
-
-    if (StringUtils.isNotBlank(stringRedisPort) || StringUtils.isNotBlank(redisUsername)
-        || StringUtils.isNotBlank(redisBindAddress)) {
-      gemfireProperties.setProperty(ConfigurationProperties.GEODE_FOR_REDIS_ENABLED, "true");
-    }
-
     // if username is specified in the command line, it will overwrite what's set in the
     // properties file
     if (StringUtils.isNotBlank(userName)) {