Overview
An action kept in Git points at an entry file: a YAML file in the same folder as the action's files. It names the file to run and the success and timing rules. These are the formats SQIBS offers for download.
You need
[Automation with Git](https://sqibs-docs.callgoose.com/automation/automation-git/) set upWhere
Your Git repositoryResult
Actions SQIBS can run from GitFile names in the entry file are names only (no path): the files sit next to the entry file. expectedRunTimeInMinutes takes 1 to 60.
Bash action
action:
bash:
# Bash file (e.g., check_filesystem_usage.bsh).
# Enter the file name only.
file: ""
# Response (exit status) indicating the action was executed successfully. For example, in Linux, an exit status of 0 indicates success.
successExitCode: 0
# Expected run time.
# We will wait up to the specified time. If the action is not completed by then, we will consider it a failure.
# Enter a value between 1 and 60.
expectedRunTimeInMinutes: 10
Python action
action:
python:
# Python file (e.g., check_filesystem_usage.py).
# Enter the file name only.
file: ""
# Response (exit status) indicating the action was executed successfully. For example, in Linux, an exit status of 0 indicates success.
successExitCode: 0
# Expected run time.
# We will wait up to the specified time. If the action is not completed by then, we will consider it a failure.
# Enter a value between 1 and 60.
expectedRunTimeInMinutes: 10
PowerShell action
action:
powershell:
# Powershell file (e.g., check_filesystem_usage.ps1).
# Enter the file name only.
file: ""
# Response (exit status) indicating the action was executed successfully. For example, in Linux, an exit status of 0 indicates success.
successExitCode: 0
# Expected run time.
# We will wait up to the specified time. If the action is not completed by then, we will consider it a failure.
# Enter a value between 1 and 60.
expectedRunTimeInMinutes: 10
SSH action
action:
ssh:
# The OS command that needs to be executed on the connected server. eg: "df -hT"
osCommand: ""
# Response (exit status) indicating the action was executed successfully. For example, in Linux, an exit status of 0 indicates success.
successExitCode: 0
# Expected run time.
# We will wait up to the specified time. If the action is not completed by then, we will consider it a failure.
# Enter a value between 1 and 60.
expectedRunTimeInMinutes: 10
Ansible action
action:
ansible:
# Which operation to do. Possible values are "playbook", "command"
# "playbook" - Run the playbook. Additional commands can also be executed afterward if needed.
# "command" - Run ansible commands.
operation: "playbook"
# Ansible playbook file (e.g., check_filesystem_usage.yml).
# Mandatory if the operation is "playbook", else it is optional.
# Enter the file name only.
playbookFile: ""
# Specify options for the Ansible playbook. eg: "-e var_name=value" to pass extra variables, or "--limit=host_group" to target specific hosts
# It is optional. You can leave it as empty.
playbookOption: ""
# Ansible commands to be executed as a part of operation.
# If the operation is "playbook", then these commands will be executed only after completing the playbook.
# Mandatory if the operation is "command", else it is optional.
ansibleCommands: []
# Response (exit status) indicating the action was executed successfully. For example, in Linux, an exit status of 0 indicates success.
successExitCode: 0
# Expected run time.
# We will wait up to the specified time. If the action is not completed by then, we will consider it a failure.
# Enter a value between 1 and 60.
expectedRunTimeInMinutes: 10
Terraform action
action:
terraform:
# Which operation to do. Possible values are "apply", "destroy", "command"
# "apply" - Run the Terraform file with the apply command. Additional commands can also be executed afterward if needed.
# "destroy" - Run the Terraform file with the destroy command. Additional commands can also be executed afterward if needed.
# "command" - Run terraform commands.
operation: "apply"
# Terraform file (e.g., main.tf).
# Mandatory if the operation is "apply" or "destroy", else it is optional.
# Enter the file name only.
terraformFile: ""
# Specify options for 'terraform apply/destroy'. eg: '-var-file="variables.tfvars"' to specify a file containing variable values
# It is optional. You can leave it as empty.
# Only valid if the operation is "apply" or "destroy"
operationOptions: ""
# Specify options for 'terraform init', which initializes the working directory. eg: '-backend-config=backend_configs.tfvars' to customize backend configurations.
# It is optional. You can leave it as empty.
initOptions: ""
# Terraform commands to be executed as a part of operation.
# If the operation is "apply" or "destroy", then these commands will be executed only after completing the operation.
# Mandatory if the operation is "command", else it is optional.
terraformCommands: []
# Response (exit status) indicating the action was executed successfully. For example, in Linux, an exit status of 0 indicates success.
successExitCode: 0
# Expected run time.
# We will wait up to the specified time. If the action is not completed by then, we will consider it a failure.
# Enter a value between 1 and 60.
expectedRunTimeInMinutes: 10
Kubernetes action
action:
kubernetes:
# Which operation to do. Possible values are "apply", "command"
# "apply" - Run the Kubernetes file. Additional commands can also be executed afterward if needed.
# "command" - Run kubernetes commands.
operation: "apply"
# Kubernetes file (e.g., nginx-deployment.yaml).
# Mandatory if the operation is "apply", else it is optional.
# Enter the file name only.
kubernetesFile: ""
# Kubernetes commands to be executed as a part of operation.
# If the operation is "apply", then these commands will be executed only after completing the operation.
# Mandatory if the operation is "command", else it is optional.
kubernetesCommands: []
# Response (exit status) indicating the action was executed successfully. For example, in Linux, an exit status of 0 indicates success.
successExitCode: 0
# Expected run time.
# We will wait up to the specified time. If the action is not completed by then, we will consider it a failure.
# Enter a value between 1 and 60.
expectedRunTimeInMinutes: 10