Änderungen von Dokument Eigene Autoconf-Rolle erstellen

Zusammenfassung

• Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)
• Anhänge (0 geändert, 1 hinzugefügt, 0 gelöscht)
  • autoconf-struktur.PNG

Details

Seiteneigenschaften

Dokument-Autor

...	...	@@ -1,1 +1,1 @@
1		-XWiki.jonasmayer@sbede
	1	+XWiki.TomAltenbrunn@sbede

Inhalt

...	...	@@ -1,3 +1,9 @@
	1	+{{toc depth="3"/}}
	2	+
	3	+
	4	+= (% style="font-size:22px" %)__**Allgemeines**__(%%) =
	5	+
	6	+
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.
2	2
3	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.
...	...	@@ -11,11 +11,14 @@
11	11	* bis Puppet-Version **1.4.x** : {{code language="bash"}}/var/lib/ld-autoconf/custom/{{/code}}
12	12	* ab Puppet-Version **1.5.x **:  {{code language="bash" layout="LINENUMBERS"}}/data/ld/autoconf/custom/{{/code}}
13	13
	20	+
14	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.
15	15
16		-Der strukturelle Aufbau ist nachfolgend ersichtlich:[[image:image-20230315120842-3.png||height="213" width="640"]]
	23	+__Der strukturelle Aufbau eines AutoConf-Verzeichnisses grafisch dargestellt:__
17	17
	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"]]
18	18
	27	+----
19	19
20	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	21
...	...	@@ -34,18 +34,18 @@
34	34
35	35	----
36	36
37		-==== **Beispielaufbau einer logodidact.yml:** ====
	46	+= (% style="font-size:22px" %)__**Beispielaufbau einer logodidact.yml**__(%%) =
38	38
	48	+
39	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.
40	40
	51	+== (% style="font-size:16px" %)**Beispiel zur Deklaration einer Autoconf Variable in logodidact.yml:**(%%) ==
41	41
42		-**Beispiel zur Deklaration einer Autoconf Variable in logodidact.yml:**
43		-
44	44	(% class="box" %)
45	45	(((
46	46	ld_info:
47	47	display_name: Meine eigene Autoconf-Rolle 1
48		-(% style="color:#27ae60" %) #[...](%%)
	57	+(% style="color:#27ae60" %) # [...](%%)
49	49	\\ vars:
50	50	globalLogLevel:
51	51	display_name: Loglevel
...	...	@@ -56,17 +56,39 @@
56	56	- compact
57	57	- detailed
58	58	- verbose
59		-\\(% style="color:#27ae60" %) #[...]
	68	+\\(% style="color:#27ae60" %) # [...]
60	60	)))
61	61
62	62	(% class="box infomessage" %)
63	63	(((
64		-(% style="font-size:12px" %)**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.
	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.
65	65	)))
66	66
	76	+
67	67	----
68	68
	79	+= (% style="font-size:22px" %)__**Neue AutoConf-Rollen nach Fertigstellung freigeben**__(%%) =
69	69
	81	+
	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	+
	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.
	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	+
	98	+= (% style="font-size:22px" %)__**Weiteres, funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“**__(%%) =
	99	+
	100	+
70	70	Zum besseren Verständnis wird nachfolgend eine mitgelieferte Autoconf-Rolle zur Konfiguration eines WLAN-Profils (SSID inkl. PSK) an Clients näher beleuchtet.
71	71
72	72	(% class="box" %)
...	...	@@ -74,6 +74,8 @@
74	74	root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
75	75	)))
76	76
	108	+== (% style="font-size:16px" %)** Struktureller Aufbau der logodidact.yml:**(%%) ==
	109	+
77	77	(% class="box" %)
78	78	(((
79	79	ld_info:
...	...	@@ -102,13 +102,13 @@
102	102	- LINUX
103	103	)))
104	104
105		-(% style="color:#1abc9c" %)display_name(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
	138	+(% style="color:#1abc9c" %)**display_name**(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
106	106
107		-(% 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/]]
	140	+(% 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/]]
108	108
109		-(% style="color:#f1c40f" %)tags(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
	142	+(% style="color:#f1c40f" %)**tags**(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
110	110
111		-(% style="color:#e74c3c" %)vars(%%) = definiert mögliche Variablen, die den Skripten übergeben werden
	144	+(% style="color:#e74c3c" %)**vars**(%%)** **= definiert mögliche Variablen, die den Skripten übergeben werden
112	112
113	113	* display_name = Name der konfigurierbaren Variable im Control Center
114	114	* optional = bestimmt, ob die Variable zwingend mit einem Wert belegt werden muss
...	...	@@ -115,11 +115,14 @@
115	115	* type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
116	116	* example = Zeigt einen grau eingefärbten Beispieltext innerhalb der definierten Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
117	117
118		-(% 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.
	151	+(% 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.
119	119
120	120
121		-==== **Beispielaufbau der main.ps1** ====
	154	+----
122	122
	156	+===== **Aufbau der main.ps1** =====
	157	+
	158	+
123	123	Im Verzeichnis {{box}} win/ {{/box}} können sich unterschiedliche Powershell-Skripte befinden. In dieser Rolle liegt das allgemeingültige Skript main.ps1 vor.
124	124
125	125	{{code width="50%"}}
...	...	@@ -183,38 +183,16 @@
183	183
184	184	==== ====
185	185
186		-(% class="wikigeneratedid" %)
187	187	==== ====
188	188
189		-(% class="wikigeneratedid" %)
190	190	==== ====
191	191
192		-(% class="wikigeneratedid" %)
193	193	==== ====
194	194
195		-(% class="wikigeneratedid" %)
196	196	==== ====
197	197
198		-(% class="wikigeneratedid" %)
199	199	==== ====
200	200
201		-(% class="wikigeneratedid" %)
202	202	==== ====
203	203
204		-(% class="wikigeneratedid" %)
205	205	==== ====
206		-
207		-==== **Neue AutoConf-Rollen freigeben** ====
208		-
209		-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.
210		-Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
211		-
212		-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.
213		-
214		-(% class="box infomessage" %)
215		-(((
216		-Der Expertenmodus wird in den **Einstellungen (Zahnrad oben rechts) -> Entwickleroptionen -> Expertenmodus aktivieren** aktiv geschaltet.
217		-)))
218		-
219		-[[image:attach:autoconf.png||data-xwiki-image-style-border="true"]]
220		-

autoconf-struktur.PNG

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.TomAltenbrunn@sbede

Größe

...	...	@@ -1,0 +1,1 @@
	1	+36.5 KB

Inhalt