Wiki-Quellcode von Eigene Autoconf-Rolle erstellen

Version 17.9 von Tom Altenbrunn am 2023/03/15 14:03

version	line-number	content
17.9	1	{{toc depth="3"/}}
	2
	3
	4	= (% style="font-size:22px" %)__Allgemeines__(%%) =
	5
	6
14.1	7	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	8
14.1	9	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.
	10	Diese fest integrierten Rollen befinden sich im LXC-Container ctrl-g1 im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
12.2	11
12.5	12	[[image:image-20230315103418-1.png\|\|height="103" width="1344" class="img-thumbnail"]]
	13
2.1	14
14.1	15	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	16
12.6	17	* bis Puppet-Version 1.4.x : {{code language="bash"}}/var/lib/ld-autoconf/custom/{{/code}}
14.1	18	* ab Puppet-Version 1.5.x : {{code language="bash" layout="LINENUMBERS"}}/data/ld/autoconf/custom/{{/code}}
12.6	19
17.9	20
15.1	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.
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
	31	* main.ps1 - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei {{box}}meta/logodidact.yml{{/box}} festgelegt sind
	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.
	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	* 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
17.9	43
12.10	44	----
2.1	45
17.9	46	= (% style="font-size:22px" %)__Beispielaufbau einer logodidact.yml__(%%) =
2.1	47
17.9	48
14.1	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.
2.1	50
17.9	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
17.9	76
15.1	77	----
	78
17.9	79	= (% style="font-size:22px" %)__Neue AutoConf-Rollen nach Fertigstellung freigeben__(%%) =
15.1	80
17.9	81
16.1	82	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.
	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	----
	97
17.9	98	= (% style="font-size:22px" %)__Weiteres, funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“__(%%) =
16.1	99
17.9	100
14.1	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
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
2.1	108	(% class="box" %)
	109	(((
1.1	110	ld_info:
	111	authors:
	112	- Marcel Petersen
	113	company: SBE network solutions GmbH
12.10	114	(% style="color:#1abc9c" %)display_name:(%%) WLAN Profil mit PSK anlegen
1.1	115	license: SBE
12.10	116	(% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
1.1	117	visible: true
	118	priority: 0
	119	applyAlways: false
12.10	120	(% style="color:#f1c40f" %) tags:(%%)
1.1	121	- CUSTOM
12.10	122	(% style="color:#e74c3c" %) vars:(%%)
1.1	123	ssid:
	124	display_name: SSID
	125	optional: false
	126	type: STRING
	127	psk:
	128	display_name: Passwort
	129	optional: false
	130	type: PASSWORD
12.10	131	(% style="color:#2980b9" %)systems:(%%)
1.1	132	- WINDOWS
	133	- LINUX
2.1	134	)))
1.1	135
12.10	136	(% style="color:#1abc9c" %)display_name(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
1.1	137
12.10	138	(% 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	139
12.10	140	(% style="color:#f1c40f" %)tags(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
1.1	141
12.10	142	(% style="color:#e74c3c" %)vars(%%) = definiert mögliche Variablen, die den Skripten übergeben werden
1.1	143
12.10	144	* display_name = Name der konfigurierbaren Variable im Control Center
	145	* optional = bestimmt, ob die Variable zwingend mit einem Wert belegt werden muss
	146	* type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
	147	* 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	148
15.1	149	(% 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	150
17.7	151	----
6.1	152
16.1	153	===== Aufbau der main.ps1 =====
2.1	154
15.1	155	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	156
12.10	157	{{code width="50%"}}
3.1	158	root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
1.1	159
	160	Param
	161	(
	162	[parameter(Mandatory=$false)]
	163	[String]
	164	$ssid,
	165	[parameter(Mandatory=$false)]
	166	[String]
	167	$psk
	168	)
3.1	169
	170	if ($ssid -ne '' -and $psk -ne '') {
1.1	171	$profile = @'
3.1	172	<WLANProfile xmlns="http://www.microsoft.com/networking/WLAN/profile/v1">
1.1	173	<name>{0}</name>
	174	<SSIDConfig>
	175	<SSID>
	176	<name>{0}</name>
	177	</SSID>
	178	</SSIDConfig>
	179	<connectionType>ESS</connectionType>
	180	<connectionMode>auto</connectionMode>
	181	<MSM>
	182	<security>
	183	<authEncryption>
	184	<authentication>WPA2PSK</authentication>
	185	<encryption>AES</encryption>
	186	<useOneX>false</useOneX>
	187	</authEncryption>
	188	<sharedKey>
	189	<keyType>passPhrase</keyType>
	190	<protected>false</protected>
	191	<keyMaterial>{1}</keyMaterial>
	192	</sharedKey>
	193	</security>
	194	</MSM>
	195	</WLANProfile>
	196	'@ -f $ssid, $psk
3.1	197
	198	$file = "$AUTOCONF_TEMP_DIR\ld_wlan_psk\wlan.xml"
	199
	200	$profile \| Out-File (New-Item $file -Force)
	201
	202	Get-NetAdapter \| Where-Object { $_.PhysicalMediaType -eq 'Native 802.11' -or `
1.1	203	$_.PhysicalMediaType -eq 'Wireless LAN' -or `
	204	$_.PhysicalMediaType -eq 'Wireless WAN' } \| ForEach-Object {
3.1	205
	206	Write-Verbose "Creating wlan profile for '$ssid' on interface '$($_.Name)'"
1.1	207	netsh wlan add profile filename= "$file" interface= "$($_.Name)"
	208	}
3.1	209
	210	Remove-Item -Path $file -Force
1.1	211	}
	212
12.10	213	Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokalen Variablen.
3.1	214	{{/code}}
1.1	215
4.1	216	==== ====
1.1	217
15.1	218	==== ====
	219
	220	==== ====
	221
	222	==== ====
	223
	224	==== ====
	225
	226	==== ====
	227
	228	==== ====
	229
	230	==== ====