Zum Inhalt springen

Änderungen von Dokument Eigene Autoconf-Rolle erstellen

Zuletzt geändert von Tom Altenbrunn am 2023/03/17 08:03
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 16.1
bearbeitet von Jonas Mayer
am 2023/03/15 13:27
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -Autoconf-Konfiguration erstellen
1 +Eigene Autoconf-Rolle erstellen
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.cge@sbede
1 +XWiki.jonasmayer@sbede
Inhalt
... ... @@ -1,26 +1,114 @@
1 -Autoconf liegt wie der Vorgänger Ansible im ctrl-g1 Container.
2 -Dort im Pfad /usr/lib/ld-autoconf/logodidact/roles/ finden sich die bestehenden Rollen.
3 -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!
1 +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.
4 4  
5 -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.
6 -Linux-Skripte würden sich im Unterordner lin befinden.
7 -\\**Beispielaufbau der logodidact.yml:**
3 +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.
4 +Diese fest integrierten Rollen befinden sich im LXC-Container ctrl-g1 im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
8 8  
6 +[[image:image-20230315103418-1.png||height="103" width="1344" class="img-thumbnail"]]
7 +
8 +
9 +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:
10 +
11 +* bis Puppet-Version **1.4.x** : {{code language="bash"}}/var/lib/ld-autoconf/custom/{{/code}}
12 +* ab Puppet-Version **1.5.x **:  {{code language="bash" layout="LINENUMBERS"}}/data/ld/autoconf/custom/{{/code}}
13 +
14 +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.
15 +
16 +Der strukturelle Aufbau ist nachfolgend ersichtlich:[[image:image-20230315120842-3.png||height="213" width="640"]]
17 +
18 +
19 +
20 +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:
21 +
22 +* **main.ps1** - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei {{box}}meta/logodidact.yml{{/box}} festgelegt sind
23 +* (% 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.
24 +* (% 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.
25 +* (% 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.
26 +* (% 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.
27 +* **collect.ps1** - Sonderfall. Dieses Skript wird ausgeführt, wenn durch einen Anwender aktiv die Phase COLLECT zum Einsammeln von Einstellungen am Client aufgerufen wird.
28 +
29 +(% class="box warningmessage" %)
30 +(((
31 +(% 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.
32 +)))
33 +
34 +
35 +----
36 +
37 +==== **Beispielaufbau einer logodidact.yml:** ====
38 +
39 +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.
40 +
41 +
42 +**Beispiel zur Deklaration einer Autoconf Variable in logodidact.yml:**
43 +
44 +(% class="box" %)
45 +(((
46 +ld_info:
47 + display_name: Meine eigene Autoconf-Rolle 1
48 +(% style="color:#27ae60" %) #[...](%%)
49 +\\ vars:
50 + globalLogLevel:
51 + display_name: Loglevel
52 + optional: true
53 + type: ENUM
54 + values:
55 + - none
56 + - compact
57 + - detailed
58 + - verbose
59 +\\(% style="color:#27ae60" %) #[...]
60 +)))
61 +
62 +(% class="box infomessage" %)
63 +(((
64 +(% 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.
65 +)))
66 +
67 +----
68 +
69 +==== **Neue AutoConf-Rollen nach Fertigstellung freigeben** ====
70 +
71 +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.
72 +Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
73 +
74 +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.
75 +
76 +(% class="box infomessage" %)
77 +(((
78 +Der Expertenmodus wird in den **Einstellungen (Zahnrad oben rechts) -> Entwickleroptionen -> Expertenmodus aktivieren** aktiv geschaltet.
79 +)))
80 +
81 +[[image:attach:autoconf.png||data-xwiki-image-style-border="true" class="img-thumbnail"]]
82 +
83 +
84 +
85 +----
86 +
87 +
88 +==== **Weiteres, funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“** ====
89 +
90 +Zum besseren Verständnis wird nachfolgend eine mitgelieferte Autoconf-Rolle zur Konfiguration eines WLAN-Profils (SSID inkl. PSK) an Clients näher beleuchtet.
91 +
92 +(% class="box" %)
93 +(((
9 9  root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
95 +)))
10 10  
97 +(% class="box" %)
98 +(((
11 11  ld_info:
12 12   authors:
13 13   - Marcel Petersen
14 14   company: SBE network solutions GmbH
15 - display_name: WLAN Profil mit PSK anlegen
103 +(% style="color:#1abc9c" %)display_name:(%%) WLAN Profil mit PSK anlegen
16 16   license: SBE
17 - uuid: 52318636-c4f5-11ea-baf9-0bff00c66ff4
105 +(% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
18 18   visible: true
19 19   priority: 0
20 20   applyAlways: false
21 - tags:
109 +(% style="color:#f1c40f" %) tags:(%%)
22 22   - CUSTOM
23 - vars:
111 +(% style="color:#e74c3c" %) vars:(%%)
24 24   ssid:
25 25   display_name: SSID
26 26   optional: false
... ... @@ -29,52 +29,34 @@
29 29   display_name: Passwort
30 30   optional: false
31 31   type: PASSWORD
32 - systems:
120 +(% style="color:#2980b9" %)systems:(%%)
33 33   - WINDOWS
34 34   - LINUX
123 +)))
35 35  
36 -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/]]
125 +(% style="color:#1abc9c" %)display_name(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
37 37  
38 -tags = beschreibt in welcher Phase die Autoconf-Regel aktiv ist.
127 +(% 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/]]
39 39  
40 -vars = definiert Variablen die den Skripten übergeben werden
129 +(% style="color:#f1c40f" %)tags(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
41 41  
42 -display_name = Name der Variable im ctrl
131 +(% style="color:#e74c3c" %)vars(%%) = definiert mögliche Variablen, die den Skripten übergeben werden
43 43  
44 -optional = bestimmt ob die Option in der Autoconf-Regel  optional ist
133 +* display_name = Name der konfigurierbaren Variable im Control Center
134 +* optional = bestimmt, ob die Variable zwingend mit einem Wert belegt werden muss
135 +* type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
136 +* example = Zeigt einen grau eingefärbten Beispieltext innerhalb der definierten Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
45 45  
46 -type = bestimmt den Wert der Variable. Mögliche Werte STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
47 -ENUM entspricht einem Dropdown-Menü, in dem man aus vordefinierte Werte auswählen kann:
138 +(% 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.
48 48  
49 -globalLogLevel:
50 - display_name: Loglevel
51 - optional: true
52 - type: ENUM
53 - values:
54 - - none
55 - - compact
56 - - detailed
57 - - full
58 58  
59 -example = Gibt eine grauen Beispielwert für die Variable vor.
141 +===== **Aufbau der main.ps1** =====
60 60  
61 -systems = für welches Betriebssystem existieren Skripte in der Autoconf-Regel
143 +Im Verzeichnis {{box}} win/ {{/box}} können sich unterschiedliche Powershell-Skripte befinden. In dieser Rolle liegt das allgemeingültige Skript main.ps1 vor.
62 62  
63 -**Beispielaufbau der main.ps1**
145 +{{code width="50%"}}
146 +root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
64 64  
65 -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.
66 -user.ps1 = user Phase, nach der Anmeldung
67 -
68 -custom.ps1 = custom Phase
69 -
70 -audit.ps1 = audit Phase
71 -
72 -setup.ps1 = setup Phase
73 -
74 -main.ps1 = alle Phasen
75 -
76 -root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
77 -
78 78  Param
79 79  (
80 80   [parameter(Mandatory=$false)]
... ... @@ -84,9 +84,10 @@
84 84   [String]
85 85   $psk
86 86  )
87 -\\if ($ssid -ne '' -and $psk -ne '') {
157 +
158 +if ($ssid -ne '' -and $psk -ne '') {
88 88   $profile = @'
89 -<WLANProfile xmlns="http:~/~/www.microsoft.com/networking/WLAN/profile/v1">
160 +<WLANProfile xmlns="http://www.microsoft.com/networking/WLAN/profile/v1">
90 90   <name>{0}</name>
91 91   <SSIDConfig>
92 92   <SSID>
... ... @@ -111,24 +111,37 @@
111 111   </MSM>
112 112  </WLANProfile>
113 113  '@ -f $ssid, $psk
114 -\\ $file = "$AUTOCONF_TEMP_DIR\ld_wlan_psk\wlan.xml"
115 -\\ $profile | Out-File (New-Item $file -Force)
116 -\\ Get-NetAdapter | Where-Object { $_.PhysicalMediaType -eq 'Native 802.11' -or `
185 +
186 + $file = "$AUTOCONF_TEMP_DIR\ld_wlan_psk\wlan.xml"
187 +
188 + $profile | Out-File (New-Item $file -Force)
189 +
190 + Get-NetAdapter | Where-Object { $_.PhysicalMediaType -eq 'Native 802.11' -or `
117 117   $_.PhysicalMediaType -eq 'Wireless LAN' -or `
118 118   $_.PhysicalMediaType -eq 'Wireless WAN' } | ForEach-Object {
119 -\\ Write-Verbose "Creating wlan profile for '$ssid' on interface '$($_.Name)'"
193 +
194 + Write-Verbose "Creating wlan profile for '$ssid' on interface '$($_.Name)'"
120 120   netsh wlan add profile filename= "$file" interface= "$($_.Name)"
121 121   }
122 -\\ Remove-Item -Path $file -Force
197 +
198 + Remove-Item -Path $file -Force
123 123  }
124 124  
125 -Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokale Variablen.
201 +Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokalen Variablen.
202 +{{/code}}
126 126  
127 -**Neue AutoConf-Regel freigeben**
204 +==== ====
128 128  
129 -Neue Autoconf-Regel müssen mit dem Befehl update-autoconf-archive eingelesen werden. 
130 -Ansonsten werden die Autoconfrollen auch zeitbasiert (Alle 4 Stunden) neu eingelesen.
131 -Im Controlcenter im Expertenmodus dann folgenden Knopfen drücken, damit dort auch die neuen Autoconf-Regeln eingelesen werden.
132 -
206 +==== ====
133 133  
134 -[[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"]]
208 +==== ====
209 +
210 +==== ====
211 +
212 +==== ====
213 +
214 +==== ====
215 +
216 +==== ====
217 +
218 +==== ====
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
image-20230315120842-3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,0 +1,1 @@
1 +34.9 KB
Inhalt