Wie entwickelt man benutzerdefinierte Ansible-Module, wenn keine vorhandenen Module den Anforderungen entsprechen?

Ansible-Module sind eigenständige Skripte, die eine spezifische Aktion ausführen. Sie abstrahieren die Komplexität von Automatisierungsaufgaben und bieten den Benutzern eine einfachere Möglichkeit, diese Aufgaben zu erledigen, ohne sich mit den Details der ausgeführten Aktionen auseinandersetzen zu müssen. Wenn zum Beispiel das Template-Modul verwendet wird, muss der Entwickler sich nicht darum kümmern, wie das Jinja2-Template-Engine verwendet wird oder wie Variablen für Platzhalter gesetzt werden. Der Entwickler gibt einfach die erforderlichen Parameter an, und das Modul übernimmt den Rest.

Die meisten Ansible-Module sind in Python geschrieben, da Ansible selbst in dieser Sprache entwickelt wurde. Ein weiteres wichtiges Werkzeug in Ansible ist der Befehl ansible-doc, mit dem man detaillierte Informationen zu den installierten Modulen abrufen kann. Dieser Befehl liefert eine kurze Beschreibung des Moduls, seine Dokumentation und Beispiel-Codes, die direkt in Playbooks verwendet werden können.

Es gibt jedoch Situationen, in denen kein bestehendes Modul die Anforderungen erfüllt. In solchen Fällen muss man ein eigenes Modul entwickeln. Dies erfordert ein grundlegendes Verständnis der Funktionsweise von Modulen und der grundlegenden Struktur von Ansible. Der Vorteil eines selbst entwickelten Moduls liegt darin, dass man genau die Funktionalität erhält, die benötigt wird, ohne sich mit unnötigen oder unpassenden Funktionen auseinandersetzen zu müssen.

Ein einfaches Beispiel für ein benutzerdefiniertes Modul ist ein Modul, das eine Begrüßungsnachricht auf dem Zielhost ausgibt. Bei der Erstellung eines eigenen Moduls beginnt man mit der Vorbereitung eines Verzeichnisses, in dem das Modul gespeichert wird. In diesem Beispiel wird ein Verzeichnis namens library innerhalb eines Arbeitsverzeichnisses erstellt. Das Modul selbst könnte in Python geschrieben sein und eine einfache Funktionalität bieten: eine Begrüßung auszugeben.

Im Code eines solchen Moduls werden vier Hauptvariablen verwendet, um das Modul zu dokumentieren: ANSIBLE_METADATA für Metainformationen über das Modul, DOCUMENTATION für die eigentliche Beschreibung und Optionen des Moduls, EXAMPLES für Beispiele zur Verwendung des Moduls und RETURN, das beschreibt, was das Modul zurückgibt. Ein einfaches Beispielmodul könnte wie folgt aussehen:

python
Copy code
#!/usr/bin/env python
ANSIBLE_METADATA = {
    'metadata_version': '1.0',
    'status': ['preview'],
    'supported_by': 'community'
}
DOCUMENTATION = '''
---
module: demo_hello
short_description: A module that says hello
version_added: "2.8"
description:
    - "A module that says hello."
options:
    name:
        description:
            - Name of the person to salute. If no value is provided, the default
              value will be used.
        required: false
        type: str
        default: John Doe
author:
    - The Ops team
'''
EXAMPLES = '''
# Pass in a custom name
- name: Say hello to Linus Torvalds
  demo_hello:
    name: "Linus Torvalds"
'''
RETURN = '''
fact:
    description: Hello string
    type: str
    sample: Hello John Doe!
'''
from ansible.module_utils.basic import AnsibleModule
FACTS = "Hello {name}!"
def run_module():
    module_args = dict(

        name=dict(type='str', default='Ada'),

    )
    module = AnsibleModule(
        argument_spec=module_args,
        supports_check_mode=True
    )
    result = dict(
        changed=False,
        fact=''
    )
    txt = FACTS.format(name=module.params['name'])
    print(txt)
    result['fact'] = txt
    if module.check_mode:
        return result
    module.exit_json(**result)
def main():
    run_module()
if __name__ == '__main__':
    main()

Das oben gezeigte Modul gibt eine einfache Begrüßungsnachricht aus, wobei der Name der Person als Parameter übergeben wird. Sollte kein Name angegeben werden, wird standardmäßig „John Doe“ verwendet. Das Modul gibt eine JSON-Antwort zurück, die die Nachricht enthält. Sobald das Modul geschrieben ist, wird es in einem Playbook verwendet, das dann auf einem Ansible-Controller ausgeführt werden kann.

Ein weiterer wichtiger Aspekt ist die korrekte Fehlerbehandlung und das Testen des Moduls. Ein gut entwickeltes Modul muss sicherstellen, dass es im Falle von Fehlern aussagekräftige Fehlermeldungen zurückgibt und die gewünschte Idempotenz gewährleistet ist. Dies bedeutet, dass das Modul bei wiederholtem Ausführen keine unnötigen Änderungen vornimmt, wenn der Zielzustand bereits erreicht ist.

Wie man Ansible-Playbooks effizient ausführt und konfiguriert

Ansible ist ein mächtiges Werkzeug für die Automatisierung von IT-Infrastrukturen, das es ermöglicht, komplexe Aufgaben auf einer Vielzahl von Servern zu koordinieren. Bei der Arbeit mit Ansible wird häufig das ansible-playbook Kommando verwendet, das eine Vielzahl von optionalen Argumenten bietet, um Playbooks nach den eigenen Bedürfnissen auszuführen. Diese Argumente helfen dabei, die Flexibilität und Kontrolle über die Ausführung zu maximieren. Das Grundformat des ansible-playbook Kommandos besteht aus einer Reihe von optionalen Argumenten, gefolgt von mindestens einem Playbook-Pfad, wobei auch mehrere Playbooks angegeben werden können.

