Zum Inhalt springen

Änderungen von Dokument Eigene Autoconf-Rolle erstellen

Zuletzt geändert von Tom Altenbrunn am 2023/03/17 08:03
Von Version 25.1
bearbeitet von Jonas Mayer
am 2023/03/15 21:53
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 36.2
bearbeitet von Tom Altenbrunn
am 2023/03/16 10:47
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.jonasmayer@sbede
1 +XWiki.TomAltenbrunn@sbede
Inhalt
... ... @@ -1,5 +1,6 @@
1 1  {{toc depth="3"/}}
2 2  
3 +----
3 3  
4 4  = (% style="font-size:22px" %)__**Allgemeines**__(%%) =
5 5  
... ... @@ -7,7 +7,7 @@
7 7  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.
8 8  
9 9  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.
10 -Diese fest integrierten Rollen befinden sich im LXC-Container ctrl-g1 im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
11 +Diese fest integrierten Rollen befinden sich im LXC-Container ctrl-g1 im Pfad (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container">/usr/lib/ld-autoconf/logodidact/roles/{{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}(%%).
11 11  
12 12  [[image:image-20230315103418-1.png||height="103" width="1344" class="img-thumbnail"]]
13 13  
... ... @@ -17,7 +17,7 @@
17 17  * bis Puppet-Version **1.4.x** : {{code language="bash"}}/var/lib/ld-autoconf/custom/{{/code}}
18 18  * ab Puppet-Version **1.5.x **:  {{code language="bash" layout="LINENUMBERS"}}/data/ld/autoconf/custom/{{/code}}
19 19  
20 -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.
21 +Der Aufbau einer Autoconf-Rolle unterliegt einer vordefinierten Struktur, bestehend aus einer Beschreibungsdatei (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container">meta/logodidact.yml{{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 (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container"> win/ {{box}} win/ {{/box}}(%%) (//Windows//) oder (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container"> lin/ {{box}} lin/ {{/box}}(%%) (//Linux//) abgespeichert sein. Zusätzlich besteht auch die Möglichkeit, in einem weiteren Unterordner (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container"> files/ {{box}} files/ {{/box}}(%%) beliebige Dateien in der Autoconf-Rolle mitzuliefern, wie zum Beispiel Bilder, Videos, etc.
21 21  
22 22  __Der strukturelle Aufbau eines AutoConf-Verzeichnisses grafisch dargestellt:__
23 23  
... ... @@ -27,7 +27,7 @@
27 27  
28 28  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:
29 29  
30 -* **main.ps1** - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei {{box}}meta/logodidact.yml{{/box}} festgelegt sind
31 +* **main.ps1** - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container">meta/logodidact.yml{{box}}meta/logodidact.yml{{/box}}(%%) festgelegt sind
31 31  * (% 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.
32 32  * (% 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.
33 33  * (% 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.
... ... @@ -39,13 +39,13 @@
39 39  (% 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.
40 40  )))
41 41  
42 -
43 43  ----
44 44  
45 +
45 45  = (% style="font-size:22px" %)__**Beispielaufbau einer logodidact.yml**__(%%) =
46 46  
47 47  
48 -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.
49 +Eine Autoconf-Beispielvorlage liegt serverseitig im Unterordner (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container">/data/ld/autoconf/custom/example/{{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.
49 49  
50 50  == (% style="font-size:16px" %)**Beispiel zur Deklaration einer Autoconf Variable in logodidact.yml**(%%) ==
51 51  
... ... @@ -72,13 +72,13 @@
72 72  **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.
73 73  )))
74 74  
75 -
76 76  ----
77 77  
78 +
78 78  = (% style="font-size:22px" %)__**Neue AutoConf-Rollen nach Fertigstellung freigeben**__(%%) =
79 79  
80 80  
81 -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.
82 +Neue Autoconf-Rollen können am Server durch Aufruf des Befehls (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container">update-autoconf-archive{{box}}update-autoconf-archive{{/box}}(%%) im LXC ctrl-g1 aktualisiert werden. Der Aufruf dieses Kommandos ist auch nach Änderungen an Autoconf-Rollen nötig.
82 82  Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
83 83  
84 84  Ü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.
... ... @@ -91,12 +91,12 @@
91 91  [[image:attach:autoconf.png||data-xwiki-image-style-border="true" class="img-thumbnail"]]
92 92  
93 93  
94 -
95 95  ----
96 96  
97 -= (% style="font-size:22px" %)__**Weiteres, funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“**__(%%) =
98 98  
98 += (% style="font-size:22px" %)__**Funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“**__(%%) =
99 99  
100 +
100 100  Zum besseren Verständnis wird nachfolgend eine feste Autoconf-Rolle zur Konfiguration eines WLAN-Profils (SSID inkl. PSK) an Clients näher beleuchtet.
101 101  
102 102  (% class="box" %)
... ... @@ -116,7 +116,7 @@
116 116   license: SBE
117 117  (% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
118 118   visible: true
119 - priority: 0
120 +(% style="color:#19177c" %) priority:(%%) 0
120 120   applyAlways: false
121 121  (% style="color:#f1c40f" %) tags:(%%)
122 122   - CUSTOM
... ... @@ -138,6 +138,8 @@
138 138  
139 139  (% 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/]]
140 140  
142 +(% 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.
143 +
141 141  (% style="color:#f1c40f" %)**tags**(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
142 142  
143 143  (% style="color:#e74c3c" %)**vars**(%%)** **= definiert mögliche Variablen, die den Skripten übergeben werden
... ... @@ -147,19 +147,24 @@
147 147  * type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
148 148  * example = Zeigt einen grau eingefärbten Beispieltext innerhalb der definierten Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
149 149  
150 -(% 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.
153 +(% 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.
151 151  
152 -
153 153  ----
154 154  
157 +
155 155  == (% style="font-size:16px" %)**Inhalt des PowerShell-Skripts main.ps1, das die Variablen entgegennimmt**(%%) ==
156 156  
160 +Im Unterverzeichnis (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container"> win/ {{box}} win/ {{/box}}(%%) oder (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container"> lin/ {{box}} lin/ {{/box}}(%%) der Autoconf-Rolle können sich wie erläutert unterschiedliche PowerShell-Skripte zur Ausführung in den verschiedenen Phasen befinden.
161 +In dieser Rolle liegt konkret das allgemeingültige Skript (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container">main.ps1{{box}}main.ps1{{/box}}(%%) vor, welches die Variablen als Parameter ##$ssid## und ##$psk## intern verwendet.
157 157  
158 -Im Verzeichnis {{box}} win/ {{/box}} können sich unterschiedliche Powershell-Skripte befinden. In dieser Rolle liegt das allgemeingültige Skript main.ps1 vor, welches die Variablen als Parameter ##$ssid## und ##$psk## intern verwendet.
159 159  
160 -{{code width="50%"}}
164 +(% style="color:#19177c" %)**Windows Variante**
165 +
166 +{{code language="text" width="50%"}}
161 161  root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
168 +{{/code}}
162 162  
170 +{{code width="50%" language="powershell"}}
163 163  Param
164 164  (
165 165   [parameter(Mandatory=$false)]
... ... @@ -212,22 +212,159 @@
212 212  
213 213   Remove-Item -Path $file -Force
214 214  }
223 +{{/code}}
215 215  
216 -Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokalen Variablen.
225 +
226 +(% style="color:#19177c" %)**Linux Variante (Network Manager)**
227 +
228 +{{code language="text" width="50%"}}
229 +root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/lin/main.ps1
217 217  {{/code}}
218 218  
219 -==== ====
232 +{{code language="powershell" width="50%"}}
233 +Param
234 +(
235 + [parameter(Mandatory=$false)]
236 + [String]
237 + $ssid,
238 + [parameter(Mandatory=$false)]
239 + [String]
240 + $psk
241 +)
220 220  
221 -==== ====
243 +if ($ssid -ne '' -and $psk -ne '') {
244 + if (Get-Command "nmcli" -ErrorAction SilentlyContinue) {
245 + # Check if kernel modules are up
246 + nmcli dev wifi rescan
247 + if ($LASTEXITCODE -ne 0) {
248 + Start-Sleep -Seconds 30
249 + }
250 +
251 + # Check again
252 + nmcli dev wifi rescan
253 + if ($LASTEXITCODE -ne 0) {
254 + Write-Verbose "Skipping role. There might be no WiFi device installed."
255 + exit 0
256 + }
257 +
258 + $config = "/etc/NetworkManager/system-connections/$ssid"
222 222  
223 -==== ====
260 + if (Test-Path -Path $config) {
261 + Write-Verbose "Removing '$config'"
262 + Remove-Item -Path $config -Recurse -Force
263 + }
224 224  
225 -==== ====
265 + Write-Verbose "Connecting to '$ssid'"
266 +
267 + nmcli device wifi connect """$ssid""" password """$psk"""
268 +
269 + if ($LASTEXITCODE -eq 0) {
270 + Start-Sleep -Seconds 5
271 + nmcli con up """$ssid"""
226 226  
227 -==== ====
273 + if ($LASTEXITCODE -ne 0) {
274 + Write-Verbose "Error: Credentials wrong?"
228 228  
229 -==== ====
276 + if (Test-Path -Path $config) {
277 + Write-Verbose "Removing '$config'"
278 + Remove-Item -Path $config -Recurse -Force
279 + }
280 + }
281 + }
282 +
283 + Write-Verbose "Exiting with code: $LASTEXITCODE"
284 + exit $LASTEXITCODE
285 + }
230 230  
231 -==== ====
287 + Write-Verbose "No suitable implementation found"
288 + exit 1
289 +}
290 +{{/code}}
232 232  
233 -==== ====
292 +----
293 +
294 += =
295 +
296 += (% style="font-size:22px" %)__**Weiteres Beispiel: eigene AutoConf-Rolle zur "Deaktivierung der Suchhervorhebung in Windows"**__(%%) =
297 +
298 +Im nachfolgenden Beispiel wird eine einfache Rolle zur Deaktivierung der Suchvorhebung in Windows deklariert.
299 +\\[[image:image-20230316103442-2.png||height="530" width="1142" class="img-thumbnail"]]
300 +
301 +(((
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 +
310 +{{code language="yaml" width="45%"}}
311 +#logodidact.yml
312 +
313 +ld_info:
314 + authors:
315 + - Olav Krapp
316 + - Marcel Petersen
317 + - Kerim Ekin
318 + company: SBE network solutions GmbH
319 + description: | #Beschreibung
320 + Die Suchhervorhebung in der Windows Suchleiste wird deaktiviert
321 + display_name: Windows Suchhervorhebung #Anzeigename im LD Control Center
322 + license: SBE
323 + uuid: fec4ff30-b2a6-407f-a6b3-0a621cd7eaf7 #einmalige UUID
324 + vars: #Deklaration der Variablen
325 + disableSearchHighlight: #Name der Variable
326 + display_name: Suchhervorhebung im Suchfeld deaktivieren #Anzeigename im LD Control Center
327 + optional: true #Auswahl optional
328 + type: BOOLEAN #Variablentyp Boolean = True/False
329 + value: false #Standardwert false
330 + visible: true #Sichtbarkeit der Variable im LD Control Center
331 + priority: 0 #Abarbeitungspriorität
332 + applyAlways: false #Rolle immer ausführen oder einmalig
333 + tags:
334 + - CUSTOM #Ausführungszeitpunkt während der/den Phase(n)
335 + systems:
336 + - WINDOWS #Betriebssystem
337 +{{/code}}
338 +
339 +== ==
340 +
341 +----
342 +
343 +== (% style="font-size:16px" %)**Aufbau der main.ps1:**(%%) ==
344 +
345 +Danach erfolgt die Erstellung des ausführbaren Codes per Powershell. Im ersten Abschnitt (% style="color:#008000" %)**Param** (%%)werden die in der im vorigen Abschnitt definierten Variaben  {{code language="bash"}}vars{{/code}} aus der logodidact.yml aufgeführt und definiert. Bei der Variable "**{{code}}disableSearchHighlight{{/code}}**" 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.
346 +\\{{code language="powershell"}}#main.ps1
347 +
348 +Param
349 +(
350 + [parameter(Mandatory=$false)] #Variable zwingend erforderlich?
351 + [bool] #Variablentyp
352 + $disableSearchHighlight #Name der def. Variable aus logodidact.yml
353 +)
354 +
355 +$SystemVersion=[System.Environment]::OSVersion.Version #Hole Windows Systemversion
356 +
357 +#Beginn des eigentlichen Codes
358 +if ($SystemVersion.Major -eq 10 -and $SystemVersion.Build -ge 19044) {
359 + $val = [int]!$disableSearchHighlight
360 + Write-Verbose "Setting EnableDynamicContentInWSB to '$val'"
361 + [Microsoft.Win32.Registry]::SetValue("HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Windows\Windows Search","EnableDynamicContentInWSB",$val,[Microsoft.Win32.RegistryValueKind]::DWord)
362 +} else {
363 + Write-Host "Feature ist erst ab dem Release 21H2 verfügbar."
364 +}{{/code}}
365 +
366 +----
367 +
368 +== (% style="font-size:16px" %)**Einlesen der AutoConf-Rollen am Server:**(%%) ==
369 +
370 +[[image:image-20230316103224-1.png||height="128" width="1226" class="img-thumbnail"]]
371 +
372 +----
373 +
374 +== (% style="font-size:16px" %)**Ansicht im LD Control Center:**(%%) ==
375 +
376 +(% class="wikigeneratedid" %)
377 + [[image:image-20230316095106-2.png||class="img-thumbnail"]]
378 +)))
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
image-20230316103224-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,0 +1,1 @@
1 +166.3 KB
Inhalt
image-20230316103442-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,0 +1,1 @@
1 +201.2 KB
Inhalt