Eigene Autoconf-Rolle erstellen

1

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.

2

3

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.

4

Diese fest integrierten Rollen befinden sich im LXC-Container ctrl-g1 im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.

5

6

[[image:image-20230315103418-1.png||height="103" width="1344" class="img-thumbnail"]]

7

8

9

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:

10

11

* bis Puppet-Version **1.4.x** : {{code language="bash"}}/var/lib/ld-autoconf/custom/{{/code}}

12

* ab Puppet-Version **1.5.x **: {{code language="bash" layout="LINENUMBERS"}}/data/ld/autoconf/custom/{{/code}}

13

14

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 ausführbaren Skript-Dateien (PowerShell oder Bash). 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. mitzugeben.

15

16

Der strukturelle Aufbau ist nachfolgend ersichtlich:[[image:image-20230315120842-3.png||height="213" width="640"]]

----

==== **Beispielaufbau einer logodidact.yml:** ====

21

22

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.

23

24

25

Zum besseren Verständnis wird nachfolgend eine mitgelieferte Autoconf-Rolle zur Konfiguration eines WLAN-Profils (SSID inkl. PSK) an Clients näher beleuchtet.

(% class="box" %)

(((

root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml

)))

(% class="box" %)

(((

ld_info:

authors:

- Marcel Petersen

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

visible: true

priority: 0

applyAlways: false

(% style="color:#f1c40f" %) tags:(%%)

45

- CUSTOM

46

(% style="color:#e74c3c" %) vars:(%%)

ssid:

display_name: SSID

optional: false

type: STRING

psk:

display_name: Passwort

53

optional: false

54

type: PASSWORD

55

(% style="color:#2980b9" %)systems:(%%)

- WINDOWS

- LINUX

)))

(% 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:**

(% class="box" %)

(((

globalLogLevel:

display_name: Loglevel

optional: true

type: ENUM

values:

- none

- compact

- detailed

- verbose

)))

(% class="box infomessage" %)

92

(((

93

(% style="font-size:12px" %)**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.

)))

----

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. Für diese Skripte 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 ausgeführt. Dies geschieht sowohl 1x während des Deployments als auch später nach jedem Hochfahren des PCs im Hintergrund.

103

* (% 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.

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 wird.

106

107

(% class="box warningmessage" %)

108

(((

109

(% 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.

)))

==== **Beispielaufbau der main.ps1** ====

114

115

Im Verzeichnis {{box}} win/ {{/box}} 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

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

Param

(

[parameter(Mandatory=$false)]

133

[String]

134

$ssid,

135

[parameter(Mandatory=$false)]

[String]

$psk

)

if ($ssid -ne '' -and $psk -ne '') {

$profile = @'

<SSID>

</SSID>

</SSIDConfig>

<MSM>

<useOneX>false</useOneX>

157

</authEncryption>

158

159

<keyType>passPhrase</keyType>

160

<protected>false</protected>

</sharedKey>

</security>

</MSM>

</WLANProfile>

'@ -f $ssid, $psk

$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.

==== ====

==== **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

Wiki-Quellcode von Eigene Autoconf-Rolle erstellen