Eigene Autoconf-Rolle erstellen

Version 13.2 von Tom Altenbrunn am 2023/03/15 12:09

Autoconf liegt wie der Vorgänger Ansible im ctrl-g1 Container und dient dazu, Einstellungen oder Konfigurationen auf bereits deployte Rechner zu übertragen, ohne ein neues Image dafür zu schreiben. Somit lassen sich relativ einfach und flexibel diverse Anpassungen an bestehenden Clients vornehmen.

Logodidact ist bereits standardmäßig mit zahlreichen eigenen Autoconf-Rollen bestückt, um ein möglichst breites Spektrum verschiedenster Anforderungen des allgemeinen Schulbetriebs abzudecken.

Vonseiten SBE bereitgestellte Rollen befinden sich im ctrl-g1-Container im Pfad /usr/lib/ld-autoconf/logodidact/roles/.

Darüber hinaus ist es Partnern und Kunden möglich für spezielle, schulspezifische Anforderungen eigene Autoconf-Rollen erstellen und im LD Control Center bereitstellen zu können. Dafür steht je nach Puppet-Versionsstand ein eigenes Verzeichnis im ctrl-g1 zur Verfügung, welches nicht durch Server-Updates beeinflusst oder überschrieben wird.

bis Puppet-Version 1.4.x : /var/lib/ld-autoconf/custom/
Ab Puppet-Version 1.5.x : /data/ld/autoconf/custom/

Der Aufbau einer Autoconf-Rolle unterliegt einer vordefinierten Struktur, bestehend aus einer logodidact.yml, welche die Informationen zu Namen, Beschreibung, Ersteller und Variablen definiert, sowie der eigentlichen ausführbaren Skript-Datei (Powershell oder Bash). Diese liegen wiederum in ihren eigenen Dateiordnern. Daneben besteht auch die Möglichkeit im Unterordner files/ (ausführbare) Dateien, Bilder, Videos, etc. mitzugeben. Der strukturelle Aufbau ist nachfolgend ersichtlich:

Beispielaufbau einer logodidact.yml:

Eine Autoconf-Beispielvorlage liegt serverseitig im Unterordner example/ vor. Zum besseren Verständnis wird nachfolgend eine Autoconf-Rolle zur Mitgabe einer WLAN-SSID samt PSK an Clients näher beleuchtet.

root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml

ld_info:
  authors:
    - Marcel Petersen
  company: SBE network solutions GmbH
display_name: WLAN Profil mit PSK anlegen
  license: SBE
uuid: 52318636-c4f5-11ea-baf9-0bff00c66ff4
  visible: true
  priority: 0
  applyAlways: false
tags:
    - CUSTOM
  vars:
    ssid:
      display_name: SSID
      optional: false
      type: STRING
    psk:
      display_name: Passwort
      optional: false
      type: PASSWORD
systems:
    - WINDOWS
    - LINUX

display_name = Anzeigename der Autoconf-Rolle im LD Control Center

uuid = ID der Autoconf-Regel. Muss einmalig sein. Bei einer eigenen Autoconf-Rolle sollte der Wert am besten neu generiert werden. https://www.uuidgenerator.net/

tags = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.

vars = definiert mögliche Variablen, die den Skripten übergeben werden

display_name = Name der konfigurierbaren Variable im Control Center
optional = bestimmt, ob die Variable zwingend mit einem Wert belegt werden muss
type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
example = Zeigt einen grau eingefärbten Beispieltext innerhalb der definierten Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).

systems = Legt fest, welche Betriebssystem-Typen durch die Autoconf-Rolle unterstützt werden. Gültige Systeme sind: WINDOWS / LINUX

Beispiel für eine Variable:

globalLogLevel:
  display_name: Loglevel
  optional: true
  type: ENUM
  values:
    - none
    - compact
    - detailed
    - full

Tipp: Der Variablentyp ENUM aus dem Beispiel entspricht einem Dropdown-Menü, in dem man aus vordefinierten Werten auswählen kann

