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 2022/01/28 18:35:22 UTC
[GitHub] [geode] jomartin-999 opened a new pull request #7326: GEODE-9999-Update the Geode for Redis documentation
jomartin-999 opened a new pull request #7326:
URL: https://github.com/apache/geode/pull/7326
<!-- 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.
To unsubscribe, e-mail: notifications-unsubscribe@geode.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] jomartin-999 commented on a change in pull request #7326: GEODE-9999: Update the Geode for Redis documentation
Posted by GitBox <gi...@apache.org>.
jomartin-999 commented on a change in pull request #7326:
URL: https://github.com/apache/geode/pull/7326#discussion_r794886316
##########
File path: geode-docs/tools_modules/geode_for_redis.html.md.erb
##########
@@ -17,25 +17,22 @@ limitations under the License.
<% set_title(product_name, "for Redis") %>
-<%=vars.product_name%> for Redis allows <%=vars.product_name%> to function as a drop-in replacement for a
+<%=vars.product_name%> for Redis allows <%=vars.product_name%> to function as 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.
+<%=vars.product_name%>’s scaling capabilities with minimal changes to their client code.
-<img src="../images_svg/geode_for_redis.svg" class="image" />
## <a id="using-geode-for-redis"></a>Using <%=vars.product_name%> for Redis
+To use the <%=vars.product_name%> for Redis feature, the cluster must have at least one server that has enabled the feature to handle incoming Redis commands.
-The <%=vars.product_name%> cluster must have at least one server that is set up to handle the incoming Redis commands.
-
-Prerequisites for running the examples:
+Prerequisites:
Review comment:
Agreed. Changed and updated to reflect feedback.
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@geode.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] DonalEvans commented on a change in pull request #7326: GEODE-9999: Update the Geode for Redis documentation
Posted by GitBox <gi...@apache.org>.
DonalEvans commented on a change in pull request #7326:
URL: https://github.com/apache/geode/pull/7326#discussion_r794774023
##########
File path: geode-docs/tools_modules/geode_for_redis.html.md.erb
##########
@@ -229,27 +233,12 @@ integer (+/- 9223372036854775807) for CURSOR.
| server | redis_version<br/>redis_mode (always returns "cluster" because <%=vars.product_name%> for Redis always runs in cluster mode.)<br/>tcp_port<br/>uptime_in_seconds<br/>uptime_in_days |
| stats | total_commands_processed<br/>instantaneous_ops_per_sec<br/>total_net_input_bytes<br/>instantaneous_input_kbps<br/>total_connections_received<br/>keyspace_hits<br/>keyspace_misses<br/>evicted_keys (always returns 0)<br/>rejected_connections (always returns 0)<br/>pubsub_channels<br/>pubsub_patterns|
-## <a id="advantages-over-redis"></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 architecture and management features help detect and resolve **network partitioning** problems without explicit management on the part of the Redis client.
-
-<%=vars.product_name%> for Redis partitions data across multiple servers and keeps replicated data up to date _synchronously_, whereas Redis uses asynchronous replication.
-This provides a higher level of data consistency within the cluster.
-
## <a id="expiration-accuracy"></a>Expiration Accuracy
Keys are expired in two ways, actively and passively:
-- With active expiration, expiration is evaluated whenever a key is accessed. If the key is due to expire, it is deleted. Active expiration is accurate to the millisecond.
-- With passive expiration, keys are evaluated every three minutes. If they are due to expire, they are deleted. Passive expiration is accurate to the second.
-
-## <a id="high-availability-model"></a>High Availability Model
-
-Data is stored in a single partitioned region that by default has one redundant copy.
-In practice this means that the cluster can tolerate the loss of a single server without the loss of
-data.
+- With active expiration, expiration is evaluated **whenever a key is accessed**. If the key is due to expire, it is deleted. Active expiration is accurate to the millisecond.
+- With passive expiration, keys are evaluated **every three minutes**. If they are due to expire, they are deleted. Passive expiration is accurate to the second.
Review comment:
I'm not certain about the "Passive expiration is accurate to the second" here. What does this actually mean? If we're only checking for passive expiration every three minutes, it seems like we're only accurate to within three minutes? Maybe this would be better removed?
##########
File path: geode-docs/tools_modules/geode_for_redis.html.md.erb
##########
@@ -17,25 +17,22 @@ limitations under the License.
<% set_title(product_name, "for Redis") %>
-<%=vars.product_name%> for Redis allows <%=vars.product_name%> to function as a drop-in replacement for a
+<%=vars.product_name%> for Redis allows <%=vars.product_name%> to function as 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.
+<%=vars.product_name%>’s scaling capabilities with minimal changes to their client code.
-<img src="../images_svg/geode_for_redis.svg" class="image" />
## <a id="using-geode-for-redis"></a>Using <%=vars.product_name%> for Redis
+To use the <%=vars.product_name%> for Redis feature, the cluster must have at least one server that has enabled the feature to handle incoming Redis commands.
-The <%=vars.product_name%> cluster must have at least one server that is set up to handle the incoming Redis commands.
-
-Prerequisites for running the examples:
+Prerequisites:
1. **Install <%=vars.product_name%>** <br/>
Using the instructions in the `README.md` file in the root of the <%=vars.product_name%> checkout directory, build and install <%=vars.product_name%>.
2. **Install the Redis CLI** <br/>
Follow installation instructions at https://redis.io/download
Review comment:
This wording might make it sound like a prerequisite for using geode-for-redis is to have the Redis CLI installed, which is not strictly true, it's just used in this example to ping the server. Maybe this could be changed to something along the lines of "have a Redis client so you can connect to the server" for the prerequisite, and then say "in this example we'll be using the Redis CLI, which can be installed from here..."?
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@geode.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] jomartin-999 commented on a change in pull request #7326: GEODE-9999: Update the Geode for Redis documentation
Posted by GitBox <gi...@apache.org>.
jomartin-999 commented on a change in pull request #7326:
URL: https://github.com/apache/geode/pull/7326#discussion_r794886599
##########
File path: geode-docs/tools_modules/geode_for_redis.html.md.erb
##########
@@ -17,25 +17,22 @@ limitations under the License.
<% set_title(product_name, "for Redis") %>
-<%=vars.product_name%> for Redis allows <%=vars.product_name%> to function as a drop-in replacement for a
+<%=vars.product_name%> for Redis allows <%=vars.product_name%> to function as 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.
+<%=vars.product_name%>’s scaling capabilities with minimal changes to their client code.
-<img src="../images_svg/geode_for_redis.svg" class="image" />
Review comment:
Removed in recent update. Thank you for catching this!
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@geode.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] jomartin-999 commented on a change in pull request #7326: GEODE-9999: Update the Geode for Redis documentation
Posted by GitBox <gi...@apache.org>.
jomartin-999 commented on a change in pull request #7326:
URL: https://github.com/apache/geode/pull/7326#discussion_r797863812
##########
File path: geode-docs/tools_modules/geode_for_redis.html.md.erb
##########
@@ -167,6 +153,25 @@ public static ConfigureRedisAction configureRedisAction() {
This is a known solution for many Managed Redis products (ElastiCache, Azure Cache for Redis, etc.) that disable the CONFIG command for security reasons.
You can read more about why this is done in the [Spring Session issue report](https://github.com/spring-projects/spring-session/issues/124).
+- If your application is using **redis-py-cluster** you will need to specificy the option **"skip_full_coverage_check=True"** when creating the connection to the cluster.
+ This is a known solution for many Managed Redis products (ElastiCache, Azure Cache for Redis, etc) that disable the CONFIG command for security reasons.
Review comment:
Fixed! 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.
To unsubscribe, e-mail: notifications-unsubscribe@geode.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] jomartin-999 commented on a change in pull request #7326: GEODE-9999: Update the Geode for Redis documentation
Posted by GitBox <gi...@apache.org>.
jomartin-999 commented on a change in pull request #7326:
URL: https://github.com/apache/geode/pull/7326#discussion_r794886014
##########
File path: geode-docs/tools_modules/geode_for_redis.html.md.erb
##########
@@ -17,25 +17,22 @@ limitations under the License.
<% set_title(product_name, "for Redis") %>
-<%=vars.product_name%> for Redis allows <%=vars.product_name%> to function as a drop-in replacement for a
+<%=vars.product_name%> for Redis allows <%=vars.product_name%> to function as 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.
+<%=vars.product_name%>’s scaling capabilities with minimal changes to their client code.
-<img src="../images_svg/geode_for_redis.svg" class="image" />
## <a id="using-geode-for-redis"></a>Using <%=vars.product_name%> for Redis
+To use the <%=vars.product_name%> for Redis feature, the cluster must have at least one server that has enabled the feature to handle incoming Redis commands.
-The <%=vars.product_name%> cluster must have at least one server that is set up to handle the incoming Redis commands.
-
-Prerequisites for running the examples:
+Prerequisites:
1. **Install <%=vars.product_name%>** <br/>
Using the instructions in the `README.md` file in the root of the <%=vars.product_name%> checkout directory, build and install <%=vars.product_name%>.
2. **Install the Redis CLI** <br/>
Follow installation instructions at https://redis.io/download
Review comment:
Agreed. Changed and updated to reflect feedback.
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@geode.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] ezoerner commented on a change in pull request #7326: GEODE-9999: Update the Geode for Redis documentation
Posted by GitBox <gi...@apache.org>.
ezoerner commented on a change in pull request #7326:
URL: https://github.com/apache/geode/pull/7326#discussion_r794783430
##########
File path: geode-docs/tools_modules/geode_for_redis.html.md.erb
##########
@@ -17,25 +17,22 @@ limitations under the License.
<% set_title(product_name, "for Redis") %>
-<%=vars.product_name%> for Redis allows <%=vars.product_name%> to function as a drop-in replacement for a
+<%=vars.product_name%> for Redis allows <%=vars.product_name%> to function as 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.
+<%=vars.product_name%>’s scaling capabilities with minimal changes to their client code.
-<img src="../images_svg/geode_for_redis.svg" class="image" />
Review comment:
The image file itself should also be removed (as Hale pointed out in Slack).
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@geode.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] davebarnes97 commented on pull request #7326: GEODE-9999: Update the Geode for Redis documentation
Posted by GitBox <gi...@apache.org>.
davebarnes97 commented on pull request #7326:
URL: https://github.com/apache/geode/pull/7326#issuecomment-1024522456
@jomartin-999 Since I'm reviewing for style & format, rather than functionality, I'll defer my review until you've addressed Donal's concerns.
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@geode.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] DonalEvans merged pull request #7326: GEODE-9999: Update the Geode for Redis documentation
Posted by GitBox <gi...@apache.org>.
DonalEvans merged pull request #7326:
URL: https://github.com/apache/geode/pull/7326
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@geode.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] DonalEvans commented on pull request #7326: GEODE-9999: Update the Geode for Redis documentation
Posted by GitBox <gi...@apache.org>.
DonalEvans commented on pull request #7326:
URL: https://github.com/apache/geode/pull/7326#issuecomment-1027294010
> There's one formatting change that I think is important to the readability of the docs. Also this isn't something that you changed, but the note on line 219 does not say anywhere in it that it is for the HSCAN command. Obviously it is a footnote of the HSCAN command so it isn't like that info is missing, but all the other footnotes start with the command they are talking about, and I think consistency is nice.
This footnote applies to HSCAN, ZSCAN and SSCAN, not just HSCAN, so if this change is made, it should mention all three commands.
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@geode.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] nonbinaryprogrammer commented on a change in pull request #7326: GEODE-9999: Update the Geode for Redis documentation
Posted by GitBox <gi...@apache.org>.
nonbinaryprogrammer commented on a change in pull request #7326:
URL: https://github.com/apache/geode/pull/7326#discussion_r796054988
##########
File path: geode-docs/tools_modules/geode_for_redis.html.md.erb
##########
@@ -167,6 +153,25 @@ public static ConfigureRedisAction configureRedisAction() {
This is a known solution for many Managed Redis products (ElastiCache, Azure Cache for Redis, etc.) that disable the CONFIG command for security reasons.
You can read more about why this is done in the [Spring Session issue report](https://github.com/spring-projects/spring-session/issues/124).
+- If your application is using **redis-py-cluster** you will need to specificy the option **"skip_full_coverage_check=True"** when creating the connection to the cluster.
+ This is a known solution for many Managed Redis products (ElastiCache, Azure Cache for Redis, etc) that disable the CONFIG command for security reasons.
Review comment:
formatting on this line is weird. it should be indented one tab to match the rest of the list. right now it looks like the next point is a sub-point of this one.
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@geode.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] jomartin-999 commented on a change in pull request #7326: GEODE-9999: Update the Geode for Redis documentation
Posted by GitBox <gi...@apache.org>.
jomartin-999 commented on a change in pull request #7326:
URL: https://github.com/apache/geode/pull/7326#discussion_r794886183
##########
File path: geode-docs/tools_modules/geode_for_redis.html.md.erb
##########
@@ -229,27 +233,12 @@ integer (+/- 9223372036854775807) for CURSOR.
| server | redis_version<br/>redis_mode (always returns "cluster" because <%=vars.product_name%> for Redis always runs in cluster mode.)<br/>tcp_port<br/>uptime_in_seconds<br/>uptime_in_days |
| stats | total_commands_processed<br/>instantaneous_ops_per_sec<br/>total_net_input_bytes<br/>instantaneous_input_kbps<br/>total_connections_received<br/>keyspace_hits<br/>keyspace_misses<br/>evicted_keys (always returns 0)<br/>rejected_connections (always returns 0)<br/>pubsub_channels<br/>pubsub_patterns|
-## <a id="advantages-over-redis"></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 architecture and management features help detect and resolve **network partitioning** problems without explicit management on the part of the Redis client.
-
-<%=vars.product_name%> for Redis partitions data across multiple servers and keeps replicated data up to date _synchronously_, whereas Redis uses asynchronous replication.
-This provides a higher level of data consistency within the cluster.
-
## <a id="expiration-accuracy"></a>Expiration Accuracy
Keys are expired in two ways, actively and passively:
-- With active expiration, expiration is evaluated whenever a key is accessed. If the key is due to expire, it is deleted. Active expiration is accurate to the millisecond.
-- With passive expiration, keys are evaluated every three minutes. If they are due to expire, they are deleted. Passive expiration is accurate to the second.
-
-## <a id="high-availability-model"></a>High Availability Model
-
-Data is stored in a single partitioned region that by default has one redundant copy.
-In practice this means that the cluster can tolerate the loss of a single server without the loss of
-data.
+- With active expiration, expiration is evaluated **whenever a key is accessed**. If the key is due to expire, it is deleted. Active expiration is accurate to the millisecond.
+- With passive expiration, keys are evaluated **every three minutes**. If they are due to expire, they are deleted. Passive expiration is accurate to the second.
Review comment:
Agreed. Removed and updated to reflect feedback.
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@geode.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] jomartin-999 commented on a change in pull request #7326: GEODE-9999: Update the Geode for Redis documentation
Posted by GitBox <gi...@apache.org>.
jomartin-999 commented on a change in pull request #7326:
URL: https://github.com/apache/geode/pull/7326#discussion_r794865872
##########
File path: geode-docs/tools_modules/geode_for_redis.html.md.erb
##########
@@ -229,27 +233,12 @@ integer (+/- 9223372036854775807) for CURSOR.
| server | redis_version<br/>redis_mode (always returns "cluster" because <%=vars.product_name%> for Redis always runs in cluster mode.)<br/>tcp_port<br/>uptime_in_seconds<br/>uptime_in_days |
| stats | total_commands_processed<br/>instantaneous_ops_per_sec<br/>total_net_input_bytes<br/>instantaneous_input_kbps<br/>total_connections_received<br/>keyspace_hits<br/>keyspace_misses<br/>evicted_keys (always returns 0)<br/>rejected_connections (always returns 0)<br/>pubsub_channels<br/>pubsub_patterns|
-## <a id="advantages-over-redis"></a>Advantages of <%=vars.product_name%> over Redis
Review comment:
I removed this section as it did not feel as though it was the best place or way to do compare this implementation vs OSS 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.
To unsubscribe, e-mail: notifications-unsubscribe@geode.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] jomartin-999 commented on a change in pull request #7326: GEODE-9999: Update the Geode for Redis documentation
Posted by GitBox <gi...@apache.org>.
jomartin-999 commented on a change in pull request #7326:
URL: https://github.com/apache/geode/pull/7326#discussion_r794865872
##########
File path: geode-docs/tools_modules/geode_for_redis.html.md.erb
##########
@@ -229,27 +233,12 @@ integer (+/- 9223372036854775807) for CURSOR.
| server | redis_version<br/>redis_mode (always returns "cluster" because <%=vars.product_name%> for Redis always runs in cluster mode.)<br/>tcp_port<br/>uptime_in_seconds<br/>uptime_in_days |
| stats | total_commands_processed<br/>instantaneous_ops_per_sec<br/>total_net_input_bytes<br/>instantaneous_input_kbps<br/>total_connections_received<br/>keyspace_hits<br/>keyspace_misses<br/>evicted_keys (always returns 0)<br/>rejected_connections (always returns 0)<br/>pubsub_channels<br/>pubsub_patterns|
-## <a id="advantages-over-redis"></a>Advantages of <%=vars.product_name%> over Redis
Review comment:
I removed this section as it did not feel as though it was the best place or way to compare this implementation vs OSS 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.
To unsubscribe, e-mail: notifications-unsubscribe@geode.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] jomartin-999 commented on a change in pull request #7326: GEODE-9999: Update the Geode for Redis documentation
Posted by GitBox <gi...@apache.org>.
jomartin-999 commented on a change in pull request #7326:
URL: https://github.com/apache/geode/pull/7326#discussion_r794924578
##########
File path: geode-docs/tools_modules/geode_for_redis.html.md.erb
##########
@@ -131,32 +113,35 @@ to implement redundant copies and this property corresponds to the partitioned r
Security is implemented slightly differently to OSS Redis. Redis stores password information in plain text in the redis.conf file.
-When using <%=vars.product_name%>, to enable security, a Security Manager needs to be configured on the server(s).
-This Security Manager will authenticate `AUTH <password>` commands and `AUTH <username> <password>` commands.
-Users can set a custom `default` username using the `geode-for-redis-username` parameter.
-If users don't set this parameter, the default username will be "default".
-This username will be used when `AUTH <password>` commands are sent without a `<username>`.
+When using <%=vars.product_name%>, to enable security, a Security Manager needs to be configured on the server(s) or _all_ `AUTH` requests will fail.
+
+This Security Manager will authenticate the `AUTH <password>` command and the `AUTH <username> <password>` command.
+Similar to OSS Redis, when users send the `AUTH <password>` command without a username, the system will use the default username `default`.
Review comment:
Updated from OSS Redis to Open Source 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.
To unsubscribe, e-mail: notifications-unsubscribe@geode.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] ezoerner commented on a change in pull request #7326: GEODE-9999: Update the Geode for Redis documentation
Posted by GitBox <gi...@apache.org>.
ezoerner commented on a change in pull request #7326:
URL: https://github.com/apache/geode/pull/7326#discussion_r794770935
##########
File path: geode-docs/tools_modules/geode_for_redis.html.md.erb
##########
@@ -17,25 +17,22 @@ limitations under the License.
<% set_title(product_name, "for Redis") %>
-<%=vars.product_name%> for Redis allows <%=vars.product_name%> to function as a drop-in replacement for a
+<%=vars.product_name%> for Redis allows <%=vars.product_name%> to function as 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.
+<%=vars.product_name%>’s scaling capabilities with minimal changes to their client code.
-<img src="../images_svg/geode_for_redis.svg" class="image" />
## <a id="using-geode-for-redis"></a>Using <%=vars.product_name%> for Redis
+To use the <%=vars.product_name%> for Redis feature, the cluster must have at least one server that has enabled the feature to handle incoming Redis commands.
-The <%=vars.product_name%> cluster must have at least one server that is set up to handle the incoming Redis commands.
-
-Prerequisites for running the examples:
+Prerequisites:
Review comment:
I had written "Prerequisites for running the examples" instead of just "Prerequisites" because installing the Redis CLI isn't really a prerequisite for running the product, is it?
##########
File path: geode-docs/tools_modules/geode_for_redis.html.md.erb
##########
@@ -17,25 +17,22 @@ limitations under the License.
<% set_title(product_name, "for Redis") %>
-<%=vars.product_name%> for Redis allows <%=vars.product_name%> to function as a drop-in replacement for a
+<%=vars.product_name%> for Redis allows <%=vars.product_name%> to function as 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.
+<%=vars.product_name%>’s scaling capabilities with minimal changes to their client code.
-<img src="../images_svg/geode_for_redis.svg" class="image" />
## <a id="using-geode-for-redis"></a>Using <%=vars.product_name%> for Redis
+To use the <%=vars.product_name%> for Redis feature, the cluster must have at least one server that has enabled the feature to handle incoming Redis commands.
-The <%=vars.product_name%> cluster must have at least one server that is set up to handle the incoming Redis commands.
-
-Prerequisites for running the examples:
+Prerequisites:
Review comment:
The Redis CLI should be mentioned as optional rather than a prerequisite
##########
File path: geode-docs/tools_modules/geode_for_redis.html.md.erb
##########
@@ -229,27 +233,12 @@ integer (+/- 9223372036854775807) for CURSOR.
| server | redis_version<br/>redis_mode (always returns "cluster" because <%=vars.product_name%> for Redis always runs in cluster mode.)<br/>tcp_port<br/>uptime_in_seconds<br/>uptime_in_days |
| stats | total_commands_processed<br/>instantaneous_ops_per_sec<br/>total_net_input_bytes<br/>instantaneous_input_kbps<br/>total_connections_received<br/>keyspace_hits<br/>keyspace_misses<br/>evicted_keys (always returns 0)<br/>rejected_connections (always returns 0)<br/>pubsub_channels<br/>pubsub_patterns|
-## <a id="advantages-over-redis"></a>Advantages of <%=vars.product_name%> over Redis
Review comment:
Part of the original ticket was to add a section for advantages of using Geode for Redis, but if you don't think that it belongs here then ok
##########
File path: geode-docs/tools_modules/geode_for_redis.html.md.erb
##########
@@ -131,32 +113,35 @@ to implement redundant copies and this property corresponds to the partitioned r
Security is implemented slightly differently to OSS Redis. Redis stores password information in plain text in the redis.conf file.
-When using <%=vars.product_name%>, to enable security, a Security Manager needs to be configured on the server(s).
-This Security Manager will authenticate `AUTH <password>` commands and `AUTH <username> <password>` commands.
-Users can set a custom `default` username using the `geode-for-redis-username` parameter.
-If users don't set this parameter, the default username will be "default".
-This username will be used when `AUTH <password>` commands are sent without a `<username>`.
+When using <%=vars.product_name%>, to enable security, a Security Manager needs to be configured on the server(s) or _all_ `AUTH` requests will fail.
+
+This Security Manager will authenticate the `AUTH <password>` command and the `AUTH <username> <password>` command.
+Similar to OSS Redis, when users send the `AUTH <password>` command without a username, the system will use the default username `default`.
Review comment:
Haven't we been calling it "native Redis", not "OSS Redis"? Technically Geode for Redis is also OSS Redis, isn't 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.
To unsubscribe, e-mail: notifications-unsubscribe@geode.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode] davebarnes97 edited a comment on pull request #7326: GEODE-9999: Update the Geode for Redis documentation
Posted by GitBox <gi...@apache.org>.
davebarnes97 edited a comment on pull request #7326:
URL: https://github.com/apache/geode/pull/7326#issuecomment-1024522456
@jomartin-999 Since I'm reviewing for style & format, rather than functionality, I'll defer my review until you've addressed Donal's concerns. (And congratulations on the very cool JIRA ticket number.)
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@geode.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org