========
Releases
========

OSDx releases can be downloaded from the `Teldat Support Website
<https://support.teldat.com/www/en/page.php?blq_id=sw-fw-updates>`_.

Versioning
==========

OSDx uses a form of semantic versioning for its releases, uniquely representing
releases with four numbers: Major version, minor version, client version, and revision.

Each major version change represents a significant internal change to OSDx, while minor
version changes are newer snapshots of the current major version. Minor versions
usually contain new features and improvements. Client versions are variants
specifically tailored for a customer. Client version ``1`` is the generic OSDx version.
Finally, revisions contain minor changes and fixes for the previous version.

Distribution files
==================

Each distribution bundle comes with the set of files needed to install OSDx, OSDx's MIB
files, and some general information about the bundle.

Common files
------------

* ``os_<fwid>_.<ext>``: OSDx image file. ``<ext>`` will be ``iso`` for SDE images and
  ``img`` otherwise.
* ``README.txt``: Text file containing general information about the distribution files
  and how to upgrade the system via SCP.
* ``version_map.txt``: Text file listing the devices and device family the bundled image
  is compatible with.
* ``mibs.tgz``: Compressed file containing OSDx's MIB files.

Device-specific
---------------

.. tab-set::

    .. tab-item:: SDE

        * ``demo_license.bin``: Demonstration license to try out OSDx.
        * ``demo_license.txt``: Same as ``demo_license.bin`` but in text format to load
          with the ``license read`` command.
        * ``Teldat_dm951-I_OSDx_Licensing.pdf``: Manual to license OSDx.
        * ``Teldat_dm952-I_OSDx_Installation.pdf``: Manual to install OSDx.

Change tracking
===============

Changes between OSDx version can be found in the `OSDx Release Tracker
<https://osdx-releases.teldat.com/>`_. Each change contains the following information:

* **OCID**: OSDx Change IDentifier. Numeric identifier for the change.
* **Ticket Type** and **Ticket Number**: Project identifier. May be RR (Roadmap
  Request), DR (Development Request), ER (Error Report), or None (generic development).
* **Features**: Features affected by the change.
* **Release Notes Description**: Brief change description.
* **Last Changed**: Timestamp of the last time the change was modified.