Wiki-Quellcode von Eigene Autoconf-Rolle erstellen

Version 44.1 von Tom Altenbrunn am 2023/03/16 11:05

version	line-number	content
17.9	1	{{toc depth="3"/}}
	2
27.1	3	----
17.9	4
	5	= (% style="font-size:22px" %)__Allgemeines__(%%) =
	6
	7
14.1	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.
1.1	9
14.1	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.
36.1	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.2	12
12.5	13	[[image:image-20230315103418-1.png\|\|height="103" width="1344" class="img-thumbnail"]]
	14
2.1	15
14.1	16	Darüber hinaus ist es Partnern und Kunden möglich, für spezielle / anwendungsspezifische Anforderungen eigene Autoconf-Rollen zu erstellen und im LD Control Center mit Clients zu verknüpfen. Dafür steht am LD-Server ein eigenes Verzeichnis zur Verfügung, welches sich ebenfalls im LXC-Container ctrl-g1 befindet und nicht durch Server-Updates beeinflusst oder überschrieben wird. Der genaue Speicherpfad hängt von der Puppet-Version des Servers ab:
2.1	17
12.6	18	* bis Puppet-Version 1.4.x : {{code language="bash"}}/var/lib/ld-autoconf/custom/{{/code}}
14.1	19	* ab Puppet-Version 1.5.x : {{code language="bash" layout="LINENUMBERS"}}/data/ld/autoconf/custom/{{/code}}
12.6	20
36.1	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.
12.6	22
17.5	23	__Der strukturelle Aufbau eines AutoConf-Verzeichnisses grafisch dargestellt:__
14.1	24
17.4	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"]]
15.1	26
17.5	27	----
15.1	28
	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
