Änderungen von Dokument Eigene Autoconf-Rolle erstellen

Zusammenfassung

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

Details

Seiteneigenschaften

Dokument-Autor

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

Inhalt

...	...	@@ -1,9 +7,3 @@
1		-{{toc depth="3"/}}
2		-
3		-
4		-= (% style="font-size:22px" %)__**Allgemeines**__(%%) =
5		-
6		-
7	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.
8	8
9	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.
...	...	@@ -17,14 +17,11 @@
17	17	* bis Puppet-Version **1.4.x** : {{code language="bash"}}/var/lib/ld-autoconf/custom/{{/code}}
18	18	* ab Puppet-Version **1.5.x **:  {{code language="bash" layout="LINENUMBERS"}}/data/ld/autoconf/custom/{{/code}}
19	19
20		-
21	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.
22	22
23		-__Der strukturelle Aufbau eines AutoConf-Verzeichnisses grafisch dargestellt:__
	16	+Der strukturelle Aufbau ist nachfolgend ersichtlich:[[image:image-20230315120842-3.png||height="213" width="640"]]
24	24
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"]]
26	26
27		-----
28	28
29	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	30
...	...	@@ -43,18 +43,18 @@
43	43
44	44	----
45	45
46		-= (% style="font-size:22px" %)__**Beispielaufbau einer logodidact.yml**__(%%) =
	37	+==== **Beispielaufbau einer logodidact.yml:** ====
47	47
48		-
49	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.
50	50
51		-== (% style="font-size:16px" %)**Beispiel zur Deklaration einer Autoconf Variable in logodidact.yml:**(%%) ==
52	52
	42	+**Beispiel zur Deklaration einer Autoconf Variable in logodidact.yml:**
	43	+
53	53	(% class="box" %)
54	54	(((
55	55	ld_info:
56	56	display_name: Meine eigene Autoconf-Rolle 1
57		-(% style="color:#27ae60" %) # [...](%%)
	48	+(% style="color:#27ae60" %) #[...](%%)
58	58	\\ vars:
59	59	globalLogLevel:
60	60	display_name: Loglevel
...	...	@@ -65,39 +65,17 @@
65	65	- compact
66	66	- detailed
67	67	- verbose
68		-\\(% style="color:#27ae60" %) # [...]
	59	+\\(% style="color:#27ae60" %) #[...]
69	69	)))
70	70
71	71	(% class="box infomessage" %)
72	72	(((
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.
	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.
74	74	)))
75	75
76		-
77	77	----
78	78
79		-= (% style="font-size:22px" %)__**Neue AutoConf-Rollen nach Fertigstellung freigeben**__(%%) =
80	80
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		-
101	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	102
103	103	(% class="box" %)
...	...	@@ -105,8 +105,6 @@
105	105	root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
106	106	)))
107	107
108		-== (% style="font-size:16px" %)** Struktureller Aufbau der logodidact.yml**(%%) ==
109		-
110	110	(% class="box" %)
111	111	(((
112	112	ld_info:
...	...	@@ -135,13 +135,13 @@
135	135	- LINUX
136	136	)))
137	137
138		-(% style="color:#1abc9c" %)**display_name**(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
	105	+(% style="color:#1abc9c" %)display_name(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
139	139
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/]]
	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/]]
141	141
142		-(% style="color:#f1c40f" %)**tags**(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
	109	+(% style="color:#f1c40f" %)tags(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
143	143
144		-(% style="color:#e74c3c" %)**vars**(%%)** **= definiert mögliche Variablen, die den Skripten übergeben werden
	111	+(% style="color:#e74c3c" %)vars(%%) = definiert mögliche Variablen, die den Skripten übergeben werden
145	145
146	146	* display_name = Name der konfigurierbaren Variable im Control Center
147	147	* optional = bestimmt, ob die Variable zwingend mit einem Wert belegt werden muss
...	...	@@ -148,11 +148,10 @@
148	148	* type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
149	149	* example = Zeigt einen grau eingefärbten Beispieltext innerhalb der definierten Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
150	150
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.
	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.
152	152
153		-----
154	154
155		-===== **Aufbau der main.ps1** =====
	121	+==== **Beispielaufbau der main.ps1** ====
156	156
157	157	Im Verzeichnis {{box}} win/ {{/box}} können sich unterschiedliche Powershell-Skripte befinden. In dieser Rolle liegt das allgemeingültige Skript main.ps1 vor.
158	158
...	...	@@ -217,16 +217,38 @@
217	217
218	218	==== ====
219	219
	186	+(% class="wikigeneratedid" %)
220	220	==== ====
221	221
	189	+(% class="wikigeneratedid" %)
222	222	==== ====
223	223
	192	+(% class="wikigeneratedid" %)
224	224	==== ====
225	225
	195	+(% class="wikigeneratedid" %)
226	226	==== ====
227	227
	198	+(% class="wikigeneratedid" %)
228	228	==== ====
229	229
	201	+(% class="wikigeneratedid" %)
230	230	==== ====
231	231
	204	+(% class="wikigeneratedid" %)
232	232	==== ====
	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,1 +1,0 @@
1		-XWiki.TomAltenbrunn@sbede

Größe

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

Inhalt