Getting Started
Special
SINGLE SIGN-ON
Teams
Users
Escalation Policies
Service
Incident
On-Call Shift
Schedules
Schedule Override
API Token
Logs
Webhook
Apps Integration
Reports
Preference
Profile
Automation
FAQ
Runner Profile
Creating a Profile Using Profile Type: Runner
Overview
This document provides step-by-step instructions for creating and configuring a profile using the Runner profile type in Callgoose SQIBS automation platform. Runner profiles allow users to set up unique runner configurations necessary for automation workflows. Below are the steps and details for creating a Runner profile.
Steps to Add a Runner Profile
- Navigate to Add Profile
- Access the automation section in the Callgoose SQIBS automation platform.
- Go to Automation, and you can see Profiles.
- Click on Profiles and then click on Add Profile to create a new profile.
- Select Profile Type
- Choose Runner as the profile type from the list of available options.
- Fill in the Details
- Name*:
- Provide a descriptive name for the profile.
- Example: Runner Instance 1.
- Description*:
- Add a detailed description of the profile.
- Example: This profile sets up a unique runner configuration for executing tasks.
- Save the Profile
- Click on Save to finalize the creation of the profile.
- Download the Key
- After saving the profile, you will be prompted to download a key.
- This key is unique to each runner program and is crucial for its operation.
- Download the key and use it together with the Callgoose SQIBS Runner jar file.
- View the Runner Profile
- Once created, the new Runner profile will appear in the Profiles section.
- You can manage or edit the profile as needed.
Internal Profiles
- Access Internal Profiles
- Click on Show Internal Profiles in the Profiles section.
- Add Internal Profile
- Click on Add Profile within the Internal Profiles section.
- Select Profile Type
- Choose the required profile type from the available options. These include:
- Bash
- Python
- SSH
- Ansible
- Terraform
- Kubernetes
- PowerShell
- Fill in the Details
- Follow the same steps as described for creating a profile for the selected type.
- Tooltip help is available for all options to guide you through the configuration.
Additional Notes
- Fields marked with an asterisk (*) are mandatory.
- The downloaded key is essential for the Runner program to function correctly. Ensure it is securely stored.
- Use descriptive names and descriptions to make it easier for team members to understand the purpose of the profile.
Example Configuration
Name: Runner Instance 1
Description: This profile sets up a unique runner configuration for executing tasks.
Conclusion
By following these steps, you can effectively create a Runner profile in Callgoose SQIBS automation platform. Runner profiles are essential for setting up and managing automation workflows, ensuring secure and efficient execution.