Zum Hauptinhalt springen

Repositories

Ein Repository ist ein Ort zum Speichern und Verwalten von Ansible-Inhalten wie Playbooks und Rollen.

Semaphore versteht Repositories, die:

  • ein lokales Dateisystem sind (/path/to/the/repo)
  • ein lokales Git-Repository sind (file://)
  • ein entferntes Git-Repository sind, auf das über HTTPS (https://) oder SSH (ssh://) zugegriffen wird
  • das Protokoll git:// wird unterstützt, ist aber aus Sicherheitsgründen nicht empfohlen.

Alle Aufgabenvorlagen benötigen ein Repository, um ausgeführt werden zu können.

Authentifizierung​

Wenn Sie ein entferntes Repository verwenden, das eine Authentifizierung erfordert, müssen Sie im Bereich Key Store von Semaphore einen Schlüssel konfigurieren.

Für entfernte Repositories, die SSH verwenden, müssen Sie Ihren SSH-Schlüssel im Key Store verwenden.

Für entfernte Repositories ohne Authentifizierung können Sie einen Schlüssel vom Typ None erstellen.

Der Schlüssel eines Repositories wird nur für dieses Repository verwendet. Um Submodule, Rollen aus requirements.yml oder andere anderswo gehostete Repositories mit eigenen Zugangsdaten zu erreichen, fügen Sie eine Zuordnung in der Host config hinzu.

Ein neues Repository erstellen​

  1. Stellen Sie sicher, dass Sie den Schlüssel für das hinzuzufügende Repository im Bereich Key Store konfiguriert haben.

  2. Gehen Sie zum Bereich Repositories von Semaphore und klicken Sie auf die Schaltfläche Neues Repository in der oberen rechten Ecke.

  3. Konfigurieren Sie das Repository:

    • Benennen Sie das Repository
    • Fügen Sie die URL hinzu. Die URL muss mit einem der folgenden beginnen:
      • /path/to/the/repo für einen lokalen Ordner im Dateisystem
      • https:// für ein entferntes Git-Repository mit Zugriff über HTTPS
      • ssh:// für ein entferntes Git-Repository mit Zugriff über SSH
      • file:// für ein lokales Git-Repository
      • git:// für ein entferntes Git-Repository mit Zugriff über das Git-Protokoll
    • Legen Sie den Branch des Repositories fest; wenn Sie nicht sicher sind, ist es wahrscheinlich master oder main
    • Aktivieren Sie Single checkout for all templates, wenn das Repository ein Monorepo ist, das alle Aufgabenvorlagen gemeinsam nutzen sollen, siehe Monorepo
    • Wählen Sie den Zugangsschlüssel aus, den Sie vor dem Einrichten dieses Repositories konfiguriert haben.

  4. Klicken Sie auf Speichern, sobald alles konfiguriert ist.

Monorepo: ein Checkout für alle Vorlagen​

Seit v2.20

Die Option Single checkout for all templates ist seit Semaphore 2.20 verfügbar. Frühere Versionen klonen ein Repository immer einmal pro Vorlage.

Standardmäßig klont Semaphore ein Repository einmal pro Aufgabenvorlage, sodass jede Vorlage in einer eigenen Kopie arbeitet. Bei einem großen Repository, das viele Vorlagen gemeinsam nutzen, kosten die Kopien Speicherplatz, und jeder Task beginnt mit einem Clone oder Pull seiner eigenen Kopie.

Aktivieren Sie Single checkout for all templates, um das Repository einmal zu klonen und diesen Checkout zwischen allen Vorlagen des Projekts zu teilen. Die Option ist für einen lokalen Ordner (/path/to/the/repo) nicht verfügbar, da dieser nie geklont wird.

Repository-Formular mit aktivierter Option Single checkout for all templates

So funktioniert der gemeinsame Checkout:

  • Bevor ein Task startet, sperrt Semaphore den Checkout, holt (fetch) und zieht (pull) den im Repository konfigurierten Branch und gibt die Sperre wieder frei. Tasks anderer Vorlagen warten auf die Sperre, während der Checkout aktualisiert wird, die Tasks selbst laufen jedoch parallel.
  • Jeder Branch erhält weiterhin einen eigenen Checkout, sodass Repositories mit unterschiedlichen Branches nie denselben Arbeitsbaum teilen.
  • Der Checkout wird gemeinsam genutzt, aber das Ansible-Home-Verzeichnis (aus requirements.yml installierte Rollen und Collections) bleibt für jede Vorlage getrennt.

Da alle Vorlagen im selben Checkout auf demselben Branch arbeiten, kann eine Vorlage eines Monorepos keinen eigenen Branch haben und den Branch-Prompt, mit dem ein Task einen Branch oder Commit wählen kann, nicht aktivieren. Das Vorlagenformular deaktiviert beides und erklärt den Grund, und die API lehnt eine solche Vorlage ab. Stellen Sie sicher, dass die Playbooks nicht in den Checkout schreiben: Ein geänderter Arbeitsbaum bricht den nächsten Pull, und Semaphore entfernt dann den Checkout und klont ihn neu.

Ein bestehendes Repository bearbeiten​

  1. Gehen Sie zum Bereich Repositories von Semaphore.

  2. Klicken Sie auf das Stiftsymbol neben dem Repository, das Sie ändern möchten; anschließend wird Ihnen die Repository-Konfiguration angezeigt.

Ein Repository löschen​

Stellen Sie sicher, dass das zu löschende Repository von keiner Aufgabenvorlage verwendet wird. Ein Repository kann nicht gelöscht werden, wenn es in einer Aufgabenvorlage verwendet wird:

  1. Gehen Sie zum Bereich Repositories von Semaphore.

  2. Klicken Sie auf das Papierkorbsymbol des Repositories, das Sie löschen möchten.

  3. Klicken Sie im Bestätigungsdialog auf Ja, wenn Sie das Repository wirklich löschen möchten.

Anforderungen​

Bei der Projektinitialisierung sucht Semaphore nach Ansible-Rollen und -Collections aus requirements.yml an den folgenden Orten und in der folgenden Reihenfolge und installiert sie.

Rollen​

  • playbook_dir/roles/requirements.yml
  • playbook_dir/requirements.yml
  • repo_path/roles/requirements.yml
  • repo_path/requirements.yml

Collections​

  • playbook_dir/collections/requirements.yml
  • playbook_dir/requirements.yml
  • repo_path/collections/requirements.yml
  • repo_path/requirements.yml

Verarbeitungslogik​

  • Jede Datei wird unabhängig verarbeitet
  • Wenn eine Datei existiert, wird sie entsprechend ihrem Typ (Rolle oder Collection) verarbeitet
  • Wenn die Verarbeitung einer Datei zu einem Fehler führt, wird der Installationsvorgang abgebrochen und der Fehler zurückgegeben
  • Dieselbe requirements.yml-Datei in den Stammverzeichnissen (playbook_dir/requirements.yml und repo_path/requirements.yml) wird zweimal verarbeitet - einmal für Rollen und einmal für Collections

Semaphore versucht, alle diese Orte zu verarbeiten, unabhängig davon, ob vorherige Orte gefunden oder erfolgreich verarbeitet wurden, außer im Fehlerfall.