Zum Inhalt springen
Version 21.1 von Jonas Mayer am 2023/03/15 21:26
Zeige letzte Bearbeiter
1 {{toc depth="3"/}}
2
3
4 = (% style="font-size:22px" %)__**Allgemeines**__(%%) =
5
6
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
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.
10 Diese fest integrierten Rollen befinden sich im LXC-Container ctrl-g1 im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
11
12 [[image:image-20230315103418-1.png||height="103" width="1344" class="img-thumbnail"]]
13
14
15 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:
16
17 * bis Puppet-Version **1.4.x** : {{code language="bash"}}/var/lib/ld-autoconf/custom/{{/code}}
18 * ab Puppet-Version **1.5.x **:  {{code language="bash" layout="LINENUMBERS"}}/data/ld/autoconf/custom/{{/code}}
19
20 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.
21
22 __Der strukturelle Aufbau eines AutoConf-Verzeichnisses grafisch dargestellt:__
23
24 [[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"]]
25
26 ----
27
28 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:
29
30 * **main.ps1** - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei {{box}}meta/logodidact.yml{{/box}} festgelegt sind
31 * (% 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.
32 * (% 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.
33 * (% 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.
34 * (% 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.
35 * **collect.ps1** - Sonderfall. Dieses Skript wird ausgeführt, wenn durch einen Anwender aktiv die Phase COLLECT zum Einsammeln von Einstellungen am Client aufgerufen wird.
36
37 (% class="box warningmessage" %)
38 (((
39 (% 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.
40 )))
41
42
43 ----
44
45 = (% style="font-size:22px" %)__**Beispielaufbau einer logodidact.yml**__(%%) =
46
47
48 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.
49
50 == (% style="font-size:16px" %)**Beispiel zur Deklaration einer Autoconf Variable in logodidact.yml**(%%) ==
51
52 (% class="box" %)
53 (((
54 ld_info:
55 display_name: Meine eigene Autoconf-Rolle 1
56 (% style="color:#27ae60" %) # [...](%%)
57 \\ vars:
58 globalLogLevel:
59 display_name: Loglevel
60 optional: true
61 type: ENUM
62 values:
63 - none
64 - compact
65 - detailed
66 - verbose
67 \\(% style="color:#27ae60" %) # [...]
68 )))
69
70 (% class="box infomessage" %)
71 (((
72 **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 )))
74
75
76 ----
77
78 = (% style="font-size:22px" %)__**Neue AutoConf-Rollen nach Fertigstellung freigeben**__(%%) =
79
80
81 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.
82 Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
83
84 Ü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.
85
86 (% class="box infomessage" %)
87 (((
88 Der Expertenmodus wird in den **Einstellungen (Zahnrad oben rechts) -> Entwickleroptionen -> Expertenmodus aktivieren** aktiv geschaltet.
89 )))
90
91 [[image:attach:autoconf.png||data-xwiki-image-style-border="true" class="img-thumbnail"]]
92
93
94
95 ----
96
97 = (% style="font-size:22px" %)__**Weiteres, funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“**__(%%) =
98
99
100 Zum besseren Verständnis wird nachfolgend eine feste Autoconf-Rolle zur Konfiguration eines WLAN-Profils (SSID inkl. PSK) an Clients näher beleuchtet.
101
102 (% class="box" %)
103 (((
104 root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
105 )))
106
107 == (% style="font-size:16px" %)** Struktureller Aufbau der logodidact.yml**(%%) ==
108
109 (% class="box" %)
110 (((
111 ld_info:
112 authors:
113 - Marcel Petersen
114 company: SBE network solutions GmbH
115 (% style="color:#1abc9c" %)display_name:(%%) WLAN Profil mit PSK anlegen
116 license: SBE
117 (% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
118 visible: true
119 priority: 0
120 applyAlways: false
121 (% style="color:#f1c40f" %) tags:(%%)
122 - CUSTOM
123 (% style="color:#e74c3c" %) vars:(%%)
124 ssid:
125 display_name: SSID
126 optional: false
127 type: STRING
128 psk:
129 display_name: Passwort
130 optional: false
131 type: PASSWORD
132 (% style="color:#2980b9" %)systems:(%%)
133 - WINDOWS
134 - LINUX
135 )))
136
137 (% style="color:#1abc9c" %)**display_name**(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
138
139 (% 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
141 (% style="color:#f1c40f" %)**tags**(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
142
143 (% style="color:#e74c3c" %)**vars**(%%)** **= definiert mögliche Variablen, die den Skripten übergeben werden
144
145 * display_name = Name der konfigurierbaren Variable im Control Center
146 * optional = bestimmt, ob die Variable zwingend mit einem Wert belegt werden muss
147 * type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
148 * example = Zeigt einen grau eingefärbten Beispieltext innerhalb der definierten Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
149
150 (% 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
152
153 ----
154
155 ===== **Aufbau der main.ps1** =====
156
157
158 Im Verzeichnis {{box}} win/ {{/box}} können sich unterschiedliche Powershell-Skripte befinden. In dieser Rolle liegt das allgemeingültige Skript main.ps1 vor.
159
160 {{code width="50%"}}
161 root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
162
163 Param
164 (
165 [parameter(Mandatory=$false)]
166 [String]
167 $ssid,
168 [parameter(Mandatory=$false)]
169 [String]
170 $psk
171 )
172
173 if ($ssid -ne '' -and $psk -ne '') {
174 $profile = @'
175 <WLANProfile xmlns="http://www.microsoft.com/networking/WLAN/profile/v1">
176 <name>{0}</name>
177 <SSIDConfig>
178 <SSID>
179 <name>{0}</name>
180 </SSID>
181 </SSIDConfig>
182 <connectionType>ESS</connectionType>
183 <connectionMode>auto</connectionMode>
184 <MSM>
185 <security>
186 <authEncryption>
187 <authentication>WPA2PSK</authentication>
188 <encryption>AES</encryption>
189 <useOneX>false</useOneX>
190 </authEncryption>
191 <sharedKey>
192 <keyType>passPhrase</keyType>
193 <protected>false</protected>
194 <keyMaterial>{1}</keyMaterial>
195 </sharedKey>
196 </security>
197 </MSM>
198 </WLANProfile>
199 '@ -f $ssid, $psk
200
201 $file = "$AUTOCONF_TEMP_DIR\ld_wlan_psk\wlan.xml"
202
203 $profile | Out-File (New-Item $file -Force)
204
205 Get-NetAdapter | Where-Object { $_.PhysicalMediaType -eq 'Native 802.11' -or `
206 $_.PhysicalMediaType -eq 'Wireless LAN' -or `
207 $_.PhysicalMediaType -eq 'Wireless WAN' } | ForEach-Object {
208
209 Write-Verbose "Creating wlan profile for '$ssid' on interface '$($_.Name)'"
210 netsh wlan add profile filename= "$file" interface= "$($_.Name)"
211 }
212
213 Remove-Item -Path $file -Force
214 }
215
216 Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokalen Variablen.
217 {{/code}}
218
219 ==== ====
220
221 ==== ====
222
223 ==== ====
224
225 ==== ====
226
227 ==== ====
228
229 ==== ====
230
231 ==== ====
232
233 ==== ====