Zum Inhalt springen

Änderungen von Dokument Eigene Autoconf-Rolle erstellen

Zuletzt geändert von Tom Altenbrunn am 2023/03/17 08:03
Von Version 40.3
bearbeitet von Tom Altenbrunn
am 2023/03/16 10:53
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 35.1
bearbeitet von Tom Altenbrunn
am 2023/03/16 10:44
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -8,7 +8,7 @@
8 8  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.
9 9  
10 10  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 -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 +Diese fest integrierten Rollen befinden sich im LXC-Container ctrl-g1 im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
12 12  
13 13  [[image:image-20230315103418-1.png||height="103" width="1344" class="img-thumbnail"]]
14 14  
... ... @@ -18,7 +18,7 @@
18 18  * bis Puppet-Version **1.4.x** : {{code language="bash"}}/var/lib/ld-autoconf/custom/{{/code}}
19 19  * ab Puppet-Version **1.5.x **:  {{code language="bash" layout="LINENUMBERS"}}/data/ld/autoconf/custom/{{/code}}
20 20  
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 +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 22  
23 23  __Der strukturelle Aufbau eines AutoConf-Verzeichnisses grafisch dargestellt:__
24 24  
... ... @@ -28,7 +28,7 @@
28 28  
29 29  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:
30 30  
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 +* **main.ps1** - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei {{box}}meta/logodidact.yml{{/box}} festgelegt sind
32 32  * (% 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.
33 33  * (% 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.
34 34  * (% 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.
... ... @@ -46,7 +46,7 @@
46 46  = (% style="font-size:22px" %)__**Beispielaufbau einer logodidact.yml**__(%%) =
47 47  
48 48  
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 +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.
50 50  
51 51  == (% style="font-size:16px" %)**Beispiel zur Deklaration einer Autoconf Variable in logodidact.yml**(%%) ==
52 52  
... ... @@ -79,7 +79,7 @@
79 79  = (% style="font-size:22px" %)__**Neue AutoConf-Rollen nach Fertigstellung freigeben**__(%%) =
80 80  
81 81  
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 +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.
83 83  Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
84 84  
85 85  Ü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.
... ... @@ -157,8 +157,8 @@
157 157  
158 158  == (% style="font-size:16px" %)**Inhalt des PowerShell-Skripts main.ps1, das die Variablen entgegennimmt**(%%) ==
159 159  
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.
160 +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.
161 +In dieser Rolle liegt konkret das allgemeingültige Skript {{box}}main.ps1{{/box}} vor, welches die Variablen als Parameter ##$ssid## und ##$psk## intern verwendet.
162 162  
163 163  
164 164  (% style="color:#19177c" %)**Windows Variante**
... ... @@ -291,13 +291,88 @@
291 291  
292 292  ----
293 293  
294 += =
295 +
294 294  = (% style="font-size:22px" %)__**Weiteres Beispiel: eigene AutoConf-Rolle zur "Deaktivierung der Suchhervorhebung in Windows"**__(%%) =
295 295  
296 296  Im nachfolgenden Beispiel wird eine einfache Rolle zur Deaktivierung der Suchvorhebung in Windows deklariert.
297 297  \\[[image:image-20230316103442-2.png||height="530" width="1142" class="img-thumbnail"]]
298 298  
301 +(((
299 299  ----
300 300  
301 301  == (% style="font-size:16px" %)**Aufbau der Logodidact.yml:**(%%) ==
302 302  
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}}**".
303 303  
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 +)))