Zum Inhalt springen
Version 27.1 von Jonas Mayer am 2023/03/16 07:48
Zeige letzte Bearbeiter
1 {{toc depth="3"/}}
2
3 ----
4
5
6 = (% style="font-size:22px" %)__**Allgemeines**__(%%) =
7
8
9 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.
10
11 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.
12 Diese fest integrierten Rollen befinden sich im LXC-Container ctrl-g1 im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
13
14 [[image:image-20230315103418-1.png||height="103" width="1344" class="img-thumbnail"]]
15
16
17 Darüber hinaus ist es Partnern und Kunden möglich, für spezielle / anwendungsspezifische Anforderungen eigene Autoconf-Rollen zu erstellen und im LD Control Center mit Clients zu verknüpfen. Dafür steht am LD-Server ein eigenes Verzeichnis zur Verfügung, welches sich ebenfalls im LXC-Container ctrl-g1 befindet und nicht durch Server-Updates beeinflusst oder überschrieben wird. Der genaue Speicherpfad hängt von der Puppet-Version des Servers ab:
18
19 * bis Puppet-Version **1.4.x** : {{code language="bash"}}/var/lib/ld-autoconf/custom/{{/code}}
20 * ab Puppet-Version **1.5.x **:  {{code language="bash" layout="LINENUMBERS"}}/data/ld/autoconf/custom/{{/code}}
21
22 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.
23
24 __Der strukturelle Aufbau eines AutoConf-Verzeichnisses grafisch dargestellt:__
25
26 [[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"]]
27
28 ----
29
30 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:
31
32 * **main.ps1** - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei {{box}}meta/logodidact.yml{{/box}} festgelegt sind
33 * (% style="color:#8e44ad" %)**setup.ps1**(%%) - Skript wird ausschließlich in der SETUP-Phase während des Deployments ausgeführt. In der Setup-Phase ist der Client noch veränderlich und besitzt noch keine Schutzfunktion, selbst wenn der Schutz aktiviert ist.
34 * (% style="color:#8e44ad" %)**custom.ps1**(%%) - Skript wird ausschließlich in der CUSTOM-Phase ausgeführt. Dies geschieht sowohl 1x während des Deployments als auch später nach jedem Hochfahren des PCs 1x im Hintergrund.
35 * (% style="color:#8e44ad" %)**user.ps1**(%%) - Skript wird ausschließlich in der USER-Phase ausgeführt. Diese Phase wird nicht direkt während des Deployments durchlaufen, sondern erst später während der Benutzeranmeldung an betriebsbereiten PCs.
36 * (% style="color:#8e44ad" %)**audit.ps1**(%%) - Skript wird ausschließlich in der AUDIT-Phase ausgeführt. Das bedeutet erst dann, wenn man an einem Client in den Audit-Modus zur Imagebearbeitung wechselt.
37 * **collect.ps1** - Sonderfall. Dieses Skript wird ausgeführt, wenn durch einen Anwender aktiv die Phase COLLECT zum Einsammeln von Einstellungen am Client aufgerufen wird.
38
39 (% class="box warningmessage" %)
40 (((
41 (% style="font-size:12px" %)**Hinweis: **Skripte, die durch ihren Dateinamen auf einzelne Phasen eingeschränkt sind ((% style="color:#8e44ad; font-size:12px" %)lila eingefärbt(% style="font-size:12px" %)), dürfen sich inhaltlich zueinander unterscheiden. Dadurch kann eine Autoconf-Rolle sehr flexibel gestaltet werden und in den verschiedenen Phasen des Deployments unterschiedliche Aktionen ausführen.
42 )))
43
44 ----
45
46
47 = (% style="font-size:22px" %)__**Beispielaufbau einer logodidact.yml**__(%%) =
48
49
50 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.
51
52 == (% style="font-size:16px" %)**Beispiel zur Deklaration einer Autoconf Variable in logodidact.yml**(%%) ==
53
54 (% class="box" %)
55 (((
56 ld_info:
57 display_name: Meine eigene Autoconf-Rolle 1
58 (% style="color:#27ae60" %) # [...](%%)
59 \\ vars:
60 globalLogLevel:
61 display_name: Loglevel
62 optional: true
63 type: ENUM
64 values:
65 - none
66 - compact
67 - detailed
68 - verbose
69 \\(% style="color:#27ae60" %) # [...]
70 )))
71
72 (% class="box infomessage" %)
73 (((
74 **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.
75 )))
76
77 ----
78
79
80 = (% style="font-size:22px" %)__**Neue AutoConf-Rollen nach Fertigstellung freigeben**__(%%) =
81
82
83 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.
84 Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
85
86 Ü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.
87
88 (% class="box infomessage" %)
89 (((
90 Der Expertenmodus wird in den **Einstellungen (Zahnrad oben rechts) -> Entwickleroptionen -> Expertenmodus aktivieren** aktiv geschaltet.
91 )))
92
93 [[image:attach:autoconf.png||data-xwiki-image-style-border="true" class="img-thumbnail"]]
94
95
96 ----
97
98
99
100
101
102
103
104
105
106
107 = (% style="font-size:22px" %)__**Weiteres, funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“**__(%%) =
108
109
110 Zum besseren Verständnis wird nachfolgend eine feste Autoconf-Rolle zur Konfiguration eines WLAN-Profils (SSID inkl. PSK) an Clients näher beleuchtet.
111
112 (% class="box" %)
113 (((
114 root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
115 )))
116
117 == (% style="font-size:16px" %)**Struktureller Aufbau der logodidact.yml**(%%) ==
118
119 (% class="box" %)
120 (((
121 ld_info:
122 authors:
123 - Marcel Petersen
124 company: SBE network solutions GmbH
125 (% style="color:#1abc9c" %) display_name:(%%) WLAN Profil mit PSK anlegen
126 license: SBE
127 (% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
128 visible: true
129 (% style="color:#19177c" %)priority:(%%) 0
130 applyAlways: false
131 (% style="color:#f1c40f" %) tags:(%%)
132 - CUSTOM
133 (% style="color:#e74c3c" %) vars:(%%)
134 ssid:
135 display_name: SSID
136 optional: false
137 type: STRING
138 psk:
139 display_name: Passwort
140 optional: false
141 type: PASSWORD
142 (% style="color:#2980b9" %) systems:(%%)
143 - WINDOWS
144 - LINUX
145 )))
146
147 (% style="color:#1abc9c" %)**display_name**(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
148
149 (% 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/]]
150
151 (% style="color:#19177c" %)**priority**(% style="color:#2980b9" %)** **(%%)= Legt die Verarbeitungsreihenfolge der Autoconf-Rolle gegenüber weiteren Rollen fest, die in derselben Phase ausgeführt werden. Bei gleicher Priorität findet die Abarbeitung alphabetisch statt. Eine höhere Priorität führt zu früherer Ausführung.
152
153 (% style="color:#f1c40f" %)**tags**(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
154
155 (% style="color:#e74c3c" %)**vars**(%%)** **= definiert mögliche Variablen, die den Skripten übergeben werden
156
157 * display_name = Name der konfigurierbaren Variable im Control Center
158 * optional = bestimmt, ob die Variable zwingend mit einem Wert belegt werden muss
159 * type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
160 * example = Zeigt einen grau eingefärbten Beispieltext innerhalb der definierten Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
161
162 (% 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.
163
164 ----
165
166
167 == (% style="font-size:16px" %)**Inhalt des PowerShell-Skripts main.ps1, das die Variablen entgegennimmt**(%%) ==
168
169 Im Unterverzeichnis {{box}} win/ {{/box}} oder {{box}} lin/ {{/box}} der Autoconf-Rolle können sich unterschiedliche PowerShell-Skripte zur Ausführung in den Phasen befinden. In dieser Rolle liegt das allgemeingültige Skript {{box}}main.ps1{{/box}} vor, welches die Variablen als Parameter ##$ssid## und ##$psk## intern verwendet.
170
171 (% class="box" %)
172 (((
173 (% style="color:#27ae60" %)# Windows Variante(%%)
174 root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
175 )))
176
177
178 {{code width="50%"}}
179 Param
180 (
181 [parameter(Mandatory=$false)]
182 [String]
183 $ssid,
184 [parameter(Mandatory=$false)]
185 [String]
186 $psk
187 )
188
189 if ($ssid -ne '' -and $psk -ne '') {
190 $profile = @'
191 <WLANProfile xmlns="http://www.microsoft.com/networking/WLAN/profile/v1">
192 <name>{0}</name>
193 <SSIDConfig>
194 <SSID>
195 <name>{0}</name>
196 </SSID>
197 </SSIDConfig>
198 <connectionType>ESS</connectionType>
199 <connectionMode>auto</connectionMode>
200 <MSM>
201 <security>
202 <authEncryption>
203 <authentication>WPA2PSK</authentication>
204 <encryption>AES</encryption>
205 <useOneX>false</useOneX>
206 </authEncryption>
207 <sharedKey>
208 <keyType>passPhrase</keyType>
209 <protected>false</protected>
210 <keyMaterial>{1}</keyMaterial>
211 </sharedKey>
212 </security>
213 </MSM>
214 </WLANProfile>
215 '@ -f $ssid, $psk
216
217 $file = "$AUTOCONF_TEMP_DIR\ld_wlan_psk\wlan.xml"
218
219 $profile | Out-File (New-Item $file -Force)
220
221 Get-NetAdapter | Where-Object { $_.PhysicalMediaType -eq 'Native 802.11' -or `
222 $_.PhysicalMediaType -eq 'Wireless LAN' -or `
223 $_.PhysicalMediaType -eq 'Wireless WAN' } | ForEach-Object {
224
225 Write-Verbose "Creating wlan profile for '$ssid' on interface '$($_.Name)'"
226 netsh wlan add profile filename= "$file" interface= "$($_.Name)"
227 }
228
229 Remove-Item -Path $file -Force
230 }
231 {{/code}}
232
233 ==== ====
234
235 ==== ====
236
237 ==== ====
238
239 ==== ====
240
241 ==== ====
242
243 ==== ====
244
245 ==== ====
246
247 ==== ====