Wiki-Quellcode von Eigene Autoconf-Rolle erstellen

Version 17.8 von Tom Altenbrunn am 2023/03/15 13:57

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