feat: add support package upload feature with files-sdk 0.3.1 #380
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Update files-sdk dependency from local path to crates.io version 0.3.1 - Add support package upload functionality to Files.com - Implement --upload and --no-save flags for support package commands - Support cluster, database, and node support package uploads - Add environment variable support for Files.com API key - All existing functionality preserved and tests passing
This commit adds secure, persistent storage for Files.com API keys used for support package uploads, addressing the critical need for users who receive static keys from Redis Support. - Made secure-storage feature part of default build - Keys stored in OS keyring (macOS Keychain, Windows Credential Manager, Linux Secret Service) - Eliminates need for plaintext API keys in environment variables - Global files_api_key in config (applies to all profiles) - Per-profile files_api_key override for flexibility - Supports keyring: prefix for secure reference (e.g., files_api_key = "keyring:my-key") 1. REDIS_ENTERPRISE_FILES_API_KEY environment variable (CI/CD) 2. Profile-specific files_api_key in config 3. Global files_api_key in config 4. System keyring (direct CLI storage) 5. REDIS_FILES_API_KEY environment variable (fallback) - redisctl files-key set <key> --use-keyring # Secure (recommended) - redisctl files-key set <key> --global # Config file - redisctl files-key set <key> --profile <name> # Per-profile - redisctl files-key get [--profile <name>] # View current key - redisctl files-key remove [--keyring|--global|--profile <name>] Global key: files_api_key = "keyring:files-api-key" Per-profile: [profiles.prod] files_api_key = "keyring:prod-files-key" - Update Cargo.toml: secure-storage now in default features - Add Config fields: global files_api_key + per-profile override - Enhance upload.rs: full priority chain with config support - Add files_key.rs: comprehensive key management handlers - Add CLI commands: FilesKeyCommands enum with set/get/remove - Update main.rs: routing and Profile initialization - Fix clippy: collapsible if, needless return, test fixtures - All builds pass with default features - cargo fmt and clippy clean - Config backward compatible (files_api_key is optional) Closes #<issue> (if applicable) Co-authored-by: Human <user@example.com>
Enable apple-native, windows-native, and linux-native features for the keyring crate to use actual platform credential stores instead of mock fallback. Without these features, keyring claims success but doesn't persist to the system keychain/credential manager. Tested on macOS with Files.com API key storage and retrieval working correctly with support package uploads.
joshrotenberg
force-pushed
the
feat/support-package-upload
branch
from
ae1b468 to
5a8a1a5
Compare
Add comprehensive documentation for new support package features: - Package optimization with --optimize flag (20-30% size reduction) - Direct upload to Files.com with --upload flag - Secure API key management with files-key commands - Update README with support package quick start - Add writing style guidelines to CLAUDE.md to prevent emojis and marketing language
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Add support package upload functionality using files-sdk 0.3.1 with secure, persistent storage for Files.com API keys.
Implements features from #379 (support package epic):
Implementation Details
Secure Storage (Default)
The secure-storage feature is now enabled by default. API keys are stored in platform-native keychains:
Configuration (Hybrid Approach)
Supports both global and per-profile API key storage:
API Key Resolution Priority
REDIS_ENTERPRISE_FILES_API_KEYenvironment variablefiles_api_keyin configfiles_api_keyin configREDIS_FILES_API_KEYenvironment variable (fallback)CLI Key Management
Package Optimization
The
--optimizeflag reduces support package size by 20-30% through:--log-lines)Upload Capability
Comparison with spfetch
Feature parity with Redis's existing spfetch/rflat tool:
Security improvements:
Technical Changes
Dependencies
files-sdk: upgraded to 0.3.1 from crates.iokeyring: enabled platform-native features (apple-native, windows-native, linux-native)secure-storage: changed from optional to default featureNew Files
crates/redisctl/src/commands/files_key.rs- Key management commandscrates/redisctl/src/commands/enterprise/support_package/optimizer.rs- Package optimizationcrates/redisctl/src/commands/enterprise/support_package/upload.rs- Upload functionalityConfig Schema
Testing
cargo fmt --all -- --checkcleancargo clippy --all-targets --all-features -- -D warningscleanDocumentation
Updated:
Use Cases
Individual Developer
CI/CD Pipeline
Multiple Files.com Accounts
Breaking Changes
None. All changes are backward compatible.
Closes #379