Zum Inhalt springen

Änderungen von Dokument Eigene Autoconf-Rolle erstellen

Zuletzt geändert von Tom Altenbrunn am 2023/03/17 08:03
Von Version 34.1
bearbeitet von Tom Altenbrunn
am 2023/03/16 10:43
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 41.3
bearbeitet von Tom Altenbrunn
am 2023/03/16 10:55
Ä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 {{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}}(%%).
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 {{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.
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 {{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
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 {{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.
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 {{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.
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 {{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.
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.
162 162  
163 163  
164 164  (% style="color:#19177c" %)**Windows Variante**
... ... @@ -291,15 +291,9 @@
291 291  
292 292  ----
293 293  
294 -(% class="wikigeneratedid" %)
295 -= =
296 -
297 297  = (% style="font-size:22px" %)__**Weiteres Beispiel: eigene AutoConf-Rolle zur "Deaktivierung der Suchhervorhebung in Windows"**__(%%) =
298 298  
299 -= =
300 -
301 -(((
302 -Im nachfolgenden Beispiel wird eine einfache Rolle zur Deaktivierung der Suchvorhebung in Windows deklariert. 
296 +Im nachfolgenden Beispiel wird eine einfache Rolle zur Deaktivierung der Suchvorhebung in Windows deklariert.
303 303  \\[[image:image-20230316103442-2.png||height="530" width="1142" class="img-thumbnail"]]
304 304  
305 305  ----
... ... @@ -306,76 +306,37 @@
306 306  
307 307  == (% style="font-size:16px" %)**Aufbau der Logodidact.yml:**(%%) ==
308 308  
309 -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
310 -"**{{code language="bash"}}disableSearchHighlight{{/code}}**".
311 -
303 +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
304 +"**{{code}}disableSearchHighlight{{/code}}**".
312 312  
313 -{{code language="yaml" width="45%"}}
306 +
307 +{{code language="yaml"}}
314 314  #logodidact.yml
315 315  
316 316  ld_info:
317 - authors:
311 + authors:
318 318   - Olav Krapp
319 319   - Marcel Petersen
320 320   - Kerim Ekin
321 - company: SBE network solutions GmbH
322 - description: | #Beschreibung
323 - Die Suchhervorhebung in der Windows Suchleiste wird deaktiviert
324 - display_name: Windows Suchhervorhebung #Anzeigename im LD Control Center
325 - license: SBE
326 - uuid: fec4ff30-b2a6-407f-a6b3-0a621cd7eaf7 #einmalige UUID
327 - vars: #Deklaration der Variablen
328 - disableSearchHighlight: #Name der Variable
329 - display_name: Suchhervorhebung im Suchfeld deaktivieren #Anzeigename im LD Control Center
330 - optional: true #Auswahl optional
331 - type: BOOLEAN #Variablentyp Boolean = True/False
332 - value: false #Standardwert false
333 - visible: true #Sichtbarkeit der Variable im LD Control Center
334 - priority: 0 #Abarbeitungspriorität
335 - applyAlways: false #Rolle immer ausführen oder einmalig
336 - tags:
315 + company: SBE network solutions GmbH
316 + description: | #Beschreibung
317 + Die Suchhervorhebung in der Windows Suchleiste wird deaktiviert
318 + display_name: Windows Suchhervorhebung #Anzeigename im LD Control Center
319 + license: SBE
320 + uuid: fec4ff30-b2a6-407f-a6b3-0a621cd7eaf7 #einmalige UUID
321 + vars: #Deklaration der Variablen
322 + disableSearchHighlight: #Name der Variable
323 + display_name: Suchhervorhebung im Suchfeld deaktivieren #Anzeigename im LD Control Center
324 + optional: true #Auswahl optional
325 + type: BOOLEAN #Variablentyp Boolean = True/False
326 + value: false #Standardwert false
327 + visible: true #Sichtbarkeit der Variable im LD Control Center
328 + priority: 0 #Abarbeitungspriorität
329 + applyAlways: false #Rolle immer ausführen oder einmalig
330 + tags:
337 337   - CUSTOM #Ausführungszeitpunkt während der/den Phase(n)
338 - systems:
332 + systems:
339 339   - WINDOWS #Betriebssystem
340 340  {{/code}}
341 341  
342 -== ==
343 -
344 -----
345 -
346 -== (% style="font-size:16px" %)**Aufbau der main.ps1:**(%%) ==
347 -
348 -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.
349 -\\{{code language="powershell"}}#main.ps1
350 -
351 -Param
352 -(
353 - [parameter(Mandatory=$false)] #Variable zwingend erforderlich?
354 - [bool] #Variablentyp
355 - $disableSearchHighlight #Name der def. Variable aus logodidact.yml
356 -)
357 -
358 -$SystemVersion=[System.Environment]::OSVersion.Version #Hole Windows Systemversion
359 -
360 -#Beginn des eigentlichen Codes
361 -if ($SystemVersion.Major -eq 10 -and $SystemVersion.Build -ge 19044) {
362 - $val = [int]!$disableSearchHighlight
363 - Write-Verbose "Setting EnableDynamicContentInWSB to '$val'"
364 - [Microsoft.Win32.Registry]::SetValue("HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Windows\Windows Search","EnableDynamicContentInWSB",$val,[Microsoft.Win32.RegistryValueKind]::DWord)
365 -} else {
366 - Write-Host "Feature ist erst ab dem Release 21H2 verfügbar."
367 -}{{/code}}
368 -
369 -----
370 -
371 -== (% style="font-size:16px" %)**Einlesen der AutoConf-Rollen am Server:**(%%) ==
372 -
373 -[[image:image-20230316103224-1.png||height="128" width="1226" class="img-thumbnail"]]
374 -
375 -----
376 -
377 -== (% style="font-size:16px" %)**Ansicht im LD Control Center:**(%%) ==
378 -
379 -(% class="wikigeneratedid" %)
380 - [[image:image-20230316095106-2.png||class="img-thumbnail"]]
381 -)))
336 +