How to check the progress of a running deployment if the window is closed

When performing a deployment using CMJ (Configuration Manager for Jira) and accidentally closing the deployment window, you can still monitor the progress of your operation through alternative methods. This guide will walk you through alternative methods to check the status and progress of your deployment even after closing the window.

Method 1: Check CMJ's Audit Logging

• Go to Audit page where you can look for entries related to CMJ operations. You can filter by time range to locate recent activity.

• Search for an entry with a message similar to:

  Started deployment of configuration snapshot '{snapshot configuration name}'

  Where {snapshot configuration name} is the name of your configuration snapshot.

• Check the timestamp and details provided in the log entry. This will indicate whether the deployment is still in progress or has encountered any issues.

Method 2: Retrieve Deployment Status Using Operation ID

• If a deployment fails due to an ongoing operation, you'll typically see an error message indicating that another deployment is already in progress.

• Alongside this message, you'll find the unique Operation ID associated with the running deployment.

• Use the provided operation ID to construct a URL for accessing CMJ's REST API endpoint.

• Example URL format:

http://host:port/context/rest/configuration-manager/1.0/deployment/{currentOperationID}

Replace {currentOperationID} with the operation ID obtained from the failed deployment message.

For example, you would use the following path to access the API on a locally run instance of Jira with a context path of /jira:

http://localhost:2990/jira/rest/configuration-manager/1.0/deployment/{currentOperationID}

• Make a GET request to the constructed URL using a tool like a web browser or cURL.

• This API request will return a JSON response containing detailed information about the ongoing deployment, including its current status, progress messages, and completion percentage.

• Upon successful retrieval, analyze the JSON output to understand the status of the deployment:

  {
    "id": 1,
    "status": "running",
    "message": "Deployment in progress. Importing presentation details.",
    "changeCount": 10,
    "progressMessages": [
      "Changed query of filter 'TestFilter' from 'project = Test AND issuetype = Bug' to 'project = Test2 AND issuetype = Story'.",
      "Changed query of filter 'TestFilter2' from 'project = 'Test Service Desk' AND issuetype = Task' to 'project = 'Test Service Desk' AND issuetype = Test.",
      "Persisting service desk changes",
      "Persisting workflow changes",
      "Persisting remaining changes",
      "Importing presentation details"
    ],
    "progressDouble": 0.5,
    "duration": 0
  }

• By default, the progress displayed in the JSON response will not automatically refresh. To see updated progress, manually refresh the page or resend the GET request to the same REST API endpoint.

• Each time you refresh or requery the endpoint, you'll get the most recent progress update for the ongoing deployment.

By leveraging the operation ID and CMJ's REST API endpoint, combined with manual refreshing of the page, you can effectively monitor the progress and status of an ongoing deployment even after closing the deployment window prematurely.