Skip to content

Automated Resource Management User Guide

Once you have setup and configured all components you are ready to start using the automated resource management orchestration solution.

How to use

The general user guide is quite simple:

  • any changes to devices in NetBox will be automatically picked up by Camunda and then reflected in Uptime Kuma and Oxidized (if enabled).

Note

If you are using nmaas please note that any change that need to be reflected in Oxidized will be made via the Git repo. All changes to the Git repo trigger a restart of the Oxidized instance, and it might take a little bit of time for it to be reloaded properly. Be patient if the Oxidized URL report a "503 Service Temporarily Unavailable" error.

The information related to devices stored in NetBox and relevant for the implementation of this orchestration scenario is presented in the figure below.

relevant device info in NetBox

Do not forget:

  • If you are using Oxidized, you must add the tags for model and group when creating a device
    • if a device does not have a model and group then Oxidized will not be informed about any device related events
  • For a monitoring probe to be added (and a configuration backup defined) a device must
    • be in the state active
    • have at least one interface
    • have at least one primary IP address
    • if any of these are not met, the device is considered non-active

Note

In Uptime Kuma the monitoring probe is named as device_name[netbox_id]. Additional IPv6 string is added to the name if the primary IP address is of that type.

Note

In Oxidized there always will be a DUMMY entry in the list as the software does not support the case when there are no active devices at a certain moment.

This is a list of some test actions you can make to see the workings of the solution:

  • create a new active device

Examples of this functionality are presented in the videos below:

  • rename an active device
  • change/remove the primary IP address of an active device
  • change device state
  • add/change tag
  • remove device interface with primary IP address
  • add both IPv4 and IPv6 primary IP addresses