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