title: How to Set Up Redis on Google Compute Engine description: Learn how to get Redis running on Google Compute Engine. author: chingor13 tags: Compute Engine, Redis date_published: 2017-06-08
This tutorial shows how to set up Redis on Google Cloud Platform in just a few minutes. Follow this tutorial to configure a standalone Redis instance on a Debian 8 (jessie) virtual machine instance on Compute Engine.
You can also use Cloud Launcher to set up Redis cluster on Compute Engine with just a few clicks.
- Install Redis on a Compute Engine instance.
- Configure Redis for remote access.
- Configure a Cloud Platform firewall to open a port. (optional)
- Connect to Redis from a remote computer. (optional)
Before you begin
You'll need a Google Cloud Console project. You can use an existing project or click the button to create a new project.
This tutorial uses billable components of Cloud Platform, including:
- Google Compute Engine
Creating a Compute Engine instance
For the purposes of this tutorial, the default machine type works fine, so you don't need to change the default setting. In production, you need to decide how much computing power is required for your application. In general, database systems tend to be more constrained by I/O bottlenecks and hard disk speed than by CPU capabilities. Redis, in particular, relies heavily on memory so be sure to allocate enough memory for your use case.
Most Linux distributions have some version of Redis integrated with their package managers. For this tutorial, you use Debian 8 (jessie) which includes Redis 2.8.
- In the Cloud Platform Console, go to the VM Instances page.
- Click the Create instance button.
- Set Name to
- In the Boot disk section, click Change to begin configuring your boot disk.
- In the OS images tab, choose Debian GNU/Linux 8 (jessie).
- In the Boot disk type section, select Standard persistent disk.
- Click Select.
- Click the Create button to create the instance.
It will take a few moments to create your new instance.
Stay on the VM instances page for the next step.
Follow these steps to install Redis on your Compute Engine instance.
- In the list of virtual machine instances, click the SSH button in the row of the instance to which you want to connect.
Update the Debian packages list. In the SSH terminal, enter the following command:
sudo apt-get update
sudo apt-get -y install redis-server
Verify that Redis is running:
ps -f -u redis
You should see something like:
yourname@redis-tutorial:~$ ps -f -u redis UID PID PPID C STIME TTY TIME CMD redis 802 1 0 21:07 ? 00:00:00 /usr/bin/redis-server 127.0.0.1:6379
Congratulations, Redis is running, but will only accept connections from
127.0.0.1 - the local machine
running the Redis server.
Configure Redis remote access
By default, Redis doesn't allow remote connections. To change this setting,
you can change the configuration in the
Follow these steps.
In the SSH terminal window, edit
redis.conf. This tutorial uses the
nanoeditor, but you can substitute your favorite editor. Enter:
sudo nano /etc/redis/redis.conf
Scroll down to the line that begins with
bind 0.0.0.0 setting enables Redis to accept connections from any IP address. This is
a commonly used setting. When bound to
127.0.0.1, Redis will only accept connections
from the local machine running Redis -- meaning your application would have to reside on the
same machine as the Redis server.
Save the file and exit the editor.
Restart the database service. In the SSH terminal, enter:
sudo service redis-server restart
Verify that Redis is listening to all traffic:
ps -f -u redis
You should now see something like:
yourname@redis-tutorial:~$ ps -f -u redis UID PID PPID C STIME TTY TIME CMD redis 950 1 0 21:07 ? 00:00:00 /usr/bin/redis-server 0.0.0.0:6379
Congratulations, Redis will now accept connections from external machines.
Open the network port (optional)
By default, this Compute Engine instance is added to the
default network in your project.
default network allows all TCP connections between its Compute Engine instances using
the internal network. In a production environment, you will want to skip this step.
Redis accepts remote connections on TCP port 6379. Follow these steps to add a firewall rule that enables traffic on this port.
In the Cloud Console, navigate to the Create a firewall rule page.
In the Network field, leave the network as default.
In the Name field, enter:
In a separate window, navigate to ip4.me to get the IPv4 address of your local computer.
Back in the Cloud Console, In Source IP Ranges, enter the IPv4 address from the previous step. Append
/32to the end of the IPv4 address to format in CIDR notation. For example:
In Allowed protocols and ports, enter:
You are now able to connect to your redis instance from your local machine.
Note that firewall rules are a global resource, so you'll only need to create this rule once for all instances.
Connect using redis-cli
Now you can connect to your Redis database from your computer. This tutorial uses
an officially supported command line tool to interact with a Redis server. Follow these steps.
Install redis on your local computer.
Navigate to the VM instances page and find the external IP address of your Compute Engine instance in the External IP column.
Ping the Redis server. Replace
[REDIS_IPV4_ADDRESS]with the external IP address from the previous step.
redis-cli -h [REDIS_IPV4_ADDRESS] ping
You should receive a response of
PONG output to the terminal.
Congratulations, you've successfully connected to your Redis server!
This tutorial provided you with a basic look at a one-machine, single-disk installation of Redis. In a production environment, it's a good idea to employ strategies for high availability, scalability, archiving, backup, load balancing, and disaster recovery. For information about disaster recovery planning, see How to Design a Disaster Recovery Plan.
For better performance and data safety, install the database engine on the boot disk as this tutorial showed, and then set up the data storage on a separate persistent disk.
For machines that have an Internet connection, limit access only to trusted IP ranges.
After you've finished the Redis tutorial, you can clean up the resources you created on Google Cloud Platform so you won't be billed for them in the future. The following sections describe how to delete or turn off these resources.
Deleting the project
The easiest way to eliminate billing is to delete the project you created for the tutorial.
To delete the project:
- In the Cloud Platform Console, go to the Projects page.
- Click the trash can icon to the right of the project name.
Warning: Deleting a project has the following consequences:
If you used an existing project, you'll also delete any other work you've done in the project. You can't reuse the project ID of a deleted project. If you created a custom project ID that you plan to use in the future, you should delete the resources inside the project instead. This ensures that URLs that use the project ID, such as an appspot.com URL, remain available.
To delete a Compute Engine instance:
- In the Cloud Platform Console, go to the VM Instances page.
- Click the checkbox next to your
- Click the Delete button at the top of the page to delete the instance.
Deleting firewall rules for the default network
To delete a firewall rule:
- In the Cloud Platform Console, go to the Firewall Rules page.
- Click the checkbox next to the firewall rule you want to delete.
- Click the Delete button at the top of the page to delete the firewall rule.
- Explore the Redis documentation.