0.4
===

Upgrading
---------
    - In CASSSIDECAR-415, a new internal table (restore_job_v6) is created to support IAM credential
      tracking for restore jobs. Spark jobs performing S3 restores should be paused during sidecar
      upgrade to ensure in-flight restore job state is not lost.
    - In CASSSIDECAR-407, the driver_parameters.username and driver_parameters.password settings in
      sidecar.yaml are now nested under a pluggable driver_parameters.auth_provider. The top-level
      username/password keys remain as a deprecated fallback. Update sidecar.yaml to configure
      auth_provider with the ConfigProvider (or FileProvider) implementation during the upgrade.

New features
------------
    - IAM instance profile credential support for S3 restore jobs (CASSSIDECAR-415). Sidecar can now
      resolve AWS credentials automatically from the platform (IMDS/ECS/EKS) without requiring key
      material to be passed by the caller. Set credentialType to IAM when creating a restore job to
      enable this mode.
    - SAI (Storage Attached Index) support in Sidecar (CASSSIDECAR-422).
    - Pluggable Cassandra driver authentication provider (CASSSIDECAR-407). A new auth_provider under
      driver_parameters supports loading connection credentials from different sources, with two
      implementations: ConfigProvider (credentials in sidecar.yaml, the prior behavior) and
      FileProvider (username and password read from files on disk).
    - File-based configuration overlay persistence with pluggable ConfigurationProvider interfaces and
      a FileBasedConfigurationProvider implementation (CASSSIDECAR-424, CASSSIDECAR-426).
    - Cluster-wide operational jobs (CASSSIDECAR-376), building on a refactored OperationalJob that
      separates job data from execution logic (CASSSIDECAR-460, CASSSIDECAR-372).
    - Live Migration enhancements including an endpoint to verify files after data copy
      (CASSSIDECAR-226), a safety check on the data copy endpoint (CASSSIDECAR-409), configuration
      validations (CASSSIDECAR-470), and feature documentation (CASSSIDECAR-469). The Live Migration
      feature is now fully implemented.
    - CDC enhancements including routing events to topics by topic-format configuration
      (CASSSIDECAR-453), immediate wake-up on receiving a phase signal rather than waiting for the
      discovery loop (CASSSIDECAR-454), and a Docker Compose setup for a local CDC demo from Cassandra
      to Sidecar to Kafka (CASSSIDECAR-419).
    - Support for column types not parseable by the Java 3.x driver (CASSSIDECAR-443).

0.3
===

New features
------------
    - ProcessLifecycleProvider for managing Cassandra process lifecycle (start/stop) via sidecar APIs with configurable
      startup and shutdown commands, state tracking, and support for custom environment configurations. Usage example
      available on examples/lifecycle.
    - CDC (Change Data Capture) support with CDC Publisher implementation, CDC/Kafka configuration APIs, and automatic
      cleanup of commit log segments in the cdc_raw directory.
    - Node management operations including on-demand repair, compaction management (stop/statistics), node drain,
      and move node to new token.
    - Stateless JWT authentication using public keys with authentication and authorization caching for improved
      performance, and endpoint to invalidate auth caches.
    - Schema monitoring with CassandraClusterSchemaMonitor implementation for tracking schema changes across the cluster.
    - Live Migration enhancements including status persistence endpoint for migration safety and tracking.
    - Additional operational endpoints for system disk information, Cassandra settings (from system_views.settings),
      and compaction statistics.

0.2
===

Upgrading
---------
    - In CASSSIDECAR-176, the default values in sidecar.yaml for vertx.filesystem_options.classpath_resolving_enabled
      and vertx.filesystem_options.file_caching_enabled changed from false to true to support the OpenAPI static
      resources. Consider changing these values during the upgrade if you plan to leverage OpenAPI.
    - In CASSSIDECAR-263, a new configuration exposes the ability to configure a new DNS resolution strategy.
      Configure sidecar.dns_resolver to use a different strategy than the default.


New features
------------
    - Enhances to the Sidecar client to list and download Cassandra instance files for Live Migration.
    - JWT Authentication support.
    - Comprehensive OpenAPI Documentation.
    - Enhancements for the control plane such as Start/Stop Binary Transport & Gossip Endpoints.
    - Enhancements to the restore capability from S3.
    - Enhancements to schema reporting such as adding an endpoint to trigger immediate schema report,
      retry failed reports, and better metrics.
    - Additional enhancements for CEP-44 such as token ring peer health monitor, CDC/Kafka Config APIs,
      and CDC Raw Directory Space Cleaner.
    - Support for flag and implementation of forward-only DNS resolution.


0.1
===

New features
------------
    - Restore capability to Sidecar, for Sidecar to allow restoring data from S3.
    - Cassandra Analytics Library Support by adding bulk endpoints for bulk reads and bulk writes.
    - Mutual TLS Authentication support.
    - Role-based access control authorization mechanism that honors the Cassandra's permissions
      to allow access to the service.
    - Health check APIs to determine the health of the native, JMX, Gossip, and service health
    - Bespoke endpoints that provide ability to access Cassandra operational stats and node management,
      including table stats, stream task monitoring, decommission of a node.
    - Sidecar Observability that captures metrics such as HTTP (number of requests created per route,
      response time taken endpoint wise); metrics per Cassandra instance maintained by Sidecar (instance
      specific restore metrics, instance specific stream and upload metrics). Server route metrics emitted
      by Vert.x.
    - Vert.x-based Client Library that supports accessing endpoints available in Sidecar, with advanced
      tunables for retries, backoff, timeouts, and other knobs.
    - Schema reporting and integration with Datahub.
