Zum Inhalt springen

Änderungen von Dokument Eigene Autoconf-Rolle erstellen

Zuletzt geändert von Tom Altenbrunn am 2023/03/17 08:03
Von Version 13.2
bearbeitet von Tom Altenbrunn
am 2023/03/15 12:09
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 12.2
bearbeitet von Tom Altenbrunn
am 2023/03/15 09:51
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,26 +1,17 @@
1 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 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 4  
5 -Vonseiten SBE bereitgestellte Rollen befinden sich im ctrl-g1-Container im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
4 +Von SBE ausgelieferte Rollen befinden sich Im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
6 6  
7 -[[image:image-20230315103418-1.png||height="103" width="1344" class="img-thumbnail"]]
6 +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.
8 8  
8 +Der Aufbau einer Autoconf-Rolle muss einer Struktur folgen, damit der Server diese Interpretieren kann.
9 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.
10 +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.
11 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 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"]]
13 +==== **Beispielaufbau der logodidact.yml:** ====
16 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 24  (% class="box" %)
25 25  (((
26 26  root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
... ... @@ -32,15 +32,15 @@
32 32   authors:
33 33   - Marcel Petersen
34 34   company: SBE network solutions GmbH
35 -(% style="color:#1abc9c" %)display_name:(%%) WLAN Profil mit PSK anlegen
26 + display_name: WLAN Profil mit PSK anlegen
36 36   license: SBE
37 -(% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
28 + uuid: 52318636-c4f5-11ea-baf9-0bff00c66ff4
38 38   visible: true
39 39   priority: 0
40 40   applyAlways: false
41 -(% style="color:#f1c40f" %) tags:(%%)
32 + tags:
42 42   - CUSTOM
43 -(% style="color:#e74c3c" %) vars:(%%)
34 + vars:
44 44   ssid:
45 45   display_name: SSID
46 46   optional: false
... ... @@ -49,27 +49,30 @@
49 49   display_name: Passwort
50 50   optional: false
51 51   type: PASSWORD
52 -(% style="color:#2980b9" %)systems:(%%)
43 + systems:
53 53   - WINDOWS
54 54   - LINUX
55 55  )))
56 56  
57 -(% style="color:#1abc9c" %)display_name(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
48 +display_name = Anzeigename der Autoconf-Rolle im LD Control Center
58 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/]]
50 +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 60  
61 -(% style="color:#f1c40f" %)tags(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
52 +tags = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
62 62  
63 -(% style="color:#e74c3c" %)vars(%%) = definiert mögliche Variablen, die den Skripten übergeben werden
54 +systems = Legt fest, welche Betriebssystem-Typen durch die Autoconf-Rolle unterstützt werden. Gültige Systeme sind: WINDOWS / LINUX
64 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).
56 +vars = definiert mögliche Variablen, die den Skripten übergeben werden
69 69  
70 -(% style="color:#2980b9" %) systems (%%)= Legt fest, welche Betriebssystem-Typen durch die Autoconf-Rolle unterstützt werden. Gültige Systeme sind: WINDOWS / LINUX
58 + ~* display_name = Name der konfigurierbaren Variable im Control Center
71 71  
60 + ~* example = Zeigt einen grau eingefärbten Beispieltext innerhalb Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
72 72  
62 + ~* optional = bestimmt, ob die Variable zwingend mit einem Wert belegt werden muss
63 +
64 + ~* type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
65 +
66 +
73 73  **Beispiel für eine Variable:**
74 74  
75 75  (% class="box" %)
... ... @@ -85,12 +85,8 @@
85 85   - full
86 86  )))
87 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 -)))
82 +(% style="font-size:12px" %)**Tipp:** Der Variablentyp ENUM aus dem Beispiel entspricht einem Dropdown-Menü, in dem man aus vordefinierte Werte auswählen kann:
92 92  
93 -----
94 94  
95 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 96  
... ... @@ -101,17 +101,14 @@
101 101  * (% style="color:#8e44ad" %)**audit.ps1**(%%) - Skript wird ausschließlich in der AUDIT-Phase während des Deployments ausgeführt.
102 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 103  
104 -(% class="box warningmessage" %)
105 -(((
106 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 108  
109 109  
110 110  ==== **Beispielaufbau der main.ps1** ====
111 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.
99 +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.
113 113  
114 -{{code width="50%"}}
101 +{{code}}
115 115  user.ps1 = user Phase, nach der Anmeldung
116 116  
117 117  custom.ps1 = custom Phase
... ... @@ -177,7 +177,7 @@
177 177   Remove-Item -Path $file -Force
178 178  }
179 179  
180 -Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokalen Variablen.
167 +Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokale Variablen.
181 181  {{/code}}
182 182  
183 183  ==== ====
... ... @@ -184,15 +184,10 @@
184 184  
185 185  ==== **Neue AutoConf-Rollen freigeben** ====
186 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.
174 +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.
188 188  Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
189 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.
177 +Betätigen Sie außerdem im LD Control Center (mit aktiviertem Expertenmodus) folgenden Knopf, damit selbst hinzugefügte Autoconf-Rollen verfügbar werden.
191 191  
192 -(% class="box infomessage" %)
193 -(((
194 -Der Expertenmodus wird in den **Einstellungen (Zahnrad oben rechts) -> Entwickleroptionen -> Expertenmodus aktivieren** aktiv geschaltet.
195 -)))
196 -
197 197  [[image:attach:autoconf.png||data-xwiki-image-style-border="true"]]
198 198  
image-20230315103418-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,1 +1,0 @@
1 -25.1 KB
Inhalt
image-20230315120842-3.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,1 +1,0 @@
1 -34.9 KB
Inhalt