Zum Inhalt springen

Änderungen von Dokument Eigene Autoconf-Rolle erstellen

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

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,17 +1,29 @@
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.
3 3  
4 -Von SBE ausgelieferte Rollen befinden sich Im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
5 +Vonseiten SBE bereitgestellte Rollen befinden sich im ctrl-g1-Container im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
5 5  
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.
7 +[[image:image-20230315103418-1.png||height="103" width="1344" class="img-thumbnail"]]
7 7  
8 -Der Aufbau einer Autoconf-Rolle muss einer Struktur folgen, damit der Server diese Interpretieren kann.
9 9  
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.
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 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}}
12 12  
13 -==== **Beispielaufbau der logodidact.yml:** ====
14 14  
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 +
15 15  (% class="box" %)
16 16  (((
17 17  root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
... ... @@ -23,15 +23,15 @@
23 23   authors:
24 24   - Marcel Petersen
25 25   company: SBE network solutions GmbH
26 - display_name: WLAN Profil mit PSK anlegen
38 +(% style="color:#1abc9c" %)display_name:(%%) WLAN Profil mit PSK anlegen
27 27   license: SBE
28 - uuid: 52318636-c4f5-11ea-baf9-0bff00c66ff4
40 +(% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
29 29   visible: true
30 30   priority: 0
31 31   applyAlways: false
32 - tags:
44 +(% style="color:#f1c40f" %) tags:(%%)
33 33   - CUSTOM
34 - vars:
46 +(% style="color:#e74c3c" %) vars:(%%)
35 35   ssid:
36 36   display_name: SSID
37 37   optional: false
... ... @@ -40,30 +40,27 @@
40 40   display_name: Passwort
41 41   optional: false
42 42   type: PASSWORD
43 - systems:
55 +(% style="color:#2980b9" %)systems:(%%)
44 44   - WINDOWS
45 45   - LINUX
46 46  )))
47 47  
48 -display_name = Anzeigename der Autoconf-Rolle im LD Control Center
60 +(% style="color:#1abc9c" %)display_name(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
49 49  
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/]]
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/]]
51 51  
52 -tags = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
64 +(% style="color:#f1c40f" %)tags(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
53 53  
54 -systems = Legt fest, welche Betriebssystem-Typen durch die Autoconf-Rolle unterstützt werden. Gültige Systeme sind: WINDOWS / LINUX
66 +(% style="color:#e74c3c" %)vars(%%) = definiert mögliche Variablen, die den Skripten übergeben werden
55 55  
56 -vars = definiert mögliche Variablen, die den Skripten übergeben werden
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).
57 57  
58 - ~* display_name = Name der konfigurierbaren Variable im Control Center
73 +(% style="color:#2980b9" %) systems (%%)= Legt fest, welche Betriebssystem-Typen durch die Autoconf-Rolle unterstützt werden. Gültige Systeme sind: WINDOWS / LINUX
59 59  
60 - ~* example = Zeigt einen grau eingefärbten Beispieltext innerhalb Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
61 61  
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 -
67 67  **Beispiel für eine Variable:**
68 68  
69 69  (% class="box" %)
... ... @@ -79,8 +79,12 @@
79 79   - full
80 80  )))
81 81  
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:
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 +)))
83 83  
96 +----
84 84  
85 85  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:
86 86  
... ... @@ -91,14 +91,17 @@
91 91  * (% style="color:#8e44ad" %)**audit.ps1**(%%) - Skript wird ausschließlich in der AUDIT-Phase während des Deployments ausgeführt.
92 92  * **collect.ps1** - Sonderfall. Dieses Skript wird ausgeführt, wenn durch einen Anwender aktiv die Phase COLLECT zum Einsammeln von Einstellungen am Client aufgerufen werden.
93 93  
107 +(% class="box warningmessage" %)
108 +(((
94 94  (% 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 +)))
95 95  
96 96  
97 97  ==== **Beispielaufbau der main.ps1** ====
98 98  
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.
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.
100 100  
101 -{{code}}
117 +{{code width="50%"}}
102 102  user.ps1 = user Phase, nach der Anmeldung
103 103  
104 104  custom.ps1 = custom Phase
... ... @@ -164,7 +164,7 @@
164 164   Remove-Item -Path $file -Force
165 165  }
166 166  
167 -Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokale Variablen.
183 +Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokalen Variablen.
168 168  {{/code}}
169 169  
170 170  ==== ====
... ... @@ -171,10 +171,15 @@
171 171  
172 172  ==== **Neue AutoConf-Rollen freigeben** ====
173 173  
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.
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.
175 175  Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
176 176  
177 -Betätigen Sie außerdem im LD Control Center (mit aktiviertem Expertenmodus) folgenden Knopf, damit selbst hinzugefügte Autoconf-Rollen verfügbar werden.
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.
178 178  
195 +(% class="box infomessage" %)
196 +(((
197 +Der Expertenmodus wird in den **Einstellungen (Zahnrad oben rechts) -> Entwickleroptionen -> Expertenmodus aktivieren** aktiv geschaltet.
198 +)))
199 +
179 179  [[image:attach:autoconf.png||data-xwiki-image-style-border="true"]]
180 180  
image-20230315103418-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,0 +1,1 @@
1 +25.1 KB
Inhalt