适用于 Redis Enterprise Software 的 Docker 快速入门

使用 Docker 设置 Redis Enterprise Software 的开发或测试部署。

Redis 企业软件
警告：
Docker 容器目前仅支持开发和测试环境，不支持用于生产环境。将 Redis Enterprise on Kubernetes 用于支持的容器化部署。

出于测试目的，您可以在 Docker 容器上运行 Redis Enterprise Software Linux、Windows 或 MacOS。 Redis Enterprise Software 容器充当集群中的节点。

要开始使用单个 Redis Enterprise Software 容器，请执行以下作：

  1. 为您的作系统安装 Docker

  2. 运行 Redis Enterprise Software Docker 容器

  3. 设置集群

  4. 创建新数据库

  5. 连接到您的数据库

安装 Docker

按照适用于您的作系统的 Docker 安装说明进行作：

运行容器

要下载并启动 Redis Enterprise Software Docker 容器，请运行以下命令docker run命令或作系统的命令行。

注意：
在 Windows 上，确保将 Docker 配置为运行基于 Linux 的容器。
docker run -d --cap-add sys_resource --name RE -p 8443:8443 -p 9443:9443 -p 12000:12000 redislabs/redis

The example command runs the Docker container with Redis Enterprise Software on localhost and opens the following ports:

  • Port 8443 for HTTPS connections

  • Port 9443 for REST API connections

  • Port 12000 configured Redis database port allowing client connections

You can publish other ports with -p <host_port>:<container_port> or use the --network host option to open all ports to the host network.

Set up a cluster

  1. In a browser, go to https://<name-or-IP-address-of-the-machine-with-Redis-Enterprise-Software-installed>:8443 to access the Cluster Manager UI. If you use a browser on the host machine, you can also access the Cluster Manager UI at https://localhost:8443.

    The cluster generates self-signed TLS certificates to secure the connection. Because these self-signed certificates are unknown to the browser, you must accept them before you proceed.

    If the server does not show the sign-in screen, try again after a few minutes.

  2. Select Create new cluster.

    When you first install Redis Enterprise Software, you need to set up a cluster.

  3. Enter an email and password for the administrator account, then select Next to proceed to cluster setup.

    Set the credentials for your admin user.

    You can also use these credentials to connect to the REST API.

  4. Enter your cluster license key if you have one. Otherwise, a trial version is installed.

    Enter your cluster license key if you have one.

  5. In the Configuration section, enter a cluster FQDN such as cluster.local, then select Next.

    Configure the cluster FQDN.
    Warning:
    If the FQDN is cluster.local, you cannot configure DNS. You cannot change the FQDN after cluster creation.

  6. On the node setup screen, select Create cluster to accept the defaults.

    Configure the node specific settings.

  7. Select OK to acknowledge the replacement of the HTTPS TLS certificate on the node. If you receive a browser warning, you can proceed safely.

    Modal shown when a page refresh is needed because the certificates have been updated.

Create a database

  1. On the Databases screen, select Quick database.

    Select Quick database on the Databases screen.

  2. Enter 12000 for the Port.

    If port 12000 is not available, enter any available port number between 10000 to 19999 or leave it blank to let the cluster assign a port number for you. You will use this port number to connect to the database.

    Create a quick database.

  3. Select Create to create your database.

When you see Database active appear on the database configuration screen, the database is activated and ready for you to use.

Database active icon.

You now have a Redis database!

Note:
If you cannot activate the database because of a memory limitation, make sure that Docker has at least 4 GB of memory allocated in the Advanced section of Docker Settings.

Connect to your database

After you create the Redis database, you can connect to it to begin storing data.

Use redis-cli inside Docker

Every installation of Redis Enterprise Software includes the command-line tool redis-cli to interact with your Redis database. You can use redis-cli to connect to your database from within the same Docker network.

Use docker exec to start an interactive redis-cli session in the running Redis Enterprise Software container:

$ docker exec -it redis-cli -h redis-12000.cluster.local -p 12000
127.0.0.1:12000> SET key1 123
OK
127.0.0.1:12000> GET key1
"123"

Connect from the host environment

The database you created uses port 12000, which is also mapped from the Docker container back to the host environment. This lets you use any method you have available locally to connect to a Redis database. Use localhost as the host and 12000 as the port.

Test different topologies

Warning:
Docker containers are currently only supported for development and test environments, not for production. Use Redis Enterprise on Kubernetes for a supported containerized deployment.

When deploying Redis Enterprise Software using Docker for testing, several common topologies are available, according to your requirements:

Single node

The simplest topology is to run a single-node Redis Enterprise Software cluster with a single container on a single host machine. You can use this topology for local development or functional testing.

Single-node clusters have limited functionality. For example, Redis Enterprise Software can't use replication or protect against failures if the cluster has only one node.

Multiple nodes on one host

You can create a multi-node Redis Enterprise Software cluster by deploying multiple containers to a single host machine. The resulting cluster is scale minimized but similar to production deployments.

However, this will also have several limitations. For example, you cannot map the same port on multiple containers on the same host.

Multiple nodes and hosts

You can create a multi-node Redis Enterprise Software cluster with multiple containers by deploying each container to a different host machine.

This topology minimizes interference between containers, allowing for the testing of more Redis Enterprise Software features.

RATE THIS PAGE
Back to top ↑