Ä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 12.9 nach 12.8

Von Version 12.8

bearbeitet von Tom Altenbrunn
am 2023/03/15 11:06

Ä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, 2 gelöscht)
- autoconf.png
- image-20230315103418-1.png

Details

Seiteneigenschaften

Titel

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

Dokument-Autor

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

Inhalt

@@ -1,23 +1,14 @@
--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.
++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 bereits standardmäßig mit zahlreichen eigenen Autoconf-Rollen bestückt, um ein möglichst breites Spektrum verschiedenster Anforderungen des allgemeinen Schulbetriebs abzudecken.
++Von SBE ausgelieferte Rollen befinden sich Im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
--Vonseiten SBE bereitgestellte Rollen befinden sich im ctrl-g1-Container im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
++Selbst erstellte Autoconf-Rollen müssen unter {{box}}/var/lib/ld-autoconf/custom/{{/box}} abgelegt werden, damit diese nicht durch Updates überschrieben werden.
--[[image:image-20230315103418-1.png||height="103" width="1344" class="img-thumbnail"]]
++Der Aufbau einer Autoconf-Regel muss einer Struktur folgen, damit der Server diese Interpretieren kann.
++Unterhalb der Regel muss ein Ordner mit Namen {{box}}meta{{/box}} mit einer {{box}}logodidact.yml{{/box}} liegen.
--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** : {{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 YAML-Datei, welche die Informationen zu Namen und Variablen definiert, sowie der eigentlichen ausführbaren Skript-Datei (Powershell oder Bash) und einer    damit der Server diese Interpretieren kann.
--
--Unterhalb der Regel muss ein Ordner mit Namen {{box}}meta{{/box}} mit einer {{box}}logodidact.yml{{/box}} liegen. In dieser Datei sind Name, Beschreibung, Ersteller sowie weitere Informationen zur Autoconf-Rolle festgelegt.
--
--
  ==== **Beispielaufbau der logodidact.yml:** ====
  (% class="box" %)
@@ -53,27 +53,19 @@
      - LINUX
  )))
--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/]]
--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.
--tags = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
++vars = definiert Variablen die den Skripten übergeben werden
--systems = Legt fest, welche Betriebssystem-Typen durch die Autoconf-Rolle unterstützt werden. Gültige Systeme sind: WINDOWS / LINUX
++display_name = Name der Variable im ctrl
--vars = definiert mögliche Variablen, die den Skripten übergeben werden
++optional = bestimmt ob die Option in der Autoconf-Regel  optional ist
--  ~* display_name = Name der konfigurierbaren Variable im Control Center
++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:
--  ~* example = Zeigt einen grau eingefärbten Beispieltext innerhalb Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
--
--  ~* 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
--
--
--**Beispiel für eine Variable:**
--
  (% class="box" %)
  (((
  globalLogLevel:
@@ -87,26 +87,17 @@
      - full
  )))
--(% style="font-size:12px" %)**Tipp:** Der Variablentyp ENUM aus dem Beispiel entspricht einem Dropdown-Menü, in dem man aus vordefinierte Werte 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. 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.
++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.
--(% 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.
--
  ==== **Beispielaufbau der main.ps1** ====
  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.
--
--{{code}}
  user.ps1 = user Phase, nach der Anmeldung
  custom.ps1 = custom Phase
@@ -117,7 +117,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
  (
@@ -128,10 +128,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>
@@ -156,33 +156,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 lokale Variablen.
--{{/code}}
--====  ====
++**Neue AutoConf-Regel freigeben**
--==== **Neue AutoConf-Rollen freigeben** ====
--
--Neue Autoconf-Rollen müssen 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) folgenden Knopf, damit selbst hinzugefügte Autoconf-Rollen verfügbar werden.
--
--[[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