Zum Hauptinhalt springen

Benutzerhandbuch

Dieser Bereich richtet sich an Personen, die bereits Zugriff auf ein Semaphore-Projekt haben. Alles hier geschieht in der Weboberfläche oder über die Projekt-API. Die Installation des Servers, seine Konfiguration und die Anbindung eines Identity Providers behandelt das Administrationshandbuch.

Die Arbeit in Semaphore folgt einer einzigen Kette. Ein Projekt enthält alles Weitere. Darin registrieren Sie die Ressourcen, die eine Ausführung benötigt: ein Repository mit Ihren Playbooks oder Skripten, die Schlüssel, mit denen Sie es und Ihre Hosts erreichen, ein Inventory der Zielmaschinen und Variablengruppen mit Werten und Geheimnissen. Ein Task Template verbindet all das zu einer Definition dessen, was ausgeführt wird, und jede Ausführung dieses Task Template ist ein Task. Zeitpläne, Workflows und eingehende Webhooks starten Task Templates für Sie.

Ein Projekt einrichten

In dieser Reihenfolge, weil jeder Schritt auf dem vorherigen aufbaut.

SeiteInhalt
ProjekteEin Projekt erstellen, die Bereiche in der Seitenleiste, Sicherung und Wiederherstellung.
TeamsDie vier eingebauten Rollen und benutzerdefinierte Rollen in Enterprise.
Key StoreSSH-Schlüssel, Logins und externe Secret-Speicher.
RepositoriesGit-Repositories und lokale Pfade, die Ihre Automatisierung enthalten.
InventoryHosts und Verbindungseinstellungen für Ansible, Workspaces für Terraform.
VariablengruppenWiederverwendbare Variablen und Geheimnisse, die an Tasks übergeben werden.

Arbeit definieren und ausführen

SeiteInhalt
Task TemplatesJedes Feld des Formulars sowie die Typen von Task Templates.
AppsWas die einzelnen Anwendungen ausführen: Ansible, Terraform, OpenTofu, Terragrunt und Skripte.
TasksEinen Task starten, Task-Status, Protokolle, Stoppen und erneutes Ausführen.
ZeitpläneTask Templates nach einem Cron-Zeitplan ausführen.
WorkflowsTask Templates mit Freigaben und Verzweigungen verketten.
IntegrationenTasks über eingehende Webhooks starten.
Projekt-RunnerDie Tasks eines Projekts an eigene Runner senden.
Ihr KontoPersönliche Einstellungen und API-Token.

Womit Sie beginnen

Wenn Sie gerade zu einem Projekt hinzugefügt wurden, lesen Sie Projekte, um sich zurechtzufinden, und danach Tasks, um einen Task auszuführen und sein Protokoll zu lesen. Wenn Sie ein Projekt von Grund auf einrichten, folgen Sie der Tabelle oben der Reihe nach.

Ganz neu bei Semaphore? Beginnen Sie mit Erste Schritte.