Skip to content

Changelog

All notable changes to VMware vRA CLI will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

[0.9.0] - 2025-01-21

Added

  • Deployment Export Functionality: New deployment export-all command for bulk deployment export
  • Enhanced Deployment Management: Export multiple deployments in JSON, YAML, or CSV formats
  • Flexible Export Options:
  • Export by deployment names, tags, or all deployments
  • Support for multiple output formats with configurable formatting
  • Optional resource details inclusion for comprehensive export data
  • Comprehensive Documentation Suite:
  • Deployment Export Guide: Complete user guide for the new export-all command
  • CLI Reference Guide: Full reference documentation for all commands and options
  • Troubleshooting Guide: Comprehensive troubleshooting and diagnostic information
  • Practical Examples Guide: Real-world automation scenarios and usage patterns
  • Enhanced Navigation: Updated MkDocs configuration with improved documentation structure
  • Export Filtering: Advanced deployment matching with name patterns and tag-based filtering
  • Batch Operations: Support for exporting large numbers of deployments efficiently

Changed

  • Improved CLI Help: Enhanced help text and documentation for all deployment commands
  • Better Error Handling: More informative error messages for export operations
  • Enhanced Service Catalog Documentation: Updated with export functionality integration

Fixed

  • Export Performance: Optimized deployment data retrieval for large-scale exports
  • Output Formatting: Improved consistency across different export formats
  • Documentation Links: Fixed cross-references between documentation sections

[0.7.0] - 2025-01-21

Added

  • Persistent Configuration Management: Complete configuration storage system
  • ConfigManager Class: Handles persistent settings in ~/.vmware-vra-cli/config.json
  • Configuration Commands:
  • vra config show: Display current configuration with source information
  • vra config set: Set individual configuration values
  • vra config reset: Reset configuration to defaults
  • vra config edit: Edit configuration file in default editor
  • Automatic Parameter Storage: Login parameters (URL, tenant, domain) saved during authentication
  • Environment Variable Override: Support for VRA_URL, VRA_TENANT, VRA_DOMAIN, etc.
  • Enhanced Login Command: Now includes tenant parameter and saves all connection details

Changed

  • Improved User Experience: No need to specify URL/tenant on every login
  • Enhanced CLI Help: Better documentation for configuration management
  • Configuration Persistence: Settings retained between CLI sessions

Fixed

  • Configuration Loss Issue: Login parameters now persist between sessions
  • Parameter Redundancy: No more need to repeatedly specify connection details

[0.6.0] - 2025-01-21

Added

  • Proper two-step VMware vRA authentication procedure following official documentation
  • VRAAuthenticator class implementing Identity Service API + IaaS API flow
  • TokenManager class for secure token storage and management
  • Domain support for multiple identity sources authentication
  • Automatic access token refresh functionality (90-day refresh tokens, 8-hour access tokens)
  • Enhanced authentication status command showing detailed token information
  • Manual token refresh command for better token management

Changed

  • Complete authentication system overhaul to follow VMware official standards
  • Improved CLI authentication commands with better user experience
  • Enhanced error handling and status reporting for authentication operations

Security

  • Implemented secure token lifecycle management
  • Added automatic token renewal to minimize credential exposure
  • Enhanced keyring integration for secure credential storage

[0.5.0] - 2025-01-21

Added

  • Added --version option to CLI for better version management
  • Cross-platform installation scripts for development tools
  • Comprehensive GitHub workflow for multiarch wheel building and publishing
  • Comprehensive tag management functionality
  • Taskfile for task automation
  • MIT license for open source distribution

Changed

  • Refined GitHub workflow configuration for better reliability
  • Updated README with correct repository URLs and tag management commands
  • Removed Windows targets from workflow to reduce build complexity

Fixed

  • Improved CI/CD pipeline stability

[0.4.0] - 2025-01-21

Added

  • Initial release of VMware vRA CLI
  • Service Catalog integration with vRealize Orchestrator API
  • Authentication management with secure token storage
  • Catalog item listing, viewing, and requesting
  • Deployment management (list, show, delete, resources)
  • Workflow operations (list, run, monitor)
  • Multiple output formats (table, JSON, YAML)
  • Configuration management with profiles
  • Rich terminal output with colors and progress indicators
  • Comprehensive documentation with MkDocs
  • Support for environment variables and configuration files
  • SSL/TLS configuration options
  • Batch operations support
  • Interactive and non-interactive modes

Security

  • Secure credential storage using system keyring
  • Bearer token authentication
  • SSL certificate verification
  • Environment variable support for CI/CD

[0.1.0] - 2024-07-21

Added

  • Initial project structure
  • Basic CLI framework with Click
  • Authentication commands
  • Service Catalog API client
  • Deployment operations
  • Workflow execution capabilities
  • Documentation structure
  • Development tooling setup

Changed

  • N/A (Initial release)

Deprecated

  • N/A (Initial release)

Removed

  • N/A (Initial release)

Fixed

  • N/A (Initial release)

Security

  • Implemented secure token storage
  • Added SSL verification

Contributing

When contributing to this project, please:

  1. Follow Conventional Commits for commit messages
  2. Update this changelog with your changes
  3. Include appropriate version bumps
  4. Add relevant documentation updates

Commit Message Format

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Types: - feat: A new feature - fix: A bug fix - docs: Documentation only changes - style: Changes that do not affect the meaning of the code - refactor: A code change that neither fixes a bug nor adds a feature - perf: A code change that improves performance - test: Adding missing tests or correcting existing tests - chore: Changes to the build process or auxiliary tools

Examples: 

feat(catalog): add support for catalog item schema retrieval

fix(auth): resolve token storage issue on macOS

docs(api): update authentication examples

chore(deps): update pydantic to v2.5.0