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. Deploy a Booked instance
  7. Configure the Booked instance
    • fill out the configuration form (Base tab only)
    • make sure you checked the following checkboxes
      • email notifications
      • user registration
      • use of Book API
      • (optional) AirFlow integration = if you want to implement authorisation via Bastion
  8. Setup the admin user credentials for Booked
    • go to the active Booked instance GUI
    • choose I Forgot My Password
    • you will receive an email (on the address you provided in configuration) with a temporary password
    • login to Libre Booking using username admin and the provided password
    • go to My Account -> Profile and set a new password
  9. (optional) Deploy a Bastion instance
  10. (optional) Configure a Bastion instance
    • fill out the configuration form (Base tab only)
    • provide the admin ssh key that will never expire
    • enable the ssh key management application using the checkbox
  11. Once all components are activated, deploy a GP4L Orchestrator instance
  12. 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 yes
      • provide the URL to the active Booked instance (should end with /)
      • provide the Libre Booking credentials (username admin, passwords the one you defined in step 7)
      • define the email from which you will receive Libre Booking notifications
        • if you want you can define any email you want in the domain @nmaas.eu
  13. 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. (optional) Deploy an Apache AirFlow instance
  2. (optional) Create a git repository for the AirFlow workflows
    • you can also use an existing repository that you have full access to if you prefer
  3. (optional) Configure the AirFlow instance
    • define the credentials for AirFlow
    • there is no need to enable Flower
    • enable Git Sync
      • provide the git credentials and access keys

Warning

Do not leave the sub-directory field empty. Create a folder in your repository and provide its name in the form.

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