You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@geode.apache.org by GitBox <gi...@apache.org> on 2021/03/17 18:24:14 UTC
[GitHub] [geode] nonbinaryprogrammer opened a new pull request #6150: GEODE-9045: rename redis properties
nonbinaryprogrammer opened a new pull request #6150:
URL: https://github.com/apache/geode/pull/6150
- redis-port -> compatible-with-redis-port
- redis-bind-address -> compatible-with-redis-bind-address
- redis-password -> compatible-with-redis-password
Thank you for submitting a contribution to Apache Geode.
In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:
### For all changes:
- [ ] Is there a JIRA ticket associated with this PR? Is it referenced in the commit message?
- [ ] Has your PR been rebased against the latest commit within the target branch (typically `develop`)?
- [ ] Is your initial contribution a single, squashed commit?
- [ ] Does `gradlew build` run cleanly?
- [ ] Have you written or updated unit tests to verify your changes?
- [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
### Note:
Please ensure that once the PR is submitted, check Concourse for build issues and
submit an update to your PR as soon as possible. If you need help, please send an
email to dev@geode.apache.org.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] nonbinaryprogrammer commented on pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
nonbinaryprogrammer commented on pull request #6150:
URL: https://github.com/apache/geode/pull/6150#issuecomment-802179257
Reviewers: to comply with Redis's copyright, "Redis" must be the last word, preceded by a preposition. Please review for that, and any typos I made in the word "compatible". and of course anything else you find
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] nonbinaryprogrammer commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
nonbinaryprogrammer commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597071573
##########
File path: geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
##########
@@ -1921,46 +1921,48 @@
*/
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's API for Redis Compatibility is
+ * 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's API for Redis compatibility is
+ * not available.
+ * Set to true to enable the Geode's API for Redis compatibility.</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>compatible-with-redis-enabled</td>
+ * <td>When the default value of false, the <%=vars.product_name%> API for compatibility with
+ * Redis is not available.
+ * Set to true to enable the <%=vars.product_name%> API for compatibility with Redis.</td>
Review comment:
I left everything else the same and just changed the text, so as far as I know it seems like it should be fine as is
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] jomartin-999 commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
jomartin-999 commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597262765
##########
File path: geode-book/master_middleman/source/subnavs/geode-subnav.erb
##########
@@ -2189,25 +2189,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_api_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_api_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_api_compatible-with-redis.html#included-commands">Included 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_api_compatible-with-redis.html#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_api_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_api_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_api_compatible-with-redis.html#loss-of-connections">Loss of Connections</a>
Review comment:
Should this:
geode_api_compatible-with-redis
be this:
geode_apis_compatible-with-redis?
adding the 's' to apis?
##########
File path: geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
##########
@@ -1921,46 +1921,43 @@
*/
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 is
+ * 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 is
+ * 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 API Compatible with Redis is not available.
+ * Set to true to enable the Geode APIs Compatible with Redis.
Review comment:
I don't think we should capitalize "Compatible".
##########
File path: 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 is not available. Set
+to true to enable the <%=vars.product_name%> APIs Compatible with Redis.</td>
Review comment:
I don't think we should capitalize "Compatible".
##########
File path: geode-redis/src/distributedTest/java/org/apache/geode/redis/GeodeRedisServerStartupDUnitTest.java
##########
@@ -241,13 +241,13 @@ public void startupFailsGivenPortAlreadyInUse() throws Exception {
public void startupFailsGivenInvalidBindAddress() {
int port = AvailablePortHelper.getRandomAvailableTCPPort();
- addIgnoredException("Could not start Redis Server");
+ addIgnoredException("Could not start Server Compatible with Redis");
Review comment:
I don't think we should capitalize "Compatible".
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/statistics/GeodeRedisStats.java
##########
@@ -72,7 +72,7 @@ public GeodeRedisStats(StatisticsFactory factory, String textId,
type = statisticsTypeFactory
.createType("RedisStats",
Review comment:
Perhaps if we changed it to something like:
"statsForServerCompatibleWithRedis" ?
##########
File path: 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_api_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%> API 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.
Review comment:
I don't think we should capitalize "Compatible".
##########
File path: geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
##########
@@ -1921,46 +1921,43 @@
*/
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 is
+ * 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 is
+ * not available.
+ * Set to true to enable the Geode APIs Compatible with Redis.</td>
Review comment:
I don't think we should capitalize "Compatible".
##########
File path: geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
##########
@@ -1921,46 +1921,43 @@
*/
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 is
+ * listening. If set to the empty string or this property is not specified, the server listens on
+ * all local addresses.
Review comment:
I don't think we should capitalize "Compatible".
##########
File path: geode-docs/tools_modules/geode_api_compatible-with-redis.html.md.erb
##########
@@ -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 with Redis compatibility enabled, you can execute the
Review comment:
If you already have some Geode servers running that are compatible with Redis, you can execute the...
##########
File path: 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
Review comment:
I don't think we should capitalize "Compatible".
##########
File path: geode-docs/tools_modules/geode_api_compatible-with-redis.html.md.erb
##########
@@ -17,55 +17,54 @@ 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_api_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
Review comment:
I don't think we should capitalize "Compatible".
##########
File path: geode-docs/tools_modules/geode_api_compatible-with-redis.html.md.erb
##########
@@ -17,55 +17,54 @@ 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_api_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:
```pre
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 Geode 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
-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.
Review comment:
I don't think we should capitalize "Compatible".
##########
File path: 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 is 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>
Review comment:
I don't think we should capitalize "Compatible".
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/gfsh/RedisCommand.java
##########
@@ -31,7 +31,7 @@
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.";
Review comment:
I don't think we should capitalize "Compatible".
##########
File path: geode-docs/tools_modules/geode_api_compatible-with-redis.html.md.erb
##########
@@ -17,55 +17,54 @@ 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
Review comment:
I don't think we should capitalize "Compatible".
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/gfsh/RedisCommandFunction.java
##########
@@ -36,7 +36,8 @@ public CliFunctionResult executeFunction(FunctionContext<Boolean> context) {
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: APIs Compatible with Redis is not enabled");
Review comment:
I don't think we should capitalize "Compatible".
"Error: APIs compatible with Redis are not enabled"
##########
File path: geode-book/master_middleman/source/subnavs/geode-subnav.erb
##########
@@ -2189,25 +2189,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_api_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_api_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_api_compatible-with-redis.html#included-commands">Included Redis Commands</a>
Review comment:
Should this be "supported" instead of "included"?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] jomartin-999 commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
jomartin-999 commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597200663
##########
File path: geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
##########
@@ -1921,46 +1921,44 @@
*/
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's API for Redis Compatibility is
+ * 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's API for Redis Compatibility is
Review comment:
Geode APIs compatible with Redis
##########
File path: geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
##########
@@ -1921,46 +1921,44 @@
*/
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's API for Redis Compatibility is
+ * 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's API for Redis Compatibility is
+ * not available.
+ * Set to true to enable the Geode's API for Compatibility 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 API for compatibility with
+ * Redis is not available.
+ * Set to true to enable the Geode API for compatibility with Redis.
Review comment:
When the default value of false, the Geode APIs compatible with Redis are not available. Set to true to enable Geode APIs compatible with Redis.
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -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 API for Compatibility with Redis. Unsupported
commands are available to use, but have not been fully tested. There is no guarantee they will work
exactly as expected.
Review comment:
@nonbinaryprogrammer & @ringles Should we remove this content?
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -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 with Redis Compatibility enabled, you can execute the
+following command with gfsh to enable unsupported commands:
Review comment:
If you already have <%=vars.produce_name%> servers enabled with the APIs compatible with Redis, you can execute the
@ringles & @nonbinaryprogrammer Should we remove this content as well?
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/PassiveExpirationManager.java
##########
@@ -80,7 +80,8 @@ private void doDataExpiration(
}
} catch (CacheClosedException ignore) {
} catch (RuntimeException | Error ex) {
- logger.warn("Passive Redis expiration failed. Will try again in 1 second.", ex);
+ logger.warn("Passive Compatibility with Redis expiration failed. Will try again in 1 second.",
Review comment:
Passive expiration failed. Will try again in 1 second.
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/data/RedisString.java
##########
@@ -649,8 +649,9 @@ protected void applyDelta(DeltaInfo deltaInfo) {
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(
+ "Compatibility with Redis APPEND sequence mismatch - delta sequence number: "
+ + appendDeltaInfo.getSequence() + " current sequence number: " + appendSequence);
Review comment:
(remove "Compatibility with Redis" - so it reads:
APPEND sequence mismatch - delta sequence number:
Does Redis throw an error like this as well? We should think about what users will need to do if they come across this message.
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/netty/NettyRedisServer.java
##########
@@ -101,7 +101,7 @@ public NettyRedisServer(Supplier<DistributionConfig> configSupplier,
if (port < RANDOM_PORT_INDICATOR) {
throw new IllegalArgumentException(
- "Redis port cannot be less than " + RANDOM_PORT_INDICATOR);
+ "Compatibility with Redis Port cannot be less than " + RANDOM_PORT_INDICATOR);
Review comment:
The compatible-with-redis-port property cannot be less than "
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/netty/ExecutionHandlerContext.java
##########
@@ -349,10 +349,10 @@ private void logResponse(RedisResponse response, String extraMessage, Throwable
if (logger.isDebugEnabled() && response != null) {
ByteBuf buf = response.encode(new UnpooledByteBufAllocator(false));
if (cause == null) {
- logger.debug("Redis command returned: {} - {}",
+ logger.debug("Compatible with Redis Command returned: {} - {}",
Review comment:
"Redis command returned:
##########
File path: 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%> API for Compatibility 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%> API for Compatibility with Redis is not available. Set
+to true to enable the <%=vars.product_name%> API for Compatibility with Redis.</td>
Review comment:
When the default value of false, the <%=vars.product_name%> APIs compatible with Redis is not available. Set
to true to enable the <%=vars.product_name%> APIs compatible with Redis.
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -17,55 +17,54 @@ 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%> API for Compatibility 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%>
+<%=vars.product_name%>’s scaling capabilities without changing their client code. Redis Clients connect to a <%=vars.product_name%>
Review comment:
Redis clients connect to a
##########
File path: geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
##########
@@ -1921,46 +1921,44 @@
*/
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's API for Redis Compatibility is
+ * 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's API for Redis Compatibility is
+ * not available.
+ * Set to true to enable the Geode's API for Compatibility with Redis.</td>
Review comment:
Set to true to enable Geode APIs compatible with Redis.
##########
File path: geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
##########
@@ -1921,46 +1921,44 @@
*/
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's API for Redis Compatibility is
Review comment:
We should change this to…
Specifies the address on which the Geode APIs compatible with Redis listen.
##########
File path: 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%> API for Compatibility with Redis is listening. If set to the empty string or this property is not
Review comment:
Specifies the address on which the <%=vars.product_name%> APIs compatible with Redis are listening. If set to the empty string or this property is not
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -1,4 +1,4 @@
-<% set_title("Redis API for", product_name) %>
+<% set_title(product_name, "API for Compatibility with Redis") %>
Review comment:
set_title(product_name, "APIs compatible with Redis")
Note we should update the file names to reflect the new naming structure...
geode_apis_compatible_with_redis.html. (we'll also need to update links in other files).
##########
File path: geode-core/src/test/resources/org/apache/geode/management/internal/cli/commands/golden-help-offline.properties
##########
@@ -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 API for Compatibility with Redis service listens on for Compatibility with Redis clients.\n\
Review comment:
Sets the port that the Geode APIs compatible with Redis service listens on for Redis clients.
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -17,55 +17,54 @@ 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%> API for Compatibility 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%>
+<%=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" />
-## <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
Review comment:
APIs compatible with Redis
##########
File path: 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%> API for Compatibility 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%> API for Compatibility with Redis is not available. Set
+to true to enable the <%=vars.product_name%> API for Compatibility 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%> API for Compatibility with Redis connections. A value of 0 selects a random port.</td>
Review comment:
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.
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -116,7 +115,7 @@ Commands not listed above are **not implemented**.
<%=vars.product_name%>’s primary advantage is its **scalability**. While the Redis server is single threaded, <%=vars.product_name%> supports high concurrency. Many Redis clients can execute commands on the <%=vars.product_name%> cluster simultaneously.
-<%=vars.product_name%>'s architecture and management features help detect and resolve **network partitioning** problems without explicit management on the part of the Redis client.
+<%=vars.product_name%>'s architecture and management features help detect and resolve **network partitioning** problems without explicit management on the part of the Redis Client.
Review comment:
on the part of the Redis client.
##########
File path: geode-book/master_middleman/source/subnavs/geode-subnav.erb
##########
@@ -2189,13 +2189,13 @@ 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/redis_api_for_geode.html">Compatible with Redis API for <%=vars.product_name%></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/redis_api_for_geode.html#using-the-api">Using <%=vars.product_name%>'s Compatibility with Redis API</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/redis_api_for_geode.html#included-commands">Included Compatible with Redis Commands</a>
Review comment:
We should be able to remove "Compatible with" here, as we are talking about Redis Commands.
This could be better phrased as:
Supported Redis Commands
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -134,12 +133,12 @@ data.
## <a id="loss-of-connections" class="no-quick-link"></a>Loss of Connections
There are a number of events that might occur within the <%=vars.product_name%> cluster that can result
-in the cluster closing the connection to the Redis client. Losing the connection to the cluster does not
+in the cluster closing the connection to the Redis Client. Losing the connection to the cluster does not
Review comment:
closing the connection to the Redis client.
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -17,55 +17,54 @@ 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%> API for Compatibility with Redis allows <%=vars.product_name%> to function as a drop-in replacement for a
Review comment:
The <%=vars.product_name%> APIs compatible with Redis allows <%=vars.product_name%> to function as a drop-in replacement for a
##########
File path: geode-core/src/test/resources/org/apache/geode/management/internal/cli/commands/golden-help-offline.properties
##########
@@ -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 API for Compatibility with Redis service listens on for Compatibility with 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 API for Compatibility with Redis service listens on for Compatibility with Redis clients. The default is to\n\
Review comment:
Sets the IP address the Geode APIs compatible with Redis service listens on for Redis clients. The default is to
##########
File path: geode-redis/src/distributedTest/java/org/apache/geode/redis/GeodeRedisServerStartupDUnitTest.java
##########
@@ -219,14 +219,14 @@ public void startupFailsGivenIllegalPort() {
.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");
Review comment:
addIgnoredException("Could not start Server compatible with Redis"); - Is this the same message that gets logged?
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -17,55 +17,54 @@ 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%> API for Compatibility 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%>
+<%=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" />
-## <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:
```pre
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 Geode 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
-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%> API for Compatibility 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.
Review comment:
The <%=vars.product_name%> APIs compatible with Redis currently supports the following Redis commands.
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -134,12 +133,12 @@ data.
## <a id="loss-of-connections" class="no-quick-link"></a>Loss of Connections
There are a number of events that might occur within the <%=vars.product_name%> cluster that can result
-in the cluster closing the connection to the Redis client. Losing the connection to the cluster does not
+in the cluster closing the connection to the Redis Client. Losing the connection to the cluster does not
imply that the server is no longer available.
When the connection is lost, the client should attempt to reconnect to the same server before
attempting to connect to another server.
-The Redis client is responsible for knowing the addresses of all servers.
+The Redis Compatiblity Client is responsible for knowing the addresses of all servers.
Review comment:
The Redis client is
##########
File path: geode-redis/src/distributedTest/java/org/apache/geode/redis/session/springRedisTestApplication/config/DUnitSocketAddressResolver.java
##########
@@ -48,7 +48,7 @@ public InetSocketAddress resolve(RedisURI redisUri) {
int redisPort =
Integer.parseInt(redisPorts[indexOfLastRedisPortReturned++ % redisPorts.length]);
- logger.info("Redis client creating connection to port " + redisPort);
+ logger.info("Compatible with Redis Client creating connection to port " + redisPort);
Review comment:
Redis client creating connection to port " + redisPort
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/gfsh/RedisCommand.java
##########
@@ -31,7 +31,7 @@
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 API for Compatibility 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 "
Review comment:
@ringles & @nonbinaryprogrammer Should we remove these?
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -134,12 +133,12 @@ data.
## <a id="loss-of-connections" class="no-quick-link"></a>Loss of Connections
There are a number of events that might occur within the <%=vars.product_name%> cluster that can result
-in the cluster closing the connection to the Redis client. Losing the connection to the cluster does not
+in the cluster closing the connection to the Redis Client. Losing the connection to the cluster does not
imply that the server is no longer available.
When the connection is lost, the client should attempt to reconnect to the same server before
attempting to connect to another server.
-The Redis client is responsible for knowing the addresses of all servers.
+The Redis Compatiblity Client is responsible for knowing the addresses of all servers.
In the case of a connection failure, an invoked command may or may not complete.
-The Redis client is responsible for deciding if the command should be retried.
+The Compatible with Redis Client is responsible for deciding if the command should be retried.
Review comment:
The Redis client
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/gfsh/RedisCommand.java
##########
@@ -31,7 +31,7 @@
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 API for Compatibility with Redis.";
Review comment:
"Commands related to the Geode APIs compatible with Redis."
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/netty/ExecutionHandlerContext.java
##########
@@ -281,7 +281,7 @@ public void channelInactive(ChannelHandlerContext ctx) {
private void executeCommand(Command command) {
try {
if (logger.isDebugEnabled()) {
- logger.debug("Executing Redis command: {} - {}", command,
+ logger.debug("Executing Compatible with Redis command: {} - {}", command,
Review comment:
"Executing Redis command:"
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/gfsh/RedisCommandFunction.java
##########
@@ -36,7 +36,8 @@ public CliFunctionResult executeFunction(FunctionContext<Boolean> context) {
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: Compatibility with Redis is not enabled");
Review comment:
"Error: APIs compatible with Redis are not enabled"
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/netty/ExecutionHandlerContext.java
##########
@@ -349,10 +349,10 @@ private void logResponse(RedisResponse response, String extraMessage, Throwable
if (logger.isDebugEnabled() && response != null) {
ByteBuf buf = response.encode(new UnpooledByteBufAllocator(false));
if (cause == null) {
- logger.debug("Redis command returned: {} - {}",
+ logger.debug("Compatible with Redis Command returned: {} - {}",
Command.getHexEncodedString(buf.array(), buf.readableBytes()), extraMessage);
} else {
- logger.debug("Redis command FAILED to return: {} - {}",
+ logger.debug("Compatible with Redis Command FAILED to return: {} - {}",
Review comment:
"Redis command FAILED to return
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/RegionProvider.java
##########
@@ -80,7 +80,7 @@ public RegionProvider(InternalCache cache) {
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",
Review comment:
Could not start server compatible with Redis - System property '%s' must be <= %d
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/netty/NettyRedisServer.java
##########
@@ -258,7 +258,7 @@ private static InetAddress getBindAddress(String requestedAddress) {
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
Review comment:
Could not start server compatible with Redis using bind address:
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/netty/NettyRedisServer.java
##########
@@ -218,7 +218,7 @@ private Channel createBoundChannel(ServerBootstrap serverBootstrap, int requeste
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 +
Review comment:
Could not start server compatible with Redis using bind address:
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/netty/ExecutionHandlerContext.java
##########
@@ -326,7 +326,7 @@ private void executeCommand(Command command) {
channelInactive(command.getChannelHandlerContext());
}
} catch (Exception e) {
- logger.warn("Execution of Redis command {} failed: {}", command, e);
+ logger.warn("Execution of Compatibility with Redis command {} failed: {}", command, e);
Review comment:
"Execution of Redis command"
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/statistics/GeodeRedisStats.java
##########
@@ -72,7 +72,7 @@ public GeodeRedisStats(StatisticsFactory factory, String textId,
type = statisticsTypeFactory
.createType("RedisStats",
- "Statistics for a GemFire Redis Server",
+ "Statistics for a Geode Compatible with Redis Server",
Review comment:
"Statistics for Geode APIs compatible with Redis"
##########
File path: geode-redis/src/performanceTest/environment-setup.sh
##########
@@ -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}'"
Review comment:
No server compatible with Redis
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/statistics/GeodeRedisStats.java
##########
@@ -72,7 +72,7 @@ public GeodeRedisStats(StatisticsFactory factory, String textId,
type = statisticsTypeFactory
.createType("RedisStats",
Review comment:
"RedisStats" - Does this string show-up anywhere user facing?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] nonbinaryprogrammer commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
nonbinaryprogrammer commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r596439158
##########
File path: geode-redis/src/integrationTest/java/org/apache/geode/redis/SSLTest.java
##########
@@ -41,8 +41,8 @@
@ClassRule
public static ServerStarterRule sslEnabledServer = new ServerStarterRule()
.withSSL("server", true, true)
- .withProperty("redis-bind-address", "localhost")
- .withProperty("redis-port", "11211")
+ .withProperty("compatible-with-redis-bind-address", "localhost")
+ .withProperty("compatible-with-redis-port", "11211")
.withProperty("redis-enabled", "true")
Review comment:
I made a whole bunch of changes, including the ones you mentioned. thank you for reviewing so quickly though :)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] jomartin-999 commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
jomartin-999 commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597194502
##########
File path: geode-book/master_middleman/source/subnavs/geode-subnav.erb
##########
@@ -2189,13 +2189,13 @@ 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/redis_api_for_geode.html">Compatible with Redis API for <%=vars.product_name%></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/redis_api_for_geode.html#using-the-api">Using <%=vars.product_name%>'s Compatibility with Redis API</a>
Review comment:
Same thing here:
"Using [product]'s APIs Compatible with Redis.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] nonbinaryprogrammer commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
nonbinaryprogrammer commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597071573
##########
File path: geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
##########
@@ -1921,46 +1921,48 @@
*/
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's API for Redis Compatibility is
+ * 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's API for Redis compatibility is
+ * not available.
+ * Set to true to enable the Geode's API for Redis compatibility.</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>compatible-with-redis-enabled</td>
+ * <td>When the default value of false, the <%=vars.product_name%> API for compatibility with
+ * Redis is not available.
+ * Set to true to enable the <%=vars.product_name%> API for compatibility with Redis.</td>
Review comment:
I left everything else the same and just changed the text, so as far as I know it seems like it should be fine as is
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] sabbey37 commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
sabbey37 commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597042947
##########
File path: geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
##########
@@ -1921,46 +1921,48 @@
*/
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's API for Redis Compatibility is
+ * 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's API for Redis compatibility is
+ * not available.
+ * Set to true to enable the Geode's API for Redis compatibility.</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>compatible-with-redis-enabled</td>
+ * <td>When the default value of false, the <%=vars.product_name%> API for compatibility with
+ * Redis is not available.
+ * Set to true to enable the <%=vars.product_name%> API for compatibility with Redis.</td>
Review comment:
I recognize that this code was here beforehand, but I don't think we can use the `<%=vars.product_name%>` variable here. Not sure that it gets resolved. Also, it doesn't seem like this is a table, all the other descriptions utilize a `<p>` tag.
##########
File path: geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
##########
@@ -1921,46 +1921,48 @@
*/
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's API for Redis Compatibility is
+ * 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's API for Redis compatibility is
+ * not available.
+ * Set to true to enable the Geode's API for Redis compatibility.</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>compatible-with-redis-enabled</td>
+ * <td>When the default value of false, the <%=vars.product_name%> API for compatibility with
+ * Redis is not available.
+ * Set to true to enable the <%=vars.product_name%> API for compatibility with Redis.</td>
Review comment:
I recognize this code was here beforehand, but I don't think we can use the `<%=vars.product_name%>` variable here. Not sure that it gets resolved. Also, it doesn't seem like this is a table, all the other descriptions utilize a `<p>` tag.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] jomartin-999 commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
jomartin-999 commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597258574
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/statistics/GeodeRedisStats.java
##########
@@ -72,7 +72,7 @@ public GeodeRedisStats(StatisticsFactory factory, String textId,
type = statisticsTypeFactory
.createType("RedisStats",
Review comment:
Okay. Someone mentioned perhaps that string shows up in VSD?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] jomartin-999 commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
jomartin-999 commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597677972
##########
File path: geode-docs/tools_modules/geode_api_compatible_with_redis.html.md.erb
##########
@@ -17,55 +17,54 @@ 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_api_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:
```pre
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 Geode 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.
Review comment:
Should we be mentioning DataDog by name? or just make it generic to 'some monitoring tools' ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] sabbey37 commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
sabbey37 commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597075448
##########
File path: geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
##########
@@ -1921,46 +1921,48 @@
*/
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's API for Redis Compatibility is
+ * 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's API for Redis compatibility is
+ * not available.
+ * Set to true to enable the Geode's API for Redis compatibility.</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>compatible-with-redis-enabled</td>
+ * <td>When the default value of false, the <%=vars.product_name%> API for compatibility with
+ * Redis is not available.
+ * Set to true to enable the <%=vars.product_name%> API for compatibility with Redis.</td>
Review comment:
I don't think it's ok that it's there or that it will get resolved. I'm not sure how it got there beforehand (it might've actually been me who put it in), but we should fix it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] nonbinaryprogrammer commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
nonbinaryprogrammer commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597249385
##########
File path: geode-redis/src/distributedTest/java/org/apache/geode/redis/GeodeRedisServerStartupDUnitTest.java
##########
@@ -219,14 +219,14 @@ public void startupFailsGivenIllegalPort() {
.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");
Review comment:
yes, it is. or at least the main part of the message. I think addIgnoredException keys off a substring, not necessarily an exact match
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] jomartin-999 commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
jomartin-999 commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597259408
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -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 API for Compatibility with Redis. Unsupported
commands are available to use, but have not been fully tested. There is no guarantee they will work
exactly as expected.
Review comment:
Sounds good. Thank you!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] nonbinaryprogrammer commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
nonbinaryprogrammer commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597131152
##########
File path: geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
##########
@@ -1921,46 +1921,48 @@
*/
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's API for Redis Compatibility is
+ * 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's API for Redis compatibility is
+ * not available.
+ * Set to true to enable the Geode's API for Redis compatibility.</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>compatible-with-redis-enabled</td>
+ * <td>When the default value of false, the <%=vars.product_name%> API for compatibility with
+ * Redis is not available.
+ * Set to true to enable the <%=vars.product_name%> API for compatibility with Redis.</td>
Review comment:
fixed
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] nonbinaryprogrammer commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
nonbinaryprogrammer commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597268737
##########
File path: geode-book/master_middleman/source/subnavs/geode-subnav.erb
##########
@@ -2189,25 +2189,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_api_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_api_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_api_compatible-with-redis.html#included-commands">Included 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_api_compatible-with-redis.html#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_api_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_api_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_api_compatible-with-redis.html#loss-of-connections">Loss of Connections</a>
Review comment:
does that combination of _ and - make sense? I don't think I meant to do that
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] nonbinaryprogrammer commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
nonbinaryprogrammer commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597252116
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/data/RedisString.java
##########
@@ -649,8 +649,9 @@ protected void applyDelta(DeltaInfo deltaInfo) {
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(
+ "Compatibility with Redis APPEND sequence mismatch - delta sequence number: "
+ + appendDeltaInfo.getSequence() + " current sequence number: " + appendSequence);
Review comment:
redis does not appear to throw any such exception, and it seems like we will rarely, if ever, throw it. I have no idea what a user would do about it. @ringles and @jhutchison worked on the delta stuff so they may have a better idea of when this will happen
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] jomartin-999 commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
jomartin-999 commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597257848
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/statistics/GeodeRedisStats.java
##########
@@ -72,7 +72,7 @@ public GeodeRedisStats(StatisticsFactory factory, String textId,
type = statisticsTypeFactory
.createType("RedisStats",
- "Statistics for a GemFire Redis Server",
+ "Statistics for a Geode Compatible with Redis Server",
Review comment:
Yup! Thank you!!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] nonbinaryprogrammer commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
nonbinaryprogrammer commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597872303
##########
File path: geode-redis/src/distributedTest/java/org/apache/geode/redis/GeodeRedisServerStartupDUnitTest.java
##########
@@ -219,14 +219,14 @@ public void startupFailsGivenIllegalPort() {
.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");
Review comment:
oh yeah, I changed the exception in a previous commit but forgot to change it here. thanks!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] sabbey37 commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
sabbey37 commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597754956
##########
File path: geode-redis/src/distributedTest/java/org/apache/geode/redis/GeodeRedisServerStartupDUnitTest.java
##########
@@ -219,14 +219,14 @@ public void startupFailsGivenIllegalPort() {
.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");
Review comment:
So silly thing, but it looks like this DUnit test is failing because it is case sensitive and the s in server should be lowercase.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] jomartin-999 commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
jomartin-999 commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597193990
##########
File path: geode-book/master_middleman/source/subnavs/geode-subnav.erb
##########
@@ -2189,13 +2189,13 @@ 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/redis_api_for_geode.html">Compatible with Redis API for <%=vars.product_name%></a>
Review comment:
For consistency, could we rephrase this to - Geode API's Compatible with Redis
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] nonbinaryprogrammer commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
nonbinaryprogrammer commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597252710
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/gfsh/RedisCommand.java
##########
@@ -31,7 +31,7 @@
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 API for Compatibility 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 "
Review comment:
I decided to leave everything related to unsupported commands because that seemed outside of the scope of this ticket
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] nonbinaryprogrammer commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
nonbinaryprogrammer commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597242605
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -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 API for Compatibility with Redis. Unsupported
commands are available to use, but have not been fully tested. There is no guarantee they will work
exactly as expected.
Review comment:
I left everything related to unsupported commands because I knew Ray and Hutch were going to take all that out. We'll probably have some annoying merge conflicts though
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] sabbey37 commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
sabbey37 commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597053621
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -17,55 +17,54 @@ 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%> API for Compatibility 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%>
+<%=vars.product_name%>’s scaling capabilities without changing their client code. Compatible with 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" />
-## <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 Compatible with Redis commands.
Review comment:
Similar to the above, it might make sense to leave this as `Redis commands` since we are actually issuing Redis commands (there is no special set of `Compatible with Redis commands`.
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -17,55 +17,54 @@ 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%> API for Compatibility 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%>
+<%=vars.product_name%>’s scaling capabilities without changing their client code. Compatible with Redis Clients connect to a <%=vars.product_name%>
Review comment:
It might make sense to leave this as just `Redis clients` vs `Compatible with Redis clients` since we're talking about actual Redis clients (Jedis, Lettuce, etc.) ... then maybe we could specify that the server is a `Geode APIs compatible with Redis server`?
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -105,18 +104,18 @@ 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**.
## <a id="advantages-over-redis" class="no-quick-link"></a>Advantages of <%=vars.product_name%> over Redis
-<%=vars.product_name%>’s primary advantage is its **scalability**. While the Redis server is single threaded, <%=vars.product_name%> supports high concurrency. Many Redis clients can execute commands on the <%=vars.product_name%> cluster simultaneously.
+<%=vars.product_name%>’s primary advantage is its **scalability**. While the Redis server is single threaded, <%=vars.product_name%> supports high concurrency. Many Redis-compatible clients can execute commands on the <%=vars.product_name%> cluster simultaneously.
-<%=vars.product_name%>'s architecture and management features help detect and resolve **network partitioning** problems without explicit management on the part of the Redis client.
+<%=vars.product_name%>'s architecture and management features help detect and resolve **network partitioning** problems without explicit management on the part of the Compatible with Redis Client.
Review comment:
I think this could also be `Redis client` since we are still talking about actual Redis clients (Jedis, Lettuce, etc.).
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -17,55 +17,54 @@ 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%> API for Compatibility 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%>
+<%=vars.product_name%>’s scaling capabilities without changing their client code. Compatible with 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" />
-## <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 Compatible with Redis commands.
Use gfsh to start at least one server with a command of the form:
```pre
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 Geode 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-compatible commands. The typical port used with a Redis-compatible cluster is 6379.
Review comment:
Same as above, this could just be `Redis commands`. Also, does the `compatible with` part need to come before Redis? so `compatible-with-Redis cluster` (or something) vs. `Redis-compatible` cluster?
##########
File path: geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
##########
@@ -1921,46 +1921,48 @@
*/
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's API for Redis Compatibility is
+ * 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's API for Redis compatibility is
+ * not available.
+ * Set to true to enable the Geode's API for Redis compatibility.</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>compatible-with-redis-enabled</td>
+ * <td>When the default value of false, the <%=vars.product_name%> API for compatibility with
+ * Redis is not available.
+ * Set to true to enable the <%=vars.product_name%> API for compatibility with Redis.</td>
Review comment:
I recognize that this code was here beforehand, but I don't think we can use the `<%=vars.product_name%>` variable here. Not sure that it gets resolved. Also, it doesn't seem like this is a table, all the other descriptions utilize a <p> tag.
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -105,18 +104,18 @@ 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**.
## <a id="advantages-over-redis" class="no-quick-link"></a>Advantages of <%=vars.product_name%> over Redis
-<%=vars.product_name%>’s primary advantage is its **scalability**. While the Redis server is single threaded, <%=vars.product_name%> supports high concurrency. Many Redis clients can execute commands on the <%=vars.product_name%> cluster simultaneously.
+<%=vars.product_name%>’s primary advantage is its **scalability**. While the Redis server is single threaded, <%=vars.product_name%> supports high concurrency. Many Redis-compatible clients can execute commands on the <%=vars.product_name%> cluster simultaneously.
Review comment:
Same as above, this could be `Redis clients`.
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -134,12 +133,12 @@ data.
## <a id="loss-of-connections" class="no-quick-link"></a>Loss of Connections
There are a number of events that might occur within the <%=vars.product_name%> cluster that can result
-in the cluster closing the connection to the Redis client. Losing the connection to the cluster does not
+in the cluster closing the connection to the Compatible with Redis Client. Losing the connection to the cluster does not
Review comment:
Same as above, I think this could be `Redis client`. Same goes for the two instances below this one.
##########
File path: geode-redis/README.md
##########
@@ -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 Compatible with Redis client will connect to.
Review comment:
Same as above, I think this could just be `Redis client`.
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -17,55 +17,54 @@ 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%> API for Compatibility 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%>
+<%=vars.product_name%>’s scaling capabilities without changing their client code. Compatible with 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" />
-## <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 Compatible with Redis commands.
Use gfsh to start at least one server with a command of the form:
```pre
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 Geode 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-compatible commands. The typical port used with a Redis-compatible cluster 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="included-commands" class="no-quick-link"></a>Included Compatible with Redis Commands
Review comment:
Same as above, this could just be `Redis Commands`.
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -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 <%=vars.product_name%> API for Compatibility with Redis commands are **unsupported**. Unsupported
Review comment:
I realize we were saying `Redis API for Geode commands` before, but I think it makes sense for this to just be `Redis commands` since we are talking about actual Redis commands that we don't support rather than a special set of commands we've created.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] nonbinaryprogrammer commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
nonbinaryprogrammer commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597277336
##########
File path: geode-book/master_middleman/source/subnavs/geode-subnav.erb
##########
@@ -2189,25 +2189,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_api_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_api_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_api_compatible-with-redis.html#included-commands">Included Redis Commands</a>
Review comment:
good catch, this way was broken
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] nonbinaryprogrammer commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
nonbinaryprogrammer commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597256291
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/statistics/GeodeRedisStats.java
##########
@@ -72,7 +72,7 @@ public GeodeRedisStats(StatisticsFactory factory, String textId,
type = statisticsTypeFactory
.createType("RedisStats",
Review comment:
I don't think so
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] sabbey37 commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
sabbey37 commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r596349636
##########
File path: geode-redis/src/integrationTest/java/org/apache/geode/redis/SSLTest.java
##########
@@ -41,8 +41,8 @@
@ClassRule
public static ServerStarterRule sslEnabledServer = new ServerStarterRule()
.withSSL("server", true, true)
- .withProperty("redis-bind-address", "localhost")
- .withProperty("redis-port", "11211")
+ .withProperty("compatible-with-redis-bind-address", "localhost")
+ .withProperty("compatible-with-redis-port", "11211")
.withProperty("redis-enabled", "true")
Review comment:
Is the `redis-enabled` property ok or should that be changed as well?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] sabbey37 commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
sabbey37 commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597740769
##########
File path: geode-redis/src/distributedTest/java/org/apache/geode/redis/GeodeRedisServerStartupDUnitTest.java
##########
@@ -219,14 +219,14 @@ public void startupFailsGivenIllegalPort() {
.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");
Review comment:
So silly thing, but it looks like this DUnit test is failing because it is case sensitive and the s in `server` should be lowercase.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] jomartin-999 commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
jomartin-999 commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597259969
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/gfsh/RedisCommand.java
##########
@@ -31,7 +31,7 @@
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 API for Compatibility 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 "
Review comment:
Sounds good!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] jomartin-999 commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
jomartin-999 commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597194502
##########
File path: geode-book/master_middleman/source/subnavs/geode-subnav.erb
##########
@@ -2189,13 +2189,13 @@ 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/redis_api_for_geode.html">Compatible with Redis API for <%=vars.product_name%></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/redis_api_for_geode.html#using-the-api">Using <%=vars.product_name%>'s Compatibility with Redis API</a>
Review comment:
Same thing here:
"Using <product>'s API compatible with Redis.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] Bill commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
Bill commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r600029611
##########
File path: geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
##########
@@ -1921,46 +1921,43 @@
*/
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 is
Review comment:
should be "APIs…are listening". Or use singular "API"
##########
File path: geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
##########
@@ -1921,46 +1921,43 @@
*/
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 is
+ * 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 is
Review comment:
"APIs…are not available"
##########
File path: geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
##########
@@ -1921,46 +1921,43 @@
*/
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 is
+ * 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 is
+ * 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 is not available.
Review comment:
ditto
##########
File path: geode-core/src/main/java/org/apache/geode/distributed/ConfigurationProperties.java
##########
@@ -1921,46 +1921,43 @@
*/
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 is
+ * 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 is
+ * 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 is 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
Review comment:
It seems like you should also change this from "Redis API for Geode" to something mentioning the "the Geode APIs compatible with Redis" as you did above (if it's important)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] sabbey37 commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
sabbey37 commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597740769
##########
File path: geode-redis/src/distributedTest/java/org/apache/geode/redis/GeodeRedisServerStartupDUnitTest.java
##########
@@ -219,14 +219,14 @@ public void startupFailsGivenIllegalPort() {
.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");
Review comment:
So silly thing, but it looks like this DUnit test is failing because it is case sensitive and the s in `server` should be lowercase.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] nonbinaryprogrammer merged pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
nonbinaryprogrammer merged pull request #6150:
URL: https://github.com/apache/geode/pull/6150
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] jomartin-999 commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
jomartin-999 commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597674468
##########
File path: geode-book/master_middleman/source/subnavs/geode-subnav.erb
##########
@@ -2189,25 +2189,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_api_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_api_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_api_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_api_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_api_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_api_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_api_compatible_with_redis.html#loss-of-connections">Loss of Connections</a>
</li>
</ul>
</li>
Review comment:
I think the file name should be
geode_apis_compatible_with_redis.html
api needs an 's' at the end of it.
##########
File path: 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 is not available. Set
Review comment:
APIs compatible with Redis **is** not available - I think the 'is' should be 'are'
##########
File path: geode-docs/tools_modules/geode_api_compatible_with_redis.html.md.erb
##########
@@ -17,55 +17,54 @@ 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_api_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:
```pre
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 Geode 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.
Review comment:
**Note**: SLOWLOG is implemented as a NoOp for compatibility with DataDog.
Should we be mentioning DataDog by name? or just make it generic to 'some monitoring tools' ?
##########
File path: geode-docs/tools_modules/geode_api_compatible_with_redis.html.md.erb
##########
@@ -17,55 +17,54 @@ 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_api_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:
```pre
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 Geode server compatible with Redis will be started.
Review comment:
Geode server compatible with Redis will be started. - Does 'Geode' in this sentence need to be <%=vars.product_name%> ?
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/netty/ExecutionHandlerContext.java
##########
@@ -326,7 +326,7 @@ private void executeCommand(Command command) {
channelInactive(command.getChannelHandlerContext());
}
} catch (Exception e) {
- logger.warn("Execution of Redis command {} failed: {}", command, e);
+ logger.warn("Execution Redis command {} failed: {}", command, e);
Review comment:
Execution **of** Redis command {} failed: {} - I think the 'of' accidentally was deleted
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] nonbinaryprogrammer commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
nonbinaryprogrammer commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597255357
##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/statistics/GeodeRedisStats.java
##########
@@ -72,7 +72,7 @@ public GeodeRedisStats(StatisticsFactory factory, String textId,
type = statisticsTypeFactory
.createType("RedisStats",
- "Statistics for a GemFire Redis Server",
+ "Statistics for a Geode Compatible with Redis Server",
Review comment:
I think that "Statistics for a Geode server compatible with Redis" makes more sense. is that ok?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] jomartin-999 commented on a change in pull request #6150: GEODE-9045: rename redis properties and reword error messages
Posted by GitBox <gi...@apache.org>.
jomartin-999 commented on a change in pull request #6150:
URL: https://github.com/apache/geode/pull/6150#discussion_r597193990
##########
File path: geode-book/master_middleman/source/subnavs/geode-subnav.erb
##########
@@ -2189,13 +2189,13 @@ 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/redis_api_for_geode.html">Compatible with Redis API for <%=vars.product_name%></a>
Review comment:
For consistency, could we rephrase this to - Geode APIs Compatible with Redis
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org