Skip to content

Improve Template/ISO Failure Status and Error Reporting #11326

Open
Feature
Open
Improve Template/ISO Failure Status and Error Reporting#11326
Feature
Labels
component:templates
Milestone
unplanned

Description

@Yuliia7-1
Yuliia7-1
opened on Jul 29, 2025

The required feature described as a wish

Description:
In the ISO/Templates flow, error responses currently return detailed error messages directly in the status field. This leads to inconsistencies and complicates error handling.

Proposal:
Introduce two improvements to the API responses for Templates and ISOs:

  1. Standardize the status Field for Failures
    When any terminal error occurs during the processing of a template or ISO, the status field should consistently return "Failed". This provides a clear and unambiguous final state for parsing.

  2. Add a Detailed Error Message Field
    A new field, named error_details, should be added to the Template/ISO API response object.
    This field will contain a detailed error string explaining the reason for the failure.

Example of the response
Failed download status of the ISO/Template:

{
  "id": "a1b2c3d4-xxxx-yyyy-zzzz-e5f6g7h8i9j0",
  "name": "my-failed-template",
  "status": "Failed",
  "error_details": "HTTP Server returned 404 (expected 200 OK)",
  ....
}

Successful download status of the ISO/Template:

{
  "id": "b1b2c3d4-xxxx-yyyy-zzzz-e5f6g7h8i9j1",
  "name": "my-template",
  "status": "Download Complete",
  "error_details": null,
  ....
}

Benefits:

  • Consistent error structure across ISO/Templates;
  • Easier parsing, logging, and UI display of error messages;
  • Avoids issues caused by leading/trailing spaces or unexpected values in status.

Tasks:

  1. Update ISO/Templates logic to return "Failed" in the status field.
  2. Return detailed error messages in the error_details field.

Activity

  1. DaanHoogland
    added this to Apache CloudStack BugFest - Issueson Jul 31, 2025
  2. DaanHoogland
    added this to the unplanned milestone on Jul 31, 2025
  3. DaanHoogland
    added the
    Feature
    issue type on Jul 31, 2025
  4. DaanHoogland
    added
    component:templates
    on Jul 31, 2025

  5. github-actions commented on Dec 18, 2025

    @github-actions
    github-actionsbot
    on Dec 18, 2025 – with GitHub Actions

    This issue is stale because it has been open for 120 days with no activity. It may be removed by administrators of this project at any time. Remove the stale label or comment to request for removal of it to prevent this.

  6. github-actions
    added
    no-issue-activity
    on Dec 18, 2025

  7. github-actions commented on Jan 6, 2026

    @github-actions
    github-actionsbot
    on Jan 6, 2026 – with GitHub Actions

    This issue was closed because it has been stale for 120 days with no activity.

  8. github-actions
    closed this as not plannedon Jan 6, 2026
  9. github-project-automation
    moved this to Done in Apache CloudStack BugFest - Issueson Jan 6, 2026
  10. DaanHoogland
    removed this from Apache CloudStack BugFest - Issueson Jan 6, 2026
  11. DaanHoogland
    reopened this on Jan 6, 2026
  12. github-actions
    removed
    no-issue-activity
    on Jan 8, 2026

  13. Yuliia7-1 commented on Jul 6, 2026

    @Yuliia7-1
    Yuliia7-1
    on Jul 6, 2026
    Author

    Hi @DaanHoogland
    What do you think about prioritizing this issue as a bug?

    While testing, I noticed that the status field remains empty for ISOs and templates. For example, in the new "Upload from local" for Volume workflow, volumes correctly return the upload status through uploaderrormsg and related status fields, but similar information is not available for ISOs and templates.

    Would it make sense to implement a status flow for ISOs and templates similar to the one already used for volumes? This would provide more consistent behavior across different upload workflows and make it easier for users to understand the current upload state and troubleshoot failures.

  14. DaanHoogland commented on Jul 13, 2026

    @DaanHoogland
    DaanHoogland
    on Jul 13, 2026
    Contributor

    Hi @DaanHoogland What do you think about prioritizing this issue as a bug?

    prioritising and marking as bug have little to no correlation , @Yuliia7-1

    While testing, I noticed that the status field remains empty for ISOs and templates. For example, in the new "Upload from local" for Volume workflow, volumes correctly return the upload status through uploaderrormsg and related status fields, but similar information is not available for ISOs and templates.

    It makes sense to align this functionality. Maybe you can bring this to the attention of the developer implemting the new uploadVolume workflow? I am not sure how much work this would be.

    Would it make sense to implement a status flow for ISOs and templates similar to the one already used for volumes? This would provide more consistent behavior across different upload workflows and make it easier for users to understand the current upload state and troubleshoot failures.

    agreed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    component:templates

    Type

    Feature

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions