Zum Inhalt springen

Änderungen von Dokument Eigene Autoconf-Rolle erstellen

Zuletzt geändert von Tom Altenbrunn am 2023/03/17 08:03
Von Version 18.1
bearbeitet von Tom Altenbrunn
am 2023/03/15 14:07
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 29.4
bearbeitet von Tom Altenbrunn
am 2023/03/16 10:28
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,6 +1,8 @@
1 1  {{toc depth="3"/}}
2 2  
3 +----
3 3  
5 +
4 4  = (% style="font-size:22px" %)__**Allgemeines**__(%%) =
5 5  
6 6  
... ... @@ -17,9 +17,8 @@
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  
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.
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.
22 -
23 23  __Der strukturelle Aufbau eines AutoConf-Verzeichnisses grafisch dargestellt:__
24 24  
25 25  [[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"]]
... ... @@ -32,7 +32,7 @@
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.
35 -* (% 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.
36 36  * **collect.ps1** - Sonderfall. Dieses Skript wird ausgeführt, wenn durch einen Anwender aktiv die Phase COLLECT zum Einsammeln von Einstellungen am Client aufgerufen wird.
37 37  
38 38  (% class="box warningmessage" %)
... ... @@ -40,15 +40,15 @@
40 40  (% 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.
41 41  )))
42 42  
43 -
44 44  ----
45 45  
46 +
46 46  = (% style="font-size:22px" %)__**Beispielaufbau einer logodidact.yml**__(%%) =
47 47  
48 48  
49 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 -== (% style="font-size:16px" %)**Beispiel zur Deklaration einer Autoconf Variable in logodidact.yml:**(%%) ==
52 +== (% style="font-size:16px" %)**Beispiel zur Deklaration einer Autoconf Variable in logodidact.yml**(%%) ==
52 52  
53 53  (% class="box" %)
54 54  (((
... ... @@ -73,9 +73,9 @@
73 73  **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.
74 74  )))
75 75  
76 -
77 77  ----
78 78  
79 +
79 79  = (% style="font-size:22px" %)__**Neue AutoConf-Rollen nach Fertigstellung freigeben**__(%%) =
80 80  
81 81  
... ... @@ -92,20 +92,20 @@
92 92  [[image:attach:autoconf.png||data-xwiki-image-style-border="true" class="img-thumbnail"]]
93 93  
94 94  
95 -
96 96  ----
97 97  
98 -= (% style="font-size:22px" %)__**Weiteres, funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“**__(%%) =
99 99  
99 += (% style="font-size:22px" %)__**Funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“**__(%%) =
100 100  
101 -Zum besseren Verständnis wird nachfolgend eine mitgelieferte Autoconf-Rolle zur Konfiguration eines WLAN-Profils (SSID inkl. PSK) an Clients näher beleuchtet.
102 102  
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 +
103 103  (% class="box" %)
104 104  (((
105 105  root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
106 106  )))
107 107  
108 -== (% style="font-size:16px" %)** Struktureller Aufbau der logodidact.yml:**(%%) ==
109 +== (% style="font-size:16px" %)**Struktureller Aufbau der logodidact.yml**(%%) ==
109 109  
110 110  (% class="box" %)
111 111  (((
... ... @@ -113,13 +113,13 @@
113 113   authors:
114 114   - Marcel Petersen
115 115   company: SBE network solutions GmbH
116 -(% style="color:#1abc9c" %)display_name:(%%) WLAN Profil mit PSK anlegen
117 +(% style="color:#1abc9c" %) display_name:(%%) WLAN Profil mit PSK anlegen
117 117   license: SBE
118 -(% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
119 +(% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
119 119   visible: true
120 - priority: 0
121 +(% style="color:#19177c" %) priority:(%%) 0
121 121   applyAlways: false
122 -(% style="color:#f1c40f" %) tags:(%%)
123 +(% style="color:#f1c40f" %) tags:(%%)
123 123   - CUSTOM
124 124  (% style="color:#e74c3c" %) vars:(%%)
125 125   ssid:
... ... @@ -130,7 +130,7 @@
130 130   display_name: Passwort
131 131   optional: false
132 132   type: PASSWORD
133 -(% style="color:#2980b9" %)systems:(%%)
134 +(% style="color:#2980b9" %) systems:(%%)
134 134   - WINDOWS
135 135   - LINUX
136 136  )))
... ... @@ -139,6 +139,8 @@
139 139  
140 140  (% 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 141  
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 +
142 142  (% style="color:#f1c40f" %)**tags**(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
143 143  
144 144  (% style="color:#e74c3c" %)**vars**(%%)** **= definiert mögliche Variablen, die den Skripten übergeben werden
... ... @@ -148,19 +148,24 @@
148 148  * type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
149 149  * example = Zeigt einen grau eingefärbten Beispieltext innerhalb der definierten Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
150 150  
151 -(% 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.
152 152  
153 -
154 154  ----
155 155  
156 -===== **Aufbau der main.ps1** =====
157 157  
159 +== (% style="font-size:16px" %)**Inhalt des PowerShell-Skripts main.ps1, das die Variablen entgegennimmt**(%%) ==
158 158  
159 -Im Verzeichnis {{box}} win/ {{/box}} können sich unterschiedliche Powershell-Skripte befinden. In dieser Rolle liegt das allgemeingültige Skript main.ps1 vor.
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.
160 160  
161 -{{code width="50%"}}
164 +
165 +(% style="color:#19177c" %)**Windows Variante**
166 +
167 +{{code language="text" width="50%"}}
162 162  root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
169 +{{/code}}
163 163  
171 +{{code width="50%" language="powershell"}}
164 164  Param
165 165  (
166 166   [parameter(Mandatory=$false)]
... ... @@ -213,22 +213,146 @@
213 213  
214 214   Remove-Item -Path $file -Force
215 215  }
224 +{{/code}}
216 216  
217 -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
218 218  {{/code}}
219 219  
220 -==== ====
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 +)
221 221  
222 -==== ====
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"
223 223  
224 -==== ====
261 + if (Test-Path -Path $config) {
262 + Write-Verbose "Removing '$config'"
263 + Remove-Item -Path $config -Recurse -Force
264 + }
225 225  
226 -==== ====
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"""
227 227  
228 -==== ====
274 + if ($LASTEXITCODE -ne 0) {
275 + Write-Verbose "Error: Credentials wrong?"
229 229  
230 -==== ====
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 + }
231 231  
232 -==== ====
288 + Write-Verbose "No suitable implementation found"
289 + exit 1
290 +}
291 +{{/code}}
233 233  
234 -==== ====
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 +)))
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