Einige der wichtigsten Argumente, die beim Ausführen von Playbooks nützlich sind, beinhalten:

• -i, --inventory: Bestimmt den Pfad zur Inventardatei oder eine durch Kommata getrennte Liste von Hosts. Dies ermöglicht es, bestimmte Hosts oder Gruppen von Hosts auszuwählen.

• -b, --become: Führt Operationen mit erhöhten Rechten aus, ohne nach einem Passwort zu fragen. Dies ist nützlich, wenn Ansible auf Systemen arbeitet, auf denen erhöhte Privilegien erforderlich sind.

• -f, --forks: Gibt an, wie viele Prozesse gleichzeitig ausgeführt werden sollen. Standardmäßig werden fünf Prozesse verwendet, aber dies kann angepasst werden, um die Leistung zu optimieren.

• -e, --extra-vars: Ermöglicht das Setzen zusätzlicher Variablen in Form von Schlüssel=Wert-Paaren oder YAML/JSON-Daten. Dies ist besonders hilfreich, um zur Laufzeit dynamische Werte zu übergeben.

• -l, --limit: Beschränkt die Auswahl auf eine Teilmenge der Hosts, was bei sehr großen Inventaren von Vorteil sein kann.

• -c, --connection: Bestimmt den Verbindungstyp. Standardmäßig wird „smart“ verwendet, was automatisch den besten Verbindungstyp auswählt.

Ansible bietet jedoch nicht nur das Kommandozeilen-Tool ansible-playbook. Es stellt auch eine Reihe von anderen Befehlen zur Verfügung, die die Verwaltung und Automatisierung von Aufgaben vereinfachen:

• ansible-config: Mit diesem Befehl können Ansible-Konfigurationsdateien initialisiert, angezeigt oder bearbeitet werden.

• ansible-doc: Zeigt die Dokumentation zu den installierten Modulen an und ist besonders hilfreich, um eine schnelle Übersicht über die verwendbaren Plugins und deren Funktionen zu erhalten.

• ansible-galaxy: Ein Befehl, der es ermöglicht, Ansible-Rollen und -Sammlungen zu erstellen, herunterzuladen, zu bauen oder zu veröffentlichen.

• ansible-pull: Ein Mechanismus, der es ermöglicht, Playbooks auf den verwalteten Knoten zu ziehen, anstatt sie von einem zentralen System zu pushen. Dies kann in großen, verteilten Umgebungen von Vorteil sein.

Eines der zentralen Konzepte bei der Arbeit mit Ansible ist die Wahl der Zielhosts, auf denen die Befehle ausgeführt werden. Wenn Sie Ansible-Playbooks oder das ansible-Kommando ausführen, müssen Sie angeben, welche Knoten oder Gruppen von Hosts betroffen sind. Ansible verwendet dabei Host Patterns, um diese Auswahl zu treffen. Ein einfaches Muster kann ein einzelner Host, eine IP-Adresse oder eine ganze Gruppe von Hosts sein, die in der Inventardatei definiert sind.

Ein einfaches Beispiel könnte so aussehen: Um alle Hosts im Inventar anzusprechen, können Sie das Muster „all“ verwenden. Möchten Sie jedoch nur einen bestimmten Host auswählen, geben Sie dessen Namen direkt an, wie etwa „db1.example.com“. Wenn Sie mehrere Hosts ansprechen möchten, können Sie diese durch Kommas oder Doppelpunkte trennen: „web1.example.com,db1.example.com“.

Darüber hinaus unterstützt Ansible eine Vielzahl komplexerer Muster, um noch gezielter zu arbeiten. Die Inklusionsoperatoren und Ausschlussoperatoren (wie ! und &) ermöglichen eine feinere Steuerung. Zum Beispiel würde das Muster webservers:!staging nur web2.example.com ansprechen, da web1.example.com in der Ausschlussgruppe staging enthalten ist.

Zusätzlich zu diesen Mustern ermöglicht Ansible auch die Verwendung von dynamischen Mustern, bei denen Variablen zur Laufzeit genutzt werden. So lässt sich das Targeting von Hosts oder Gruppen noch flexibler und dynamischer gestalten.

Es ist entscheidend, sich zu vergewissern, dass alle verwendeten Muster mit den Einträgen in der Inventardatei übereinstimmen. Wenn ein Host oder eine Gruppe nicht in der Inventardatei vorhanden ist, kann auch kein entsprechendes Muster zur Auswahl genutzt werden. Darüber hinaus kann die Verwendung von Arrays eine präzisere Kontrolle über die zu bearbeitenden Hosts bieten.

Neben der Auswahl der Hosts spielt auch die Konfiguration von Ansible eine wichtige Rolle, um die Leistung und die Benutzbarkeit zu optimieren. Ansible ermöglicht es, viele seiner Eigenschaften über eine zentrale Konfigurationsdatei anzupassen. Diese Konfigurationsdatei, typischerweise im INI-Format, kann an verschiedenen Orten definiert werden: Entweder direkt im Arbeitsverzeichnis oder in einer globalen Konfigurationsdatei.

Ein wichtiger Aspekt bei der Konfiguration ist die Vererbung von Einstellungen. Ansible lädt Konfigurationsdateien in einer bestimmten Reihenfolge, was bedeutet, dass benutzerspezifische Einstellungen Vorrang vor globalen Einstellungen haben. Das Verständnis dieser Hierarchie ist entscheidend, um die Konfiguration optimal zu steuern und Konflikte zu vermeiden.