Wiki-Quellcode von Eigene Autoconf-Rolle erstellen

Version 12.3 von Tom Altenbrunn am 2023/03/15 10:07

version	line-number	content
12.2	1	Autoconf liegt wie der Vorgänger Ansible im ctrl-g1 Container und dient dazu, Einstellungen oder Konfigurationen auf bereits deployte Rechner zu übertragen, ohne ein neues Image dafür zu schreiben. Somit lassen sich relativ einfach und flexibel diverse Anpassungen an bestehenden Clients vornehmen.
1.1	2
12.3	3	Logodidact ist bereits standardmäßig mit zahlreichen eigenen Autoconf-Rollen bestückt, um ein möglichst breites Spektrum verschiedenster Anforderungen des allgemeinen Schulbetriebs abzudecken.
12.2	4
2.1	5	Von SBE ausgelieferte Rollen befinden sich Im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
1.1	6
6.1	7	Selbst erstellte Autoconf-Rollen müssen unter {{box}}/data/ld/autoconf/custom{{/box}} (bzw. früher vor Puppet-Version 1.5.x unter {{box}}/var/lib/ld-autoconf/custom/{{/box}}) abgelegt werden, damit diese nicht durch Updates überschrieben werden.
2.1	8
6.1	9	Der Aufbau einer Autoconf-Rolle muss einer Struktur folgen, damit der Server diese Interpretieren kann.
2.1	10
11.2	11	Unterhalb der Regel muss ein Ordner mit Namen {{box}}meta{{/box}} mit einer {{box}}logodidact.yml{{/box}} liegen. In dieser Datei sind Name, Beschreibung, Ersteller sowie weitere Informationen zur Autoconf-Rolle festgelegt.
2.1	12
	13
	14	==== Beispielaufbau der logodidact.yml: ====
	15
	16	(% class="box" %)
	17	(((
1.1	18	root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
2.1	19	)))
1.1	20
2.1	21	(% class="box" %)
	22	(((
1.1	23	ld_info:
	24	authors:
	25	- Marcel Petersen
	26	company: SBE network solutions GmbH
	27	display_name: WLAN Profil mit PSK anlegen
	28	license: SBE
	29	uuid: 52318636-c4f5-11ea-baf9-0bff00c66ff4
	30	visible: true
	31	priority: 0
	32	applyAlways: false
	33	tags:
	34	- CUSTOM
	35	vars:
	36	ssid:
	37	display_name: SSID
	38	optional: false
	39	type: STRING
	40	psk:
	41	display_name: Passwort
	42	optional: false
	43	type: PASSWORD
	44	systems:
	45	- WINDOWS
	46	- LINUX
2.1	47	)))
1.1	48
6.1	49	display_name = Anzeigename der Autoconf-Rolle im LD Control Center
1.1	50
6.1	51	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	52
6.1	53	tags = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
1.1	54
6.1	55	systems = Legt fest, welche Betriebssystem-Typen durch die Autoconf-Rolle unterstützt werden. Gültige Systeme sind: WINDOWS / LINUX
1.1	56
6.1	57	vars = definiert mögliche Variablen, die den Skripten übergeben werden
1.1	58
6.1	59	~* display_name = Name der konfigurierbaren Variable im Control Center
1.1	60
6.1	61	~* example = Zeigt einen grau eingefärbten Beispieltext innerhalb Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
	62
	63	~* optional = bestimmt, ob die Variable zwingend mit einem Wert belegt werden muss
	64
	65	~* type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
	66
	67
	68	Beispiel für eine Variable:
	69
2.1	70	(% class="box" %)
	71	(((
1.1	72	globalLogLevel:
	73	display_name: Loglevel
	74	optional: true
	75	type: ENUM
	76	values:
	77	- none
	78	- compact
	79	- detailed
	80	- full
2.1	81	)))
1.1	82
9.1	83	(% style="font-size:12px" %)Tipp: Der Variablentyp ENUM aus dem Beispiel entspricht einem Dropdown-Menü, in dem man aus vordefinierte Werte auswählen kann:
1.1	84
	85
