You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by he...@apache.org on 2021/05/25 16:23:28 UTC
[geode] branch support/1.14 updated: GEODE-9294: Final Pass of 1.14
Docs (#6509)
This is an automated email from the ASF dual-hosted git repository.
heybales pushed a commit to branch support/1.14
in repository https://gitbox.apache.org/repos/asf/geode.git
The following commit(s) were added to refs/heads/support/1.14 by this push:
new 4b48944 GEODE-9294: Final Pass of 1.14 Docs (#6509)
4b48944 is described below
commit 4b48944e1999471b6795c31ff2c2789955264df2
Author: Hale Bales <hb...@vmware.com>
AuthorDate: Tue May 25 09:22:09 2021 -0700
GEODE-9294: Final Pass of 1.14 Docs (#6509)
check over the docs to make sure that they make sense and match the current behavior in 1.14. removes an unused image and updates a diagram used in our erb docs
---
geode-apis-compatible-with-redis/README.md | 106 ++++++++-------------
geode-apis-compatible-with-redis/gfsh.png | Bin 16270 -> 0 bytes
.../geode_apis_compatible_with_redis.html.md.erb | 84 +++++-----------
.../geode_apis_compatible_with_redis.svg | 8 +-
4 files changed, 67 insertions(+), 131 deletions(-)
diff --git a/geode-apis-compatible-with-redis/README.md b/geode-apis-compatible-with-redis/README.md
index 2ee7cd1..6b25ade 100644
--- a/geode-apis-compatible-with-redis/README.md
+++ b/geode-apis-compatible-with-redis/README.md
@@ -1,14 +1,13 @@
-# Apache Geode APIs Compatible with Redis
+# <a name="top"></a>Apache Geode APIs Compatible with Redis
Note: This feature is experimental and is subject to change in future releases of Apache Geode.
-[Introduction](#introduction)
-[How To Try It](#how-to-try-it)
-[Building Apache Geode](#building-apache-geode)
-[Starting a Geode Server with Redis Enabled](#starting-a-server)
-[Adding an Additional Geode Server Compatible with Redis](#adding-a-server)
-[Shutting Down](#shutting-down)
-[Redis Commands](#redis-commands)
+1. [Introduction](#introduction)
+2. [How To Try It](#how-to-try-it)
+ i. [Starting a Geode Server Compatible with Redis](#starting-a-server)
+ ii. [Adding an Additional Geode Server Compatible with Redis](#adding-a-server)
+ iii. [Shutting Down](#shutting-down)
+3. [Redis Commands](#redis-commands)
## <a name="introduction"></a>Introduction
@@ -16,14 +15,14 @@ The Geode APIs compatible with Redis allow Geode to function as a drop-in replac
Redis clients connect to a Geode server in the same way they connect to a Redis server, using a hostname and a port number, with optional password authentication.
-### <a name="redis-commands"></a>Supported Redis Commands
-
-Not all Redis commands are supported. See [Supported Redis Commands](#supported-redis-commands) for the implemented subset.
+Note: Not all Redis commands are supported. See [Supported Redis Commands](#supported-redis-commands) for the implemented subset.
## <a name="how-to-try-it"></a>How To Try It
Install and configure Geode v1.14 or later.
+### <a name="starting-a-server"></a>Starting a Geode Server with APIs Compatible with Redis Enabled
+
Use gfsh to start at least one server with a command of the form:
```console
@@ -38,13 +37,9 @@ start server \
If any of the options `compatible-with-redis-bind-address`, `compatible-with-redis-password`, or `compatible-with-redis-port` are included, a Geode server with APIs compatible with Redis will be started.
- Replace `<serverName>` with the name of your server.
-
- Replace `<locatorPort>` with your locator port.
-
- Replace `<compatibleWithRedisPort>` with the port that the Geode server listens on for Redis commands. The typical port used with a cluster compatible with Redis is 6379.
-
- Replace `<compatibleWithRedisBindAddress>` with the address of the server host.
-
- Replace `<compatibleWithWithRedisPassword>` with the password clients use to authenticate.
Your Geode instance should now be up and running (1 locator and 1 server) and ready to accept Redis
@@ -63,7 +58,9 @@ redis-cli -h <compatibleWithRedisBindAddress> -p <compatibleWithRedisPort> -a <c
If the server is functioning properly, you should see a response of `PONG`.
-### <a name="adding-a-server"></a>Optional - Adding an additional Geode server with compatible with Redis APIS
+[Return to top](#top)
+
+### <a name="adding-a-server"></a>Optional - Adding an Additional Geode Server Compatible with Redis
If you’re interested in testing Geode scalability, in gfsh run the `start server` command again BUT
make sure you change the `--name=` and `--redis-port=` parameters.
@@ -71,6 +68,7 @@ For example:
```commandLine
$ start server --name=redisServer2 --locators=localhost[10334] --server-port=0 --compatible-with-redis-port=6380
```
+[Return to top](#top)
### <a name="shutting-down"></a>Shutting Down
To shut down the Geode instance you started, in the terminal with gfsh running type the following command
@@ -91,11 +89,13 @@ To confirm that everything shut down correctly, if you execute a Redis command i
Could not connect to Redis at 127.0.0.1:6379: Connection refused
not connected>
```
+[Return to top](#top)
+
### <a name="redis-commands"></a>Redis Commands
The Geode APIs compatible with Redis implement a subset of the full Redis command set.
-#### <a name="supported-redis-commands"></a> Supported Redis Commands [Return to top](#introduction)
+#### <a name="supported-redis-commands"></a> Supported Redis Commands
- APPEND <br/>
- AUTH <br/>
- DECR <br/>
@@ -151,78 +151,48 @@ The Geode APIs compatible with Redis implement a subset of the full Redis comman
**NOTES:**
-<sup>1</sup>Redis accepts 64-bit signed integers for the HSCAN cursor and COUNT parameters. The Geode APIs compatible with Redis are limited to 32-bit integer values for these parameters.
+<sup>1</sup> Redis accepts 64-bit signed integers for the HSCAN cursor and COUNT parameters. The Geode APIs compatible with Redis are limited to 32-bit integer values for these parameters.
<br/>
<sup>2</sup> INFO is implemented for the sections and fields listed below:
-
+ - server
+ - redis_version
+ - redis_mode (always returns "standalone")
+ - tcp_port
+ - uptime_in_seconds
+ - uptime_in_days
- clients
-
- connected_clients
-
- blocked_clients (always returns 0)
-
- - cluster
-
- - cluster_enables (always returns 0)
-
- - keyspace
-
- - returns stats for db: 0
-
- memory
-
- maxmemory
-
- used_memory
-
- - mem_fragmentation_ratio (always reports 1.00)
-
+ - mem_fragmentation_ratio (always reports 1.00)
- persistence
-
- loading (always returns 0)
-
- rdb_changes_since_last_save (always returns 0)
-
- rdb_last_save_time (always returns 0)
-
- - replication
-
- - role
-
- - connected_slaves (always returns 0)
-
- - server
-
- - redis_version
-
- - redis_mode
-
- - tcp_port
-
- - uptime_in_seconds
-
- - uptime_in_days
-
- stats
-
- total_commands_processed
-
- instantaneous_ops_per_sec
-
- total_net_input_bytes
-
- instantaneous_input_kbps
-
- total_connections_received
-
- keyspace_hits
-
- keyspace_misses
-
- evicted_keys (always returns 0)
-
- rejected_connections (always returns 0)
-
+ - keyspace
+ - returns stats for db: 0
+ - keys (returns num keys)
+ - expires (always returns 0)
+ - avg_ttl (always returns 0)
+ - replication
+ - role (always returns "master")
+ - connected_slaves (always returns 0)
+ - cluster
+ - cluster_enabled (always returns 0)
<br/>
-<sup>3</sup> SLOWLOG is implemented as a NoOp.
+<sup>3</sup> SLOWLOG is implemented as a NoOp.
+
+[Return to top](#top)
diff --git a/geode-apis-compatible-with-redis/gfsh.png b/geode-apis-compatible-with-redis/gfsh.png
deleted file mode 100644
index 8804022..0000000
Binary files a/geode-apis-compatible-with-redis/gfsh.png and /dev/null differ
diff --git a/geode-docs/developing/geode_apis_compatible_with_redis.html.md.erb b/geode-docs/developing/geode_apis_compatible_with_redis.html.md.erb
index c95204d..54d995b 100644
--- a/geode-docs/developing/geode_apis_compatible_with_redis.html.md.erb
+++ b/geode-docs/developing/geode_apis_compatible_with_redis.html.md.erb
@@ -27,7 +27,7 @@ optional password authentication.
<img src="../images_svg/geode_apis_compatible_with_redis.svg" class="image" />
-## <a id="using-the-api" class="no-quick-link"></a>Using the <%=vars.product_name%> API compatible with Redis
+## <a id="using-the-api" class="no-quick-link"></a>Using the <%=vars.product_name%> APIs Compatible with Redis
The <%=vars.product_name%> cluster must have at least one server that is set up to handle the incoming Redis commands.
@@ -45,16 +45,12 @@ start server \
If any of the options `compatible-with-redis-bind-address`, `compatible-with-redis-password`, or `compatible-with-redis-port`
are included, a <%=vars.product_name%> server with APIs compatible with Redis will be started.
-Replace `<serverName>` with the name of your server.
-
-Replace `<locatorPort>` with your locator port.
-
-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 `<compatibleWithRedisBindAddress>` with the address of the server host.
-
-Replace `<compatibleWithWithRedisPassword>` with the password clients use to authenticate.
+- Replace `<serverName>` with the name of your server.
+- Replace `<locatorPort>` with your locator port.
+- 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 `<compatibleWithRedisBindAddress>` with the address of the server host.
+- Replace `<compatibleWithWithRedisPassword>` with the password clients use to authenticate.
To confirm the server is listening, run:
@@ -137,73 +133,43 @@ These commands are supported for Redis 5.
**[2]** INFO is implemented for the sections and fields listed below:
+ - server
+ - redis_version
+ - redis_mode (always returns "standalone")
+ - tcp_port
+ - uptime_in_seconds
+ - uptime_in_days
- clients
-
- connected_clients
-
- blocked_clients (always returns 0)
-
- - cluster
-
- - cluster_enables (always returns 0)
-
- - keyspace
-
- - returns stats for db: 0
-
- memory
-
- maxmemory
-
- used_memory
-
- mem_fragmentation_ratio (always reports 1.00)
-
- persistence
-
- loading (always returns 0)
-
- rdb_changes_since_last_save (always returns 0)
-
- rdb_last_save_time (always returns 0)
-
- - replication
-
- - role
-
- - connected_slaves (always returns 0)
-
- - server
-
- - redis_version
-
- - redis_mode
-
- - tcp_port
-
- - uptime_in_seconds
-
- - uptime_in_days
-
- stats
-
- total_commands_processed
-
- instantaneous_ops_per_sec
-
- total_net_input_bytes
-
- instantaneous_input_kbps
-
- total_connections_received
-
- keyspace_hits
-
- keyspace_misses
-
- evicted_keys (always returns 0)
-
- rejected_connections (always returns 0)
+ - keyspace
+ - returns stats for db: 0
+ - keys (returns num keys)
+ - expires (always returns 0)
+ - avg_ttl (always returns 0)
+ - replication
+ - role (always returns "master")
+ - connected_slaves (always returns 0)
+ - cluster
+ - cluster_enabled (always returns 0)
**[3]** SLOWLOG is implemented as a NoOp.
@@ -217,8 +183,8 @@ These commands are supported for Redis 5.
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 second. If they are due to expire, they are deleted. Passive expiration is accurate to the second.
+- With active expiration, expiration is evaluated whenever a key is accessed. If the key is due to expire, it is deleted.
+- With passive expiration, keys are evaluated every 3 minutes. If they are due to expire, they are deleted.
## <a id="high-availability-model" class="no-quick-link"></a>High Availability Model
diff --git a/geode-docs/images_svg/geode_apis_compatible_with_redis.svg b/geode-docs/images_svg/geode_apis_compatible_with_redis.svg
index f983cf8..81f4818 100644
--- a/geode-docs/images_svg/geode_apis_compatible_with_redis.svg
+++ b/geode-docs/images_svg/geode_apis_compatible_with_redis.svg
@@ -3,13 +3,13 @@
<rect x="0.5" y="0.5" width="749" height="318" rx="3.5" fill="white" stroke="black"/>
<rect x="50" y="86" width="467" height="147" fill="url(#pattern0)"/>
<rect x="567" width="183" height="92" rx="4" fill="#A41F10"/>
+<rect x="836.5" y="8.5" width="246" height="75" rx="3.5" stroke="black"/>
+<rect x="836.5" y="119.5" width="246" height="75" rx="3.5" stroke="black"/>
<path d="M596.48 40H598.964L593.798 27.634H591.296L586.13 40H588.632L589.568 37.768H595.544L596.48 40ZM590.378 35.824L592.556 30.622L594.734 35.824H590.378ZM600.601 40H602.851V35.842H605.983C608.629 35.842 610.609 34.15 610.609 31.738C610.609 29.326 608.629 27.634 605.983 27.634H600.601V40ZM602.851 33.772V29.704H605.731C607.261 29.704 608.323 30.478 608.323 31.738C608.323 32.998 607.261 33.772 605.731 33.772H602.851ZM612.415 40H614.647V27.634H612.415V40ZM620.596 40.216C622.774 40.216 624 [...]
-<path d="M881.006 51H883.49L878.324 38.634H875.822L870.656 51H873.158L874.094 48.768H880.07L881.006 51ZM874.904 46.824L877.082 41.622L879.26 46.824H874.904ZM890.546 41.478C889.16 41.478 888.044 42.108 887.306 43.17V41.694H885.11V54.096H887.306V49.524C888.044 50.586 889.16 51.216 890.546 51.216C893.012 51.216 894.812 49.2 894.812 46.338C894.812 43.494 893.012 41.478 890.546 41.478ZM889.952 49.344C888.404 49.344 887.324 48.084 887.324 46.338C887.324 44.592 888.404 43.35 889.952 43.35C891.5 [...]
-<path d="M881.111 164H883.595L878.429 151.634H875.927L870.761 164H873.263L874.199 161.768H880.175L881.111 164ZM875.009 159.824L877.187 154.622L879.365 159.824H875.009ZM890.65 154.478C889.264 154.478 888.148 155.108 887.41 156.17V154.694H885.214V167.096H887.41V162.524C888.148 163.586 889.264 164.216 890.65 164.216C893.116 164.216 894.916 162.2 894.916 159.338C894.916 156.494 893.116 154.478 890.65 154.478ZM890.056 162.344C888.508 162.344 887.428 161.084 887.428 159.338C887.428 157.592 888 [...]
+<path d="M866.006 51H868.49L863.324 38.634H860.822L855.656 51H858.158L859.094 48.768H865.07L866.006 51ZM859.904 46.824L862.082 41.622L864.26 46.824H859.904ZM875.546 41.478C874.16 41.478 873.044 42.108 872.306 43.17V41.694H870.11V54.096H872.306V49.524C873.044 50.586 874.16 51.216 875.546 51.216C878.012 51.216 879.812 49.2 879.812 46.338C879.812 43.494 878.012 41.478 875.546 41.478ZM874.952 49.344C873.404 49.344 872.324 48.084 872.324 46.338C872.324 44.592 873.404 43.35 874.952 43.35C876.5 [...]
+<path d="M861.111 164H863.595L858.429 151.634H855.927L850.761 164H853.263L854.199 161.768H860.175L861.111 164ZM855.009 159.824L857.187 154.622L859.365 159.824H855.009ZM870.65 154.478C869.264 154.478 868.148 155.108 867.41 156.17V154.694H865.214V167.096H867.41V162.524C868.148 163.586 869.264 164.216 870.65 164.216C873.116 164.216 874.916 162.2 874.916 159.338C874.916 156.494 873.116 154.478 870.65 154.478ZM870.056 162.344C868.508 162.344 867.428 161.084 867.428 159.338C867.428 157.592 868 [...]
<line x1="750" y1="45.5" x2="836" y2="45.5" stroke="black"/>
<line x1="750" y1="158.5" x2="836" y2="158.5" stroke="black"/>
-<circle cx="835.5" cy="45.5" r="1.5" fill="black"/>
-<circle cx="835.5" cy="158.5" r="1.5" fill="black"/>
<defs>
<pattern id="pattern0" patternContentUnits="objectBoundingBox" width="1" height="1">
<use xlink:href="#image0" transform="translate(0 -0.00215054) scale(0.00129032 0.00409919)"/>