Änderungen von Dokument Eigene Autoconf-Rolle erstellen

Zuletzt geändert von Tom Altenbrunn am 2023/03/17 08:03

Von 13.1 nach 13.2 Von 28.1 nach 29.1

Von Version 13.2

bearbeitet von Tom Altenbrunn
am 2023/03/15 12:09

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Auf Version 28.1

bearbeitet von Jonas Mayer
am 2023/03/16 07:55

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)
Anhänge (0 geändert, 1 hinzugefügt, 0 gelöscht)
- autoconf-struktur.PNG

Details

Seiteneigenschaften

Dokument-Autor

@@ -1,1 +1,1 @@
--XWiki.TomAltenbrunn@sbede
++XWiki.jonasmayer@sbede

Inhalt

@@ -1,31 +1,113 @@
--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.
++{{toc depth="3"/}}
--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 {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
++= (% style="font-size:22px" %)__**Allgemeines**__(%%) =
++
++
++Autoconf liegt wie der Vorgänger Ansible im ctrl-g1 Container und dient dazu, individuelle Einstellungen während des Deployments auf Rechner zu übertragen. Es können über diesen Mechanismus nachträglich auch kleinere Anpassungen an Clients übertragen werden, ohne dafür ein neues Image auf den Server hochzuladen. Somit lassen sich relativ einfach und flexibel diverse Anpassungen an bestehenden Clients vornehmen.
++
++LogoDIDACT ist standardmäßig bereits mit zahlreichen Autoconf-Rollen bestückt, die mitgeliefert werden, um ein möglichst breites Spektrum verschiedenster Anforderungen des allgemeinen Schulbetriebs abzudecken.
++Diese fest integrierten Rollen befinden sich im LXC-Container ctrl-g1 im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
++
  [[image:image-20230315103418-1.png||height="103" width="1344" class="img-thumbnail"]]
--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.
++Darüber hinaus ist es Partnern und Kunden möglich, für spezielle / anwendungsspezifische Anforderungen eigene Autoconf-Rollen zu erstellen und im LD Control Center mit Clients zu verknüpfen. Dafür steht am LD-Server ein eigenes Verzeichnis zur Verfügung, welches sich ebenfalls im LXC-Container ctrl-g1 befindet und nicht durch Server-Updates beeinflusst oder überschrieben wird. Der genaue Speicherpfad hängt von der Puppet-Version des Servers ab:
  * bis Puppet-Version **1.4.x** : {{code language="bash"}}/var/lib/ld-autoconf/custom/{{/code}}
--* Ab Puppet-Version **1.5.x **:  {{code language="bash" layout="LINENUMBERS"}}/data/ld/autoconf/custom/{{/code}}
++* ab Puppet-Version **1.5.x **:  {{code language="bash" layout="LINENUMBERS"}}/data/ld/autoconf/custom/{{/code}}
--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:[[image:image-20230315120842-3.png||height="213" width="640"]]
++Der Aufbau einer Autoconf-Rolle unterliegt einer vordefinierten Struktur, bestehend aus einer Beschreibungsdatei {{box}}meta/logodidact.yml{{/box}}, welche die Informationen zu Namen, Beschreibung, Ersteller, Variablen, usw. definiert, sowie zugehörige Skript-Dateien (PowerShell). Diese Skript-Dateien müssen - abhängig vom vorgesehen Ziel-Betriebssystem - in einem Unterordner {{box}} win/ {{/box}} (//Windows//) oder {{box}} lin/ {{/box}} (//Linux//) abgespeichert sein. Zusätzlich besteht auch die Möglichkeit, in einem weiteren Unterordner {{box}} files/ {{/box}} beliebige Dateien in der Autoconf-Rolle mitzuliefern, wie zum Beispiel Bilder, Videos, etc.
++__Der strukturelle Aufbau eines AutoConf-Verzeichnisses grafisch dargestellt:__
++
++[[image:attach:autoconf-struktur.PNG||data-xwiki-image-style-border="true" data-xwiki-image-style-text-wrap="true" height="348" width="642" class="img-thumbnail"]]
++
  ----
--==== **Beispielaufbau einer logodidact.yml:** ====
++Für die Funktionalität der Autoconf-Rolle ist es also nötig, PowerShell-Skripte am Server abzuspeichern, die die Instruktionen an den Arbeitsstationen ausführen. Für diese Skripte sind folgende Dateinamen zulässig:
--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.
++* **main.ps1** - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei {{box}}meta/logodidact.yml{{/box}} festgelegt sind
++* (% style="color:#8e44ad" %)**setup.ps1**(%%) - Skript wird ausschließlich in der SETUP-Phase während des Deployments ausgeführt. In der Setup-Phase ist der Client noch veränderlich und besitzt noch keine Schutzfunktion, selbst wenn der Schutz aktiviert ist.
++* (% style="color:#8e44ad" %)**custom.ps1**(%%) - Skript wird ausschließlich in der CUSTOM-Phase ausgeführt. Dies geschieht sowohl 1x während des Deployments als auch später nach jedem Hochfahren des PCs 1x im Hintergrund.
++* (% style="color:#8e44ad" %)**user.ps1**(%%) - Skript wird ausschließlich in der USER-Phase ausgeführt. Diese Phase wird nicht direkt während des Deployments durchlaufen, sondern erst später während der Benutzeranmeldung an betriebsbereiten PCs.
++* (% style="color:#8e44ad" %)**audit.ps1**(%%) - Skript wird ausschließlich in der AUDIT-Phase ausgeführt. Das bedeutet erst dann, wenn man an einem Client in den Audit-Modus zur Imagebearbeitung wechselt.
++* **collect.ps1** - Sonderfall. Dieses Skript wird ausgeführt, wenn durch einen Anwender aktiv die Phase COLLECT zum Einsammeln von Einstellungen am Client aufgerufen wird.
++
++(% class="box warningmessage" %)
++(((
++(% style="font-size:12px" %)**Hinweis: **Skripte, die durch ihren Dateinamen auf einzelne Phasen eingeschränkt sind ((% style="color:#8e44ad; font-size:12px" %)lila eingefärbt(% style="font-size:12px" %)), dürfen sich inhaltlich zueinander unterscheiden. Dadurch kann eine Autoconf-Rolle sehr flexibel gestaltet werden und in den verschiedenen Phasen des Deployments unterschiedliche Aktionen ausführen.
++)))
++
++----
++
++
++= (% style="font-size:22px" %)__**Beispielaufbau einer logodidact.yml**__(%%) =
++
++
++Eine Autoconf-Beispielvorlage liegt serverseitig im Unterordner {{box}}/data/ld/autoconf/custom/example/{{/box}} abgespeichert. Darin wird die Verwendung verschiedener Variablentypen aufgezeigt, die als Parameter an die Skript-Dateien weitergegeben werden können. Die Verwendung solcher Variablen innerhalb einer Autoconf-Rolle ist optional, je nach Zweck jedoch häufig sinnvoll.
++
++== (% style="font-size:16px" %)**Beispiel zur Deklaration einer Autoconf Variable in logodidact.yml**(%%) ==
++
++(% class="box" %)
++(((
++ld_info:
++  display_name: Meine eigene Autoconf-Rolle 1
++(% style="color:#27ae60" %)  # [...](%%)
++\\  vars:
++    globalLogLevel:
++      display_name: Loglevel
++      optional: true
++      type: ENUM
++      values:
++        - none
++        - compact
++        - detailed
++        - verbose
++\\(% style="color:#27ae60" %)  # [...]
++)))
++
++(% class="box infomessage" %)
++(((
++**Tipp:** Der Variablentyp ENUM aus dem Beispiel ergibt ein Dropdown-Menü, in dem man aus den vordefinierten 4 Werten (none / compact / detailed / verbose) auswählen kann.
++)))
++
++----
++
++
++= (% style="font-size:22px" %)__**Neue AutoConf-Rollen nach Fertigstellung freigeben**__(%%) =
++
++
++Neue Autoconf-Rollen können am Server durch Aufruf des Befehls {{box}}update-autoconf-archive{{/box}} 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.
++
++Über den Button "AutoConf Rollen neu einlesen" im LD Control Center (mit aktiviertem Expertenmodus) werden die neu erstellten Rollen im Anschluss sichtbar und sind wie gewohnt Betriebssystemen zuordenbar.
++
++(% class="box infomessage" %)
++(((
++Der Expertenmodus wird in den **Einstellungen (Zahnrad oben rechts) -> Entwickleroptionen -> Expertenmodus aktivieren** aktiv geschaltet.
++)))
++
++[[image:attach:autoconf.png||data-xwiki-image-style-border="true" class="img-thumbnail"]]
++----
++
++
++= (% style="font-size:22px" %)__**Weiteres, funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“**__(%%) =
++
++
++Zum besseren Verständnis wird nachfolgend eine feste Autoconf-Rolle zur Konfiguration eines WLAN-Profils (SSID inkl. PSK) an Clients näher beleuchtet.
++
  (% class="box" %)
  (((
  root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
  )))
++== (% style="font-size:16px" %)**Struktureller Aufbau der logodidact.yml**(%%) ==
++
  (% class="box" %)
  (((
  ld_info:
@@ -32,13 +32,13 @@
    authors:
      - Marcel Petersen
    company: SBE network solutions GmbH
--(% style="color:#1abc9c" %)display_name:(%%) WLAN Profil mit PSK anlegen
++(% style="color:#1abc9c" %)  display_name:(%%) WLAN Profil mit PSK anlegen
    license: SBE
--(% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
++(% style="color:#8e44ad" %)  uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
    visible: true
--  priority: 0
++(% style="color:#19177c" %)  priority:(%%) 0
    applyAlways: false
--(% style="color:#f1c40f" %) tags:(%%)
++(% style="color:#f1c40f" %)  tags:(%%)
      - CUSTOM
  (% style="color:#e74c3c" %)  vars:(%%)
      ssid:
@@ -49,81 +49,44 @@
        display_name: Passwort
        optional: false
        type: PASSWORD
--(% style="color:#2980b9" %)systems:(%%)
++(% style="color:#2980b9" %)  systems:(%%)
      - WINDOWS
      - LINUX
  )))
--(% style="color:#1abc9c" %)display_name(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
++(% style="color:#1abc9c" %)**display_name**(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
--(% style="color:#8e44ad" %)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/>>url:https://www.uuidgenerator.net/]]
++(% style="color:#8e44ad" %)**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/>>url:https://www.uuidgenerator.net/]]
--(% style="color:#f1c40f" %)tags(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
++(% style="color:#19177c" %)**priority**(% style="color:#2980b9" %)** **(%%)= Legt die Verarbeitungsreihenfolge der Autoconf-Rolle gegenüber weiteren Rollen fest, die in derselben Phase ausgeführt werden. Bei gleicher Priorität findet die Abarbeitung alphabetisch statt. Eine höhere Priorität führt zu früherer Ausführung.
--(% style="color:#e74c3c" %)vars(%%) = definiert mögliche Variablen, die den Skripten übergeben werden
++(% style="color:#f1c40f" %)**tags**(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
++(% style="color:#e74c3c" %)**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).
--(% style="color:#2980b9" %) systems (%%)= Legt fest, welche Betriebssystem-Typen durch die Autoconf-Rolle unterstützt werden. Gültige Systeme sind: WINDOWS / LINUX
++(% style="color:#2980b9" %)**systems **(%%)= Legt fest, welche Betriebssystem-Typen durch die Autoconf-Rolle unterstützt werden. Gültige Systeme sind WINDOWS / LINUX. Die Rolle aus dem Beispiel unterstützt beide Betriebssysteme gleichzeitig.
--
--**Beispiel für eine Variable:**
--
--(% class="box" %)
--(((
--globalLogLevel:
--  display_name: Loglevel
--  optional: true
--  type: ENUM
--  values:
--    - none
--    - compact
--    - detailed
--    - full
--)))
--
--(% class="box infomessage" %)
--(((
--(% style="font-size:12px" %)**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 {{box}}win{{/box}}. Darin sind folgende Dateinamen zulässig:
--* **main.ps1** - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei {{box}}meta/logodidact.yml{{/box}} festgelegt sind
--* (% style="color:#8e44ad" %)**setup.ps1**(%%) - Skript wird ausschließlich in der SETUP-Phase während des Deployments ausgeführt.
--* (% style="color:#8e44ad" %)**custom.ps1**(%%) - Skript wird ausschließlich in der CUSTOM-Phase während des Deployments ausgeführt.
--* (% style="color:#8e44ad" %)**user.ps1**(%%) - Skript wird ausschließlich in der USER-Phase während des Deployments ausgeführt.
--* (% style="color:#8e44ad" %)**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.
++== (% style="font-size:16px" %)**Inhalt des PowerShell-Skripts main.ps1, das die Variablen entgegennimmt**(%%) ==
--(% class="box warningmessage" %)
--(((
--(% style="font-size:12px" %)**Hinweis: **Skripte, die durch ihren Dateinamen auf die einzelnen Phasen eingeschränkt sind ((% style="color:#8e44ad; font-size:12px" %)lila eingefärbt(% style="font-size:12px" %)), können sich inhaltlich zueinander unterscheiden. Dadurch kann eine Autoconf-Rolle sehr flexibel gestaltet werden.
--)))
++Im Unterverzeichnis {{box}} win/ {{/box}} oder {{box}} lin/ {{/box}} der Autoconf-Rolle können sich wie erläutert unterschiedliche PowerShell-Skripte zur Ausführung in den verschiedenen Phasen befinden.
++In dieser Rolle liegt konkret das allgemeingültige Skript {{box}}main.ps1{{/box}} vor, welches die Variablen als Parameter ##$ssid## und ##$psk## intern verwendet.
--==== **Beispielaufbau der main.ps1** ====
++(% style="color:#19177c" %)**Windows Variante**
--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.
--
--{{code width="50%"}}
--user.ps1 = user Phase, nach der Anmeldung
--
--custom.ps1 = custom Phase
--
--audit.ps1 = audit Phase
--
--setup.ps1 = setup Phase
--
--main.ps1 = alle Phasen
--
++{{code language="text" width="50%"}}
  root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
++{{/code}}
++{{code width="50%" language="powershell"}}
  Param
  (
   [parameter(Mandatory=$false)]
@@ -176,23 +176,71 @@
    Remove-Item -Path $file -Force
  }
++{{/code}}
--Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokalen Variablen.
++
++(% style="color:#19177c" %)**Linux Variante (Network Manager)**
++
++{{code width="50%" language="text"}}
++root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
  {{/code}}
--====  ====
++{{code language="powershell" width="50%"}}
++Param
++(
++  [parameter(Mandatory=$false)]
++  [String]
++  $ssid,
++  [parameter(Mandatory=$false)]
++  [String]
++  $psk
++)
--==== **Neue AutoConf-Rollen freigeben** ====
++if ($ssid -ne '' -and $psk -ne '') {
++  if (Get-Command "nmcli" -ErrorAction SilentlyContinue) {
++    # Check if kernel modules are up
++    nmcli dev wifi rescan
++ if ($LASTEXITCODE -ne 0) {
++   Start-Sleep -Seconds 30
++ }
++
++ # Check again
++ nmcli dev wifi rescan
++ if ($LASTEXITCODE -ne 0) {
++   Write-Verbose "Skipping role. There might be no WiFi device installed."
++   exit 0
++ }
++
++    $config = "/etc/NetworkManager/system-connections/$ssid"
--Neue Autoconf-Rollen können am Server durch Aufruf des Befehls {{box}}update-autoconf-archive{{/box}} 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.
++    if (Test-Path -Path $config) {
++      Write-Verbose "Removing '$config'"
++      Remove-Item -Path $config -Recurse -Force
++    }
--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.
++    Write-Verbose "Connecting to '$ssid'"
++
++    nmcli device wifi connect """$ssid""" password """$psk"""
++
++    if ($LASTEXITCODE -eq 0) {
++      Start-Sleep -Seconds 5
++      nmcli con up """$ssid"""
--(% class="box infomessage" %)
--(((
--Der Expertenmodus wird in den **Einstellungen (Zahnrad oben rechts) -> Entwickleroptionen -> Expertenmodus aktivieren** aktiv geschaltet.
--)))
++      if ($LASTEXITCODE -ne 0) {
++        Write-Verbose "Error: Credentials wrong?"
--[[image:attach:autoconf.png||data-xwiki-image-style-border="true"]]
--
++        if (Test-Path -Path $config) {
++          Write-Verbose "Removing '$config'"
++          Remove-Item -Path $config -Recurse -Force
++        }
++      }
++    }
++
++    Write-Verbose "Exiting with code: $LASTEXITCODE"
++    exit $LASTEXITCODE
++  }
++
++  Write-Verbose "No suitable implementation found"
++  exit 1
++}
++{{/code}}

autoconf-struktur.PNG

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.TomAltenbrunn@sbede

Größe

...	...	@@ -1,0 +1,1 @@
	1	+36.5 KB

Inhalt