Integration with GitLab Runner

To manage / onboard GitLab Runner as the RBA tool, user needs to perform the following steps:

  1. On the left menu bar, Go to Runbooks → Manage Runbook Tool. The Manage Runbook Tool appears.
  2. Click Create & Map Runbook Tool to add a new tool or click to edit an existing runbook automation tool.
  3. Select the organization for which you need to create a runbook tool in the Organization field.
  4. Type the runbook tool name in the Runbook Tool Name field.
  5. Select GitLab Runner from the Runbook tool type drop-down.
  6. Select REST API as the integration method for BigFix for the integration method field.
  7. Select Project Access Token as the Authentication Type.
    Figure 1. Manage Runbook Tool

    Selection of from Project Access Token requires users to enter Project Token

  8. Type the URL in the API URL*. field.

    Sample URL - https://<ip>:<port>

  9. Select the Integration Method Type as POST.
    Note:
    API URL is dependent on the selected integration method

  10. Enter Project Token.

  11. Specify the path to get the consolidated scripts for the execution of runbooks in the Master Runbook Path field. This will be provided by respective Runbook Tool teams if they have a master runbook.
    Note:
    This is not a mandatory field. Users can change and run these scripts any time.
  12. Select Proxy Required, if the environment needs access to content from servers outside a firewall.
  13. Type the return code key in the Return Code Key field to identify the success or failure of runbook execution. E.g. status
  14. Type the return message key in the Return Message Key field to display the success or failure of runbook execution. E.g. result.
  15. Type the Toil Value (for manual execution) which implies the manual execution time of runbook under this tool (in minute)
  16. Type the Toil Value (for auto execution) which implies the auto execution time of runbook under this tool (in minute) if available else it’s a non- mandatory field.
  17. Type the Connection Retry Count which shows the retry count in case the connection with the RBAtool fails.
    Figure 2. Manage Runbook Tool (Cont.)
  18. Click Submit/Update for adding a new tool or making changes in an existing tool. An appropriate success message will be displayed.