agama-state.md

Agama Status

The new API of Agama offers an end-point to retrieve the status of the installation (GET /status).

The status contains the installation state and the progress of each scope in a single JSON file.

Installation State

The installation can be in one of the following states:

• configuring: the installation is being configured.
• installig: the system is being installed.
• finished: the installation is done.

Progress Report

There is a progress for each scope (e.g., storage, software, network, etc).

The progress contains the following information:

• Scope
• Number of steps (size)
• Optionally, the name of each step (steps)
• Name of current step (step)
• Index of current step (index)

Example

{
  "state": "configuring",
  "progress": [
    {
      "scope": "storage",
      "size": 2,
      "steps": ["Probe system", "Calculate proposal"],
      "step": "Calculate proposal",
      "index": 2,
    },
    {
      "scope": "software",
      "size": 2,
      "step": "Calculate proposal",
      "index": 1,
    }
  ]
}