Skip to content

Commit a300b9e

Browse files
committed
docs: add Docker Hub usage documentation
1 parent e3db188 commit a300b9e

File tree

1 file changed

+46
-4
lines changed

1 file changed

+46
-4
lines changed

README.md

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,16 +83,58 @@ cargo build --release --features enterprise-only --bin redis-enterprise
8383
cargo build --release --bin redisctl
8484
```
8585

86-
### Using Docker (for Enterprise testing)
86+
### Using Docker Hub Image
87+
88+
The official Docker images are available on Docker Hub at [joshrotenberg/redisctl](https://hub.docker.com/r/joshrotenberg/redisctl):
89+
90+
#### Available Tags
91+
- `latest` - Latest stable release
92+
- `v0.1.0`, `v0.2.0`, etc. - Specific version tags
93+
- `main` - Latest development build from main branch
94+
95+
```bash
96+
# Pull the latest image
97+
docker pull joshrotenberg/redisctl:latest
98+
99+
# Or pull a specific version
100+
docker pull joshrotenberg/redisctl:v0.1.0
101+
102+
# Run a command directly
103+
docker run --rm joshrotenberg/redisctl:latest --help
104+
105+
# Use with environment variables for Redis Cloud
106+
docker run --rm \
107+
-e REDIS_CLOUD_API_KEY="your-key" \
108+
-e REDIS_CLOUD_API_SECRET="your-secret" \
109+
joshrotenberg/redisctl:latest cloud subscription list
110+
111+
# Use with environment variables for Redis Enterprise
112+
docker run --rm \
113+
-e REDIS_ENTERPRISE_URL="https://your-cluster:9443" \
114+
-e REDIS_ENTERPRISE_USER="admin@example.com" \
115+
-e REDIS_ENTERPRISE_PASSWORD="your-password" \
116+
-e REDIS_ENTERPRISE_INSECURE="true" \
117+
joshrotenberg/redisctl:latest enterprise cluster info
118+
119+
# Run interactively with a shell
120+
docker run -it --rm \
121+
-e REDIS_ENTERPRISE_URL="https://your-cluster:9443" \
122+
-e REDIS_ENTERPRISE_USER="admin@example.com" \
123+
-e REDIS_ENTERPRISE_PASSWORD="your-password" \
124+
--entrypoint /bin/sh \
125+
joshrotenberg/redisctl:latest
126+
```
127+
128+
### Local Development with Docker Compose
87129
```bash
88130
# Start Redis Enterprise cluster with initialization
89131
docker compose up -d
90132

91133
# Check cluster status
92-
docker compose logs init
134+
docker compose logs init-cluster
93135

94-
# Access interactive CLI
95-
docker compose run --rm cli
136+
# Watch logs
137+
docker compose logs -f
96138

97139
# Clean up
98140
docker compose down -v

0 commit comments

Comments
 (0)