Änderungen von Dokument Eigene Autoconf-Rolle erstellen

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

Von 2.1 nach 1.1 Von 15.1 nach 14.1

Von Version 14.1

bearbeitet von Jonas Mayer
am 2023/03/15 13:05

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

Auf Version 2.1

bearbeitet von Christian Germann
am 2022/08/09 10:53

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

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (3 geändert, 0 hinzugefügt, 0 gelöscht)
Anhänge (0 geändert, 0 hinzugefügt, 3 gelöscht)

Details

Seiteneigenschaften

Titel

@@ -1,1 +1,1 @@
--Eigene Autoconf-Rolle erstellen
++Autoconf-Konfiguration erstellen

Dokument-Autor

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

Inhalt

@@ -1,29 +1,16 @@
--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.
++Autoconf liegt wie der Vorgänger Ansible im ctrl-g1 Container und dient dazu Einstellungen oder Konfigurationen auf die deployten Rechner ohne ein Image dafür zu schreiben.
--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}}.
++Von SBE ausgelieferte Rollen befinden sich Im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
--[[image:image-20230315103418-1.png||height="103" width="1344" class="img-thumbnail"]]
++Selbst erstellte Autoconf-Rollen müssen unter {{box}}/var/lib/ld-autoconf/custom/{{/box}} abgelegt werden, damit diese nicht durch Updates überschrieben werden.
++Der Aufbau einer Autoconf-Regel muss einer Struktur folgen, damit der Server diese Interpretieren kann.
--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:
++Unterhalb der Regel muss ein Ordner mit Namen {{box}}meta{{/box}} mit einer {{box}}logodidact.yml{{/box}} liegen.
--* 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}}
--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 ausführbaren Skript-Dateien (PowerShell oder Bash). 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. mitzugeben.
++==== **Beispielaufbau der logodidact.yml:** ====
--Der strukturelle Aufbau ist nachfolgend ersichtlich:[[image:image-20230315120842-3.png||height="213" width="640"]]
--
------
--
--==== **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.
--
--
--Zum besseren Verständnis wird nachfolgend eine mitgelieferte 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
@@ -35,15 +35,15 @@
    authors:
      - Marcel Petersen
    company: SBE network solutions GmbH
--(% style="color:#1abc9c" %)display_name:(%%) WLAN Profil mit PSK anlegen
++  display_name: WLAN Profil mit PSK anlegen
    license: SBE
--(% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
++  uuid: 52318636-c4f5-11ea-baf9-0bff00c66ff4
    visible: true
    priority: 0
    applyAlways: false
--(% style="color:#f1c40f" %) tags:(%%)
++  tags:
      - CUSTOM
--(% style="color:#e74c3c" %)  vars:(%%)
++  vars:
      ssid:
        display_name: SSID
        optional: false
@@ -52,29 +52,24 @@
        display_name: Passwort
        optional: false
        type: PASSWORD
--(% style="color:#2980b9" %)systems:(%%)
++  systems:
      - WINDOWS
      - LINUX
  )))
--(% style="color:#1abc9c" %)display_name(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
++uuid = ID der Autoconf-Regel, muss einmalig sein. Bei einer eigenen Autoconf-Regel sollte der Wert am besten neugeneriert 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/]]
++tags = beschreibt in welcher Phase die Autoconf-Regel aktiv ist.
--(% style="color:#f1c40f" %)tags(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
++vars = definiert Variablen die den Skripten übergeben werden
--(% style="color:#e74c3c" %)vars(%%) = definiert mögliche Variablen, die den Skripten übergeben werden
++display_name = Name der Variable im ctrl
--*  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).
++optional = bestimmt ob die Option in der Autoconf-Regel  optional ist
--(% style="color:#2980b9" %) systems (%%)= Legt fest, welche Betriebssystem-Typen durch die Autoconf-Rolle unterstützt werden. Gültige Systeme sind: WINDOWS / LINUX
++type = bestimmt den Wert der Variable. Mögliche Werte STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
++ENUM entspricht einem Dropdown-Menü, in dem man aus vordefinierte Werte auswählen kann:
--
--**Beispiel für eine Variable:**
--
  (% class="box" %)
  (((
  globalLogLevel:
@@ -85,36 +85,20 @@
      - none
      - compact
      - detailed
--    - verbose
++    - full
  )))
--(% class="box infomessage" %)
--(((
--(% style="font-size:12px" %)**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.
--)))
++example = Gibt eine grauen Beispielwert für die Variable vor.
------
++systems = für welches Betriebssystem existieren Skripte in der Autoconf-Regel
--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. Für diese Skripte 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 ausgeführt. Dies geschieht sowohl 1x während des Deployments als auch später nach jedem Hochfahren des PCs 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 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 wird.
++Die eigentliche Skripte liegen direkt unterhalb der Autoconf-Regel im Verzeichnis {{box}}win{{/box}} neben dem Ordner {{box}}meta{{/box}}. Dort kann das Script main.ps1 heißen oder je nach dem in welcher Phase des Deployment es ausgeführt werden soll auch custom.ps1, setup.ps1, audit.ps1.
--(% 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.
--)))
--
  ==== **Beispielaufbau der main.ps1** ====
--Im Verzeichnis {{box}} win/ {{/box}} 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%"}}
++Im win-Verzeichnis können sich unterschiedliche Powershellskripte 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
@@ -125,7 +125,7 @@
  main.ps1 = alle Phasen
--root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
++root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
  Param
  (
@@ -136,10 +136,9 @@
   [String]
   $psk
  )
--
--if ($ssid -ne '' -and $psk -ne '') {
++\\if ($ssid -ne '' -and $psk -ne '') {
   $profile = @'
--<WLANProfile xmlns="http://www.microsoft.com/networking/WLAN/profile/v1">
++<WLANProfile xmlns="http:~/~/www.microsoft.com/networking/WLAN/profile/v1">
          <name>{0}</name>
          <SSIDConfig>
                  <SSID>
@@ -164,38 +164,24 @@
          </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 `
++\\ $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)'"
++\\    Write-Verbose "Creating wlan profile for '$ssid' on interface '$($_.Name)'"
      netsh wlan add profile filename= "$file" interface= "$($_.Name)"
   }
--
--  Remove-Item -Path $file -Force
++\\  Remove-Item -Path $file -Force
  }
--Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokalen Variablen.
--{{/code}}
++Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokale Variablen.
--====  ====
++**Neue AutoConf-Regel freigeben**
--==== **Neue AutoConf-Rollen 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.
--
--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.
--
--(% 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"]]
++Neue Autoconf-Regel müssen mit dem Befehl update-autoconf-archive eingelesen werden.
++Ansonsten werden die Autoconfrollen auch zeitbasiert (Alle 4 Stunden) neu eingelesen.
++Im Controlcenter im Expertenmodus dann folgenden Knopfen drücken, damit dort auch die neuen Autoconf-Regeln eingelesen werden.
++
++[[image:https://wiki.sbe.de/xwiki/bin/download/Main/SBE_intern/LogoDIDACT2.0/Lddeploy/Autoconf%20erstellen/WebHome/autoconf.png?rev=1.1||alt="autoconf.png"]]

autoconf.png

Author

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

Größe

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

Inhalt

image-20230315103418-1.png

Author

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

Größe

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

Inhalt

image-20230315120842-3.png

Author

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

Größe

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

Inhalt