Skip to content

Automated Resource Management: Run in nmaas

Warning

To be able to run the automated resource management use-case in nmaas you need an nmaas account and access to a domain where you can instantiate the use-case components.

Step-by-Step Guide on instantiating the components

Note

Use the highest versions of the components available, the use-case process orchestration is kept up-to-date with the newest nmaas component versions.

  1. Login to nmaas
  2. Deploy a NetBox instance
  3. Configure the NetBox instance
    • fill out the configuration form with the required credentials
    • make sure you remember the API token, you will need it later
  4. (optional) Deploy an Oxidized instance
  5. (optional) Configure the Oxidized instance
    • fill out the configuration form (Base tab only)
    • it doesn't matter what you will provide for device username, password and IP address, they will not be used later on, so just supply some dummy information in these fields
  6. Once the two components are activated, deploy a GP4L Orchestrator instance
  7. Configure the GP4L Orchestrator instance
    • provide the credentials for the Camunda orchestrator admin user
    • access your NetBox instance in a new tab and copy the URL
    • paste the URL and add /api at the end
    • paste the token you saved before
    • for this use-case you must use Uptime Kuma, so enable must be set to yes
    • define the credentials for accessing Uptime Kuma via GUI and API
    • choose whether you want Uptime Kuma to notify you via email for any monitoring events
    • choose whether you will enable or no Oxidized
      • go to your Oxidized instance page and choose Actions -> Configure
      • copy the ssh:// path
      • paste the path in the configuration form
      • define the rest of the required Oxidized credentials
    • choose enable LibreBooking no
  8. Once the instance is active, go to actions and access the Uptime Kuma GUI
    • try to login with the credentials you defined

Warning

In some cases, not all configuration parameters are correctly processed by nmaas. In this case you will not be able to login to Uptime Kuma. This is a sign that the instance has not been created correctly and you should remove it, and try to deploy and configure a new orchestrator instance. The nmaas team is actively working on finding a remedy for this problem.

  1. You are now ready to move to step 2: Configure