gantsign.antigen_bundles

Ansible Rolle: Antigen Bundles

Diese Ansible Rolle fügt Bundles zu deiner Antigen Konfiguration für Zsh hinzu. Es ist nützlich, diese Rolle mit Ansible-Tags zu kombinieren, um bestimmte Bundles bedingt zu installieren.

Wichtig: Du musst Antigen mit der gantsign.antigen Rolle installiert haben (und Antigen für denselben Benutzer konfiguriert haben), damit diese Rolle funktioniert.

:thumbsdown: Abkündigung Hinweis :thumbsdown:

Die letzte Antigen-Version war v2.2.3 am 4. Januar 2018. Da Antigen anscheinend nicht mehr gewartet wird, empfehlen wir, diese Rolle nicht zu verwenden. Diese Rolle wird weiterhin gewartet, bis GantSign zu einem anderen Zsh-Plugin-Manager wechselt.

Anforderungen

Ansible >= 2.9
Linux-Distribution
- Debian Familie
  - Debian
    - Stretch (9)
    - Buster (10)
    - Bullseye (11)
  - Ubuntu
    - Bionic (18.04)
    - Focal (20.04)
- RedHat Familie
  - Rocky Linux
    - 8
  - Fedora
    - 35
- SUSE Familie
  - openSUSE
    - 15.3
- Hinweis: Andere Versionen funktionieren wahrscheinlich, wurden aber nicht getestet.

Rollevariablen

Die folgenden Variablen ändern das Verhalten dieser Rolle:

# Antigen wird pro Benutzer konfiguriert, daher musst du die Benutzer angeben, für die es installiert werden soll
users:
  - username: # Der Benutzername des Benutzers, für den Antigen installiert werden soll
    antigen_bundles:
      - name: # Der Name des Antigen-Bundles (z.B. eines der Plugins, die mit Oh-My-Zsh kommen)
        url: # Optional. Wenn es nicht eines der Oh-My-Zsh-Plugins ist, musst du die URL angeben (verwendet owner/repo-Verkürzung für GitHub)
        location: # Optional. Das Verzeichnis im Repository, das das Plugin enthält
        branch: # Optional. Git-Branch, der ausgecheckt werden soll.
        tag: # Optional. Git-Tag, der ausgecheckt werden soll (hat Vorrang vor branch)
        args: [] # Optional. Befehlszeilenargumente, die an Antigen übergeben werden
        env: {} # Optional. Umgebungsvariablen, die gesetzt werden sollen
      # Weitere Bundles hier
  # Weitere Benutzer hier

Beispiel Playbooks

Beispiel, das nur die Konfiguration für diese Rolle zeigt:

- hosts: servers
  roles:
    - role: gantsign.antigen_bundles
      users:
        - username: beispiel
          antigen_bundles:
            # Bundle aus dem Standard-Repo (robbyrussell's oh-my-zsh)
            - name: command-not-found
            # Syntax-Hervorhebungs-Bundle
            - name: zsh-syntax-highlighting # `name` ist erforderlich (jede gültige Dateiname genügt, solange er einzigartig für die Bundles ist)
              url: zsh-users/zsh-syntax-highlighting

Beispiel mit der erforderlichen Begleitrolle gantsign.antigen:

- hosts: servers
  roles:
    - role: gantsign.antigen
      users:
        - username: beispiel
          antigen_libraries:
            - name: oh-my-zsh
          antigen_theme:
            name: robbyrussell
          antigen_bundles:
            - name: command-not-found
            - name: docker
            - name: git

    - role: gantsign.antigen_bundles
      tags:
        - java
      users:
        - username: beispiel
          antigen_bundles:
            - name: mvn

Im obigen Beispiel wird das mvn Bundle/Plugin nicht installiert, wenn du Ansible anweist, Aufgaben mit dem Tag java zu überspringen.

Weitere Rollen von GantSign

Du findest weitere Rollen von GantSign auf Ansible Galaxy.

Entwicklung & Tests

Dieses Projekt verwendet Molecule zur Unterstützung bei der Entwicklung und dem Testen; die Rolle wird mit Testinfra und pytest getestet.

Für die Entwicklung oder den Test musst du Folgendes installiert haben:

Linux (z.B. Ubuntu)
Docker
Python (einschließlich python-pip)
Ansible
Molecule

Da es schwierig sein kann, die oben genannten zu installieren, enthält dieses Projekt Molecule Wrapper. Molecule Wrapper ist ein Shell-Skript, das Molecule und seine Abhängigkeiten (außer Linux) installiert und dann Molecule mit dem Befehl ausführt, den du ihm übergibst.

Um diese Rolle mit Molecule Wrapper zu testen, führe den folgenden Befehl im Projektstammverzeichnis aus: