Skip to content

Commit 80540ab

Browse files
committed
docs: add Docker Hub usage documentation
1 parent 0f52038 commit 80540ab

File tree

1 file changed

+50
-8
lines changed

1 file changed

+50
-8
lines changed

README.md

Lines changed: 50 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -83,19 +83,61 @@ 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+
8795
```bash
88-
# Start Redis Enterprise cluster
89-
make docker-up
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="[email protected]" \
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="[email protected]" \
123+
-e REDIS_ENTERPRISE_PASSWORD="your-password" \
124+
--entrypoint /bin/sh \
125+
joshrotenberg/redisctl:latest
126+
```
90127

91-
# Access the CLI
92-
make docker-cli
128+
### Local Development with Docker Compose
129+
```bash
130+
# Start Redis Enterprise cluster with test environment
131+
docker compose up -d
93132

94-
# Run tests
95-
make docker-test
133+
# Watch logs
134+
docker compose logs -f
135+
136+
# Run CLI commands against test cluster
137+
docker compose exec enterprise bash
96138

97139
# Clean up
98-
make docker-down
140+
docker compose down -v
99141
```
100142

101143
## Quick Start

0 commit comments

Comments
 (0)