Install on AWS EC2
How to install Redis Insight on AWS EC2
This tutorial shows you how to install Redis Insight on an AWS EC2 instance and manage ElastiCache Redis instances using Redis Insight. To complete this tutorial you must have access to the AWS Console and permissions to launch EC2 instances.
Step 1: Create a new IAM Role (optional)
Redis Insight needs read-only access to S3 and ElastiCache APIs. This is an optional step.
- Log in to the AWS Console and navigate to the IAM screen.
- Create a new IAM Role.
- Under Select type of trusted entity, choose EC2. The role is used by an EC2 instance.
- Assign the following permissions:
- AmazonS3ReadOnlyAccess
- AmazonElastiCacheReadOnlyAccess
Step 2: Launch EC2 Instance
Next, launch an EC2 instance.
- Navigate to EC2 under AWS Console.
- Click Launch Instance.
- Choose 64-bit Amazon Linux AMI.
- Choose at least a t2.medium instance. The size of the instance depends on the memory used by your ElastiCache instance that you want to analyze.
- Under Configure Instance:
- Choose the VPC that has your ElastiCache instances.
- Choose a subnet that has network access to your ElastiCache instances.
- Ensure that your EC2 instance has a public IP Address.
- Assign the IAM role that you created in Step 1.
- Under the storage section, allocate at least 100 GiB storage.
- Under security group, ensure that:
- Incoming traffic is allowed on port 5540
- Incoming traffic is allowed on port 22 only during installation
- Review and launch the ec2 instance.
Step 3: Verify permissions and connectivity
Next, verify that the EC2 instance has the required IAM permissions and can connect to ElastiCache Redis instances.
- SSH into the newly launched EC2 instance.
- Open a command prompt.
- Run the command
aws s3 ls
. This should list all S3 buckets.- If the
aws
command cannot be found, make sure your EC2 instance is based of Amazon Linux.
- If the
- Next, find the hostname of the ElastiCache instance you want to analyze and run the command
echo info | nc <redis host> 6379
. - If you see some details about the ElastiCache Redis instance, you can proceed to the next step.
- If you cannot connect to redis, you should review your VPC, subnet, and security group settings.
Step 4: Install Docker on EC2
Next, install Docker on the EC2 instance. Run the following commands:
sudo yum update -y
sudo yum install -y docker
sudo service docker start
sudo usermod -a -G docker ec2-user
- Log out and log back in again to pick up the new docker group permissions.
- To verify, run
docker ps
. You should see some output without having to runsudo
.
Step 5: Run Redis Insight in the Docker container
Finally, install Redis Insight using one of the options described below.
- If you do not want to persist your Redis Insight data:
docker run -d --name redisinsight -p 5540:5540 redis/redisinsight:latest
- If you want to persist your Redis Insight data, first attach the Docker volume to the
/data
path and then run the following command:
docker run -d --name redisinsight -p 5540:5540 redis/redisinsight:latest -v redisinsight:/data
If the previous command returns a permission error, ensure that the user with ID = 1000
has the necessary permission to access the volume provided (redisinsight
in the command above).
Find the IP Address of your EC2 instances and launch your browser at http://<EC2 IP Address>:5540
. Accept the EULA and start using Redis Insight.
Redis Insight also provides a health check endpoint at http://<EC2 IP Address>:5540/api/health/
to monitor the health of the running container.
Summary
In this guide, we installed Redis Insight on an AWS EC2 instance running Docker. As a next step, you should add an ElastiCache Redis Instance and then run the memory analysis.