Zum Inhalt springen
Version 29.2 von Tom Altenbrunn am 2023/03/16 10:24
Zeige letzte Bearbeiter
1 {{toc depth="3"/}}
2
3 ----
4
5
6 = (% style="font-size:22px" %)__**Allgemeines**__(%%) =
7
8
9 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.
10
11 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.
12 Diese fest integrierten Rollen befinden sich im LXC-Container ctrl-g1 im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
13
14 [[image:image-20230315103418-1.png||height="103" width="1344" class="img-thumbnail"]]
15
16
17 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:
18
19 * bis Puppet-Version **1.4.x** : {{code language="bash"}}/var/lib/ld-autoconf/custom/{{/code}}
20 * ab Puppet-Version **1.5.x **:  {{code language="bash" layout="LINENUMBERS"}}/data/ld/autoconf/custom/{{/code}}
21
22 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.
23
24 __Der strukturelle Aufbau eines AutoConf-Verzeichnisses grafisch dargestellt:__
25
26 [[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"]]
27
28 ----
29
30 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:
31
32 * **main.ps1** - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei {{box}}meta/logodidact.yml{{/box}} festgelegt sind
33 * (% 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.
34 * (% 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.
35 * (% 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.
36 * (% 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.
37 * **collect.ps1** - Sonderfall. Dieses Skript wird ausgeführt, wenn durch einen Anwender aktiv die Phase COLLECT zum Einsammeln von Einstellungen am Client aufgerufen wird.
38
39 (% class="box warningmessage" %)
40 (((
41 (% 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.
42 )))
43
44 ----
45
46
47 = (% style="font-size:22px" %)__**Beispielaufbau einer logodidact.yml**__(%%) =
48
49
50 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.
51
52 == (% style="font-size:16px" %)**Beispiel zur Deklaration einer Autoconf Variable in logodidact.yml**(%%) ==
53
54 (% class="box" %)
55 (((
56 ld_info:
57 display_name: Meine eigene Autoconf-Rolle 1
58 (% style="color:#27ae60" %) # [...](%%)
59 \\ vars:
60 globalLogLevel:
61 display_name: Loglevel
62 optional: true
63 type: ENUM
64 values:
65 - none
66 - compact
67 - detailed
68 - verbose
69 \\(% style="color:#27ae60" %) # [...]
70 )))
71
72 (% class="box infomessage" %)
73 (((
74 **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.
75 )))
76
77 ----
78
79
80 = (% style="font-size:22px" %)__**Neue AutoConf-Rollen nach Fertigstellung freigeben**__(%%) =
81
82
83 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.
84 Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
85
86 Ü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.
87
88 (% class="box infomessage" %)
89 (((
90 Der Expertenmodus wird in den **Einstellungen (Zahnrad oben rechts) -> Entwickleroptionen -> Expertenmodus aktivieren** aktiv geschaltet.
91 )))
92
93 [[image:attach:autoconf.png||data-xwiki-image-style-border="true" class="img-thumbnail"]]
94
95
96 ----
97
98
99 = (% style="font-size:22px" %)__**Funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“**__(%%) =
100
101
102 Zum besseren Verständnis wird nachfolgend eine feste Autoconf-Rolle zur Konfiguration eines WLAN-Profils (SSID inkl. PSK) an Clients näher beleuchtet.
103
104 (% class="box" %)
105 (((
106 root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
107 )))
108
109 == (% style="font-size:16px" %)**Struktureller Aufbau der logodidact.yml**(%%) ==
110
111 (% class="box" %)
112 (((
113 ld_info:
114 authors:
115 - Marcel Petersen
116 company: SBE network solutions GmbH
117 (% style="color:#1abc9c" %) display_name:(%%) WLAN Profil mit PSK anlegen
118 license: SBE
119 (% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
120 visible: true
121 (% style="color:#19177c" %) priority:(%%) 0
122 applyAlways: false
123 (% style="color:#f1c40f" %) tags:(%%)
124 - CUSTOM
125 (% style="color:#e74c3c" %) vars:(%%)
126 ssid:
127 display_name: SSID
128 optional: false
129 type: STRING
130 psk:
131 display_name: Passwort
132 optional: false
133 type: PASSWORD
134 (% style="color:#2980b9" %) systems:(%%)
135 - WINDOWS
136 - LINUX
137 )))
138
139 (% style="color:#1abc9c" %)**display_name**(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
140
141 (% 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/]]
142
143 (% 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.
144
145 (% style="color:#f1c40f" %)**tags**(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
146
147 (% style="color:#e74c3c" %)**vars**(%%)** **= definiert mögliche Variablen, die den Skripten übergeben werden
148
149 * display_name = Name der konfigurierbaren Variable im Control Center
150 * optional = bestimmt, ob die Variable zwingend mit einem Wert belegt werden muss
151 * type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
152 * example = Zeigt einen grau eingefärbten Beispieltext innerhalb der definierten Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
153
154 (% 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.
155
156 ----
157
158
159 == (% style="font-size:16px" %)**Inhalt des PowerShell-Skripts main.ps1, das die Variablen entgegennimmt**(%%) ==
160
161 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.
162 In dieser Rolle liegt konkret das allgemeingültige Skript {{box}}main.ps1{{/box}} vor, welches die Variablen als Parameter ##$ssid## und ##$psk## intern verwendet.
163
164
165 (% style="color:#19177c" %)**Windows Variante**
166
167 {{code language="text" width="50%"}}
168 root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
169 {{/code}}
170
171 {{code width="50%" language="powershell"}}
172 Param
173 (
174 [parameter(Mandatory=$false)]
175 [String]
176 $ssid,
177 [parameter(Mandatory=$false)]
178 [String]
179 $psk
180 )
181
182 if ($ssid -ne '' -and $psk -ne '') {
183 $profile = @'
184 <WLANProfile xmlns="http://www.microsoft.com/networking/WLAN/profile/v1">
185 <name>{0}</name>
186 <SSIDConfig>
187 <SSID>
188 <name>{0}</name>
189 </SSID>
190 </SSIDConfig>
191 <connectionType>ESS</connectionType>
192 <connectionMode>auto</connectionMode>
193 <MSM>
194 <security>
195 <authEncryption>
196 <authentication>WPA2PSK</authentication>
197 <encryption>AES</encryption>
198 <useOneX>false</useOneX>
199 </authEncryption>
200 <sharedKey>
201 <keyType>passPhrase</keyType>
202 <protected>false</protected>
203 <keyMaterial>{1}</keyMaterial>
204 </sharedKey>
205 </security>
206 </MSM>
207 </WLANProfile>
208 '@ -f $ssid, $psk
209
210 $file = "$AUTOCONF_TEMP_DIR\ld_wlan_psk\wlan.xml"
211
212 $profile | Out-File (New-Item $file -Force)
213
214 Get-NetAdapter | Where-Object { $_.PhysicalMediaType -eq 'Native 802.11' -or `
215 $_.PhysicalMediaType -eq 'Wireless LAN' -or `
216 $_.PhysicalMediaType -eq 'Wireless WAN' } | ForEach-Object {
217
218 Write-Verbose "Creating wlan profile for '$ssid' on interface '$($_.Name)'"
219 netsh wlan add profile filename= "$file" interface= "$($_.Name)"
220 }
221
222 Remove-Item -Path $file -Force
223 }
224 {{/code}}
225
226
227 (% style="color:#19177c" %)**Linux Variante (Network Manager)**
228
229 {{code language="text" width="50%"}}
230 root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/lin/main.ps1
231 {{/code}}
232
233 {{code language="powershell" width="50%"}}
234 Param
235 (
236 [parameter(Mandatory=$false)]
237 [String]
238 $ssid,
239 [parameter(Mandatory=$false)]
240 [String]
241 $psk
242 )
243
244 if ($ssid -ne '' -and $psk -ne '') {
245 if (Get-Command "nmcli" -ErrorAction SilentlyContinue) {
246 # Check if kernel modules are up
247 nmcli dev wifi rescan
248 if ($LASTEXITCODE -ne 0) {
249 Start-Sleep -Seconds 30
250 }
251
252 # Check again
253 nmcli dev wifi rescan
254 if ($LASTEXITCODE -ne 0) {
255 Write-Verbose "Skipping role. There might be no WiFi device installed."
256 exit 0
257 }
258
259 $config = "/etc/NetworkManager/system-connections/$ssid"
260
261 if (Test-Path -Path $config) {
262 Write-Verbose "Removing '$config'"
263 Remove-Item -Path $config -Recurse -Force
264 }
265
266 Write-Verbose "Connecting to '$ssid'"
267
268 nmcli device wifi connect """$ssid""" password """$psk"""
269
270 if ($LASTEXITCODE -eq 0) {
271 Start-Sleep -Seconds 5
272 nmcli con up """$ssid"""
273
274 if ($LASTEXITCODE -ne 0) {
275 Write-Verbose "Error: Credentials wrong?"
276
277 if (Test-Path -Path $config) {
278 Write-Verbose "Removing '$config'"
279 Remove-Item -Path $config -Recurse -Force
280 }
281 }
282 }
283
284 Write-Verbose "Exiting with code: $LASTEXITCODE"
285 exit $LASTEXITCODE
286 }
287
288 Write-Verbose "No suitable implementation found"
289 exit 1
290 }
291 {{/code}}
292
293 ----
294
295 = (% style="font-size:22px" %)__**Beispiel: eigene AutoConf-Rolle zur "Deaktivierung der Suchhervorhebung in Windows"**__(%%)
296 =
297
298 (((
299 Im nachfolgenden Beispiel wird eine einfache Rolle zur Deaktivierung der Suchvorhebung in Windows deklariert. 
300 \\[[image:attach:windowSearchHiglight-PNG.PNG||height="487" width="1051" class="img-thumbnail"]]
301
302
303 == (% style="font-size:16px" %)**Aufbau der Logodidact.yml:**(%%) ==
304
305 Neben den allgemeinen Informationen über die Autoren (authors), Unternehmen (company), einer Beschreibung (description), dem Anzeigenamen (display_name) im LD Control Center, usw, beginnt im Abschnitt {{code language="bash"}}vars{{/code}} die eigentliche Definition der Variable
306 "**{{code language="bash"}}disableSearchHighlight{{/code}}**".
307
308 {{code language="yaml" width="45%"}}
309 #logodidact.yml
310
311 ld_info:
312 authors:
313 - Olav Krapp
314 - Marcel Petersen
315 - Kerim Ekin
316 company: SBE network solutions GmbH
317 description: | #Beschreibung
318 Die Suchhervorhebung in der Windows Suchleiste wird deaktiviert
319 display_name: Windows Suchhervorhebung #Anzeigename im LD Control Center
320 license: SBE
321 uuid: fec4ff30-b2a6-407f-a6b3-0a621cd7eaf7 #einmalige UUID
322 vars: #Deklaration der Variablen
323 disableSearchHighlight: #Name der Variable
324 display_name: Suchhervorhebung im Suchfeld deaktivieren #Anzeigename im LD Control Center
325 optional: true #Auswahl optional
326 type: BOOLEAN #Variablentyp Boolean = True/False
327 value: false #Standardwert false
328 visible: true #Sichtbarkeit der Variable im LD Control Center
329 priority: 0 #Abarbeitungspriorität
330 applyAlways: false #Rolle immer ausführen oder einmalig
331 tags:
332 - CUSTOM #Ausführungszeitpunkt während der/den Phase(n)
333 systems:
334 - WINDOWS #Betriebssystem
335 {{/code}}
336
337 (% style="font-size:16px" %)**Aufbau der main.ps1:**(%%)
338 \\Danach erfolgt die Erstellung des ausführbaren Codes per Powershell. Im ersten Abschnitt Param werden die in der im vorigen Abschnitt definierten Variaben "vars" aus der logodidact.yml aufgeführt und definiert. Bei der Variable "disableSearchHighlight" handelt es sich um ein Boolean (True/False). Die Bedingung "[parameter(Mandatory=$false)]" setzt das Vorhandensein der Variable während dem Ablauf des Skriptes nicht als zwingend notwendig voraus, sodass bei einem darauffolgenden Verarbeitungsfehler o.ä. die Abarbeitung weiter erfolgt.
339 \\{{code language="powershell"}}#main.ps1
340
341 Param
342 (
343 [parameter(Mandatory=$false)] #Variable zwingend erforderlich?
344 [bool] #Variablentyp
345 $disableSearchHighlight #Name der def. Variable aus logodidact.yml
346 )
347
348 $SystemVersion=[System.Environment]::OSVersion.Version #Hole Windows Systemversion
349
350 if ($SystemVersion.Major -eq 10 -and $SystemVersion.Build -ge 19044) {
351 $val = [int]!$disableSearchHighlight
352 Write-Verbose "Setting EnableDynamicContentInWSB to '$val'"
353 [Microsoft.Win32.Registry]::SetValue("HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Windows\Windows Search","EnableDynamicContentInWSB",$val,[Microsoft.Win32.RegistryValueKind]::DWord)
354 } else {
355 Write-Host "Feature ist erst ab dem Release 21H2 verfügbar."
356 }{{/code}}
357
358 \\\\(% style="font-size:16px" %)**Einlesen der AutoConf-Rollen am Server:**(%%)
359 [[image:image-20230316102252-3.png||height="122" width="1167"]]
360 \\Ansicht im LD Control Center nach erfolgreichem Import der AutoConf-Rolle:
361 \\[[image:image-20230316095106-2.png||class="img-thumbnail"]]
362 )))