Skip to content

Improve Version reporting and tracking #267

@DavidEdell

Description

@DavidEdell

This is a catch-all to improve display and capture of ANMS Version information in various places in the UI and REST API.

  • 'Agents' tab has a version displayed on the bottom that is a timestamp. This only exists on the Agents tab
  • Header displays 'ANMS - Version 0'
  • REST API exposes the managers '/nm/version' but we don't have an equivalent '/version' for ANMS version information
    • a '/version' should include the NM Version, Tagged ANMS version, and perhaps a built timestamp, Git SHA, Container SHA, and/or Container tag
    • Note: '/version' should replace the example '/hello' API
  • A 'Version' page should be included in the UI (as part of help pages, or a popup when clicking on version in header) that provides full version details
  • Discretely from the ANMS version we should
    • Define a REST API Version. This would only be updated if we make breaking changes to the REST API in the future and is independent from the ANMS versioning. This is a relatively standard practice to aid long-term compatibility with third-party integrations.
    • Define a tagged DB Version. This is related to User Friendly Upgrade Process #254 and ensuring we have a method to cleanly upgrade the DB and identify if the DB Schema version mismatches the software (this could be checked on system startup to catch errors early)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    Status

    Todo

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions