Rolle `semaphore_bootstrap`
Quelle: pkr-lab/pkr-lab-docs/capulus/capulus-ansible/rollen/semaphore_bootstrap.md
Rolle semaphore_bootstrap
Projekte, Inventories, Templates und Zeitpläne in Semaphore per REST-API.
| Läuft gegen | controlplane-0 |
| Tags | – |
| Quellcode | roles/semaphore_bootstrap |
Projekte für die Control-Planes und Worker
Das Projekt für controlplane-1 heißt controlplane-1 (Template Deploy controlplane-1, Inventar controlplane_1_only). Das frühere Projekt worker-0 bleibt nach dem Umbenennen in Semaphore als Altlast stehen, make semaphore-bootstrap löscht nichts. Es wird in der UI von Hand gelöscht. Der nächtliche Zyklus (20030) sucht nur noch worker-1.
Hinweis zur Quelle der Projekte
semaphore_projects wird aus defaults/main.yml gelesen, kann aber in group_vars/all.yml überschrieben werden. Nach dem Umbenennen der Gruppen (k3s_servers, k3s_primary, k3s_agents statt homeservers) muss eine solche Überschreibung dieselben Inventar-Inhalte nutzen, sonst findet das Playbook in Semaphore keine Hosts. Nach jedem Merge, der Hostnamen oder Gruppen ändert, läuft make semaphore-bootstrap.
Variablen
Defaults aus defaults/main.yml. Überschreiben in group_vars/ oder host_vars/.
| Variable | Default | Bedeutung |
|---|---|---|
semaphore_api_base |
https://semaphore-api.tech.homeserver |
– |
semaphore_namespace |
semaphore |
– |
semaphore_ansible_repo_url |
https://github.com/pkr-lab/capulus-ansible.git |
– |
semaphore_admin_password_path |
/etc/semaphore-secrets/admin_password |
– |
semaphore_admin_username |
admin |
– |
semaphore_ssh_private_key_path |
/etc/semaphore-secrets/id_ed25519 |
– |
semaphore_api_ready_retries |
60 |
– |
semaphore_api_ready_delay |
5 |
– |
semaphore_vault_password |
`` | – |
semaphore_ssh_login |
ubuntu |
– |
semaphore_default_keys |
[{login: '{{ semaphore_ssh_login }}', name: semaphore-ssh-key, type: ssh}, {name: git-n… |
– |
semaphore_default_environment |
{env: {ANSIBLE_VAULT_PASSWORD_FILE: /var/run/semaphore-secrets/ansible_vault_password},… |
– |
semaphore_projects |
[{description: Deploy / re-provision the home-server itself., environments: ['{{ semaph… |
– |
semaphore_bootstrap_delete_orphan_projects |
true |
löscht Semaphore-Projekte, die nicht in semaphore_projects stehen; false lässt von Hand angelegte Projekte stehen |
Ablauf
- vorhandene environments im projekt {{ project_spec.name }} auflisten
- feststellen ob environment {{ env_spec.name }} existiert
- id des vorhandenen environments {{ env_spec.name }} ermitteln
- environment {{ env_spec.name }} anlegen
- environment {{ env_spec.name }} aktualisieren
- vorhandene inventories im projekt {{ project_spec.name }} auflisten
- feststellen ob inventory {{ inventory_spec.name }} existiert
- id des vorhandenen inventorys {{ inventory_spec.name }} ermitteln
- inventory {{ inventory_spec.name }} anlegen
- inventory {{ inventory_spec.name }} aktualisieren
- mit http-details abbrechen, wenn das inventory-update fehlschlug
- vorhandene keys im projekt {{ project_spec.name }} auflisten
- feststellen ob der key im projekt {{ project_spec.name }} existiert
- privaten ssh-schlüssel von semaphore von der platte lesen
- ssh-zugangsschlüssel im projekt {{ project_spec.name }} anlegen
- mit sichtbaren http-details abbrechen, wenn das anlegen des ssh-schlüssels fehlschlug
- id des vorhandenen ssh-schlüssels {{ key_spec.name }} ermitteln
- ssh-schlüssel {{ key_spec.name }} im projekt {{ project_spec.name }} aktualisieren
- zugangsschlüssel vom typ none im projekt {{ project_spec.name }} anlegen
- schlüssel vom typ login_password im projekt {{ project_spec.name }} anlegen
- mit http-details abbrechen, wenn das anlegen des vault-schlüssels fehlschlug
- id des vorhandenen login_password-schlüssels {{ key_spec.name }} ermitteln
- login_password-schlüssel {{ key_spec.name }} im projekt {{ project_spec.name }} aktualisieren
- admin-passwort von der platte lesen
- admin-passwort als fakt setzen
- bei semaphore anmelden
- abbrechen, wenn semaphore die admin-zugangsdaten ablehnt
- session-cookie übernehmen
- zeilenumbruch als fakt für den pem-body setzen
- vorabprüfung — semaphore_vault_password darf nicht leer sein
- warten bis das semaphore-deployment angelegt ist
- warten bis das semaphore-deployment ausgerollt ist
- warten bis die http-api von semaphore antwortet
- bei semaphore authentifizieren
- jedes semaphore-projekt einrichten
- alle projekte für das aufräumen verwaister projekte auflisten
- verwaiste projekte löschen, die nicht in semaphore_projects stehen (nur mit
semaphore_bootstrap_delete_orphan_projects: true) - zusammenfassung des semaphore-bootstraps anzeigen
- vorhandene projekte für {{ project_spec.name }} auflisten
- projekt-id für {{ project_spec.name }} ermitteln
- projekt {{ project_spec.name }} anlegen
- neue projekt-id für {{ project_spec.name }} übernehmen
- standard-zugangsschlüssel im projekt {{ project_spec.name }} einrichten
- keys im projekt {{ project_spec.name }} erneut auflisten
- zuordnung key-name→id für das projekt {{ project_spec.name }} bilden
- repository für das projekt {{ project_spec.name }} einrichten
- inventories für das projekt {{ project_spec.name }} einrichten
- inventories im projekt {{ project_spec.name }} erneut auflisten
- zuordnung inventory-name→id für das projekt {{ project_spec.name }} bilden
- environments für das projekt {{ project_spec.name }} einrichten
- environments im projekt {{ project_spec.name }} erneut auflisten
- zuordnung environment-name→id für das projekt {{ project_spec.name }} bilden
- templates für das projekt {{ project_spec.name }} einrichten
- templates im projekt {{ project_spec.name }} erneut auflisten
- zuordnung template-name→id für das projekt {{ project_spec.name }} bilden
- schedules für das projekt {{ project_spec.name }} einrichten
- vorhandene repositories im projekt {{ project_spec.name }} auflisten
- repository-id im projekt {{ project_spec.name }} ermitteln
- sicherstellen dass der key git-none im projekt {{ project_spec.name }} existiert
- repository im projekt {{ project_spec.name }} anlegen
- neue repository-id für das projekt {{ project_spec.name }} übernehmen
- vorhandene schedules im projekt {{ project_spec.name }} auflisten
- feststellen ob schedule '{{ schedule_spec.name }}' existiert
- id des vorhandenen schedules '{{ schedule_spec.name }}' ermitteln
- sicherstellen dass template '{{ schedule_spec.template }}' für schedule '{{ schedule_spec.name }}' existiert
- schedule '{{ schedule_spec.name }}' anlegen
- schedule '{{ schedule_spec.name }}' aktualisieren
- vorhandene templates im projekt {{ project_spec.name }} auflisten
- feststellen ob template {{ template_spec.name }} existiert
- id des vorhandenen templates {{ template_spec.name }} ermitteln
- sicherstellen dass inventory '{{ template_spec.inventory }}' im projekt {{ project_spec.name }} existiert
- template {{ template_spec.name }} anlegen
- template {{ template_spec.name }} aktualisieren
Fehlersuche
Allgemeines Vorgehen bei Rollen: ansible-playbook <playbook>.yml --limit <host> --tags <tag> --check --diff -vvv zeigt Änderungen ohne sie anzuwenden (make <ziel>-check bei den Playbooks mit Dry-Run). Die Rollenübersicht mit Make-Zielen: Rollen.
kubectl -n semaphore get pods
kubectl -n semaphore logs deploy/semaphore --tail=100
ansible-playbook <playbook>.yml --tags semaphore-bootstrap -vvv
| Symptom | Ursache | Lösung |
|---|---|---|
semaphore_vault_password is empty … |
Vault-Passwort fehlt | in group_vars/all.yml (verschlüsselt) setzen |
Semaphore returned status … on login … |
Admin-Passwort stimmt nicht mehr (in der UI geändert) oder Pod nicht bereit | Admin-Benutzer im Pod zurücksetzen oder PVC leeren und erneut ausführen |
SSH key creation returned HTTP … / Vault key creation returned HTTP … |
API-Fehler beim Anlegen der Schlüssel | Antwort im Fehlertext lesen, Semaphore-Version prüfen |
Inventory '…' update failed: HTTP … |
API-Fehler beim Aktualisieren des Inventars | Antwort lesen |
Key 'git-none' not found … |
git-none fehlt in semaphore_default_keys |
Liste ergänzen |
Template '…' references unknown inventory … |
Template verweist auf unbekanntes Inventory | Namen im Projekt abgleichen (Fehler listet die vorhandenen) |
Schedule '…' references unknown template … |
Zeitplan verweist auf unbekanntes Template | wie oben |
Betrieb: Semaphore.
Allgemeine Fehlersuche: Host-Troubleshooting, zentrale Fehlersuche.