jomartin-999 commented on a change in pull request #6844:
URL: https://github.com/apache/geode/pull/6844#discussion_r703828649
##########
File path: geode-apis-compatible-with-redis/README.md
##########
@@ -56,14 +53,40 @@ Your Geode instance should now be up and running (1 locator
and 1 server) and re
To confirm the server is listening, in a separate terminal run:
```console
-redis-cli -h <compatibleWithRedisBindAddress> -p <compatibleWithRedisPort> -a
<compatibleWithRedisPassword> ping
+redis-cli -h <compatibleWithRedisBindAddress> -p <compatibleWithRedisPort> ping
```
- 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 name="adding-a-server"></a>Optional - Adding an additional Geode server
with compatible with Redis APIS
+## <a name="security"></a>Security
+
+Security is implemented slightly differently to Redis. To enable security, a
Security Manager needs to be configured. This Security Manager will
authenticate `AUTH username password` commands. Instead of a default,
system-wide password, a default username can be set using the
`geode-compatible-with-redis-username` parameter. This username is used when
`AUTH` commands are sent with only a password.
+
+For example, the following gfsh command will configure a
`SimpleSecurityManager`:
+
+```console
+start server \
+ --name=<serverName> \
+ --locators=<locatorPort> \
+ --compatible-with-redis-port=<compatibleWithRedisPort> \
+ --compatible-with-redis-bind-address=<compatibleWithRedisBindAddress> \
+ --compatible-with-redis-username=<compatibleWithRedisUsername> \
+
--J=-Dgemfire.security-manager=org.apache.geode.examples.SimpleSecurityManager
+```
+
+To confirm that the server is working, in a separate terminal run:
+
+```console
+redis-cli -h <compatibleWithRedisBindAddress> -p <compatibleWithRedisPort>
--user <compatibleWithRedisUsername> -a <compatibleWithRedisUsername> ping
Review comment:
I believe they will need to add "-c" when starting the cli in cluster
mode.
We should also link to or have an example of how one would actually use a
security manager in production. For example, users would include the jar in
their server startup...and do they have to include it in every startup? Also
noting that that if they don't start with a security manager, they'll have
to....delete the instance and start a new one?
##########
File path: geode-apis-compatible-with-redis/README.md
##########
@@ -56,14 +53,40 @@ Your Geode instance should now be up and running (1 locator
and 1 server) and re
To confirm the server is listening, in a separate terminal run:
```console
-redis-cli -h <compatibleWithRedisBindAddress> -p <compatibleWithRedisPort> -a
<compatibleWithRedisPassword> ping
+redis-cli -h <compatibleWithRedisBindAddress> -p <compatibleWithRedisPort> ping
Review comment:
Users also need to add a -c (and maybe the port) in order to connect in
cluster mode.
##########
File path: geode-apis-compatible-with-redis/README.md
##########
@@ -14,7 +14,7 @@ Note: This feature is experimental and is subject to change
in future releases o
The Geode APIs compatible with Redis allow Geode to function as a drop-in
replacement for a highly-available Redis data store, letting Redis applications
take advantage of Geode’s scaling capabilities without changing their client
code.
-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.
+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
username/password authentication.
Review comment:
I think we need to update this section include something about clients
that support CLUSTER commands only, at this time.
Are we actually going to accept username and password in the same way that
Redis does? or just password...
We should be explicit in the forms that we accept. Also, aren't we removing
the password parameter? I think we need to make this are a bit clearer on what
actually happens.
##########
File path: geode-apis-compatible-with-redis/README.md
##########
@@ -56,14 +53,40 @@ Your Geode instance should now be up and running (1 locator
and 1 server) and re
To confirm the server is listening, in a separate terminal run:
```console
-redis-cli -h <compatibleWithRedisBindAddress> -p <compatibleWithRedisPort> -a
<compatibleWithRedisPassword> ping
+redis-cli -h <compatibleWithRedisBindAddress> -p <compatibleWithRedisPort> ping
```
- 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 name="adding-a-server"></a>Optional - Adding an additional Geode server
with compatible with Redis APIS
+## <a name="security"></a>Security
+
+Security is implemented slightly differently to Redis. To enable security, a
Security Manager needs to be configured. This Security Manager will
authenticate `AUTH username password` commands. Instead of a default,
system-wide password, a default username can be set using the
`geode-compatible-with-redis-username` parameter. This username is used when
`AUTH` commands are sent with only a password.
Review comment:
Can we link the **Security Manager** mention to the Security Manager
section in the docs?
I think here we need to be explicit in saying that we support both AUTH
(password only) and AUTH (username & password). Right now it sounds like we
only accept the latter.
We should also mention that if no username is set, the system will default
[insert whatever default username we select 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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
