Änderungen von Dokument Eigene Autoconf-Rolle erstellen

Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Inhalt

...	...	@@ -6,15 +6,24 @@
6	6
7	7	[[image:image-20230315103418-1.png||height="103" width="1344" class="img-thumbnail"]]
8	8
9		-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.
10	10
11		-Der Aufbau einer Autoconf-Rolle muss einer Struktur folgen, damit der Server diese Interpretieren kann.
	10	+Darüber hinaus ist es Partnern und Kunden möglich für spezielle, schulspezifische Anforderungen eigene Autoconf-Rollen erstellen und im LD Control Center bereitstellen zu können. Dafür steht je nach Puppet-Versionsstand ein eigenes Verzeichnis im ctrl-g1 zur Verfügung, welches nicht durch Server-Updates beeinflusst oder überschrieben wird.
12	12
13		-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.
	12	+* bis Puppet-Version **1.4.x** : {{code language="bash"}}/var/lib/ld-autoconf/custom/{{/code}}
	13	+* Ab Puppet-Version **1.5.x **:  {{code language="bash" layout="LINENUMBERS"}}/data/ld/autoconf/custom/{{/code}}
14	14
15	15
16		-==== **Beispielaufbau der logodidact.yml:** ====
	16	+Der Aufbau einer Autoconf-Rolle unterliegt einer vordefinierten Struktur, bestehend aus einer logodidact.yml, welche die Informationen zu Namen, Beschreibung, Ersteller und Variablen definiert, sowie der eigentlichen ausführbaren Skript-Datei (Powershell oder Bash). Diese liegen wiederum in ihren eigenen Dateiordnern. Daneben besteht auch die Möglichkeit im Unterordner files/ (ausführbare) Dateien, Bilder, Videos, etc. mitzugeben.
	17	+Der strukturelle Aufbau ist nachfolgend ersichtlich:
	18	+[[image:image-20230315112326-2.png||height="215" width="633" class="img-thumbnail"]]
17	17
	20	+----
	21	+
	22	+==== **Beispielaufbau einer logodidact.yml:** ====
	23	+
	24	+Eine Autoconf-Beispielvorlage liegt serverseitig im Unterordner example/ vor. Zum besseren Verständnis wird nachfolgend eine Autoconf-Rolle zur Mitgabe einer WLAN-SSID samt PSK an Clients näher beleuchtet.
	25	+
	26	+
18	18	(% class="box" %)
19	19	(((
20	20	root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
...	...	@@ -26,15 +26,15 @@
26	26	authors:
27	27	- Marcel Petersen
28	28	company: SBE network solutions GmbH
29		- display_name: WLAN Profil mit PSK anlegen
	38	+(% style="color:#1abc9c" %)display_name:(%%) WLAN Profil mit PSK anlegen
30	30	license: SBE
31		- uuid: 52318636-c4f5-11ea-baf9-0bff00c66ff4
	40	+(% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
32	32	visible: true
33	33	priority: 0
34	34	applyAlways: false
35		- tags:
	44	+(% style="color:#f1c40f" %) tags:(%%)
36	36	- CUSTOM
37		- vars:
	46	+(% style="color:#e74c3c" %) vars:(%%)
38	38	ssid:
39	39	display_name: SSID
40	40	optional: false
...	...	@@ -43,30 +43,27 @@
43	43	display_name: Passwort
44	44	optional: false
45	45	type: PASSWORD
46		- systems:
	55	+(% style="color:#2980b9" %)systems:(%%)
47	47	- WINDOWS
48	48	- LINUX
49	49	)))
50	50
51		-display_name = Anzeigename der Autoconf-Rolle im LD Control Center
	60	+(% style="color:#1abc9c" %)display_name(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
52	52
53		-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/]]
	62	+(% 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/]]
