Skip to content

Update Ansible task template guide and added Task Template overview #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added src/.gitbook/assets/ansible_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.gitbook/assets/ansible_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
* [Runners 🅿](./user-guide/projects/runners.md)
* [Task Templates](./user-guide/task-templates/README.md)
* [Ansible](./user-guide/task-templates/ansible.md)
* [Terraform/OpenTofu](./user-guide/task-templates/terraform/README.md)
* [Terraform/OpenTofu](./user-guide/task-templates/terraform.md)
* [Workspaces](./user-guide/task-templates/terraform/workspaces.md)
* [States 🅿](./user-guide/task-templates/terraform/states.md)
* [Shell/Bash scripts](./user-guide/task-templates/bash.md)
Expand Down
2 changes: 1 addition & 1 deletion src/user-guide/task-templates/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Task Templates

Templates define how to run an Ansible Playbook. The template allows you to specify the following parameters:
Templates define how to run Semaphore tasks. Currently the following task types are supported:

* Playbook repository
* Playbook filename
Expand Down
59 changes: 53 additions & 6 deletions src/user-guide/task-templates/ansible.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,61 @@

# Ansible

Using Semaphore UI you can run Terraform code. To do this, you need to create a **Terraform Code Template**.
Using Semaphore UI you can run Ansible playbooks. To do this, you need to create an **Ansible Playbook** Template.

1. Go go Task Templates section and click the **New Template** button.
1. Go go **Task Templates** section, click on **New Template** and then **Ansible Playbook**.

![](<../../.gitbook/assets/terraform_1.webp>)
![](<../../.gitbook/assets/ansible_1.png>)

2. Set up the template and click the **Create** button.
2. Set up the template.

![](<../../.gitbook/assets/terraform_2.webp>)
The template allows you to specify the following parameters:

3. You can now run your Terraform code.
* Repository
* Path to playbook file
* Inventory
* Variable Groups
* Vaults
* and much more

![](<../../.gitbook/assets/ansible_2.png>)

An ansible-playbook template can be one of the following types:

* [Task](#task)
* [Build](#build)
* [Deploy](#deploy)

### Task

Just runs specified playbooks with specified parameters.

### Build

This type of template should be used to create [artifacts](https://en.wikipedia.org/wiki/Artifact\_\(software\_development\)). The start version of the artifact can be specified in a template parameter. Each run increments the artifact version.

![](<../../.gitbook/assets/template\_new\_build\_ipad (1).png>)

Semaphore doesn't support artifacts out-of-box, it only provides task versioning. You should implement the artifact creation yourself. Read the article [CI/CD](../../administration-guide/cicd.md) to know how to do this.

### Deploy

This type of template should be used to deploy artifacts to the destination servers. Each `deploy` template is associated with a `build` template.

![](../../.gitbook/assets/template\_new\_deploy\_ipad.png)

This allows you to deploy a specific version of the artifact to the servers.

### Schedule

You can set up task scheduling by specifying a cron schedule in the template settings. Cron expression format you can find in [documentation](https://pkg.go.dev/github.com/robfig/cron/v3#hdr-CRON\_Expression\_Format).

![](../../.gitbook/assets/template\_schedule.png)

#### Run a task when a new commit is added to the repository

You can use cron to periodically check for new commits in the repository and trigger a task upon their arrival.

For example you have source code of the app in the git repository. You can add it to **Repositories** and trigger the Build task for new commits.

![](../../.gitbook/assets/template\_schedule\_commit.png)