Zum Hauptinhalt springen

Ansible

Mit Semaphore UI können Sie Ansible-Playbooks ausführen. Dazu müssen Sie ein Ansible Playbook-Template erstellen.

  1. Öffnen Sie den Bereich Task-Templates, klicken Sie auf Neues Template und dann auf Ansible Playbook.

  1. Richten Sie das Template ein.

Im Template können Sie die folgenden Parameter angeben:

  • Repository
  • Pfad zur Playbook-Datei
  • Arbeitsverzeichnis (optional)
  • Inventory
  • Variablengruppen
  • Vaults
  • Zusätzliche CLI-Argumente (tags, skip-tags, limit, Ausführlichkeit)
  • Umgebungsvariablen

Arbeitsverzeichnis​

Verwenden Sie Arbeitsverzeichnis, um Ansible-Befehle aus einem Unterverzeichnis des Template-Repositorys auszuführen. Geben Sie einen Pfad relativ zum Repository-Stammverzeichnis an. Wenn zum Beispiel ansible.cfg in <repository>/automation liegt, geben Sie automation ein. Absolute Pfade und Pfade außerhalb des Repositorys werden abgelehnt. Wird nichts angegeben, verwendet Semaphore das Repository-Stammverzeichnis.

Das Arbeitsverzeichnis beeinflusst das Ansible-Verhalten, das vom aktuellen Verzeichnis des Prozesses abhängt. Die Suchreihenfolge der Konfigurationsdatei von Ansible umfasst ansible.cfg im aktuellen Verzeichnis. Das Arbeitsverzeichnis beeinflusst auch die Auflösung relativer Pfade in zusätzlichen CLI-Argumenten; Beispiele sind --extra-vars @vars.yml und --private-key key.pem. Playbook- und Datei-Inventory-Pfade bleiben relativ zu ihren jeweiligen Repository-Stammverzeichnissen.

Das Ändern des Arbeitsverzeichnisses fügt für sich genommen nicht das Unterverzeichnis roles/ oder collections/ dieses Verzeichnisses zu den Suchpfaden von Ansible hinzu. Playbook-relative Rollenerkennung und Collections neben einem Playbook basieren weiterhin auf dem Speicherort des Playbooks. Das Arbeitsverzeichnis kann ihre Erkennung dennoch indirekt beeinflussen, wenn die ausgewählte ansible.cfg roles_path oder collections_path konfiguriert.

Template-Typen​

Ein ansible-playbook-Template kann einen der folgenden Typen haben:

Task​

Führt einfach die angegebenen Playbooks mit den angegebenen Parametern aus.

Wenn Sie das Template über einen API-Aufruf mit der limit-Funktion starten möchten, aktivieren Sie unbedingt die Option Ansible-Prompts: Limit. Andernfalls wird das im API-Aufruf gesetzte Limit ignoriert. Bei einem über die API ausgelösten Task führt dies zu keiner interaktiven Abfrage; der Task läuft unbeaufsichtigt.

Build​

Dieser Template-Typ sollte zum Erstellen von Artefakten verwendet werden. Die Startversion des Artefakts kann in einem Template-Parameter angegeben werden. Jede Ausführung erhöht die Artefaktversion.

Semaphore unterstützt Artefakte nicht von Haus aus, es stellt lediglich eine Task-Versionierung bereit. Die Erstellung der Artefakte müssen Sie selbst implementieren. Lesen Sie den Artikel CI/CD, um zu erfahren, wie das geht.

Deploy​

Dieser Template-Typ sollte zum Bereitstellen von Artefakten auf den Zielservern verwendet werden. Jedes deploy-Template ist mit einem build-Template verknüpft.

So können Sie eine bestimmte Version des Artefakts auf den Servern bereitstellen.

Template-Optionen​

Zeitplan​

Sie können die Task-Planung einrichten, indem Sie in den Template-Einstellungen einen Cron-Zeitplan angeben. Das Format der Cron-Ausdrücke finden Sie in der Dokumentation.

Einen Task ausführen, wenn ein neuer Commit zum Repository hinzugefügt wird​

Sie können Cron verwenden, um regelmäßig nach neuen Commits im Repository zu suchen und bei deren Eintreffen einen Task auszulösen.

Beispielsweise haben Sie den Quellcode der App im Git-Repository. Sie können es zu Repositories hinzufügen und den Build-Task bei neuen Commits auslösen.

Tags, skip-tags und limit​

Templates unterstützen Ansible-CLI-Optionen:

  • --tags
  • --skip-tags
  • --limit

Diese können im Template gesetzt und beim Erstellen eines Tasks überschrieben werden. Stellen Sie sicher, dass die entsprechenden Prompts aktiviert sind, wenn Sie diese Werte über die API übergeben möchten.

Parallelität (--forks / -f)​

Steuern Sie, mit wie vielen Hosts Ansible parallel Verbindungen aufbaut, indem Sie --forks oder -f in den Zusätzlichen CLI-Argumenten des Templates übergeben. Die Argumente müssen gültiges JSON sein – verwenden Sie ein Array aus einzelnen Token:

["--forks", "10"]

Die Kurzform wird ebenfalls unterstützt:

["-f", "10"]

Wenn Überschreiben der Argumente im Task erlauben im Template aktiviert ist, kann ein Task zur Laufzeit seinen eigenen forks-Wert angeben. Ansible erhält sowohl die Template- als auch die Task-Argumente; das letzte --forks / -f auf der Befehlszeile gewinnt.

Wenn die Argumente kein gültiges JSON sind, schlägt der Task mit einem aussagekräftigen Validierungsfehler fehl, bevor die Ausführung beginnt.

Authentifizierung​

Die Authentifizierung für die Hosts im Playbook erfolgt über die Benutzerverweise aus dem Schlüsselspeicher im Inventory. Der Benutzer für SSH wird durch den optionalen Benutzer am Schlüsselspeicher-Element bestimmt.

Mehrere Vault-Passwörter​

Sie können einem Template mehrere Vault-Passwörter aus dem Schlüsselspeicher zuordnen. Während der Ausführung versucht Ansible, mit den angegebenen Passwörtern zu entschlüsseln.

Ausführlichkeitsstufe​

Sie können die Ausführlichkeit von Ansible für einen Task (zum Beispiel -v, -vvv) im Template-/Task-Formular anpassen, um die Fehlersuche zu erleichtern.