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