Zum Inhalt springen

Änderungen von Dokument Eigene Autoconf-Rolle erstellen

Zuletzt geändert von Tom Altenbrunn am 2023/03/17 08:03
Von Version 17.3
bearbeitet von Tom Altenbrunn
am 2023/03/15 13:47
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 29.3
bearbeitet von Tom Altenbrunn
am 2023/03/16 10:26
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,3 +1,11 @@
1 +{{toc depth="3"/}}
2 +
3 +----
4 +
5 +
6 += (% style="font-size:22px" %)__**Allgemeines**__(%%) =
7 +
8 +
1 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.
2 2  
3 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.
... ... @@ -11,11 +11,13 @@
11 11  * bis Puppet-Version **1.4.x** : {{code language="bash"}}/var/lib/ld-autoconf/custom/{{/code}}
12 12  * ab Puppet-Version **1.5.x **:  {{code language="bash" layout="LINENUMBERS"}}/data/ld/autoconf/custom/{{/code}}
13 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.
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.
15 15  
16 -Der strukturelle Aufbau ist nachfolgend ersichtlich:
24 +__Der strukturelle Aufbau eines AutoConf-Verzeichnisses grafisch dargestellt:__
17 17  
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"]]
18 18  
28 +----
19 19  
20 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 21  
... ... @@ -23,7 +23,7 @@
23 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 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 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.
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.
27 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 28  
29 29  (% class="box warningmessage" %)
... ... @@ -31,16 +31,16 @@
31 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 32  )))
33 33  
34 -
35 35  ----
36 36  
37 -==== **Beispielaufbau einer logodidact.yml:** ====
38 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.
47 += (% style="font-size:22px" %)__**Beispielaufbau einer logodidact.yml**__(%%) =
40 40  
41 41  
42 -**Beispiel zur Deklaration einer Autoconf Variable in logodidact.yml:**
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.
43 43  
52 +== (% style="font-size:16px" %)**Beispiel zur Deklaration einer Autoconf Variable in logodidact.yml**(%%) ==
53 +
44 44  (% class="box" %)
45 45  (((
46 46  ld_info:
... ... @@ -66,12 +66,14 @@
66 66  
67 67  ----
68 68  
69 -==== **Neue AutoConf-Rollen nach Fertigstellung freigeben** ====
70 70  
80 += (% style="font-size:22px" %)__**Neue AutoConf-Rollen nach Fertigstellung freigeben**__(%%) =
81 +
82 +
71 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 72  Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
73 73  
74 -Über den Button "AutoConf Rollen neu einlesen" im LD Control Center (mit aktiviertem Expertenmodus) werden die neu erstellten AutoConf-Rollen im Anschluss sichtbar und sind wie gewohnt Betriebssystemen zuordenbar.
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.
75 75  
76 76  (% class="box infomessage" %)
77 77  (((
... ... @@ -81,18 +81,21 @@
81 81  [[image:attach:autoconf.png||data-xwiki-image-style-border="true" class="img-thumbnail"]]
82 82  
83 83  
84 -
85 85  ----
86 86  
87 -==== **Weiteres, funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“** ====
88 88  
89 -Zum besseren Verständnis wird nachfolgend eine mitgelieferte Autoconf-Rolle zur Konfiguration eines WLAN-Profils (SSID inkl. PSK) an Clients näher beleuchtet.
99 += (% style="font-size:22px" %)__**Funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“**__(%%) =
90 90  
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 +
91 91  (% class="box" %)
92 92  (((
93 93  root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
94 94  )))
95 95  
109 +== (% style="font-size:16px" %)**Struktureller Aufbau der logodidact.yml**(%%) ==
110 +
96 96  (% class="box" %)
97 97  (((
98 98  ld_info:
... ... @@ -99,13 +99,13 @@
99 99   authors:
100 100   - Marcel Petersen
101 101   company: SBE network solutions GmbH
102 -(% style="color:#1abc9c" %)display_name:(%%) WLAN Profil mit PSK anlegen
117 +(% style="color:#1abc9c" %) display_name:(%%) WLAN Profil mit PSK anlegen
103 103   license: SBE
104 -(% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
119 +(% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
105 105   visible: true
106 - priority: 0
121 +(% style="color:#19177c" %) priority:(%%) 0
107 107   applyAlways: false
108 -(% style="color:#f1c40f" %) tags:(%%)
123 +(% style="color:#f1c40f" %) tags:(%%)
109 109   - CUSTOM
110 110  (% style="color:#e74c3c" %) vars:(%%)
111 111   ssid:
... ... @@ -116,34 +116,44 @@
116 116   display_name: Passwort
117 117   optional: false
118 118   type: PASSWORD
119 -(% style="color:#2980b9" %)systems:(%%)
134 +(% style="color:#2980b9" %) systems:(%%)
120 120   - WINDOWS
121 121   - LINUX
122 122  )))
123 123  
124 -(% style="color:#1abc9c" %)display_name(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
139 +(% style="color:#1abc9c" %)**display_name**(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
125 125  
126 -(% 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/]]
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/]]
127 127  
128 -(% style="color:#f1c40f" %)tags(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
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.
129 129  
130 -(% style="color:#e74c3c" %)vars(%%) = definiert mögliche Variablen, die den Skripten übergeben werden
145 +(% style="color:#f1c40f" %)**tags**(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
131 131  
147 +(% style="color:#e74c3c" %)**vars**(%%)** **= definiert mögliche Variablen, die den Skripten übergeben werden
148 +
132 132  * display_name = Name der konfigurierbaren Variable im Control Center
133 133  * optional = bestimmt, ob die Variable zwingend mit einem Wert belegt werden muss
134 134  * type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
135 135  * example = Zeigt einen grau eingefärbten Beispieltext innerhalb der definierten Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
136 136  
137 -(% 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.
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.
138 138  
156 +----
139 139  
140 -===== **Aufbau der main.ps1** =====
141 141  
142 -Im Verzeichnis {{box}} win/ {{/box}} können sich unterschiedliche Powershell-Skripte befinden. In dieser Rolle liegt das allgemeingültige Skript main.ps1 vor.
159 +== (% style="font-size:16px" %)**Inhalt des PowerShell-Skripts main.ps1, das die Variablen entgegennimmt**(%%) ==
143 143  
144 -{{code width="50%"}}
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%"}}
145 145  root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
169 +{{/code}}
146 146  
171 +{{code width="50%" language="powershell"}}
147 147  Param
148 148  (
149 149   [parameter(Mandatory=$false)]
... ... @@ -196,22 +196,146 @@
196 196  
197 197   Remove-Item -Path $file -Force
198 198  }
224 +{{/code}}
199 199  
200 -Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokalen Variablen.
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
201 201  {{/code}}
202 202  
203 -==== ====
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 +)
204 204  
205 -==== ====
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"
206 206  
207 -==== ====
261 + if (Test-Path -Path $config) {
262 + Write-Verbose "Removing '$config'"
263 + Remove-Item -Path $config -Recurse -Force
264 + }
208 208  
209 -==== ====
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"""
210 210  
211 -==== ====
274 + if ($LASTEXITCODE -ne 0) {
275 + Write-Verbose "Error: Credentials wrong?"
212 212  
213 -==== ====
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 + }
214 214  
215 -==== ====
288 + Write-Verbose "No suitable implementation found"
289 + exit 1
290 +}
291 +{{/code}}
216 216  
217 -==== ====
293 +----
294 +
295 += (% style="font-size:22px" %)__**Beispiel: eigene AutoConf-Rolle zur "Deaktivierung der Suchhervorhebung in Windows"**__(%%) =
296 +
297 += =
298 +
299 +(((
300 +Im nachfolgenden Beispiel wird eine einfache Rolle zur Deaktivierung der Suchvorhebung in Windows deklariert. 
301 +\\[[image:attach:windowSearchHiglight-PNG.PNG||height="487" width="1051" class="img-thumbnail"]]
302 +
303 +
304 +== (% style="font-size:16px" %)**Aufbau der Logodidact.yml:**(%%) ==
305 +
306 +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
307 +"**{{code language="bash"}}disableSearchHighlight{{/code}}**".
308 +
309 +{{code language="yaml" width="45%"}}
310 +#logodidact.yml
311 +
312 +ld_info:
313 + authors:
314 + - Olav Krapp
315 + - Marcel Petersen
316 + - Kerim Ekin
317 + company: SBE network solutions GmbH
318 + description: | #Beschreibung
319 + Die Suchhervorhebung in der Windows Suchleiste wird deaktiviert
320 + display_name: Windows Suchhervorhebung #Anzeigename im LD Control Center
321 + license: SBE
322 + uuid: fec4ff30-b2a6-407f-a6b3-0a621cd7eaf7 #einmalige UUID
323 + vars: #Deklaration der Variablen
324 + disableSearchHighlight: #Name der Variable
325 + display_name: Suchhervorhebung im Suchfeld deaktivieren #Anzeigename im LD Control Center
326 + optional: true #Auswahl optional
327 + type: BOOLEAN #Variablentyp Boolean = True/False
328 + value: false #Standardwert false
329 + visible: true #Sichtbarkeit der Variable im LD Control Center
330 + priority: 0 #Abarbeitungspriorität
331 + applyAlways: false #Rolle immer ausführen oder einmalig
332 + tags:
333 + - CUSTOM #Ausführungszeitpunkt während der/den Phase(n)
334 + systems:
335 + - WINDOWS #Betriebssystem
336 +{{/code}}
337 +
338 +
339 +
340 +(% style="font-size:16px" %)**Aufbau der main.ps1:**(%%)
341 +\\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.
342 +\\{{code language="powershell"}}#main.ps1
343 +
344 +Param
345 +(
346 + [parameter(Mandatory=$false)] #Variable zwingend erforderlich?
347 + [bool] #Variablentyp
348 + $disableSearchHighlight #Name der def. Variable aus logodidact.yml
349 +)
350 +
351 +$SystemVersion=[System.Environment]::OSVersion.Version #Hole Windows Systemversion
352 +
353 +if ($SystemVersion.Major -eq 10 -and $SystemVersion.Build -ge 19044) {
354 + $val = [int]!$disableSearchHighlight
355 + Write-Verbose "Setting EnableDynamicContentInWSB to '$val'"
356 + [Microsoft.Win32.Registry]::SetValue("HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Windows\Windows Search","EnableDynamicContentInWSB",$val,[Microsoft.Win32.RegistryValueKind]::DWord)
357 +} else {
358 + Write-Host "Feature ist erst ab dem Release 21H2 verfügbar."
359 +}{{/code}}
360 +
361 +
362 +\\(% style="font-size:16px" %)**Einlesen der AutoConf-Rollen am Server:**(%%)
363 +\\[[image:image-20230316102252-3.png||height="122" width="1167"]]
364 +\\Ansicht im LD Control Center nach erfolgreichem Import der AutoConf-Rolle:
365 +\\[[image:image-20230316095106-2.png||class="img-thumbnail"]]
366 +)))
autoconf-struktur.PNG
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,0 +1,1 @@
1 +36.5 KB
Inhalt
image-20230316094933-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,0 +1,1 @@
1 +43.3 KB
Inhalt
image-20230316095106-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,0 +1,1 @@
1 +47.8 KB
Inhalt
image-20230316102252-3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,0 +1,1 @@
1 +166.3 KB
Inhalt
image-20230316102302-4.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,0 +1,1 @@
1 +166.3 KB
Inhalt