Eigene Module in Ansible

In diesem Tutorial zeigen wir, wie du eigene Module in Ansible erstellst, um benutzerdefinierte Aufgaben und Anforderungen zu automatisieren. Ansible ist bekannt für seine Flexibilität und Erweiterbarkeit, und eigene Module sind eine der besten Möglichkeiten, diese Stärke zu nutzen. Wenn die Standardmodule von Ansible nicht ganz das abdecken, was du benötigst, kannst du deine eigenen erstellen.

Voraussetzungen:

• Grundlegende Kenntnisse in Ansible und YAML
• Python-Programmierkenntnisse
• Installiertes Ansible auf deinem System

---

Was sind Ansible-Module?

Module sind die Bausteine von Ansible. Sie führen Aufgaben auf den verwalteten Hosts aus. Ansible wird mit einer Vielzahl von integrierten Modulen geliefert, die zum Beispiel für die Paketinstallation, Dateiverwaltung und Benutzerverwaltung genutzt werden können. Wenn kein geeignetes Modul vorhanden ist, kannst du ein eigenes erstellen, um deine spezifischen Anforderungen zu erfüllen.

Warum eigene Module?

Manchmal reichen die Standard-Module von Ansible nicht aus, um komplexere oder spezifische Aufgaben auszuführen. Eigene Module erlauben es, diese Lücken zu schließen, indem sie benutzerdefinierte Funktionalitäten implementieren.

---

Erstellung eines eigenen Ansible-Moduls

In diesem Beispiel zeigen wir, wie du ein einfaches eigenes Ansible-Modul schreibst, das eine Datei erstellt und eine benutzerdefinierte Nachricht in die Datei schreibt.

1. Verzeichnisstruktur

Zuerst benötigen wir eine ordentliche Verzeichnisstruktur, um das Modul zu integrieren. Ansible sucht automatisch in bestimmten Verzeichnissen nach Modulen. Wir werden die Struktur so anlegen:

my_ansible_project/
├── library/
│   └── my_module.py
├── playbook.yml
└── hosts

Die Datei my_module.py wird unser benutzerdefiniertes Modul enthalten.

2. Python-Modul schreiben

Erstelle die Datei my_module.py im Verzeichnis library/ und füge den folgenden Code ein:

#!/usr/bin/python

from ansible.module_utils.basic import AnsibleModule

def main():
    # Argument-Spezifikation für das Modul
    module_args = dict(
        path=dict(type='str', required=True),
        content=dict(type='str', required=True),
        state=dict(type='str', default='present', choices=['present', 'absent']),
    )

    # Ansible Modul Objekt initialisieren
    module = AnsibleModule(
        argument_spec=module_args,
        supports_check_mode=True
    )

    # Parameterwerte abrufen
    path = module.params['path']
    content = module.params['content']
    state = module.params['state']

    # Datei existiert bereits?
    result = dict(
        changed=False,
        path=path,
        state=state,
    )

    # Logik für das Erstellen oder Entfernen der Datei
    if state == 'present':
        try:
            with open(path, 'w') as f:
                f.write(content)
            result['changed'] = True
        except Exception as e:
            module.fail_json(msg=str(e))
    elif state == 'absent':
        if os.path.exists(path):
            try:
                os.remove(path)
                result['changed'] = True
            except Exception as e:
                module.fail_json(msg=str(e))
        else:
            result['changed'] = False

    # Ergebnis an Ansible zurückgeben
    module.exit_json(**result)

if __name__ == '__main__':
    main()

Erklärung:

• Wir verwenden die AnsibleModule-Klasse, um ein Modul zu erstellen. Sie hilft uns dabei, Argumente zu verarbeiten und mit Ansible zu kommunizieren.
• Das Modul akzeptiert drei Argumente: path (Dateipfad), content (Inhalt der Datei) und state (ob die Datei vorhanden sein soll oder nicht).
• Je nach dem state-Parameter erstellt oder löscht das Modul die Datei.

3. Playbook erstellen

Jetzt erstellen wir ein einfaches Ansible-Playbook playbook.yml, um unser Modul zu testen:

---
- hosts: localhost
  tasks:
    - name: Datei erstellen mit benutzerdefiniertem Modul
      my_module:
        path: /tmp/meine_datei.txt
        content: "Dies ist eine benutzerdefinierte Nachricht."
        state: present

Dieses Playbook führt unser benutzerdefiniertes Modul aus und erstellt eine Datei mit dem angegebenen Inhalt.

4. Ausführen des Playbooks

Um das Playbook auszuführen, gehe in das Verzeichnis deines Projekts und führe folgenden Befehl aus:

ansible-playbook -i hosts playbook.yml

Wenn alles korrekt eingerichtet ist, wird Ansible das Modul ausführen und eine Datei /tmp/meine_datei.txt mit der angegebenen Nachricht erstellen.

5. Überprüfung des Ergebnisses

Nach dem erfolgreichen Ausführen des Playbooks sollte die Datei /tmp/meine_datei.txt mit dem Inhalt Dies ist eine benutzerdefinierte Nachricht. erstellt worden sein.

Um die Datei zu entfernen, kannst du das Playbook mit folgendem state-Wert ausführen:

    - name: Datei entfernen mit benutzerdefiniertem Modul
      my_module:
        path: /tmp/meine_datei.txt
        state: absent

Fazit

Dieses einfache Tutorial zeigt, wie du eigene Ansible-Module schreiben kannst, um spezifische Automatisierungsaufgaben zu bewältigen. Mit eigenen Modulen kannst du die Flexibilität von Ansible auf deine speziellen Anforderungen erweitern, indem du maßgeschneiderte Funktionen implementierst. Python und Ansible bieten eine robuste Grundlage, um deine eigenen Module effizient zu erstellen und in Playbooks zu integrieren.

Viel Spaß beim Experimentieren und Automatisieren mit Ansible!