{"id":3891,"date":"2024-07-22T07:00:00","date_gmt":"2024-07-22T05:00:00","guid":{"rendered":"https:\/\/www.my-it-brain.de\/wordpress\/?p=3891"},"modified":"2024-07-12T16:19:52","modified_gmt":"2024-07-12T14:19:52","slug":"wie-wird-im-ansible-automation-controller-eine-neue-inventory-source-hinzugefuegt","status":"publish","type":"post","link":"https:\/\/www.my-it-brain.de\/wordpress\/wie-wird-im-ansible-automation-controller-eine-neue-inventory-source-hinzugefuegt\/","title":{"rendered":"Wie wird im Ansible Automation Controller eine neue Inventory Source hinzugef\u00fcgt?"},"content":{"rendered":"\n

In diesem \u00dcberblick beschreibe ich am Beispiel der Proxmox inventory source<\/a>, wie eine eigene Inventory Source im Ansible Automation Controller hinzugef\u00fcgt werden kann.<\/p>\n\n\n\n

Die folgenden Schritte wurden mit der Ansible Automation Platform 2.4<\/a> getestet. Die einzelnen Schritte sollten in gleicher Weise auch in Ansible AWX<\/a> ausgef\u00fchrt werden k\u00f6nnen.<\/p>\n\n\n\n

Um diesem Text folgen zu k\u00f6nnen, werden Kenntnisse im Umgang mit Ansible und Git auf der Kommandozeile vorausgesetzt.<\/p>\n\n\n\n

Der Text verweist, wo m\u00f6glich, auf bestehende Dokumentation. Es handelt sich bei diesem Text nicht um ein klassisches Tutorial. Er dient mir als Ged\u00e4chtnisst\u00fctze und mag euch eine Anregung sein, bzw. im besten Fall die Wissensl\u00fccken schlie\u00dfen, die sich mit der Dokumentation allein nicht schlie\u00dfen lassen.<\/p>\n\n\n\n

Ausgangssituation<\/h2>\n\n\n\n

Abschnitt 18.4.5.1. Inventory sources<\/a> im Automation Controller User Guide<\/a> f\u00fchrt die in der Ansible Automation Platform (AAP) unterst\u00fctzten Inventory Sources auf. M\u00f6chte man nun bspw. Proxmox Virtual Environment (PVE)<\/a>, Microsoft Active Directory oder Cisco DNA Center als Quelle f\u00fcr sein Inventar benutzen, wird man auf den ersten Blick nicht f\u00fcndig.<\/p>\n\n\n\n

F\u00fcr das Beispiel in diesem Text werden Hosts aus der Bestandsliste eines PVE als Inventory Source hinzugef\u00fcgt. Die dabei verwendete Vorgehensweise kann auch f\u00fcr andere Inventory Plugins verwendet werden. Die Entwicklung von Inventory Plugins ist jedoch nicht Gegenstand dieses Textes. Hierzu wird auf die Dokumentation unter \u201eDeveloping dynamic inventory\u201c<\/a> verwiesen.<\/p>\n\n\n\n

Mein Kollege Steffen Scheib hat mir geholfen, das Proxmox-Plugin zu konfigurieren, wof\u00fcr ich ihm an dieser Stelle nochmal ganz herzlich danke. Es liegt auf meiner Arbeitsstation als Ansible Project<\/a> in folgender Verzeichnisstruktur vor:<\/p>\n\n\n\n

]$ tree proxmox_inventory\/\nproxmox_inventory\/\n\u251c\u2500\u2500 collections\n\u2502   \u2514\u2500\u2500 requirements.yml\n\u251c\u2500\u2500 inventory\n\u2502   \u2514\u2500\u2500 inventory.proxmox.yml\n\u2514\u2500\u2500 vault_password_file\n\n3 directories, 3 files<\/code><\/pre>\n\n\n\n
Mit Ausnahme der Datei vault_password_file<\/code> wurden alle Dateien und Verzeichnisse in Git aufgenommen. Ich verwende einen einfachen Git-Server<\/a> in meiner Laborumgebung, auf welchen ich meine lokalen Repositorys pushe. Der Automation Controller synchronisiert das Projekt aus dem Git-Repo, um es als Inventory Source verf\u00fcgbar zu machen.<\/p>\n\n\n\n
Die Vorgehensweise im \u00dcberblick<\/h2>\n\n\n\n
    \n
  1. Ansible Credential f\u00fcr Source Control erstellen<\/a><\/li>\n\n\n\n
  2. Ein Ansible Projekt hinzuf\u00fcgen<\/a><\/li>\n\n\n\n
  3. Einen Custom Credential Type erstellen<\/a><\/li>\n\n\n\n
  4. Ein Ansible Inventory hinzuf\u00fcgen<\/a><\/li>\n<\/ol>\n\n\n\n
    Ansible Credential f\u00fcr Source Control erstellen<\/h2>\n\n\n\n
    Das Proxmox Inventory Plugin befindet sich in einem Git-Repository, auf welches mit SSH-Key-Authentifizierung zugegriffen werden kann. Damit auch der Automation Controller auf dieses Repository zugreifen kann, wird ein Credential vom Typ Source Control<\/a> erstellt.<\/p>\n\n\n\n
    \"\"
    Beipsiel f\u00fcr einen Source Control Credential Typ im Ansible Automation Controller<\/figcaption><\/figure>\n\n\n\n
    Der SSH-Private-Key wurde von meinem Host hochgeladen und verschl\u00fcsselt im Automation Controller gespeichert. Der Key l\u00e4sst sich in der GUI nicht wieder sichtbar machen, lediglich ersetzen.<\/p>\n\n\n\n
    Ein Ansible Projekt hinzuf\u00fcgen<\/h2>\n\n\n\n
    Der Dokumentation folgend<\/a>, wird ein Projekt hinzugef\u00fcgt:<\/p>\n\n\n\n
    \"\"
    Beispiel einer ausgef\u00fcllten Maske im Automation Controller, zum Hinzuf\u00fcgen eines Projekts.<\/figcaption><\/figure>\n\n\n\n
    Wenn alles passt, wird das Projekt nach dem Speichern erfolgreich synchronisiert:<\/p>\n\n\n\n
    \"\"<\/figure>\n\n\n\n
    Dieses Projekt wird in einem sp\u00e4teren Schritt zur Erstellung des Inventory ben\u00f6tigt.<\/p>\n\n\n\n
    Einen Custom Credential Type erstellen<\/h2>\n\n\n\n
    Bevor ich auf die Erstellung selbst eingehe, m\u00f6chte ich kurz beschreiben, warum dieser Schritt notwendig ist.<\/p>\n\n\n\n
    Folgender Codeblock zeigt meine Datei inventory.proxmox.yml<\/code> welche einige mit Ansible Vault<\/a> verschl\u00fcsselte Werte enth\u00e4lt:<\/p>\n\n\n\n
    ]$ cat inventory\/inventory.proxmox.yml \n---\nplugin: 'community.general.proxmox'\nurl: 'https:\/\/pve.example.com'\nuser: !vault |\n          $ANSIBLE_VAULT;1.1;AES256\n          30623661316338386633623162303036346562346238386162633263636164636338393532613565\n          3332616265353962326139363533313261623739643765640a623032613034613139653162356266\n          34646464323233313964663939643631313539353736313364333433643136306632633065633664\n          3234346635396563350a656334353632643830353534386636306365656261356436613662623163\n          31663535363264356537336531393731633164613733316537383433653334643433\ntoken_id: !vault |\n          $ANSIBLE_VAULT;1.1;AES256\n          62356662336534646661353666356263363734666231643932393430336639363032303266636432\n          3762343235633335613663393838343532326230353130380a616161313830373265306137346562\n          61613662333764393565316362623838633332376366373161646237363163663039613863393439\n          3165616664626633390a396465343430373837343662373634653634643138613131633034306432\n          62623438366166353765366339323263393833396133653866343833663335663766\ntoken_secret: !vault |\n          $ANSIBLE_VAULT;1.1;AES256\n          66386338643463373837666164396332306261366634396630306430663937613963346164636433\n          3362396566343932393234353439383932316436396437380a336365393038373566383534623136\n          30353332383464356664393666383664636536666531663463623232353136353636363366653431\n          3234616531623537630a393530643437376363653438643036636436316636616265316361623661\n          35313832613063633662363531346164306638373538393164373663633335333863646430663232\n          6339343164633865636239356538326438333937366134613738\n\nvalidate_certs: false\n\n# fail if a variable is not resolvable\nstrict: true\n\n# facts are required to retrieve proxmox_vmtype\nwant_facts: true\n\n# only allow qemu VMs\nfilters:\n  - \"proxmox_vmtype == 'qemu'\"<\/code><\/pre>\n\n\n\n
    Auf der Kommandozeile meines Hosts kann ich den Inhalt des Dynamic Inventory wie folgt anzeigen lassen:<\/p>\n\n\n\n
    ansible-inventory -i inventory\/inventory.proxmox.yml --list --vault-password-file vault_password_file<\/code><\/pre>\n\n\n\n
    Die Datei vault_password_file<\/code> befindet sich jedoch nicht im Git, da sie das Passwort im Klartext enth\u00e4lt. Aus diesem Grund m\u00f6chte ich die Datei auch nicht auf dem Automation Controller ablegen. Irgendwie m\u00fcssen auf dem Automation Controller jedoch Credentials hinterlegt werden, um die Ansible Vault encrypted_strings<\/a> zu entschl\u00fcsseln. Die L\u00f6sung steckt in diesem Kommentar<\/a> auf Github. Im Automation Controller User Guide gibt es dazu Chapter 11. Custom credential types<\/a>.<\/p>\n\n\n\n
    Fertig sieht das dann so aus:<\/p>\n\n\n\n
    \"\"
    Quelle: https:\/\/github.com\/ansible\/awx\/issues\/4089#issuecomment-1632066592<\/a><\/figcaption><\/figure>\n\n\n\n
    Das Schl\u00fcssel-Wert-Paar secret: true<\/code> stellt sicher, dass das Passwort verschl\u00fcsselt gespeichert wird. Es kann danach im Automation Controller nicht mehr im Klartext angezeigt werden. Nachdem der neue Credential Typ erstellt ist, kann dieser instanziiert werden:<\/p>\n\n\n\n
    \"\"
    Beispiel des neuen Custom Credential Typs ‚encrypted_vault_password‘<\/figcaption><\/figure>\n\n\n\n
    Das Vault Passwort wird in das entsprechende Formularfeld kopiert. Es ist standardm\u00e4\u00dfig nicht sichtbar und wird wie oben bereits erw\u00e4hnt, verschl\u00fcsselt gespeichert. Mit diesem Credential verf\u00fcgt der Automation Controller nun \u00fcber die notwendigen Informationen, um das Proxmox Inventory auszulesen.<\/p>\n\n\n\n
    Ein Ansible Inventory hinzuf\u00fcgen<\/h2>\n\n\n\n
    Zuerst wird ein Inventory nach Dokumentation<\/a> erstellt. Anschlie\u00dfend wird diesem eine Inventory Source hinzugef\u00fcgt<\/a>.<\/p>\n\n\n\n
    Die Formularfelder sind dabei wie folgt zu bef\u00fcllen:<\/p>\n\n\n\n