Für die Funktionalität der Autoconf-Rolle ist es nötig, PowerShell-Skripte am Server abzuspeichern, die die Instruktionen an den Arbeitsstationen ausführen. Diese Skripte liegen unterhalb der Autoconf-Rolle im Verzeichnis win. Darin sind folgende Dateinamen zulässig:

main.ps1 - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei meta/logodidact.yml festgelegt sind
setup.ps1 - Skript wird ausschließlich in der SETUP-Phase während des Deployments ausgeführt.
custom.ps1 - Skript wird ausschließlich in der CUSTOM-Phase während des Deployments ausgeführt.
user.ps1 - Skript wird ausschließlich in der USER-Phase während des Deployments ausgeführt.
audit.ps1 - Skript wird ausschließlich in der AUDIT-Phase während des Deployments ausgeführt.
collect.ps1 - Sonderfall. Dieses Skript wird ausgeführt, wenn durch einen Anwender aktiv die Phase COLLECT zum Einsammeln von Einstellungen am Client aufgerufen werden.

Hinweis: Skripte, die durch ihren Dateinamen auf die einzelnen Phasen eingeschränkt sind (lila eingefärbt), können sich inhaltlich zueinander unterscheiden. Dadurch kann eine Autoconf-Rolle sehr flexibel gestaltet werden.

Beispielaufbau der main.ps1

Im win-Verzeichnis können sich unterschiedliche Powershell-Skripte befinden. Der jeweilige Name der .ps1 Datei gibt an zu welcher Phase die Datei ausgeführt wird.

user.ps1 = user Phase, nach der Anmeldung

custom.ps1 = custom Phase

audit.ps1 = audit Phase

setup.ps1 = setup Phase

main.ps1 = alle Phasen

root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1

Param
(
[parameter(Mandatory=$false)]
[String]
$ssid,
[parameter(Mandatory=$false)]
[String]
$psk
)

if ($ssid -ne '' -and $psk -ne '') {
$profile = @'
<WLANProfile xmlns="http://www.microsoft.com/networking/WLAN/profile/v1">
       <name>{0}</name>
       <SSIDConfig>
               <SSID>
                       <name>{0}</name>
               </SSID>
       </SSIDConfig>
       <connectionType>ESS</connectionType>
       <connectionMode>auto</connectionMode>
       <MSM>
               <security>
                       <authEncryption>
                               <authentication>WPA2PSK</authentication>
                               <encryption>AES</encryption>
                               <useOneX>false</useOneX>
                       </authEncryption>
                       <sharedKey>
                               <keyType>passPhrase</keyType>
                               <protected>false</protected>
                               <keyMaterial>{1}</keyMaterial>
                       </sharedKey>
               </security>
       </MSM>
</WLANProfile>
'@ -f $ssid, $psk

$file = "$AUTOCONF_TEMP_DIR\ld_wlan_psk\wlan.xml"

$profile | Out-File (New-Item $file -Force)

Get-NetAdapter | Where-Object { $_.PhysicalMediaType -eq 'Native 802.11' -or `
   $_.PhysicalMediaType -eq 'Wireless LAN' -or `
   $_.PhysicalMediaType -eq 'Wireless WAN' } | ForEach-Object {

   Write-Verbose "Creating wlan profile for '$ssid' on interface '$($_.Name)'"
   netsh wlan add profile filename= "$file" interface= "$($_.Name)"
}

Remove-Item -Path $file -Force
}

Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokalen Variablen.

Neue AutoConf-Rollen freigeben

Neue Autoconf-Rollen können am Server durch Aufruf des Befehls update-autoconf-archive im LXC ctrl-g1 aktualisiert werden. Der Aufruf dieses Kommandos ist auch nach Änderungen an Autoconf-Rollen nötig.
Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.

Betätigen Sie außerdem im LD Control Center (mit aktiviertem Expertenmodus) den Reiter "AutoConf Rollen neu einlesen", damit selbst hinzugefügte Autoconf-Rollen verfügbar werden.

Der Expertenmodus wird in den Einstellungen (Zahnrad oben rechts) -> Entwickleroptionen -> Expertenmodus aktivieren aktiv geschaltet.