ezoerner commented on a change in pull request #7274: URL: https://github.com/apache/geode/pull/7274#discussion_r790033691
########## File path: geode-docs/tools_modules/geode_for_redis.html.md.erb ########## @@ -25,160 +25,320 @@ optional password authentication. <img src="../images_svg/geode_for_redis.svg" class="image" /> -## <a id="using-the-api" class="no-quick-link"></a>Using <%=vars.product_name%> for Redis +## <a id="using-geode-for-redis" class="no-quick-link"></a>Using <%=vars.product_name%> for Redis 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: +Prerequisites for running the examples: -```pre -start server \ +1. **Install Geode** \ + Using the instructions in the `README.md` file in the root of the <%=vars.product_name%> checkout directory, build and install Geode. +2. **Install the Redis CLI** \ + Follow installation instructions at https://redis.io/download + +Use `gfsh` to start a locator for managing a <%=vars.product_name%> cluster: +```commandLine +gfsh> start locator +``` + +Use `gfsh` to start at least one server with a command of the form: + +```commandLine +gfsh> start server --J=-Dgemfire.geode-for-redis-enabled=true --J=-Dgemfire.geode-for-redis-port=6379 +``` + +More information about the options when starting a server is given in the section [Start Server Options](#start-server-options). +Note that `gfsh` suppots tab completion which can help with long option names. + +To confirm the server is listening, in a separate terminal run: + +```commandLine +> redis-cli -c ping +``` + +The `-c` option enables cluster mode in the redis-cli, which is necessary since +<%=vars.product_name%> for Redis runs as a Redis Cluster. + +If the server is functioning properly, you should see a response of `PONG`. + +### <a name="adding-a-server"></a> Add an additional Geode server compatible with Redis APIs +If you’re interested in testing Geode scalability, in gfsh run the `start server` command again. + +However, there are two ports that must be unique for each server in the cluster, the +`gemfire.geode-for-redis-port`, used for receiving Redis commands, and the +`server-port`, which is used for cluster communication. + +The first server used `6379` for the redis port; we'll use `6380` for the second server. + +The first server was started without +a server port specified, so it used the default `40404`. To start up an additional server, you need to specify +a different server port, or use `--server-port=0` which tells <%=vars.product_name%> to use +an arbitrary available port for the server port. + +For example: +```commandLine +gfsh> start server --J=-Dgemfire.geode-for-redis-enabled=true --J=-Dgemfire.geode-for-redis-port=6380 --server-port=0 +``` + +### <a name="shutting-down"></a>Shutting Down +To shut down the Geode cluster you started, in the terminal with gfsh running type the following command + +```commandLine +gfsh> shutdown --include-locators=true +``` + +This command shuts down the entire Geode cluster. You are prompted with the following choice: + +```commandline +As a lot of data in memory will be lost, including possibly events in queues, do you really want to shutdown the entire distributed system? (Y/n) +``` + +To confirm that everything shut down correctly, if you execute a Redis command in the `redis-cli` you should see the following message: + +```commandline +Could not connect to Redis at 127.0.0.1:6379: Connection refused +``` + +## <a name="start-server-options"></a>Start Server Options + +The options that are specific to starting a server for <%=vars.product_name%> for Redis are listed below. +For other options see [start server](gfsh/command-pages/start.html#topic_3764EE2DB18B4AE4A625E0354471738A). + +### `gemfire.geode-for-redis-enabled` (Default: `false`) +If set to `true`, a <%=vars.product_name%> server with <%=vars.product_name%> for Redis will be started. + +### `gemfire.geode-for-redis-port` (Default: `6379`) +Specifies the port on which the <%=vars.product_name%> server +listens on for Redis commands. The typical port used with a cluster compatible with Redis is 6379 Review comment: I changed this to. Specifies the port on which the Geode server listens for Redis commands. Note that the default port `6379` is the same port that native Redis uses by default. ########## File path: geode-docs/tools_modules/geode_for_redis.html.md.erb ########## @@ -25,160 +25,320 @@ optional password authentication. <img src="../images_svg/geode_for_redis.svg" class="image" /> -## <a id="using-the-api" class="no-quick-link"></a>Using <%=vars.product_name%> for Redis +## <a id="using-geode-for-redis" class="no-quick-link"></a>Using <%=vars.product_name%> for Redis 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: +Prerequisites for running the examples: -```pre -start server \ +1. **Install Geode** \ + Using the instructions in the `README.md` file in the root of the <%=vars.product_name%> checkout directory, build and install Geode. +2. **Install the Redis CLI** \ + Follow installation instructions at https://redis.io/download + +Use `gfsh` to start a locator for managing a <%=vars.product_name%> cluster: +```commandLine +gfsh> start locator +``` + +Use `gfsh` to start at least one server with a command of the form: + +```commandLine +gfsh> start server --J=-Dgemfire.geode-for-redis-enabled=true --J=-Dgemfire.geode-for-redis-port=6379 +``` + +More information about the options when starting a server is given in the section [Start Server Options](#start-server-options). +Note that `gfsh` suppots tab completion which can help with long option names. + +To confirm the server is listening, in a separate terminal run: + +```commandLine +> redis-cli -c ping +``` + +The `-c` option enables cluster mode in the redis-cli, which is necessary since +<%=vars.product_name%> for Redis runs as a Redis Cluster. + +If the server is functioning properly, you should see a response of `PONG`. + +### <a name="adding-a-server"></a> Add an additional Geode server compatible with Redis APIs +If you’re interested in testing Geode scalability, in gfsh run the `start server` command again. + +However, there are two ports that must be unique for each server in the cluster, the +`gemfire.geode-for-redis-port`, used for receiving Redis commands, and the +`server-port`, which is used for cluster communication. + +The first server used `6379` for the redis port; we'll use `6380` for the second server. + +The first server was started without +a server port specified, so it used the default `40404`. To start up an additional server, you need to specify +a different server port, or use `--server-port=0` which tells <%=vars.product_name%> to use +an arbitrary available port for the server port. + +For example: +```commandLine +gfsh> start server --J=-Dgemfire.geode-for-redis-enabled=true --J=-Dgemfire.geode-for-redis-port=6380 --server-port=0 +``` + +### <a name="shutting-down"></a>Shutting Down +To shut down the Geode cluster you started, in the terminal with gfsh running type the following command + +```commandLine +gfsh> shutdown --include-locators=true +``` + +This command shuts down the entire Geode cluster. You are prompted with the following choice: + +```commandline +As a lot of data in memory will be lost, including possibly events in queues, do you really want to shutdown the entire distributed system? (Y/n) +``` + +To confirm that everything shut down correctly, if you execute a Redis command in the `redis-cli` you should see the following message: + +```commandline +Could not connect to Redis at 127.0.0.1:6379: Connection refused +``` + +## <a name="start-server-options"></a>Start Server Options + +The options that are specific to starting a server for <%=vars.product_name%> for Redis are listed below. +For other options see [start server](gfsh/command-pages/start.html#topic_3764EE2DB18B4AE4A625E0354471738A). + +### `gemfire.geode-for-redis-enabled` (Default: `false`) +If set to `true`, a <%=vars.product_name%> server with <%=vars.product_name%> for Redis will be started. + +### `gemfire.geode-for-redis-port` (Default: `6379`) +Specifies the port on which the <%=vars.product_name%> server +listens on for Redis commands. The typical port used with a cluster compatible with Redis is 6379 Review comment: I changed this to: Specifies the port on which the Geode server listens for Redis commands. Note that the default port `6379` is the same port that native Redis uses by default. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
