Wiki-Quellcode von Eigene Autoconf-Rolle erstellen

Version 17.2 von Tom Altenbrunn am 2023/03/15 13:44

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