Änderungen von Dokument Eigene Autoconf-Rolle erstellen

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

Von 12.10 nach 13.1

Von Version 1.1

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

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

Auf Version 12.10

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

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

Details

Seiteneigenschaften

Titel

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

Dokument-Autor

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

Inhalt

@@ -1,26 +1,49 @@
--Autoconf liegt wie der Vorgänger Ansible im ctrl-g1 Container.
--Dort im Pfad /usr/lib/ld-autoconf/logodidact/roles/ finden sich die bestehenden Rollen.
--Für eigene Rollen sollte die Rolle unter  /var/lib/ld-autoconf/custom abgelegt werden. Nach einem LD-Update geht so die Arbeit nicht verloren!
++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.
--Eine Autoconf-Regel besteht aus den Informationen zur Regel, die in der logodidact.yml im Ordner meta liegen und den jeweiligen Skripten für Windows im Unterordner win.
--Linux-Skripte würden sich im Unterordner lin befinden.
--\\**Beispielaufbau der logodidact.yml:**
++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}}.
++
++[[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.
++
++* 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 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-20230315112326-2.png||height="215" width="633" class="img-thumbnail"]]
++
++----
++
++==== **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.
++
++
++(% class="box" %)
++(((
  root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
++)))
++(% class="box" %)
++(((
  ld_info:
    authors:
      - Marcel Petersen
    company: SBE network solutions GmbH
--  display_name: WLAN Profil mit PSK anlegen
++(% style="color:#1abc9c" %)display_name:(%%) WLAN Profil mit PSK anlegen
    license: SBE
--  uuid: 52318636-c4f5-11ea-baf9-0bff00c66ff4
++(% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
    visible: true
    priority: 0
    applyAlways: false
--  tags:
++(% style="color:#f1c40f" %) tags:(%%)
      - CUSTOM
--  vars:
++(% style="color:#e74c3c" %)  vars:(%%)
      ssid:
        display_name: SSID
        optional: false
@@ -29,23 +29,31 @@
        display_name: Passwort
        optional: false
        type: PASSWORD
--  systems:
++(% style="color:#2980b9" %)systems:(%%)
      - WINDOWS
      - LINUX
++)))
--uuid = ID der Autoconf-Regel, muss einmalig sein. Bei einer eigenen Autoconf-Regel muss der Wert am besten neugeniert werden. [[https:~~/~~/www.uuidgenerator.net/>>url:https://www.uuidgenerator.net/]]
++(% style="color:#1abc9c" %)display_name(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
--tags = beschreibt in welcher Phase die Autoconf-Regel aktiv ist.
++(% 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/]]
--vars = definiert Variablen die den Skripten übergeben werden
++(% style="color:#f1c40f" %)tags(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
--display_name = Name der Variable im ctrl
++(% style="color:#e74c3c" %)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
++*  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).
--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:
++(% style="color:#2980b9" %) systems (%%)= Legt fest, welche Betriebssystem-Typen durch die Autoconf-Rolle unterstützt werden. Gültige Systeme sind: WINDOWS / LINUX
++
++**Beispiel für eine Variable:**
++
++(% class="box" %)
++(((
  globalLogLevel:
    display_name: Loglevel
    optional: true
@@ -55,14 +55,35 @@
      - compact
      - detailed
      - full
++)))
--example = Gibt eine grauen Beispielwert für die Variable vor.
++(% 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
++)))
--systems = für welches Betriebssystem existieren Skripte in der Autoconf-Regel
++----
--**Beispielaufbau der main.ps1**
++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:
--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.
++* **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.
++
++(% 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.
++)))
++
++
++==== **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.
++
++{{code width="50%"}}
  user.ps1 = user Phase, nach der Anmeldung
  custom.ps1 = custom Phase
@@ -73,7 +73,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
  (
@@ -84,9 +84,10 @@
   [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>
@@ -111,24 +111,38 @@
          </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.
++Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokalen Variablen.
++{{/code}}
--**Neue AutoConf-Regel freigeben**
++====  ====
--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.
--
++==== **Neue AutoConf-Rollen freigeben** ====
--[[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"]]
++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"]]
++

autoconf.png

Author

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

Größe

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

Inhalt

image-20230315103418-1.png

Author

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

Größe

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

Inhalt