# Live Validation
This crate has extensive mock and fixture coverage, but live validation is still
important for catching schema drift, undocumented fields, and version-specific
behavior in Redis Enterprise.
This document describes the current live-validation path for local development.
## Sources
- Official Docker quickstart for Redis Enterprise Software:
[redis.io/docs/latest/operate/rs/7.22/installing-upgrading/quickstarts/docker-quickstart/](https://redis.io/docs/latest/operate/rs/7.22/installing-upgrading/quickstarts/docker-quickstart/)
- Official REST API reference landing page:
[redis.io/docs/latest/operate/rs/references/rest-api/](https://redis.io/docs/latest/operate/rs/references/rest-api/)
- Official REST API requests index:
[redis.io/docs/latest/operate/rs/references/rest-api/requests/](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/)
## Local Docker Path
The repo includes a `docker-compose.yml` for local Redis Enterprise testing.
This matches the official Redis guidance that Docker is suitable for development
and test environments.
The compose file defaults to:
- `REDIS_ENTERPRISE_IMAGE=redislabs/redis:8.0.10-81`
- `REDIS_ENTERPRISE_API_PORT=9443`
- `REDIS_ENTERPRISE_UI_PORT=8443`
- `REDIS_ENTERPRISE_DB_PORT=12000`
You can override the host ports to avoid collisions with an existing local
cluster:
```bash
REDIS_ENTERPRISE_API_PORT=19443 \
REDIS_ENTERPRISE_UI_PORT=18443 \
REDIS_ENTERPRISE_DB_PORT=22000 \
docker compose up -d redis-enterprise
```
Initialize the cluster once the container is healthy:
```bash
REDIS_ENTERPRISE_API_PORT=19443 \
REDIS_ENTERPRISE_UI_PORT=18443 \
REDIS_ENTERPRISE_DB_PORT=22000 \
docker compose --profile init up init
```
If you use the default ports, you can omit those overrides. If you use custom
ports for `up`, reuse the same overrides for `init` so Compose treats the stack
as the same service definition.
The init profile configures:
- cluster name: `test-cluster`
- admin user: `admin@redis.local`
- admin password: `Redis123!`
If you prefer, you can also initialize through the UI on the configured admin
UI port, such as `https://localhost:8443`.
## Licensing for local validation
Redis Enterprise runs in trial mode by default when no license is uploaded. The
trial allows enough shards and features for SDK validation against every
endpoint covered by `live_enterprise_smoke.rs`. There is no need to apply for a
trial key to bring up the local validation cluster.
If you do need to test license-gated behavior, the Admin UI accepts a license
file via Cluster -> License. Treat that license file the same way as any other
credential — never commit it to the repository.
## TLS
The local Redis Enterprise cluster ships with a self-signed certificate. You
have three options for talking to it from this SDK:
1. **Insecure mode (recommended for the local runbook)** — set
`REDIS_ENTERPRISE_INSECURE=true`. The client skips certificate validation.
Use only against trusted local development clusters.
2. **Trust the self-signed cert** — set `REDIS_ENTERPRISE_CA_CERT` to a PEM
file containing the cluster's self-signed CA. Recommended whenever you need
to validate the full TLS path (for example when reproducing a TLS-related
bug). The cluster exposes its CA through the Admin UI under Cluster ->
Security, or directly via `docker compose exec redis-enterprise
/opt/redislabs/bin/openssl s_client -showcerts -connect 127.0.0.1:9443`.
3. **Real TLS** — for cloud or shared clusters, configure the cluster with a
certificate signed by a CA your client already trusts and leave both
`REDIS_ENTERPRISE_INSECURE` and `REDIS_ENTERPRISE_CA_CERT` unset.
Production deployments should never use option 1. Bias toward option 2 in
shared dev environments so that a misconfigured DNS name fails loudly.
## Smoke Checks
Export the client environment variables:
```bash
export REDIS_ENTERPRISE_URL="https://localhost:9443"
export REDIS_ENTERPRISE_USER="admin@redis.local"
export REDIS_ENTERPRISE_PASSWORD="Redis123!"
export REDIS_ENTERPRISE_INSECURE="true"
```
If you started the stack on alternate ports, point `REDIS_ENTERPRISE_URL` at the
chosen API port instead.
Run the example client:
```bash
cargo run --example basic_enterprise
```
Run the opt-in live smoke test:
```bash
cargo test --test live_enterprise_smoke -- --ignored
```
## Teardown and cleanup
The validation cluster is fully disposable. Tear it down with:
```bash
docker compose down -v
```
`-v` removes the named volume that holds the cluster state (license,
configuration, databases). Re-running `docker compose up -d` after a `-v`
teardown starts from a fresh, uninitialized cluster, so the `init` profile
must run again.
If you want to keep cluster state between runs (faster iteration, but cluster
config drifts as you make changes), drop the `-v`:
```bash
docker compose down
docker compose up -d
```
To rebuild the entire local environment from scratch (for example after a
Redis Enterprise image bump), remove the image as well:
```bash
docker compose down -v --rmi local
docker image rm "${REDIS_ENTERPRISE_IMAGE:-redislabs/redis:8.0.10-81}"
docker compose pull
docker compose up -d
```
## Current Validation Snapshot
On April 21, 2026, the existing `basic_enterprise` example completed
successfully against a local Redis Enterprise Software `8.0.10-81` cluster and
returned live data for:
- `GET /v1/cluster`
- `GET /v1/nodes`
- `GET /v1/bdbs`
That validates the current typed client against a real cluster for a minimal
read-only flow, but it does not yet establish full endpoint completeness.
## Next Steps
- Expand the ignored live smoke suite beyond cluster, node, and database reads
- Add disposable-resource CRUD flows for higher-confidence validation
- Compare live responses against the generated API inventory in
[api-inventory.md](/Users/josh.rotenberg/Code/active/redis-enterprise-rs/docs/api-inventory.md)