6.1	86	Für die Funktionalität der Autoconf-Rolle ist es nötig, PowerShell-Skripte am Server abzuspeichern, die die Instruktionen an den Arbeitsstationen ausführen. Diese Skripte liegen unterhalb der Autoconf-Rolle im Verzeichnis {{box}}win{{/box}}. Darin sind folgende Dateinamen zulässig:
1.1	87
8.1	88	* main.ps1 - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei {{box}}meta/logodidact.yml{{/box}} festgelegt sind
	89	* (% style="color:#8e44ad" %)setup.ps1(%%) - Skript wird ausschließlich in der SETUP-Phase während des Deployments ausgeführt.
	90	* (% style="color:#8e44ad" %)custom.ps1(%%) - Skript wird ausschließlich in der CUSTOM-Phase während des Deployments ausgeführt.
	91	* (% style="color:#8e44ad" %)user.ps1(%%) - Skript wird ausschließlich in der USER-Phase während des Deployments ausgeführt.
	92	* (% style="color:#8e44ad" %)audit.ps1(%%) - Skript wird ausschließlich in der AUDIT-Phase während des Deployments ausgeführt.
	93	* collect.ps1 - Sonderfall. Dieses Skript wird ausgeführt, wenn durch einen Anwender aktiv die Phase COLLECT zum Einsammeln von Einstellungen am Client aufgerufen werden.
2.1	94
9.1	95	(% style="font-size:12px" %)Hinweis: Skripte, die durch ihren Dateinamen auf die einzelnen Phasen eingeschränkt sind ((% style="color:#8e44ad; font-size:12px" %)lila eingefärbt(% style="font-size:12px" %)), können sich inhaltlich zueinander unterscheiden. Dadurch kann eine Autoconf-Rolle sehr flexibel gestaltet werden.
2.1	96
7.1	97
2.1	98	==== Beispielaufbau der main.ps1 ====
	99
1.1	100	Im win-Verzeichnis können sich unterschiedliche Powershellskripte befinden. Der jeweilige Name der .ps1 Datei gibt an zu welcher Phase die Datei ausgeführt wird.
3.1	101
	102	{{code}}
1.1	103	user.ps1 = user Phase, nach der Anmeldung
	104
	105	custom.ps1 = custom Phase
	106
	107	audit.ps1 = audit Phase
	108
	109	setup.ps1 = setup Phase
	110
	111	main.ps1 = alle Phasen
	112
3.1	113	root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
1.1	114
	115	Param
	116	(
	117	[parameter(Mandatory=$false)]
	118	[String]
	119	$ssid,
	120	[parameter(Mandatory=$false)]
	121	[String]
	122	$psk
	123	)
3.1	124
	125	if ($ssid -ne '' -and $psk -ne '') {
1.1	126	$profile = @'
3.1	127	<WLANProfile xmlns="http://www.microsoft.com/networking/WLAN/profile/v1">
1.1	128	<name>{0}</name>
	129	<SSIDConfig>
	130	<SSID>
	131	<name>{0}</name>
	132	</SSID>
	133	</SSIDConfig>
	134	<connectionType>ESS</connectionType>
	135	<connectionMode>auto</connectionMode>
	136	<MSM>
	137	<security>
	138	<authEncryption>
	139	<authentication>WPA2PSK</authentication>
	140	<encryption>AES</encryption>
	141	<useOneX>false</useOneX>
	142	</authEncryption>
	143	<sharedKey>
	144	<keyType>passPhrase</keyType>
	145	<protected>false</protected>
	146	<keyMaterial>{1}</keyMaterial>
	147	</sharedKey>
	148	</security>
	149	</MSM>
	150	</WLANProfile>
	151	'@ -f $ssid, $psk
3.1	152
	153	$file = "$AUTOCONF_TEMP_DIR\ld_wlan_psk\wlan.xml"
	154
	155	$profile \| Out-File (New-Item $file -Force)
	156
	157	Get-NetAdapter \| Where-Object { $_.PhysicalMediaType -eq 'Native 802.11' -or `
1.1	158	$_.PhysicalMediaType -eq 'Wireless LAN' -or `
	159	$_.PhysicalMediaType -eq 'Wireless WAN' } \| ForEach-Object {
3.1	160
	161	Write-Verbose "Creating wlan profile for '$ssid' on interface '$($_.Name)'"
1.1	162	netsh wlan add profile filename= "$file" interface= "$($_.Name)"
	163	}
3.1	164
	165	Remove-Item -Path $file -Force
1.1	166	}
	167
	168	Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokale Variablen.
3.1	169	{{/code}}
1.1	170
4.1	171	==== ====
1.1	172
12.1	173	==== Neue AutoConf-Rollen freigeben ====
4.1	174
12.1	175	Neue Autoconf-Rollen müssen 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.
	176	Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
3.1	177
12.1	178	Betätigen Sie außerdem im LD Control Center (mit aktiviertem Expertenmodus) folgenden Knopf, damit selbst hinzugefügte Autoconf-Rollen verfügbar werden.
	179
3.1	180	[[image:attach:autoconf.png\|\|data-xwiki-image-style-border="true"]]
1.1	181