Zum Inhalt springen
Version 13.2 von Tom Altenbrunn am 2023/03/15 12:09
Zeige letzte Bearbeiter
1 Autoconf liegt wie der Vorgänger Ansible im ctrl-g1 Container und dient dazu, Einstellungen oder Konfigurationen auf bereits deployte Rechner zu übertragen, ohne ein neues Image dafür zu schreiben. Somit lassen sich relativ einfach und flexibel diverse Anpassungen an bestehenden Clients vornehmen.
2
3 Logodidact ist bereits standardmäßig mit zahlreichen eigenen Autoconf-Rollen bestückt, um ein möglichst breites Spektrum verschiedenster Anforderungen des allgemeinen Schulbetriebs abzudecken.
4
5 Vonseiten SBE bereitgestellte Rollen befinden sich im ctrl-g1-Container im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
6
7 [[image:image-20230315103418-1.png||height="103" width="1344" class="img-thumbnail"]]
8
9
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.
11
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
15 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. Der strukturelle Aufbau ist nachfolgend ersichtlich:[[image:image-20230315120842-3.png||height="213" width="640"]]
16
17 ----
18
19 ==== **Beispielaufbau einer logodidact.yml:** ====
20
21 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.
22
23
24 (% class="box" %)
25 (((
26 root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
27 )))
28
29 (% class="box" %)
30 (((
31 ld_info:
32 authors:
33 - Marcel Petersen
34 company: SBE network solutions GmbH
35 (% style="color:#1abc9c" %)display_name:(%%) WLAN Profil mit PSK anlegen
36 license: SBE
37 (% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
38 visible: true
39 priority: 0
40 applyAlways: false
41 (% style="color:#f1c40f" %) tags:(%%)
42 - CUSTOM
43 (% style="color:#e74c3c" %) vars:(%%)
44 ssid:
45 display_name: SSID
46 optional: false
47 type: STRING
48 psk:
49 display_name: Passwort
50 optional: false
51 type: PASSWORD
52 (% style="color:#2980b9" %)systems:(%%)
53 - WINDOWS
54 - LINUX
55 )))
56
57 (% style="color:#1abc9c" %)display_name(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
58
59 (% 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/]]
60
61 (% style="color:#f1c40f" %)tags(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
62
63 (% style="color:#e74c3c" %)vars(%%) = definiert mögliche Variablen, die den Skripten übergeben werden
64
65 * display_name = Name der konfigurierbaren Variable im Control Center
66 * optional = bestimmt, ob die Variable zwingend mit einem Wert belegt werden muss
67 * type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
68 * example = Zeigt einen grau eingefärbten Beispieltext innerhalb der definierten Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
69
70 (% style="color:#2980b9" %) systems (%%)= Legt fest, welche Betriebssystem-Typen durch die Autoconf-Rolle unterstützt werden. Gültige Systeme sind: WINDOWS / LINUX
71
72
73 **Beispiel für eine Variable:**
74
75 (% class="box" %)
76 (((
77 globalLogLevel:
78 display_name: Loglevel
79 optional: true
80 type: ENUM
81 values:
82 - none
83 - compact
84 - detailed
85 - full
86 )))
87
88 (% class="box infomessage" %)
89 (((
90 (% style="font-size:12px" %)**Tipp:** Der Variablentyp ENUM aus dem Beispiel entspricht einem Dropdown-Menü, in dem man aus vordefinierten Werten auswählen kann
91 )))
92
93 ----
94
95 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:
96
97 * **main.ps1** - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei {{box}}meta/logodidact.yml{{/box}} festgelegt sind
98 * (% style="color:#8e44ad" %)**setup.ps1**(%%) - Skript wird ausschließlich in der SETUP-Phase während des Deployments ausgeführt.
99 * (% style="color:#8e44ad" %)**custom.ps1**(%%) - Skript wird ausschließlich in der CUSTOM-Phase während des Deployments ausgeführt.
100 * (% style="color:#8e44ad" %)**user.ps1**(%%) - Skript wird ausschließlich in der USER-Phase während des Deployments ausgeführt.
101 * (% style="color:#8e44ad" %)**audit.ps1**(%%) - Skript wird ausschließlich in der AUDIT-Phase während des Deployments ausgeführt.
102 * **collect.ps1** - Sonderfall. Dieses Skript wird ausgeführt, wenn durch einen Anwender aktiv die Phase COLLECT zum Einsammeln von Einstellungen am Client aufgerufen werden.
103
104 (% class="box warningmessage" %)
105 (((
106 (% 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.
107 )))
108
109
110 ==== **Beispielaufbau der main.ps1** ====
111
112 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.
113
114 {{code width="50%"}}
115 user.ps1 = user Phase, nach der Anmeldung
116
117 custom.ps1 = custom Phase
118
119 audit.ps1 = audit Phase
120
121 setup.ps1 = setup Phase
122
123 main.ps1 = alle Phasen
124
125 root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
126
127 Param
128 (
129 [parameter(Mandatory=$false)]
130 [String]
131 $ssid,
132 [parameter(Mandatory=$false)]
133 [String]
134 $psk
135 )
136
137 if ($ssid -ne '' -and $psk -ne '') {
138 $profile = @'
139 <WLANProfile xmlns="http://www.microsoft.com/networking/WLAN/profile/v1">
140 <name>{0}</name>
141 <SSIDConfig>
142 <SSID>
143 <name>{0}</name>
144 </SSID>
145 </SSIDConfig>
146 <connectionType>ESS</connectionType>
147 <connectionMode>auto</connectionMode>
148 <MSM>
149 <security>
150 <authEncryption>
151 <authentication>WPA2PSK</authentication>
152 <encryption>AES</encryption>
153 <useOneX>false</useOneX>
154 </authEncryption>
155 <sharedKey>
156 <keyType>passPhrase</keyType>
157 <protected>false</protected>
158 <keyMaterial>{1}</keyMaterial>
159 </sharedKey>
160 </security>
161 </MSM>
162 </WLANProfile>
163 '@ -f $ssid, $psk
164
165 $file = "$AUTOCONF_TEMP_DIR\ld_wlan_psk\wlan.xml"
166
167 $profile | Out-File (New-Item $file -Force)
168
169 Get-NetAdapter | Where-Object { $_.PhysicalMediaType -eq 'Native 802.11' -or `
170 $_.PhysicalMediaType -eq 'Wireless LAN' -or `
171 $_.PhysicalMediaType -eq 'Wireless WAN' } | ForEach-Object {
172
173 Write-Verbose "Creating wlan profile for '$ssid' on interface '$($_.Name)'"
174 netsh wlan add profile filename= "$file" interface= "$($_.Name)"
175 }
176
177 Remove-Item -Path $file -Force
178 }
179
180 Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokalen Variablen.
181 {{/code}}
182
183 ==== ====
184
185 ==== **Neue AutoConf-Rollen freigeben** ====
186
187 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.
188 Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
189
190 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.
191
192 (% class="box infomessage" %)
193 (((
194 Der Expertenmodus wird in den **Einstellungen (Zahnrad oben rechts) -> Entwickleroptionen -> Expertenmodus aktivieren** aktiv geschaltet.
195 )))
196
197 [[image:attach:autoconf.png||data-xwiki-image-style-border="true"]]
198