54	54
55		-tags = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
	64	+(% style="color:#f1c40f" %)tags(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
56	56
57		-systems = Legt fest, welche Betriebssystem-Typen durch die Autoconf-Rolle unterstützt werden. Gültige Systeme sind: WINDOWS / LINUX
	66	+(% style="color:#e74c3c" %)vars(%%) = definiert mögliche Variablen, die den Skripten übergeben werden
58	58
59		-vars = definiert mögliche Variablen, die den Skripten übergeben werden
	68	+* display_name = Name der konfigurierbaren Variable im Control Center
	69	+* optional = bestimmt, ob die Variable zwingend mit einem Wert belegt werden muss
	70	+* type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
	71	+* example = Zeigt einen grau eingefärbten Beispieltext innerhalb der definierten Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
60	60
61		- ~* display_name = Name der konfigurierbaren Variable im Control Center
	73	+(% style="color:#2980b9" %) systems (%%)= Legt fest, welche Betriebssystem-Typen durch die Autoconf-Rolle unterstützt werden. Gültige Systeme sind: WINDOWS / LINUX
62	62
63		- ~* example = Zeigt einen grau eingefärbten Beispieltext innerhalb Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
64	64
65		- ~* optional = bestimmt, ob die Variable zwingend mit einem Wert belegt werden muss
66		-
67		- ~* type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
68		-
69		-
70	70	**Beispiel für eine Variable:**
71	71
72	72	(% class="box" %)
...	...	@@ -82,8 +82,12 @@
82	82	- full
83	83	)))
84	84
85		-(% style="font-size:12px" %)**Tipp:** Der Variablentyp ENUM aus dem Beispiel entspricht einem Dropdown-Menü, in dem man aus vordefinierte Werte auswählen kann:
	91	+(% class="box infomessage" %)
	92	+(((
	93	+(% style="font-size:12px" %)**Tipp:** Der Variablentyp ENUM aus dem Beispiel entspricht einem Dropdown-Menü, in dem man aus vordefinierten Werten auswählen kann
	94	+)))
86	86
	96	+----
87	87
88	88	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:
89	89
...	...	@@ -94,14 +94,17 @@
94	94	* (% style="color:#8e44ad" %)**audit.ps1**(%%) - Skript wird ausschließlich in der AUDIT-Phase während des Deployments ausgeführt.
95	95	* **collect.ps1** - Sonderfall. Dieses Skript wird ausgeführt, wenn durch einen Anwender aktiv die Phase COLLECT zum Einsammeln von Einstellungen am Client aufgerufen werden.
96	96
	107	+(% class="box warningmessage" %)
	108	+(((
97	97	(% 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.
	110	+)))
98	98
99	99
100	100	==== **Beispielaufbau der main.ps1** ====
101	101
102		-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.
	115	+Im win-Verzeichnis können sich unterschiedliche Powershell-Skripte befinden. Der jeweilige Name der .ps1 Datei gibt an zu welcher Phase die Datei ausgeführt wird.
103	103
104		-{{code}}
	117	+{{code width="50%"}}
105	105	user.ps1 = user Phase, nach der Anmeldung
106	106
107	107	custom.ps1 = custom Phase
...	...	@@ -167,7 +167,7 @@
167	167	Remove-Item -Path $file -Force
168	168	}
169	169
170		-Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokale Variablen.
	183	+Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokalen Variablen.
171	171	{{/code}}
172	172
173	173	==== ====
...	...	@@ -174,10 +174,15 @@
174	174
175	175	==== **Neue AutoConf-Rollen freigeben** ====
176	176
177		-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.
	190	+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.
178	178	Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
179	179
180		-Betätigen Sie außerdem im LD Control Center (mit aktiviertem Expertenmodus) folgenden Knopf, damit selbst hinzugefügte Autoconf-Rollen verfügbar werden.
	193	+Betätigen Sie außerdem im LD Control Center (mit aktiviertem Expertenmodus) den Reiter "AutoConf Rollen neu einlesen", damit selbst hinzugefügte Autoconf-Rollen verfügbar werden.
181	181
	195	+(% class="box infomessage" %)
	196	+(((
	197	+Der Expertenmodus wird in den **Einstellungen (Zahnrad oben rechts) -> Entwickleroptionen -> Expertenmodus aktivieren** aktiv geschaltet.
	198	+)))
	199	+
182	182	[[image:attach:autoconf.png||data-xwiki-image-style-border="true"]]
183	183