36.1	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
15.1	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	* (% 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	* (% 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.
20.1	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.
15.1	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
	38	(% class="box warningmessage" %)
	39	(((
	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	)))
	42
12.10	43	----
2.1	44
27.1	45
17.9	46	= (% style="font-size:22px" %)__Beispielaufbau einer logodidact.yml__(%%) =
2.1	47
17.9	48
36.1	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.
2.1	50
19.1	51	== (% style="font-size:16px" %)Beispiel zur Deklaration einer Autoconf Variable in logodidact.yml(%%) ==
14.1	52
15.1	53	(% class="box" %)
	54	(((
	55	ld_info:
	56	display_name: Meine eigene Autoconf-Rolle 1
17.1	57	(% style="color:#27ae60" %) # [...](%%)
15.1	58	\\ vars:
	59	globalLogLevel:
	60	display_name: Loglevel
	61	optional: true
	62	type: ENUM
	63	values:
	64	- none
	65	- compact
	66	- detailed
	67	- verbose
17.1	68	\\(% style="color:#27ae60" %) # [...]
15.1	69	)))
	70
	71	(% class="box infomessage" %)
	72	(((
17.2	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.
15.1	74	)))
	75
	76	----
	77
27.1	78
17.9	79	= (% style="font-size:22px" %)__Neue AutoConf-Rollen nach Fertigstellung freigeben__(%%) =
15.1	80
17.9	81
36.1	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.
16.1	83	Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
	84
17.6	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.
16.1	86
	87	(% class="box infomessage" %)
	88	(((
	89	Der Expertenmodus wird in den Einstellungen (Zahnrad oben rechts) -> Entwickleroptionen -> Expertenmodus aktivieren aktiv geschaltet.
	90	)))
	91
	92	[[image:attach:autoconf.png\|\|data-xwiki-image-style-border="true" class="img-thumbnail"]]
	93
	94
	95	----
	96
27.1	97
29.2	98	= (% style="font-size:22px" %)__Funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“__(%%) =
16.1	99
17.9	100
21.1	101	Zum besseren Verständnis wird nachfolgend eine feste Autoconf-Rolle zur Konfiguration eines WLAN-Profils (SSID inkl. PSK) an Clients näher beleuchtet.
14.1	102
2.1	103	(% class="box" %)
	104	(((
1.1	105	root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
2.1	106	)))
1.1	107
24.1	108	== (% style="font-size:16px" %)Struktureller Aufbau der logodidact.yml(%%) ==
17.10	109
2.1	110	(% class="box" %)
	111	(((
1.1	112	ld_info:
	113	authors:
	114	- Marcel Petersen
	115	company: SBE network solutions GmbH
25.1	116	(% style="color:#1abc9c" %) display_name:(%%) WLAN Profil mit PSK anlegen
1.1	117	license: SBE
25.1	118	(% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
1.1	119	visible: true
28.1	120	(% style="color:#19177c" %) priority:(%%) 0
1.1	121	applyAlways: false
25.1	122	(% style="color:#f1c40f" %) tags:(%%)
1.1	123	- CUSTOM
12.10	124	(% style="color:#e74c3c" %) vars:(%%)
1.1	125	ssid:
	126	display_name: SSID
	127	optional: false
	128	type: STRING
	129	psk:
	130	display_name: Passwort
	131	optional: false
	132	type: PASSWORD
25.1	133	(% style="color:#2980b9" %) systems:(%%)
1.1	134	- WINDOWS
	135	- LINUX
2.1	136	)))
1.1	137
17.10	138	(% style="color:#1abc9c" %)display_name(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
1.1	139
17.10	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/]]
1.1	141
27.1	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
17.10	144	(% style="color:#f1c40f" %)tags(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
1.1	145
17.10	146	(% style="color:#e74c3c" %)vars(%%) = definiert mögliche Variablen, die den Skripten übergeben werden
1.1	147
12.10	148	* display_name = Name der konfigurierbaren Variable im Control Center
	149	* optional = bestimmt, ob die Variable zwingend mit einem Wert belegt werden muss
	150	* type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
	151	* example = Zeigt einen grau eingefärbten Beispieltext innerhalb der definierten Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
1.1	152
27.1	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.
1.1	154
17.7	155	----
6.1	156
27.1	157
23.1	158	== (% style="font-size:16px" %)Inhalt des PowerShell-Skripts main.ps1, das die Variablen entgegennimmt(%%) ==
2.1	159
36.1	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.
17.11	162
3.1	163
28.1	164	(% style="color:#19177c" %)Windows Variante
27.1	165
28.1	166	{{code language="text" width="50%"}}
	167	root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
	168	{{/code}}
	169
	170	{{code width="50%" language="powershell"}}
1.1	171	Param
	172	(
	173	[parameter(Mandatory=$false)]
	174	[String]
	175	$ssid,
	176	[parameter(Mandatory=$false)]
	177	[String]
	178	$psk
	179	)
3.1	180
	181	if ($ssid -ne '' -and $psk -ne '') {
1.1	182	$profile = @'
3.1	183	<WLANProfile xmlns="http://www.microsoft.com/networking/WLAN/profile/v1">
1.1	184	<name>{0}</name>
	185	<SSIDConfig>
	186	<SSID>
	187	<name>{0}</name>
	188	</SSID>
	189	</SSIDConfig>
	190	<connectionType>ESS</connectionType>
	191	<connectionMode>auto</connectionMode>
	192	<MSM>
	193	<security>
	194	<authEncryption>
	195	<authentication>WPA2PSK</authentication>
	196	<encryption>AES</encryption>
	197	<useOneX>false</useOneX>
	198	</authEncryption>
	199	<sharedKey>
	200	<keyType>passPhrase</keyType>
	201	<protected>false</protected>
	202	<keyMaterial>{1}</keyMaterial>
	203	</sharedKey>
	204	</security>
	205	</MSM>
	206	</WLANProfile>
	207	'@ -f $ssid, $psk
3.1	208
	209	$file = "$AUTOCONF_TEMP_DIR\ld_wlan_psk\wlan.xml"
	210
	211	$profile \| Out-File (New-Item $file -Force)
	212
	213	Get-NetAdapter \| Where-Object { $_.PhysicalMediaType -eq 'Native 802.11' -or `
1.1	214	$_.PhysicalMediaType -eq 'Wireless LAN' -or `
	215	$_.PhysicalMediaType -eq 'Wireless WAN' } \| ForEach-Object {
3.1	216
	217	Write-Verbose "Creating wlan profile for '$ssid' on interface '$($_.Name)'"
1.1	218	netsh wlan add profile filename= "$file" interface= "$($_.Name)"
	219	}
3.1	220
	221	Remove-Item -Path $file -Force
1.1	222	}
3.1	223	{{/code}}
1.1	224
	225
28.1	226	(% style="color:#19177c" %)Linux Variante (Network Manager)
15.1	227
29.1	228	{{code language="text" width="50%"}}
	229	root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/lin/main.ps1
28.1	230	{{/code}}
15.1	231
28.1	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	)
15.1	242
28.1	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"
15.1	259
28.1	260	if (Test-Path -Path $config) {
	261	Write-Verbose "Removing '$config'"
	262	Remove-Item -Path $config -Recurse -Force
	263	}
15.1	264
28.1	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"""
15.1	272
28.1	273	if ($LASTEXITCODE -ne 0) {
	274	Write-Verbose "Error: Credentials wrong?"
	275
	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	}
	286
	287	Write-Verbose "No suitable implementation found"
	288	exit 1
	289	}
	290	{{/code}}
29.2	291
	292	----
	293
32.2	294	= (% style="font-size:22px" %)__Weiteres Beispiel: eigene AutoConf-Rolle zur "Deaktivierung der Suchhervorhebung in Windows"__(%%) =
29.2	295
34.2	296	Im nachfolgenden Beispiel wird eine einfache Rolle zur Deaktivierung der Suchvorhebung in Windows deklariert.
	297	\\[[image:image-20230316103442-2.png\|\|height="530" width="1142" class="img-thumbnail"]]
29.3	298
31.1	299	----
29.2	300
41.5	301	== (% style="font-size:16px" %)Aufbau der Logodidact.yml(%%) ==
29.2	302
41.3	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}}".
41.2	305
41.3	306
41.4	307	{{code language="yaml" width="45%"}}
41.3	308	#logodidact.yml
	309
	310	ld_info:
	311	authors:
	312	- Olav Krapp
	313	- Marcel Petersen
	314	- Kerim Ekin
	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:
	331	- CUSTOM #Ausführungszeitpunkt während der/den Phase(n)
	332	systems:
	333	- WINDOWS #Betriebssystem
	334	{{/code}}
	335
43.2	336	----
41.6	337
42.3	338	== (% style="font-size:16px" %)Aufbau der main.ps1(%%) ==
41.6	339
43.3	340	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 Variablen {{code}}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.
41.6	341
43.4	342	{{code language="powershell"}}
	343	#main.ps1
42.2	344
43.4	345	Param
	346	(
	347	[parameter(Mandatory=$false)] #Variable zwingend erforderlich?
	348	[bool] #Variablentyp
	349	$disableSearchHighlight #Name der def. Variable aus logodidact.yml
	350	)
43.2	351
43.4	352	$SystemVersion=[System.Environment]::OSVersion.Version #Hole Windows Systemversion
	353
	354	#Beginn des eigentlichen Codes
	355	if ($SystemVersion.Major -eq 10 -and $SystemVersion.Build -ge 19044) {
	356	$val = [int]!$disableSearchHighlight
	357	Write-Verbose "Setting EnableDynamicContentInWSB to '$val'"
	358	[Microsoft.Win32.Registry]::SetValue("HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Windows\Windows Search","EnableDynamicContentInWSB",$val,[Microsoft.Win32.RegistryValueKind]::DWord)
	359	} else {
	360	Write-Host "Feature ist erst ab dem Release 21H2 verfügbar."
	361	}
	362	{{/code}}
	363
43.5	364	----
	365
	366	== (% style="font-size:16px" %)Einlesen der AutoConf-Rollen am Server(%%) ==
	367
	368	[[image:image-20230316110425-1.png\|\|height="124" width="1186" class="img-thumbnail"]]
	369
	370
	371	== (% style="font-size:16px" %)Ansicht im LD Control Center(%%) ==
	372
	373	[[image:image-20230316110525-2.png\|\|class="img-thumbnail"]]
	374
44.1	375