Wiki-Quellcode von Eigene Autoconf-Rolle erstellen

Version 29.1 von Jonas Mayer am 2023/03/16 07:58

version	line-number	content
17.9	1	{{toc depth="3"/}}
	2
27.1	3	----
17.9	4
27.1	5
17.9	6	= (% style="font-size:22px" %)__Allgemeines__(%%) =
	7
	8
14.1	9	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	10
14.1	11	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.
	12	Diese fest integrierten Rollen befinden sich im LXC-Container ctrl-g1 im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
12.2	13
12.5	14	[[image:image-20230315103418-1.png\|\|height="103" width="1344" class="img-thumbnail"]]
	15
2.1	16
14.1	17	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	18
12.6	19	* bis Puppet-Version 1.4.x : {{code language="bash"}}/var/lib/ld-autoconf/custom/{{/code}}
14.1	20	* ab Puppet-Version 1.5.x : {{code language="bash" layout="LINENUMBERS"}}/data/ld/autoconf/custom/{{/code}}
12.6	21
20.1	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.
12.6	23
17.5	24	__Der strukturelle Aufbau eines AutoConf-Verzeichnisses grafisch dargestellt:__
14.1	25
17.4	26	[[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	27
17.5	28	----
15.1	29
	30	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:
	31
	32	* main.ps1 - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei {{box}}meta/logodidact.yml{{/box}} festgelegt sind
	33	* (% 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.
	34	* (% 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.
	35	* (% 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	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.
15.1	37	* collect.ps1 - Sonderfall. Dieses Skript wird ausgeführt, wenn durch einen Anwender aktiv die Phase COLLECT zum Einsammeln von Einstellungen am Client aufgerufen wird.
	38
	39	(% class="box warningmessage" %)
	40	(((
	41	(% 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.
	42	)))
	43
12.10	44	----
2.1	45
27.1	46
17.9	47	= (% style="font-size:22px" %)__Beispielaufbau einer logodidact.yml__(%%) =
2.1	48
17.9	49
14.1	50	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.
2.1	51
19.1	52	== (% style="font-size:16px" %)Beispiel zur Deklaration einer Autoconf Variable in logodidact.yml(%%) ==
14.1	53
15.1	54	(% class="box" %)
	55	(((
	56	ld_info:
	57	display_name: Meine eigene Autoconf-Rolle 1
17.1	58	(% style="color:#27ae60" %) # [...](%%)
15.1	59	\\ vars:
	60	globalLogLevel:
	61	display_name: Loglevel
	62	optional: true
	63	type: ENUM
	64	values:
	65	- none
	66	- compact
	67	- detailed
	68	- verbose
17.1	69	\\(% style="color:#27ae60" %) # [...]
15.1	70	)))
	71
	72	(% class="box infomessage" %)
	73	(((
17.2	74	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	75	)))
	76
	77	----
	78
27.1	79
17.9	80	= (% style="font-size:22px" %)__Neue AutoConf-Rollen nach Fertigstellung freigeben__(%%) =
15.1	81
17.9	82
16.1	83	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.
	84	Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
	85
17.6	86	Ü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	87
	88	(% class="box infomessage" %)
	89	(((
	90	Der Expertenmodus wird in den Einstellungen (Zahnrad oben rechts) -> Entwickleroptionen -> Expertenmodus aktivieren aktiv geschaltet.
	91	)))
	92
	93	[[image:attach:autoconf.png\|\|data-xwiki-image-style-border="true" class="img-thumbnail"]]
	94
	95
	96	----
	97
27.1	98
17.9	99	= (% style="font-size:22px" %)__Weiteres, funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“__(%%) =
16.1	100
17.9	101
21.1	102	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	103
2.1	104	(% class="box" %)
	105	(((
1.1	106	root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
2.1	107	)))
1.1	108
24.1	109	== (% style="font-size:16px" %)Struktureller Aufbau der logodidact.yml(%%) ==
17.10	110
2.1	111	(% class="box" %)
	112	(((
1.1	113	ld_info:
	114	authors:
	115	- Marcel Petersen
	116	company: SBE network solutions GmbH
25.1	117	(% style="color:#1abc9c" %) display_name:(%%) WLAN Profil mit PSK anlegen
1.1	118	license: SBE
25.1	119	(% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
1.1	120	visible: true
28.1	121	(% style="color:#19177c" %) priority:(%%) 0
1.1	122	applyAlways: false
25.1	123	(% style="color:#f1c40f" %) tags:(%%)
1.1	124	- CUSTOM
12.10	125	(% style="color:#e74c3c" %) vars:(%%)
1.1	126	ssid:
	127	display_name: SSID
	128	optional: false
	129	type: STRING
	130	psk:
	131	display_name: Passwort
	132	optional: false
	133	type: PASSWORD
25.1	134	(% style="color:#2980b9" %) systems:(%%)
1.1	135	- WINDOWS
	136	- LINUX
2.1	137	)))
1.1	138
17.10	139	(% style="color:#1abc9c" %)display_name(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
1.1	140
17.10	141	(% 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	142
27.1	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
17.10	145	(% style="color:#f1c40f" %)tags(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
1.1	146
17.10	147	(% style="color:#e74c3c" %)vars(%%) = definiert mögliche Variablen, die den Skripten übergeben werden
1.1	148
12.10	149	* display_name = Name der konfigurierbaren Variable im Control Center
	150	* optional = bestimmt, ob die Variable zwingend mit einem Wert belegt werden muss
	151	* type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
	152	* 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	153
27.1	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.
1.1	155
17.7	156	----
6.1	157
27.1	158
23.1	159	== (% style="font-size:16px" %)Inhalt des PowerShell-Skripts main.ps1, das die Variablen entgegennimmt(%%) ==
2.1	160
28.1	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.
17.11	163
3.1	164
28.1	165	(% style="color:#19177c" %)Windows Variante
27.1	166
28.1	167	{{code language="text" width="50%"}}
	168	root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
	169	{{/code}}
	170
	171	{{code width="50%" language="powershell"}}
1.1	172	Param
	173	(
	174	[parameter(Mandatory=$false)]
	175	[String]
	176	$ssid,
	177	[parameter(Mandatory=$false)]
	178	[String]
	179	$psk
	180	)
3.1	181
	182	if ($ssid -ne '' -and $psk -ne '') {
1.1	183	$profile = @'
3.1	184	<WLANProfile xmlns="http://www.microsoft.com/networking/WLAN/profile/v1">
1.1	185	<name>{0}</name>
	186	<SSIDConfig>
	187	<SSID>
	188	<name>{0}</name>
	189	</SSID>
	190	</SSIDConfig>
	191	<connectionType>ESS</connectionType>
	192	<connectionMode>auto</connectionMode>
	193	<MSM>
	194	<security>
	195	<authEncryption>
	196	<authentication>WPA2PSK</authentication>
	197	<encryption>AES</encryption>
	198	<useOneX>false</useOneX>
	199	</authEncryption>
	200	<sharedKey>
	201	<keyType>passPhrase</keyType>
	202	<protected>false</protected>
	203	<keyMaterial>{1}</keyMaterial>
	204	</sharedKey>
	205	</security>
	206	</MSM>
	207	</WLANProfile>
	208	'@ -f $ssid, $psk
3.1	209
	210	$file = "$AUTOCONF_TEMP_DIR\ld_wlan_psk\wlan.xml"
	211
	212	$profile \| Out-File (New-Item $file -Force)
	213
	214	Get-NetAdapter \| Where-Object { $_.PhysicalMediaType -eq 'Native 802.11' -or `
1.1	215	$_.PhysicalMediaType -eq 'Wireless LAN' -or `
	216	$_.PhysicalMediaType -eq 'Wireless WAN' } \| ForEach-Object {
3.1	217
	218	Write-Verbose "Creating wlan profile for '$ssid' on interface '$($_.Name)'"
1.1	219	netsh wlan add profile filename= "$file" interface= "$($_.Name)"
	220	}
3.1	221
	222	Remove-Item -Path $file -Force
1.1	223	}
3.1	224	{{/code}}
1.1	225
	226
28.1	227	(% style="color:#19177c" %)Linux Variante (Network Manager)
15.1	228
29.1	229	{{code language="text" width="50%"}}
	230	root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/lin/main.ps1
28.1	231	{{/code}}
15.1	232
28.1	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	)
15.1	243
28.1	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"
15.1	260
28.1	261	if (Test-Path -Path $config) {
	262	Write-Verbose "Removing '$config'"
	263	Remove-Item -Path $config -Recurse -Force
	264	}
15.1	265
28.1	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"""
15.1	273
28.1	274	if ($LASTEXITCODE -ne 0) {
	275	Write-Verbose "Error: Credentials wrong?"
	276
	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	}
	287
	288	Write-Verbose "No suitable implementation found"
	289	exit 1
	290	}
	291	{{/code}}