Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Authentication

redisctl supports authentication for both Redis Cloud and Redis Enterprise deployments.

Redis Cloud

Redis Cloud uses API key authentication:

  • API Key - Your account key (public identifier)
  • API Secret - Your secret key (keep this private!)

Getting Your API Keys

  1. Log in to app.redislabs.com
  2. Click your name → Account Settings → API Keys
  3. Click "Add API Key" and give it a name
  4. Copy both the Account key and Secret (you won't see the secret again!)

Setting Up Authentication

When compiled with the secure-storage feature, store credentials securely in your OS keyring:

# Install with secure storage support
cargo install redisctl --features secure-storage

# Create secure profile
redisctl profile set cloud \
  --deployment cloud \
  --api-key "your-account-key" \
  --api-secret "your-secret-key" \
  --use-keyring  # Stores in OS keyring

# Test it works
redisctl --profile cloud api cloud get /

Your config will contain secure references:

[profiles.cloud]
deployment_type = "cloud"
api_key = "keyring:cloud-api-key"      # Actual value in OS keyring
api_secret = "keyring:cloud-api-secret" # Actual value in OS keyring

Option 2: Environment Variables

Use environment variables (good for CI/CD):

export REDIS_CLOUD_API_KEY="your-account-key"
export REDIS_CLOUD_API_SECRET="your-secret-key"

# Test it works
redisctl api cloud get /

Option 3: Configuration File (Development Only)

For development only, you can use plaintext config at ~/.config/redisctl/config.toml:

[profiles.cloud]
deployment_type = "cloud"
api_key = "your-account-key"
api_secret = "your-secret-key"

⚠️ Warning: This stores credentials in plaintext. Use keyring or environment variables for production!

Redis Enterprise

Redis Enterprise uses basic authentication with username/password.

Default Credentials

  • Username: admin@cluster.local (default)
  • Password: Set during cluster setup

Setting Up Authentication

Store credentials securely in your OS keyring:

# Create secure profile
redisctl profile set enterprise \
  --deployment enterprise \
  --url "https://cluster.example.com:9443" \
  --username "admin@cluster.local" \
  --password "your-password" \
  --use-keyring  # Stores in OS keyring

# For self-signed certificates
redisctl profile set enterprise --insecure true

# Test it works
redisctl --profile enterprise api enterprise get /v1/cluster

Your config will contain secure references:

[profiles.enterprise]
deployment_type = "enterprise"
url = "https://cluster.example.com:9443"
username = "keyring:enterprise-username"  # Actual value in OS keyring
password = "keyring:enterprise-password"  # Actual value in OS keyring
insecure = false

Option 2: Environment Variables

Use environment variables:

export REDIS_ENTERPRISE_URL="https://cluster.example.com:9443"
export REDIS_ENTERPRISE_USER="admin@cluster.local"
export REDIS_ENTERPRISE_PASSWORD="your-password"

# For self-signed certificates
export REDIS_ENTERPRISE_INSECURE="true"

# Test it works
redisctl api enterprise get /v1/cluster

Option 3: Configuration File (Development Only)

For development only, add to ~/.config/redisctl/config.toml:

[profiles.enterprise]
deployment_type = "enterprise"
url = "https://cluster.example.com:9443"
username = "admin@cluster.local"
password = "your-password"
insecure = true  # For self-signed certs

⚠️ Warning: This stores credentials in plaintext. Use keyring or environment variables for production!

Security Tips

  1. Never commit credentials - Use environment variables or secure vaults
  2. Use read-only API keys when possible for Cloud
  3. Rotate credentials regularly
  4. Set file permissions: chmod 600 ~/.config/redisctl/config.toml

Troubleshooting

Authentication Failed

Check your credentials:

# Enable debug logging to see what's happening
RUST_LOG=debug redisctl api cloud get /

Connection Refused

Verify the URL and port are correct:

curl -k https://your-cluster:9443/v1/cluster

Certificate Errors

For development/testing with self-signed certificates:

export REDIS_ENTERPRISE_INSECURE=true

See Also