Introduction
How To Try It
Add an Additional Geode Server Compatible with Redis
Shutting Down
Security
Redis Commands
Geode for Redis allows Redis clients to use Geode as a highly-available Redis data store. Redis applications can take advantage of Geode’s scaling capabilities with minimal changes to the client code (Redis clients must be compatible with Redis CLUSTER commands).
Redis clients connect to a Geode server in the same way they connect to a Redis server, using a hostname and a port number.
Not all Redis commands are supported at this time. See Supported Redis Commands for the implemented subset.
Install and configure Geode v1.15 or later.
In a terminal, start Geode using the gfsh command.
With gfsh running, in the same terminal, start one locator
gfsh> start locator
Once the locator has started, start at least one server with a command of the form:
gfsh> start server \ --name=<serverName> \ --locators=localhost[<locatorPort>] \ --J=-Dgemfire.geode-for-redis-enabled=true \ --J=-Dgemfire.geode-for-redis-port=<geodeForRedisPort> \ --J=-Dgemfire.geode-for-redis-bind-address=<geodeForRedisBindAddress>
If the option geode-for-redis-enabled is set to true, a Geode server with Geode for Redis will be started.
Replace <serverName> with the name of your server.
Replace <locatorPort> with your locator port.
Replace <geodeForRedisPort> 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 <geodeForRedisBindAddress> with the address of the server host.
Your Geode instance should now be up and running (1 locator and 1 server) and ready to accept Redis commands.
Keep this terminal open and running so that you can easily shutdown the Geode instance when you are done working locally.
To confirm the server is listening, in a separate terminal run:
$> redis-cli -c -h <geodeForRedisBindAddress> -p <geodeForRedisPort> ping
<geodeForRedisBindAddress>, <geodeForRedisPort>, and <geodeForRedisPassword> with the same values as the server.If the server is functioning properly, you should see a response of PONG.
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.
For example:
gfsh> start server --name=redisServer2 --locators=localhost[10334] --server-port=0 --geode-for-redis-port=6380
To shut down the Geode instance you started, in the terminal with gfsh running type the following command
gfsh> shutdown --include-locators=true
This command shuts down the entire Geode instance/cluster. You are prompted with the following choice:
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:
Could not connect to Redis at 127.0.0.1:6379: Connection refused not connected>
Security is implemented slightly differently to OSS Redis. Redis stores password information in plain text in the redis.conf file.
When using Apache Geode, 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. This username will be used when AUTH <password> commands are sent without a <username>.
The following gfsh command will configure a SimpleSecurityManager:
gfsh> start server \ --name=<serverName> \ --locators=<locatorPort> \ --J=-Dgemfire.geode-for-redis-enabled=true \ --J=-Dgemfire.geode-for-redis-port=<geodeForRedisPort> \ --J=-Dgemfire.geode-for-redis-bind-address=<geodeForRedisBindAddress> \ --J=-Dgemfire.geode-for-redis-username=<geodeForRedisUsername> \ --J=-Dgemfire.security-manager=org.apache.geode.examples.SimpleSecurityManager
To confirm that the server is working, in a separate terminal run:
$> redis-cli -c -h <geodeForRedisBindAddress> -p <geodeForRedisPort> \ --user <geodeForRedisUsername> -a <geodeForRedisUsername> ping
The SimpleSecurityManager is only to be used for demonstration purposes. It will authenticate successfully when the password and username are the same.
Note that the geode-for-redis-username property is only needed if AUTH commands are issued without a username. In this case, the Security Manager will need to respond to authentication requests using this username.
Note also that any AUTH requests will fail if no Security Manager has been configured.
@Bean public static ConfigureRedisAction configureRedisAction() { return ConfigureRedisAction.NO_OP; }
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 here.
Geode for Redis implements a subset of the full Redis command set.
NOTES:
1Redis accepts 64-bit signed integers for the HSCAN cursor and COUNT parameters. Geode for Redis is limited to 32-bit integer values for these parameters.
2 INFO is implemented for the sections and fields listed below:
clients
connected_clients
blocked_clients (always returns 0)
cluster
keyspace
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)
pubsub_channels
pubsub_patterns