Wiki-Quellcode von Eigene Autoconf-Rolle erstellen

Version 12.2 von Tom Altenbrunn am 2023/03/15 09:51

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.2	3
2.1	4	Von SBE ausgelieferte Rollen befinden sich Im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
1.1	5
6.1	6	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	7
6.1	8	Der Aufbau einer Autoconf-Rolle muss einer Struktur folgen, damit der Server diese Interpretieren kann.
2.1	9
11.2	10	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	11
	12
	13	==== Beispielaufbau der logodidact.yml: ====
	14
	15	(% class="box" %)
	16	(((
1.1	17	root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
2.1	18	)))
1.1	19
2.1	20	(% class="box" %)
	21	(((
1.1	22	ld_info:
	23	authors:
	24	- Marcel Petersen
	25	company: SBE network solutions GmbH
	26	display_name: WLAN Profil mit PSK anlegen
	27	license: SBE
	28	uuid: 52318636-c4f5-11ea-baf9-0bff00c66ff4
	29	visible: true
	30	priority: 0
	31	applyAlways: false
	32	tags:
	33	- CUSTOM
	34	vars:
	35	ssid:
	36	display_name: SSID
	37	optional: false
	38	type: STRING
	39	psk:
	40	display_name: Passwort
	41	optional: false
	42	type: PASSWORD
	43	systems:
	44	- WINDOWS
	45	- LINUX
2.1	46	)))
1.1	47
6.1	48	display_name = Anzeigename der Autoconf-Rolle im LD Control Center
1.1	49
6.1	50	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	51
6.1	52	tags = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
1.1	53
6.1	54	systems = Legt fest, welche Betriebssystem-Typen durch die Autoconf-Rolle unterstützt werden. Gültige Systeme sind: WINDOWS / LINUX
1.1	55
6.1	56	vars = definiert mögliche Variablen, die den Skripten übergeben werden
1.1	57
6.1	58	~* display_name = Name der konfigurierbaren Variable im Control Center
1.1	59
6.1	60	~* example = Zeigt einen grau eingefärbten Beispieltext innerhalb Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
	61
	62	~* optional = bestimmt, ob die Variable zwingend mit einem Wert belegt werden muss
	63
	64	~* type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
	65
	66
	67	Beispiel für eine Variable:
	68
2.1	69	(% class="box" %)
	70	(((
1.1	71	globalLogLevel:
	72	display_name: Loglevel
	73	optional: true
	74	type: ENUM
	75	values:
	76	- none
	77	- compact
	78	- detailed
	79	- full
2.1	80	)))
1.1	81
9.1	82	(% 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	83
	84
6.1	85	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	86
8.1	87	* main.ps1 - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei {{box}}meta/logodidact.yml{{/box}} festgelegt sind
	88	* (% style="color:#8e44ad" %)setup.ps1(%%) - Skript wird ausschließlich in der SETUP-Phase während des Deployments ausgeführt.
	89	* (% style="color:#8e44ad" %)custom.ps1(%%) - Skript wird ausschließlich in der CUSTOM-Phase während des Deployments ausgeführt.
	90	* (% style="color:#8e44ad" %)user.ps1(%%) - Skript wird ausschließlich in der USER-Phase während des Deployments ausgeführt.
	91	* (% style="color:#8e44ad" %)audit.ps1(%%) - Skript wird ausschließlich in der AUDIT-Phase während des Deployments ausgeführt.
	92	* 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	93
9.1	94	(% 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	95
7.1	96
2.1	97	==== Beispielaufbau der main.ps1 ====
	98
1.1	99	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	100
	101	{{code}}
1.1	102	user.ps1 = user Phase, nach der Anmeldung
	103
	104	custom.ps1 = custom Phase
	105
	106	audit.ps1 = audit Phase
	107
	108	setup.ps1 = setup Phase
	109
	110	main.ps1 = alle Phasen
	111
3.1	112	root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
1.1	113
	114	Param
	115	(
	116	[parameter(Mandatory=$false)]
	117	[String]
	118	$ssid,
	119	[parameter(Mandatory=$false)]
	120	[String]
	121	$psk
	122	)
3.1	123
	124	if ($ssid -ne '' -and $psk -ne '') {
1.1	125	$profile = @'
3.1	126	<WLANProfile xmlns="http://www.microsoft.com/networking/WLAN/profile/v1">
1.1	127	<name>{0}</name>
	128	<SSIDConfig>
	129	<SSID>
	130	<name>{0}</name>
	131	</SSID>
	132	</SSIDConfig>
	133	<connectionType>ESS</connectionType>
	134	<connectionMode>auto</connectionMode>
	135	<MSM>
	136	<security>
	137	<authEncryption>
	138	<authentication>WPA2PSK</authentication>
	139	<encryption>AES</encryption>
	140	<useOneX>false</useOneX>
	141	</authEncryption>
	142	<sharedKey>
	143	<keyType>passPhrase</keyType>
	144	<protected>false</protected>
	145	<keyMaterial>{1}</keyMaterial>
	146	</sharedKey>
	147	</security>
	148	</MSM>
	149	</WLANProfile>
	150	'@ -f $ssid, $psk
3.1	151
	152	$file = "$AUTOCONF_TEMP_DIR\ld_wlan_psk\wlan.xml"
	153
	154	$profile \| Out-File (New-Item $file -Force)
	155
	156	Get-NetAdapter \| Where-Object { $_.PhysicalMediaType -eq 'Native 802.11' -or `
1.1	157	$_.PhysicalMediaType -eq 'Wireless LAN' -or `
	158	$_.PhysicalMediaType -eq 'Wireless WAN' } \| ForEach-Object {
3.1	159
	160	Write-Verbose "Creating wlan profile for '$ssid' on interface '$($_.Name)'"
1.1	161	netsh wlan add profile filename= "$file" interface= "$($_.Name)"
	162	}
3.1	163
	164	Remove-Item -Path $file -Force
1.1	165	}
	166
	167	Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokale Variablen.
3.1	168	{{/code}}
1.1	169
4.1	170	==== ====
1.1	171
12.1	172	==== Neue AutoConf-Rollen freigeben ====
4.1	173
12.1	174	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.
	175	Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
3.1	176
12.1	177	Betätigen Sie außerdem im LD Control Center (mit aktiviertem Expertenmodus) folgenden Knopf, damit selbst hinzugefügte Autoconf-Rollen verfügbar werden.
	178
3.1	179	[[image:attach:autoconf.png\|\|data-xwiki-image-style-border="true"]]
1.1	180