# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

NVDebug 2.2.0
============

Released October 2, 2026

Release Highlights
------------------

- Improved multi-system collection and time-windowed output for eligible
  collectors.
- Expanded diagnostic decoding, including mixed and split archives.
- Clearer reporting of successful, partial, and failed collections.
- LogLake credentials and destinations can use environment variables or a
  protected environment file.
- Updated collector and system coverage, OneClick instructions, and setup
  guidance.

Upgrade Notes
-------------

Existing 2.x ``config.yaml`` discovery and documented field aliases,
``execution_scheduler=legacy_global``, ``report_format=legacy`` and
``report_format=both``, and supported historical status/manifest data and
artifacts remain supported. A ``duts`` key in ``tool_config.yaml`` remains
rejected; use ``dut_config.yaml``. No supported configuration or output
compatibility behavior is removed for these legacy paths.

SSH key logins that require password-based sudo now support
``host_sudo_password``. Set it to the remote sudo password; ``host_pass``
remains the local key passphrase. Password-based SSH and passwordless sudo
keep their existing behavior.

Earlier Release Highlights
--------------------------

NVDebug 2.1.0 - May 15, 2026
--------------------------------

- Expanded MGX system coverage.
- Added Host, management-controller, inventory, diagnostic-dump, console,
  NVMe, and event-log collection.
- Improved OneClick, PowerShelf collection, and platform detection.

NVDebug 2.0.1 - February 13, 2026
-------------------------------------

- Added LogLake uploads.
- Expanded supported-system and diagnostic coverage.
- Added collector controls and fixed several Host and management-controller
  collections.

NVDebug 2.0.0 - October 13, 2025
------------------------------------

- Introduced the current command workflow and expanded supported systems and
  diagnostic coverage.
- Made NVDebug available through the official NVIDIA open-nvdebug project on
  GitHub.

NVDebug 1.8.0 - August 8, 2025
-----------------------------------

- Added automatic platform detection, preflight checks, flexible local and
  remote collection, and more reliable parsing and cleanup.

NVDebug 1.7.0 - June 12, 2025
----------------------------------

- Expanded network, management-controller, and hardware diagnostics and
  improved reports and dump decoding.

NVDebug 1.6.1 - April 23, 2025
-----------------------------------

- Improved collection performance and updated common usage guidance.

NVDebug 1.6 - April 18, 2025
---------------------------------

- Added parallel collection, configurable timeouts, collector selection,
  improved OneClick support, and hidden password entry.

NVDebug 1.5 - February 21, 2025
------------------------------------

- Added automatic archive splitting, configurable connection ports, HTML
  reports, and broader diagnostic coverage.

NVDebug 1.4 - December 16, 2024
-----------------------------------

- Added PowerShelf collection, more diagnostic sources, SSH-key usage, and
  per-system archives.

NVDebug 1.3 - October 4, 2024
---------------------------------

- Added rack-scale, multi-system collection and made collection output easier
  to navigate.

NVDebug 1.2.1 - July 19, 2024
-----------------------------------

- Added decoding for supported binary logs and nested archives.

NVDebug 1.2 - June 26, 2024
--------------------------------

- Improved errors and preflight results, expanded management-controller
  diagnostics, and added the BMC collection script.

NVDebug 1.1 - April 2, 2024
--------------------------------

- Improved local host collection, added SSH-key support, and expanded NVIDIA
  host and management-controller diagnostics.

NVDebug 1.0 - February 26, 2024
------------------------------------

- Added log sanitization, IPv6 support, configuration-file selection, and
  additional diagnostic decoding.

NVDebug 0.5.1 - February 8, 2024
------------------------------------

- Improved configuration compatibility and IPv6 support.

NVDebug 0.5 - January 18, 2024
----------------------------------

- Added out-of-band health checks and more flexible connection settings.

NVDebug 0.4 - November 8, 2023
----------------------------------

- Added collector selection, a configurable output directory, broader system
  support, and clearer timing and error output.

NVDebug 0.3.2 - October 23, 2023
------------------------------------

- Added verbose output and more configuration choices.

NVDebug 0.3.1 - October 16, 2023
------------------------------------

- Added host collection and initial DGX and HGX H100 support.

NVDebug 0.2.1 - September 26, 2023
--------------------------------------

- Improved BMC connection checks, execution summaries, and collection status.

NVDebug 0.2 - September 20, 2023
------------------------------------

- Improved collection reliability, error handling, and archive creation.

NVDebug 0.1 - August 18, 2023
---------------------------------

- Initial NVDebug release.
