This is an automated email from the ASF dual-hosted git repository.
heybales pushed a commit to branch support/1.14
in repository https://gitbox.apache.org/repos/asf/geode.git
The following commit(s) were added to refs/heads/support/1.14 by this push:
new 92b048f GEODE-9045: customer facing references to Redis (#6150)
(#6209)
92b048f is described below
commit 92b048fe4705064a8507ac63fa86d5a0f65d3cd5
Author: Hale Bales <hba...@pivotal.io>
AuthorDate: Tue Mar 30 09:33:26 2021 -0700
GEODE-9045: customer facing references to Redis (#6150) (#6209)
Change the customer facing references to Redis to comply with Redis's
copyright. Instead of calling ourselves Geode Redis, we are called
Geode APIs compatible with Redis.
- property redis-port -> compatible-with-redis-port
- property redis-bind-address -> compatible-with-redis-bind-address
- property redis-password -> compatible-with-redis-password
- property redis-enabled -> compatible-with-redis-enabled
- use the word Redis when referring to actual Redis
- rename html documentation file and change all references to it
- fix filename that mixed dashes and underscores
(cherry picked from commit d9ec6fb2b8716a5c4f8bc6afadd8edff796de4a6)
---
ci/scripts/execute_redis_tests.sh | 10 ++---
.../source/subnavs/geode-subnav.erb | 14 +++---
.../geode/distributed/ConfigurationProperties.java | 47 ++++++++++-----------
.../internal/AbstractDistributionConfig.java | 2 +-
.../cli/commands/golden-help-offline.properties | 12 +++---
...de.png => geode_apis_compatible_with_redis.png} | Bin
.../topics/gemfire_properties.html.md.erb | 16 +++----
geode-docs/tools_modules/book_intro.html.md.erb | 4 +-
...> geode_apis_compatible_with_redis.html.md.erb} | 47 ++++++++++-----------
.../internal/cli/commands/StartServerCommand.java | 5 ++-
.../internal/cli/util/HyphenFormatterTest.java | 9 ++--
geode-redis/README.md | 26 ++++++------
.../GeodeRedisServerStartUpAcceptanceTest.java | 10 ++---
.../redis/GeodeRedisServerStartupDUnitTest.java | 8 ++--
.../java/org/apache/geode/redis/SSLTest.java | 6 +--
.../redis/internal/PassiveExpirationManager.java | 3 +-
.../geode/redis/internal/RegionProvider.java | 2 +-
.../geode/redis/internal/data/RedisString.java | 5 ++-
.../geode/redis/internal/gfsh/RedisCommand.java | 2 +-
.../redis/internal/gfsh/RedisCommandFunction.java | 3 +-
.../redis/internal/netty/NettyRedisServer.java | 6 +--
.../redis/internal/statistics/GeodeRedisStats.java | 4 +-
.../src/performanceTest/environment-setup.sh | 8 ++--
23 files changed, 125 insertions(+), 124 deletions(-)
diff --git a/ci/scripts/execute_redis_tests.sh
b/ci/scripts/execute_redis_tests.sh
index 66daf7c..3b7cce6 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-redis-unsupported-commands=true \
--name=server1 \
- --redis-port=6380 \
- --redis-bind-address=127.0.0.1 \
- --redis-password=foobar
+ --compatible-with-redis-port=6380 \
+ --compatible-with-redis-bind-address=127.0.0.1 \
+ --compatible-with-redis-password=foobar
failCount=0
@@ -48,8 +48,8 @@ failCount=0
--J=-Denable-redis-unsupported-commands=true \
--name=server2 \
--server-port=0 \
- --redis-port=6379 \
- --redis-bind-address=127.0.0.1
+ --compatible-with-redis-port=6379 \
+ --compatible-with-redis-bind-address=127.0.0.1
./runtest --host 127.0.0.1 --port 6379 --single unit/type/set --single
unit/expire \
--single unit/type/hash --single unit/type/string \
diff --git a/geode-book/master_middleman/source/subnavs/geode-subnav.erb
b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
index fa0f050..deeb4b3 100644
--- a/geode-book/master_middleman/source/subnavs/geode-subnav.erb
+++ b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
@@ -2206,25 +2206,25 @@ gfsh</a>
</ul>
</li>
<li class="has_submenu">
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/redis_api_for_geode.html">Redis
API for <%=vars.product_name%></a>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/geode_apis_compatible_with_redis.html"><%=vars.product_name%>
APIs compatible with Redis</a>
<ul>
<li>
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/redis_api_for_geode.html#using-the-api">Using
the Redis API for <%=vars.product_name%></a>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/geode_apis_compatible_with_redis.html#using-the-api">Using
<%=vars.product_name%> APIs Compatible with Redis</a>
</li>
<li>
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/redis_api_for_geode.html#included-commands">Included
Redis Commands</a>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/geode_apis_compatible_with_redis.html#supported-commands">Supported
Redis Commands</a>
</li>
<li>
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/redis_api_for_geode.html#advantages-over-redis">Advantages
of <%=vars.product_name%> over Redis</a>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/geode_apis_compatible_with_redis#advantages-over-redis">Advantages
of <%=vars.product_name%> over Redis</a>
</li>
<li>
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/redis_api_for_geode.html#expiration-accuracy">Expiration
Accuracy</a>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/geode_apis_compatible_with_redis.html#expiration-accuracy">Expiration
Accuracy</a>
</li>
<li>
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/redis_api_for_geode.html#high-availability-model">High
Availability Model</a>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/geode_apis_compatible_with_redis.html#high-availability-model">High
Availability Model</a>
</li>
<li>
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/redis_api_for_geode.html#loss-of-connections">Loss
of Connections</a>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/geode_apis_compatible_with_redis.html#loss-of-connections">Loss
of Connections</a>
</li>
</ul>
</li>
diff --git
a/geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
b/geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
index 1955210..f33745c 100644
---
a/geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
+++
b/geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
@@ -1921,55 +1921,52 @@ public interface ConfigurationProperties {
*/
String OFF_HEAP_MEMORY_SIZE = "off-heap-memory-size";
/**
- * The static String definition of the <i>"redis-bind-address"</i> property
<a
- * name="redis-bind-address"/a>
+ * The static String definition of the
<i>"compatible-with-redis-bind-address"</i> property <a
+ * name="compatible-with-redis-bind-address"/a>
* </p>
- * <U>Description</U>: 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.
+ * <U>Description</U>: Specifies the address on which Geode APIs compatible
with Redis are
+ * listening. If set to the empty string or this property is not specified,
the server listens on
+ * all local addresses.
* </p>
* <U>Default</U>: ""
*/
- String REDIS_BIND_ADDRESS = "redis-bind-address";
+ String REDIS_BIND_ADDRESS = "compatible-with-redis-bind-address";
/**
- * The static String definition of the <i>"redis-enabled"</i> property <a
- * name="redis-enabled"/a>
+ * The static String definition of the
<i>"compatible-with-redis-enabled"</i> property <a
+ * name="compatible-with-redis-enabled"/a>
* </p>
- * <U>Description</U>: When the default value of false, the Redis API for
Geode is not available.
- * Set to true to enable the Redis API for Geode.</td>
+ * <U>Description</U>: When the default value of false, the Geode APIs
compatible with Redis are
+ * not available.
+ * Set to true to enable the Geode APIs compatible with Redis.</td>
* </p>
* <U>Default</U>: false
- * <td>redis-enabled</td>
- * <td>When the default value of false, the Redis API for
<%=vars.product_name%> is not available.
- * Set
- * to true to enable the Redis API for <%=vars.product_name%>.</td>
- * <td>S</td>
- * <td>false</td>
- * </tr>
+ * When the default value of false, the Geode APIs compatible with Redis are
not available.
+ * Set to true to enable the Geode APIs compatible with Redis.
* </p>
*/
- String REDIS_ENABLED = "redis-enabled";
+ String REDIS_ENABLED = "compatible-with-redis-enabled";
/**
- * The static String definition of the <i>"redis-password"</i> property <a
- * name="redis-password"/a>
+ * The static String definition of the
<i>"compatible-with-redis-password"</i> property <a
+ * name="compatible-with-redis-password"/a>
* </p>
* <U>Description</U>: Specifies the password that the server uses when a
client attempts to
* authenticate.
* </p>
* <U>Default</U>: no password set
*/
- String REDIS_PASSWORD = "redis-password";
+ String REDIS_PASSWORD = "compatible-with-redis-password";
/**
- * The static String definition of the <i>"redis-port"</i> property <a
name="redis-port"/a>
+ * The static String definition of the <i>"compatible-with-redis-port"</i>
property <a
+ * name="compatible-with-redis-port"/a>
* </p>
- * <U>Description</U>: Specifies the port on which the server listens for
Redis API for Geode
- * connections. A value of 0 selects a random port.</td>
+ * <U>Description</U>: Specifies the port on which the server listens for
connections from Geode
+ * APIs compatible with Redis. A value of 0 selects a random port.</td>
* </p>
* <U>Default</U>: 6379
* </p>
* <U>Allowed values</U>: 0..65535
*/
- String REDIS_PORT = "redis-port";
+ String REDIS_PORT = "compatible-with-redis-port";
/**
* The static String definition of the <i>"lock-memory"</i> property <a
name="lock-memory"/a>
* </p>
diff --git
a/geode-core/src/main/java/org/apache/geode/distributed/internal/AbstractDistributionConfig.java
b/geode-core/src/main/java/org/apache/geode/distributed/internal/AbstractDistributionConfig.java
index 8271493..c5e19d3 100644
---
a/geode-core/src/main/java/org/apache/geode/distributed/internal/AbstractDistributionConfig.java
+++
b/geode-core/src/main/java/org/apache/geode/distributed/internal/AbstractDistributionConfig.java
@@ -673,7 +673,7 @@ public abstract class AbstractDistributionConfig extends
AbstractConfig
if (value != null && value.length() > 0 &&
!LocalHostUtil.isLocalHost(value)) {
throw new IllegalArgumentException(
String.format(
- "The redis-bind-address %s is not a valid address for this
machine. These are the valid addresses for this machine: %s",
+ "The compatible-with-redis-bind-address %s is not a valid
address for this machine. These are the valid addresses for this machine: %s",
value, LocalHostUtil.getMyAddresses()));
}
return value;
diff --git
a/geode-core/src/test/resources/org/apache/geode/management/internal/cli/commands/golden-help-offline.properties
b/geode-core/src/test/resources/org/apache/geode/management/internal/cli/commands/golden-help-offline.properties
index 8199dbf..e0e4b8a 100644
---
a/geode-core/src/test/resources/org/apache/geode/management/internal/cli/commands/golden-help-offline.properties
+++
b/geode-core/src/test/resources/org/apache/geode/management/internal/cli/commands/golden-help-offline.properties
@@ -2572,7 +2572,7 @@ SYNTAX\n\
\ \ \ \ [--lock-memory(=value)?] [--log-level=value] [--max-connections=value]
[--max-heap=value]\n\
\ \ \ \ [--max-message-count=value] [--max-threads=value]
[--mcast-address=value] [--mcast-port=value]\n\
\ \ \ \ [--memcached-port=value] [--memcached-protocol=value]
[--memcached-bind-address=value]\n\
-\ \ \ \ [--redis-port=value] [--redis-bind-address=value]
[--redis-password=value]\n\
+\ \ \ \ [--compatible-with-redis-port=value]
[--compatible-with-redis-bind-address=value]
[--compatible-with-redis-password=value]\n\
\ \ \ \ [--message-time-to-live=value] [--off-heap-memory-size=value]
[--properties-file=value]\n\
\ \ \ \ [--rebalance(=value)?] [--security-properties-file=value]
[--server-bind-address=value]\n\
\ \ \ \ [--server-port=value] [--socket-buffer-size=value]
[--spring-xml-location=value]\n\
@@ -2719,14 +2719,14 @@ PARAMETERS\n\
\ \ \ \ \ \ \ \ Sets the IP address the Geode memcached service listens on for
memcached clients. The\n\
\ \ \ \ \ \ \ \ default is to bind to the first non-loopback address for this
machine.\n\
\ \ \ \ \ \ \ \ Required: false\n\
-\ \ \ \ redis-port\n\
-\ \ \ \ \ \ \ \ Sets the port that the Geode Redis service listens on for
Redis clients.\n\
+\ \ \ \ compatible-with-redis-port\n\
+\ \ \ \ \ \ \ \ Sets the port that the Geode APIs compatible with Redis
service listens on for Redis clients.\n\
\ \ \ \ \ \ \ \ Required: false\n\
-\ \ \ \ redis-bind-address\n\
-\ \ \ \ \ \ \ \ Sets the IP address the Geode Redis service listens on for
Redis clients. The default is to\n\
+\ \ \ \ compatible-with-redis-bind-address\n\
+\ \ \ \ \ \ \ \ Sets the IP address the Geode APIs compatible with Redis
service listens on for Redis clients. The default is to\n\
\ \ \ \ \ \ \ \ bind to the first non-loopback address for this machine.\n\
\ \ \ \ \ \ \ \ Required: false\n\
-\ \ \ \ redis-password\n\
+\ \ \ \ compatible-with-redis-password\n\
\ \ \ \ \ \ \ \ Sets the authentication password for GeodeRedisServer\n\
\ \ \ \ \ \ \ \ Required: false\n\
\ \ \ \ message-time-to-live\n\
diff --git a/geode-docs/images/redis_api_for_geode.png
b/geode-docs/images/geode_apis_compatible_with_redis.png
similarity index 100%
rename from geode-docs/images/redis_api_for_geode.png
rename to geode-docs/images/geode_apis_compatible_with_redis.png
diff --git a/geode-docs/reference/topics/gemfire_properties.html.md.erb
b/geode-docs/reference/topics/gemfire_properties.html.md.erb
index 9ebf611..bbdedf5 100644
--- a/geode-docs/reference/topics/gemfire_properties.html.md.erb
+++ b/geode-docs/reference/topics/gemfire_properties.html.md.erb
@@ -487,28 +487,28 @@ off-heap-memory-size=120g</code></pre></td>
<td><em>not set</em></td>
</tr>
<tr>
-<td>redis-bind-address</td>
-<td>Specifies the address on which the Redis API for <%=vars.product_name%> is
listening. If set to the empty string or this property is not
+<td>compatible-with-redis-bind-address</td>
+<td>Specifies the address on which the <%=vars.product_name%> APIs compatible
with Redis is listening. If set to the empty string or this property is not
specified, the server listens on all local addresses.
<td>S</td>
<td><code>""</code></td>
</tr>
<tr>
-<td>redis-enabled</td>
-<td>When the default value of false, the Redis API for <%=vars.product_name%>
is not available. Set
-to true to enable the Redis API for <%=vars.product_name%>.</td>
+<td>compatible-with-redis-enabled</td>
+<td>When the default value of false, the <%=vars.product_name%> APIs
compatible with Redis are not available. Set
+to true to enable the <%=vars.product_name%> APIs compatible with Redis.</td>
<td>S</td>
<td>false</td>
</tr>
<tr>
-<td>redis-password</td>
+<td>compatible-with-redis-password</td>
<td>Specifies the password that the server uses when a client attempts to
authenticate.</td>
<td>S</td>
<td>no password set</td>
</tr>
<tr>
-<td>redis-port</td>
-<td>Specifies the port on which the server listens for Redis API for
<%=vars.product_name%> connections. A value of 0 selects a random port.</td>
+<td>compatible-with-redis-port</td>
+<td>Specifies the port on which the server listens for <%=vars.product_name%>
APIs compatible with Redis connections. A value of 0 selects a random port.</td>
<td>S</td>
<td>6379</td>
</tr>
diff --git a/geode-docs/tools_modules/book_intro.html.md.erb
b/geode-docs/tools_modules/book_intro.html.md.erb
index 7b28f56..f3df49c 100644
--- a/geode-docs/tools_modules/book_intro.html.md.erb
+++ b/geode-docs/tools_modules/book_intro.html.md.erb
@@ -39,9 +39,9 @@ limitations under the License.
<%=vars.product_name%> Pulse is a Web Application that provides a
graphical dashboard for monitoring vital, real-time health and performance of
<%=vars.product_name%> clusters, members, and regions.
-- **[Redis API for <%=vars.product_name%>](redis_api_for_geode.html)**
+- **[<%=vars.product_name%> APIs compatible with
Redis](geode_apis_compatible_with_redis.html)**
- The Redis API for <%=vars.product_name%> allows <%=vars.product_name%> to
function as a drop-in replacement for a Redis data store, letting Redis
applications take advantage of <%=vars.product_name%>’s scaling capabilities
without changing their client code. Redis clients connect to a
<%=vars.product_name%> server in the same way they connect to a Redis server,
using a hostname and a port number.
+ The <%=vars.product_name%> APIs compatible with Redis allows
<%=vars.product_name%> to function as a drop-in replacement for a Redis data
store, letting Redis applications take advantage of <%=vars.product_name%>’s
scaling capabilities without changing their client code. Redis clients connect
to a <%=vars.product_name%> server in the same way they connect to a Redis
server, using a hostname and a port number.
- **[Apache Lucene® Integration](lucene_integration.html)**
diff --git a/geode-docs/tools_modules/redis_api_for_geode.html.md.erb
b/geode-docs/tools_modules/geode_apis_compatible_with_redis.html.md.erb
similarity index 69%
rename from geode-docs/tools_modules/redis_api_for_geode.html.md.erb
rename to geode-docs/tools_modules/geode_apis_compatible_with_redis.html.md.erb
index 61534df..3cd49f9 100644
--- a/geode-docs/tools_modules/redis_api_for_geode.html.md.erb
+++ b/geode-docs/tools_modules/geode_apis_compatible_with_redis.html.md.erb
@@ -1,4 +1,4 @@
-<% set_title("Redis API for", product_name) %>
+<% set_title(product_name, "APIs Compatible with Redis") %>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,18 +17,17 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-The Redis API for <%=vars.product_name%> allows <%=vars.product_name%> to
function as a drop-in replacement for a
+The <%=vars.product_name%> APIs compatible with Redis allows
<%=vars.product_name%> to function as a drop-in replacement for a
highly-available Redis data store, letting Redis applications take advantage of
<%=vars.product_name%>’s scaling capabilities without changing their client
code. Redis clients connect to a <%=vars.product_name%>
server in the same way they connect to a Redis server, using a hostname and a
port number, with
optional password authentication.
-<img src="../images/redis_api_for_geode.png" class="image" />
+<img src="../images/geode_apis_compatible_with_redis.png" class="image" />
-## <a id="using-the-api" class="no-quick-link"></a>Using the Redis API for
<%=vars.product_name%>
+## <a id="using-the-api" class="no-quick-link"></a>Using the
<%=vars.product_name%> API compatible with Redis
-The <%=vars.product_name%> cluster must have at least one server that is set
up to handle the incoming Redis
-commands.
+The <%=vars.product_name%> cluster must have at least one server that is set
up to handle the incoming Redis commands.
Use gfsh to start at least one server with a command of the form:
@@ -36,39 +35,39 @@ Use gfsh to start at least one server with a command of the
form:
start server \
--name=<serverName> \
--locators=<locatorPort> \
- --redis-port=<redisPort> \
- --redis-bind-address=<redisBindAddress> \
- --redis-password=<redisPassword>
+ --compatible-with-redis-port=<compatibleWithRedisPort> \
+ --compatible-with-redis-bind-address=<compatibleWithRedisBindAddress> \
+ --compatible-with-redis-password=<compatibleWithRedisPassword>
```
-If any of the options `redis-bind-address`, `redis-password`, or `redis-port`
are included, a compatible-with-Redis Geode server will be started.
+If any of the options `compatible-with-redis-bind-address`,
`compatible-with-redis-password`, or `compatible-with-redis-port` are included,
a <%=vars.product_name%> server compatible with Redis will be started.
Replace `<serverName>` with the name of your server.
Replace `<locatorPort>` with your locator port.
-Replace `<redisPort>` with the port that the <%=vars.product_name%> server
listens on for Redis commands. The typical port used with a Redis cluster is
6379.
+Replace `<compatibleWithRedisPort>` with the port that the
<%=vars.product_name%> server listens on for Redis commands. The typical port
used with a cluster compatible with Redis is 6379.
-Replace `<redisBindAddress>` with the address of the server host.
+Replace `<compatibleWithRedisBindAddress>` with the address of the server host.
-Replace `<redisPassword>` with the password clients use to authenticate.
+Replace `<compatibleWithWithRedisPassword>` with the password clients use to
authenticate.
To confirm the server is listening, run:
``` pre
-redis-cli -h <redisBindAddress> -p <redisPort> -a <redisPassword> ping
+redis-cli -h <compatibleWithRedisBindAddress> -p <compatibleWithRedisPort> -a
<compatibleWithRedisPassword> ping
```
-Replace `<redisBindAddress>`,`<redisPort>`, and `<redisPassword>` with the
same values as the server.
+Replace `<compatibleWithRedisBindAddress>`,`<compatibleWithRedisPort>`, and
`<compatibleWithRedisPassword>` with the same values as the server.
If the server is functioning properly, you should see a response of `PONG`.
-## <a id="included-commands" class="no-quick-link"></a>Included Redis Commands
+## <a id="supported-commands" class="no-quick-link"></a>Supported Redis
Commands
-The Redis API for <%=vars.product_name%> currently supports the following
commands. See [Redis commands](https://redis.io/commands/) for a complete list
of and more information on Redis commands.
+The <%=vars.product_name%> APIs compatible with Redis currently supports the
following Redis commands. See [Redis commands](https://redis.io/commands/) for
a complete list of and more information on Redis commands.
**Note**: These commands are supported for Redis 5.
-**Note**: SLOWLOG is implemented as a NoOp for compatibility with DataDog.
+**Note**: SLOWLOG is implemented as a NoOp for compatibility with some
monitoring tools.
- **Connection**: AUTH, PING, QUIT
- **Hashes**: HDEL, HEXISTS, HGET, HGETALL, HINCRBY, HINCRBYFLOAT, HKEYS,
HLEN, HMGET, HMSET, HSCAN, HSET, HSETNX, HSTRLEN, HVALS
@@ -79,7 +78,7 @@ The Redis API for <%=vars.product_name%> currently supports
the following comman
- **Sets**: SADD, SMEMBERS, SREM
- **Strings**: APPEND, DECR, GET, GETRANGE, INCR, INCRBY, INCRBYFLOAT, MGET,
SET, SETNX, STRLEN
-The following Redis API for <%=vars.product_name%> commands are
**unsupported**. Unsupported
+The following Redis commands are **unsupported** by <%=vars.produce_name%>'s
APIs compatible with Redis. Unsupported
commands are available to use, but have not been fully tested. There is no
guarantee they will work
exactly as expected.
@@ -91,8 +90,8 @@ exactly as expected.
- **Strings**: BITCOUNT, BITOP, BITPOS, DECRBY, GETBIT, GETSET, MSET,
MSETNX, PSETEX, SETBIT, SETEX, SETRANGE
-If you already have some Geode servers running with Redis enabled, you can
execute the following
-command with gfsh to enable unsupported commands:
+If you already have some Geode servers running that are compatible with Redis,
you can execute the
+following command with gfsh to enable unsupported commands:
```pre
redis --enable-unsupported-commands
@@ -105,9 +104,9 @@ start server \
--J=-Denable-redis-unsupported-commands=true \
--name=<serverName> \
--locators=<locatorPort> \
- --redis-port=<redisPort> \
- --redis-bind-address=<redisBindAddress> \
- --redis-password=<redisPassword>
+ --compatible-with-redis-port=<compatibleWithRedisPort> \
+ --compatible-with-redis-bind-address=<compatibleWithRedisBindAddress> \
+ --compatible-with-redis-password=<compatibleWithRedisPassword>
```
Commands not listed above are **not implemented**.
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 6e4eec8..288f390 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
@@ -302,8 +302,9 @@ public class StartServerCommand extends OfflineGfshCommand {
StartMemberUtils.setPropertyIfNotNull(gemfireProperties,
ConfigurationProperties.HTTP_SERVICE_BIND_ADDRESS,
httpServiceBindAddress);
- // if redis-port, redis-bind-address, or redis-password are specified in
the command line,
- // REDIS_ENABLED should be set to true
+ // if compatible-with-redis-port, compatible-with-redis-bind-address, or
+ // compatible-with-redis-password are specified in the command line,
REDIS_ENABLED should be set
+ // to true
String stringRedisPort;
stringRedisPort = redisPort == null ? "" : redisPort.toString();
diff --git
a/geode-gfsh/src/test/java/org/apache/geode/management/internal/cli/util/HyphenFormatterTest.java
b/geode-gfsh/src/test/java/org/apache/geode/management/internal/cli/util/HyphenFormatterTest.java
index bdecedf..24aba2b 100644
---
a/geode-gfsh/src/test/java/org/apache/geode/management/internal/cli/util/HyphenFormatterTest.java
+++
b/geode-gfsh/src/test/java/org/apache/geode/management/internal/cli/util/HyphenFormatterTest.java
@@ -227,10 +227,11 @@ public class HyphenFormatterTest {
@Test
public void optionWithOneHyphenAfterOneJOption() {
- String cmd = "start server --name=me3 --J=-Dgemfire.jmx-manager=true
--redis-port=8080";
+ String cmd =
+ "start server --name=me3 --J=-Dgemfire.jmx-manager=true
--compatible-with-redis-port=8080";
String formattedCmd = this.formatter.formatCommand(cmd);
String expected =
- "start server --name=me3 --J=\"-Dgemfire.jmx-manager=true\"
--redis-port=8080";
+ "start server --name=me3 --J=\"-Dgemfire.jmx-manager=true\"
--compatible-with-redis-port=8080";
assertThat(formattedCmd).as(cmd).isEqualTo(expected);
}
@@ -246,10 +247,10 @@ public class HyphenFormatterTest {
@Test
public void optionWithOneHyphenAfterTwoJOptions() {
String cmd =
- "start server --name=me3 --J=-Dgemfire.jmx-manager=true
--J=-Dgemfire.jmx-manager-start=true --redis-port=8080";
+ "start server --name=me3 --J=-Dgemfire.jmx-manager=true
--J=-Dgemfire.jmx-manager-start=true --compatible-with-redis-port=8080";
String formattedCmd = this.formatter.formatCommand(cmd);
String expected =
- "start server --name=me3 --J=\"-Dgemfire.jmx-manager=true\"
--J=\"-Dgemfire.jmx-manager-start=true\" --redis-port=8080";
+ "start server --name=me3 --J=\"-Dgemfire.jmx-manager=true\"
--J=\"-Dgemfire.jmx-manager-start=true\" --compatible-with-redis-port=8080";
assertThat(formattedCmd).as(cmd).isEqualTo(expected);
}
diff --git a/geode-redis/README.md b/geode-redis/README.md
index 9d86ef5..0e21195 100644
--- a/geode-redis/README.md
+++ b/geode-redis/README.md
@@ -1,24 +1,24 @@
-# Redis API for Apache Geode
+# Apache Geode APIs Compatible with Redis
[Introduction](#introduction)
[How To Try It](#how-to-try-it)
[Building Apache Geode](#building-apache-geode)
[Starting a Geode Server with Redis Enabled](#starting-a-server)
-[Adding an Additional Geode Redis Server](#adding-a-server)
+[Adding an Additional Geode Server Compatible with Redis](#adding-a-server)
[Shutting Down](#shutting-down)
[Redis Commands](#redis-commands)
## <a name="introduction"></a>Introduction
-The Redis API for Geode allows an application to send Redis commands to Geode.
This will allow users to
+The Geode APIs compatible with Redis allows an application to send Redis
commands to Geode. This will allow users to
switch seamlessly from native Redis to Geode as a data store/caching solution.
The API allows Geode to listen for and interpret incoming Redis commands on a
designated port.
## <a name="how-to-try-it"></a>How To Try It
-The Redis API for Geode is currently in early access. We’ll build the develop
branch of Apache Geode
+The Geode APIs compatible with Redis is currently in early access. We’ll build
the develop branch of Apache Geode
and then connect the [Redis-CLI](https://redis.io/topics/quickstart) to that
instance.
**Note:** Currently Geode requires **Java 8 JDK** to build.
@@ -61,7 +61,7 @@ You should now see GFSH starting up with a version of
1.14.x.-build.x
### <a name="starting-a-server"></a>Starting a Geode Server with Redis Enabled
-**Note**: if you wish to run the Geode Redis API on the default Redis port
(6379), make sure to stop
+**Note**: if you wish to run the Geode APIs compatible with Redis on the
default Redis port (6379), make sure to stop
any applications running on that port before starting the Geode server,
especially any native Redis
servers.
@@ -78,12 +78,12 @@ connection, the locator directs the client to one of the
least loaded servers.
For example:
```commandline
- gfsh> start server --name=redisServer1 --locators=localhost[10334]
--server-port=0 --redis-port=6379
+ gfsh> start server --name=redisServer1 --locators=localhost[10334]
--server-port=0 --compatible-with-redis-port=6379
```
* --name: A name you create for your server.
* --locators: This is the location of the locator you started in step 1.
* --server-port: The port that Geode clients connect to.
- * --redis-port: The port that your Redis client will connect to.
+ * --compatible-with-redis-port: The port that your Redis client will
connect to.
Your Geode instance should now be up and running (1 locator and 1 server)
and ready to accept Redis
commands.
@@ -98,13 +98,13 @@ connection, the locator directs the client to one of the
least loaded servers.
If working correctly you should now be in the redis-cli and see
`127.0.0.1:6379>`. If you run the
`PING` command you should receive a response of `PONG`.
-### <a name="adding-a-server"></a>Optional - Adding an Additional Geode Redis
Server
+### <a name="adding-a-server"></a>Optional - Adding an Additional Geode server
compatible with Redis
If you’re interested in testing Geode scalability, in GFSH run the start
server command again BUT
make sure you change the `--name=` and `--redis-port=` parameters.
For example:
```commandLine
- $ start server --name=redisServer2 --locators=localhost[10334]
--server-port=0 --redis-port=6380
+ $ start server --name=redisServer2 --locators=localhost[10334]
--server-port=0 --compatible-with-redis-port=6380
```
### <a name="shutting-down"></a>Shutting Down
@@ -128,7 +128,7 @@ not connected>
```
### <a name="redis-commands"></a>Redis Commands
-The Redis API for Geode currently implements a subset of the full Redis
command set. Some commands
+The Geode APIs compatible with Redis currently implements a subset of the full
Redis command set. Some commands
are **unsupported** (see table below). Unsupported commands are available to
use, but have not been
fully tested. There is no guarantee they will work exactly as expected.
@@ -148,9 +148,9 @@ start server \
--J=-Denable-redis-unsupported-commands=true \
--name=<serverName> \
--locators=<locatorPort> \
- --redis-port=<redisPort> \
- --redis-bind-address=<redisBindAddress> \
- --redis-password=<redisPassword>
+ --compatible-with-redis-port=<redisPort> \
+ --compatible-with-redis-bind-address=<redisBindAddress> \
+ --compatible-with-redis-password=<redisPassword>
```
#### <a name="redis-command-status"></a>Redis Command Status [Return to
top](#introduction)
diff --git
a/geode-redis/src/acceptanceTest/java/org/apache/geode/redis/internal/executor/GeodeRedisServerStartUpAcceptanceTest.java
b/geode-redis/src/acceptanceTest/java/org/apache/geode/redis/internal/executor/GeodeRedisServerStartUpAcceptanceTest.java
index 9e63c2d..385a5a7 100644
---
a/geode-redis/src/acceptanceTest/java/org/apache/geode/redis/internal/executor/GeodeRedisServerStartUpAcceptanceTest.java
+++
b/geode-redis/src/acceptanceTest/java/org/apache/geode/redis/internal/executor/GeodeRedisServerStartUpAcceptanceTest.java
@@ -43,8 +43,8 @@ public class GeodeRedisServerStartUpAcceptanceTest {
"start server",
"--server-port", "0",
"--name", "same-port-and-address-server",
- "--redis-bind-address", "localhost",
- "--redis-port", String.valueOf(port));
+ "--compatible-with-redis-bind-address", "localhost",
+ "--compatible-with-redis-port", String.valueOf(port));
GfshExecution execution;
try (Socket interferingSocket = new Socket()) {
@@ -66,7 +66,7 @@ public class GeodeRedisServerStartUpAcceptanceTest {
"start server",
"--server-port", "0",
"--name", "same-port-all-addresses-server",
- "--redis-port", String.valueOf(port));
+ "--compatible-with-redis-port", String.valueOf(port));
GfshExecution execution;
try (Socket interferingSocket = new Socket()) {
@@ -86,7 +86,7 @@ public class GeodeRedisServerStartUpAcceptanceTest {
"start server",
"--server-port", "0",
"--name", "invalid-bind-server",
- "--redis-bind-address", "1.1.1.1");
+ "--compatible-with-redis-bind-address", "1.1.1.1");
GfshExecution execution;
execution = GfshScript.of(startServerCommand)
@@ -94,6 +94,6 @@ public class GeodeRedisServerStartUpAcceptanceTest {
.execute(gfshRule);
assertThat(execution.getOutputText()).containsIgnoringCase(
- "The redis-bind-address 1.1.1.1 is not a valid address for this
machine");
+ "The compatible-with-redis-bind-address 1.1.1.1 is not a valid address
for this machine");
}
}
diff --git
a/geode-redis/src/distributedTest/java/org/apache/geode/redis/GeodeRedisServerStartupDUnitTest.java
b/geode-redis/src/distributedTest/java/org/apache/geode/redis/GeodeRedisServerStartupDUnitTest.java
index 31aa860..1f4fbd7 100644
---
a/geode-redis/src/distributedTest/java/org/apache/geode/redis/GeodeRedisServerStartupDUnitTest.java
+++
b/geode-redis/src/distributedTest/java/org/apache/geode/redis/GeodeRedisServerStartupDUnitTest.java
@@ -219,14 +219,14 @@ public class GeodeRedisServerStartupDUnitTest {
.withProperty(REDIS_PORT, "-1")
.withProperty(REDIS_BIND_ADDRESS, "localhost")
.withProperty(REDIS_ENABLED, "true"))).hasRootCauseMessage(
- "Could not set \"redis-port\" to \"-1\" because its value can not
be less than \"0\".");
+ "Could not set \"compatible-with-redis-port\" to \"-1\" because
its value can not be less than \"0\".");
}
@Test
public void startupFailsGivenPortAlreadyInUse() throws Exception {
int port = AvailablePortHelper.getRandomAvailableTCPPort();
- addIgnoredException("Could not start Redis Server");
+ addIgnoredException("Could not start server compatible with Redis");
try (Socket interferingSocket = new Socket()) {
interferingSocket.bind(new InetSocketAddress("localhost", port));
assertThatThrownBy(() -> cluster.startServerVM(0, s -> s
@@ -241,13 +241,13 @@ public class GeodeRedisServerStartupDUnitTest {
public void startupFailsGivenInvalidBindAddress() {
int port = AvailablePortHelper.getRandomAvailableTCPPort();
- addIgnoredException("Could not start Redis Server");
+ addIgnoredException("Could not start server compatible with Redis");
assertThatThrownBy(() -> cluster.startServerVM(0, s -> s
.withProperty(REDIS_PORT, "" + port)
.withProperty(REDIS_BIND_ADDRESS, "1.1.1.1")
.withProperty(REDIS_ENABLED, "true")))
.hasStackTraceContaining(
- "The redis-bind-address 1.1.1.1 is not a valid address for
this machine");
+ "The compatible-with-redis-bind-address 1.1.1.1 is not a valid
address for this machine");
}
@Test
diff --git
a/geode-redis/src/integrationTest/java/org/apache/geode/redis/SSLTest.java
b/geode-redis/src/integrationTest/java/org/apache/geode/redis/SSLTest.java
index dda15b0..08f1182 100644
--- a/geode-redis/src/integrationTest/java/org/apache/geode/redis/SSLTest.java
+++ b/geode-redis/src/integrationTest/java/org/apache/geode/redis/SSLTest.java
@@ -41,9 +41,9 @@ public class SSLTest {
@ClassRule
public static ServerStarterRule sslEnabledServer = new ServerStarterRule()
.withSSL("server", true, true)
- .withProperty("redis-bind-address", "localhost")
- .withProperty("redis-port", "11211")
- .withProperty("redis-enabled", "true")
+ .withProperty("compatible-with-redis-bind-address", "localhost")
+ .withProperty("compatible-with-redis-port", "11211")
+ .withProperty("compatible-with-redis-enabled", "true")
.withAutoStart();
diff --git
a/geode-redis/src/main/java/org/apache/geode/redis/internal/PassiveExpirationManager.java
b/geode-redis/src/main/java/org/apache/geode/redis/internal/PassiveExpirationManager.java
index c4b261a..c5edd81 100644
---
a/geode-redis/src/main/java/org/apache/geode/redis/internal/PassiveExpirationManager.java
+++
b/geode-redis/src/main/java/org/apache/geode/redis/internal/PassiveExpirationManager.java
@@ -78,7 +78,8 @@ public class PassiveExpirationManager {
}
} catch (CacheClosedException ignore) {
} catch (RuntimeException | Error ex) {
- logger.warn("Passive Redis expiration failed. Will try again in 1
second.", ex);
+ logger.warn("Passive expiration failed. Will try again in 1 second.",
+ ex);
} finally {
redisStats.endPassiveExpirationCheck(start, expireCount);
}
diff --git
a/geode-redis/src/main/java/org/apache/geode/redis/internal/RegionProvider.java
b/geode-redis/src/main/java/org/apache/geode/redis/internal/RegionProvider.java
index 17a4544..1a19556 100644
---
a/geode-redis/src/main/java/org/apache/geode/redis/internal/RegionProvider.java
+++
b/geode-redis/src/main/java/org/apache/geode/redis/internal/RegionProvider.java
@@ -80,7 +80,7 @@ public class RegionProvider {
protected static void validateBucketCount(int buckets) {
if (buckets > REDIS_SLOTS) {
throw new ManagementException(String.format(
- "Could not start Redis Server - System property '%s' must be <= %d",
+ "Could not start server compatible with Redis - System property '%s'
must be <= %d",
REDIS_REGION_BUCKETS_PARAM, REDIS_SLOTS));
}
}
diff --git
a/geode-redis/src/main/java/org/apache/geode/redis/internal/data/RedisString.java
b/geode-redis/src/main/java/org/apache/geode/redis/internal/data/RedisString.java
index f10fc36..f27d105 100644
---
a/geode-redis/src/main/java/org/apache/geode/redis/internal/data/RedisString.java
+++
b/geode-redis/src/main/java/org/apache/geode/redis/internal/data/RedisString.java
@@ -640,8 +640,9 @@ public class RedisString extends AbstractRedisData {
appendSequence = appendDeltaInfo.getSequence();
} else if (appendDeltaInfo.getSequence() != appendSequence) {
// Exceptional case should never happen
- throw new RuntimeException("Redis APPEND sequence mismatch - delta
sequence number: "
- + appendDeltaInfo.getSequence() + " current sequence number: " +
appendSequence);
+ throw new RuntimeException(
+ "APPEND sequence mismatch - delta sequence number: "
+ + appendDeltaInfo.getSequence() + " current sequence number: "
+ appendSequence);
}
}
}
diff --git
a/geode-redis/src/main/java/org/apache/geode/redis/internal/gfsh/RedisCommand.java
b/geode-redis/src/main/java/org/apache/geode/redis/internal/gfsh/RedisCommand.java
index dd90b78..535eafc 100644
---
a/geode-redis/src/main/java/org/apache/geode/redis/internal/gfsh/RedisCommand.java
+++
b/geode-redis/src/main/java/org/apache/geode/redis/internal/gfsh/RedisCommand.java
@@ -31,7 +31,7 @@ import org.apache.geode.security.ResourcePermission;
public class RedisCommand extends GfshCommand {
public static final String REDIS = "redis";
public static final String REDIS__HELP =
- "Commands related to the Redis API for Geode.";
+ "Commands related to the Geode APIs compatible with Redis.";
public static final String REDIS__ENABLE_UNSUPPORTED_COMMANDS =
"enable-unsupported-commands";
public static final String REDIS__ENABLE_UNSUPPORTED_COMMANDS__HELP =
"Boolean value to determine "
diff --git
a/geode-redis/src/main/java/org/apache/geode/redis/internal/gfsh/RedisCommandFunction.java
b/geode-redis/src/main/java/org/apache/geode/redis/internal/gfsh/RedisCommandFunction.java
index a1f5fa2..8aff0d3 100644
---
a/geode-redis/src/main/java/org/apache/geode/redis/internal/gfsh/RedisCommandFunction.java
+++
b/geode-redis/src/main/java/org/apache/geode/redis/internal/gfsh/RedisCommandFunction.java
@@ -36,7 +36,8 @@ public class RedisCommandFunction extends
CliFunction<Boolean> {
InternalCache cache = (InternalCache) context.getCache();
if (!cache.getInternalDistributedSystem().getConfig().getRedisEnabled()) {
- return new CliFunctionResult(context.getMemberName(), false, "Error:
Redis is not enabled");
+ return new CliFunctionResult(context.getMemberName(), false,
+ "Error: Geode APIs compatible with Redis are not enabled");
}
GeodeRedisService geodeRedisService =
cache.getService(GeodeRedisService.class);
diff --git
a/geode-redis/src/main/java/org/apache/geode/redis/internal/netty/NettyRedisServer.java
b/geode-redis/src/main/java/org/apache/geode/redis/internal/netty/NettyRedisServer.java
index 3a1d903..1cb665d 100644
---
a/geode-redis/src/main/java/org/apache/geode/redis/internal/netty/NettyRedisServer.java
+++
b/geode-redis/src/main/java/org/apache/geode/redis/internal/netty/NettyRedisServer.java
@@ -101,7 +101,7 @@ public class NettyRedisServer {
if (port < RANDOM_PORT_INDICATOR) {
throw new IllegalArgumentException(
- "Redis port cannot be less than " + RANDOM_PORT_INDICATOR);
+ "The compatible-with-redis-port cannot be less than " +
RANDOM_PORT_INDICATOR);
}
selectorGroup = createEventLoopGroup("Selector", true, 1);
@@ -218,7 +218,7 @@ public class NettyRedisServer {
channelFuture.syncUninterruptibly();
} catch (Exception ex) {
throw new ManagementException(
- "Could not start Redis Server using bind address: " + bindAddress +
+ "Could not start server compatible with Redis using bind address: "
+ bindAddress +
" and port: " + port + ". " +
"Please make sure nothing else is running on this address/port
combination.",
ex);
@@ -258,7 +258,7 @@ public class NettyRedisServer {
return InetAddress.getByName(requestedAddress);
} catch (UnknownHostException e) {
throw new ManagementException(
- "Could not start Redis Server using bind address: '" +
requestedAddress
+ "Could not start server compatible with Redis using bind address:
'" + requestedAddress
+ "'. Please make sure that this is a valid address for this
host.",
e);
}
diff --git
a/geode-redis/src/main/java/org/apache/geode/redis/internal/statistics/GeodeRedisStats.java
b/geode-redis/src/main/java/org/apache/geode/redis/internal/statistics/GeodeRedisStats.java
index f0f1f0c..9bb835f 100644
---
a/geode-redis/src/main/java/org/apache/geode/redis/internal/statistics/GeodeRedisStats.java
+++
b/geode-redis/src/main/java/org/apache/geode/redis/internal/statistics/GeodeRedisStats.java
@@ -71,8 +71,8 @@ public class GeodeRedisStats {
descriptorList.toArray(new StatisticDescriptor[descriptorList.size()]);
type = statisticsTypeFactory
- .createType("RedisStats",
- "Statistics for a GemFire Redis Server",
+ .createType("statsForServerCompatibleWithRedis",
+ "Statistics for a Geode server compatible with Redis",
descriptorArray);
fillCompletedIdMap(type);
diff --git a/geode-redis/src/performanceTest/environment-setup.sh
b/geode-redis/src/performanceTest/environment-setup.sh
index b9ab0a0..36c6fb5 100755
--- a/geode-redis/src/performanceTest/environment-setup.sh
+++ b/geode-redis/src/performanceTest/environment-setup.sh
@@ -55,7 +55,7 @@ while getopts ":f:rgt:c:h:p:" opt; do
done
if [ -z ${SERVER_TYPE} ]; then
- echo "Please specify native Redis (-r) or Geode Redis (-g)"
+ echo "Please specify native Redis (-r) or Geode APIs compatible with Redis
(-g)"
exit 1
fi
@@ -101,11 +101,11 @@ if [ ${SERVER_TYPE} == "geode" ]; then
--log-level=none
--locators=localhost[10334]
--server-port=0
- --redis-port=6379
- --redis-bind-address=127.0.0.1"
+ --compatible-with-redis-port=6379
+ --compatible-with-redis-bind-address=127.0.0.1"
else
if [ ${SERVER_NOT_FOUND} -eq 1 ]; then
- echo "No Redis server detected on host '${REDIS_HOST}' at port
'${REDIS_PORT}'"
+ echo "No server compatible with Redis detected on host '${REDIS_HOST}' at
port '${REDIS_PORT}'"
exit 1
fi
fi
