hardware-observer docs explanation - hardware-observer charm lifecycle

charm
,
1

Lifecycle of the hardware-observer charm

This document describes the details of each event handler in hardware-observer.

hardware-observer-lifecycle.excalidraw
hardware-observer-lifecycle.excalidraw1526×1832 290 KB

The diagram above shows the basic lifecycle of the hardware-observer charm.

Install/ upgrade-charm

  • During these events we install all the required user uploaded resources after checking the available collectors present on the host and populating the “hw_tool_enable_list”.
  • If everything goes well, we store the successful resource installed state in StoredState so that it can be used later on during the checks in update-status event handler.
  • The charm also notifies the user during this event in case of any missing resources that are required to be uploaded by setting the application status to Blocked.
  • Then we proceed to install all the exporters (currently prometheus-hardware-exporter and smartctl_exporter).
  • Finally we execute the update_status event handler to ensure that the right charm status is set.

Remove

  • Remove all enabled tools and hardware resources that have been uploaded by the user and installed on the host by the charm.
  • Remove all installed exporters.
  • Remove the charm itself.

Update-status

  • Set the required charm’s status to “Blocked” based on various conditions.
    • If all resources are not installed
    • if cos-agent relation is not present
    • If exporter config is not correctly provided
    • If any enabled hardware tools have not been installed correctly
    • If any of the exporters are not healthy (service failed for some reason)
  • Otherwise, set the charm’s status to “Active”.

Config-changed

  • We defer the event in case all required resources have not been uploaded and installed.
  • If the cos-agent relation is present, then we validate the provided config to make sure it’s proper and render the configuration file for each exporter. If the config file setup fails for any reason, we set the charm’s status to “Blocked” with an appropriate status message.
  • Finally we execute the update-status event handler to ensure that the right charm status is set.

Cos-agent relation joined

  • Defer the event in case the resources have not been uploaded and installed.
  • Once that’s done, we proceed to enable and start each exporter service.
  • Run update-status event handler to ensure the right charm status is set.

Cos-agent relation departed

  • Disable and stop each running exporter service.
  • Run update-status event handler to ensure the right charm status is set.