Zum Inhalt springen

Änderungen von Dokument Eigene Autoconf-Rolle erstellen

Zuletzt geändert von Tom Altenbrunn am 2023/03/17 08:03
Von Version 15.1
bearbeitet von Jonas Mayer
am 2023/03/15 13:23
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 4.1
bearbeitet von Christian Germann
am 2022/10/04 10:52
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -Eigene Autoconf-Rolle erstellen
1 +Eigene Autoconf-Regel erstellen
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.jonasmayer@sbede
1 +XWiki.cge@sbede
Inhalt
... ... @@ -1,76 +1,18 @@
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.
1 +Autoconf liegt wie der Vorgänger Ansible im ctrl-g1 Container und dient dazu Einstellungen oder Konfigurationen auf die deployten Rechner ohne ein Image dafür zu schreiben.
2 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}}.
3 +Von SBE ausgelieferte Rollen befinden sich Im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
5 5  
6 -[[image:image-20230315103418-1.png||height="103" width="1344" class="img-thumbnail"]]
5 +Selbst erstellte Autoconf-Rollen müssen unter {{box}}/var/lib/ld-autoconf/custom/{{/box}} abgelegt werden, damit diese nicht durch Updates überschrieben werden.
7 7  
7 +Der Aufbau einer Autoconf-Regel muss einer Struktur folgen, damit der Server diese Interpretieren kann.
8 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:
9 +Unterhalb der Regel muss ein Ordner mit Namen {{box}}meta{{/box}} mit einer {{box}}logodidact.yml{{/box}} liegen.
10 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 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 zugehörige Skript-Dateien (PowerShell). 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.
12 +==== **Beispielaufbau der logodidact.yml:** ====
15 15  
16 -Der strukturelle Aufbau ist nachfolgend ersichtlich:[[image:image-20230315120842-3.png||height="213" width="640"]]
17 -
18 -
19 -
20 -Für die Funktionalität der Autoconf-Rolle ist es also nötig, PowerShell-Skripte am Server abzuspeichern, die die Instruktionen an den Arbeitsstationen ausführen. Für diese Skripte sind folgende Dateinamen zulässig:
21 -
22 -* **main.ps1** - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei {{box}}meta/logodidact.yml{{/box}} festgelegt sind
23 -* (% style="color:#8e44ad" %)**setup.ps1**(%%) - Skript wird ausschließlich in der SETUP-Phase während des Deployments ausgeführt. In der Setup-Phase ist der Client noch veränderlich und besitzt noch keine Schutzfunktion, selbst wenn der Schutz aktiviert ist.
24 -* (% 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 1x im Hintergrund.
25 -* (% 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.
26 -* (% style="color:#8e44ad" %)**audit.ps1**(%%) - Skript wird ausschließlich in der AUDIT-Phase ausgeführt. Das bedeutet, erst dann, wenn man an einem Client in den Audit-Modus zur Imagebearbeitung wechselt.
27 -* **collect.ps1** - Sonderfall. Dieses Skript wird ausgeführt, wenn durch einen Anwender aktiv die Phase COLLECT zum Einsammeln von Einstellungen am Client aufgerufen wird.
28 -
29 -(% class="box warningmessage" %)
30 -(((
31 -(% 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.
32 -)))
33 -
34 -
35 -----
36 -
37 -==== **Beispielaufbau einer logodidact.yml:** ====
38 -
39 -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.
40 -
41 -
42 -**Beispiel zur Deklaration einer Autoconf Variable in logodidact.yml:**
43 -
44 44  (% class="box" %)
45 45  (((
46 -ld_info:
47 - display_name: Meine eigene Autoconf-Rolle 1
48 -(% style="color:#27ae60" %) #[...](%%)
49 -\\ vars:
50 - globalLogLevel:
51 - display_name: Loglevel
52 - optional: true
53 - type: ENUM
54 - values:
55 - - none
56 - - compact
57 - - detailed
58 - - verbose
59 -\\(% style="color:#27ae60" %) #[...]
60 -)))
61 -
62 -(% class="box infomessage" %)
63 -(((
64 -(% 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.
65 -)))
66 -
67 -----
68 -
69 -
70 -Zum besseren Verständnis wird nachfolgend eine mitgelieferte Autoconf-Rolle zur Konfiguration eines WLAN-Profils (SSID inkl. PSK) an Clients näher beleuchtet.
71 -
72 -(% class="box" %)
73 -(((
74 74  root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
75 75  )))
76 76  
... ... @@ -80,15 +80,15 @@
80 80   authors:
81 81   - Marcel Petersen
82 82   company: SBE network solutions GmbH
83 -(% style="color:#1abc9c" %)display_name:(%%) WLAN Profil mit PSK anlegen
25 + display_name: WLAN Profil mit PSK anlegen
84 84   license: SBE
85 -(% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
27 + uuid: 52318636-c4f5-11ea-baf9-0bff00c66ff4
86 86   visible: true
87 87   priority: 0
88 88   applyAlways: false
89 -(% style="color:#f1c40f" %) tags:(%%)
31 + tags:
90 90   - CUSTOM
91 -(% style="color:#e74c3c" %) vars:(%%)
33 + vars:
92 92   ssid:
93 93   display_name: SSID
94 94   optional: false
... ... @@ -97,32 +97,60 @@
97 97   display_name: Passwort
98 98   optional: false
99 99   type: PASSWORD
100 -(% style="color:#2980b9" %)systems:(%%)
42 + systems:
101 101   - WINDOWS
102 102   - LINUX
103 103  )))
104 104  
105 -(% style="color:#1abc9c" %)display_name(%%) = Anzeigename der Autoconf-Rolle im LD Control Center
47 +uuid = ID der Autoconf-Regel, muss einmalig sein. Bei einer eigenen Autoconf-Regel sollte der Wert am besten neugeneriert werden. [[https:~~/~~/www.uuidgenerator.net/>>url:https://www.uuidgenerator.net/]]
106 106  
107 -(% 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/]]
49 +tags = beschreibt in welcher Phase die Autoconf-Regel aktiv ist.
108 108  
109 -(% style="color:#f1c40f" %)tags(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
51 +vars = definiert Variablen die den Skripten übergeben werden
110 110  
111 -(% style="color:#e74c3c" %)vars(%%) = definiert mögliche Variablen, die den Skripten übergeben werden
53 +display_name = Name der Variable im ctrl
112 112  
113 -* display_name = Name der konfigurierbaren Variable im Control Center
114 -* optional = bestimmt, ob die Variable zwingend mit einem Wert belegt werden muss
115 -* type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
116 -* example = Zeigt einen grau eingefärbten Beispieltext innerhalb der definierten Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
55 +optional = bestimmt ob die Option in der Autoconf-Regel  optional ist
117 117  
118 -(% style="color:#2980b9" %) systems (%%)= Legt fest, welche Betriebssystem-Typen durch die Autoconf-Rolle unterstützt werden. Gültige Systeme sind WINDOWS / LINUX. Die Rolle aus dem Beispiel unterstützt beide Betriebssysteme gleichzeitig.
57 +type = bestimmt den Wert der Variable. Mögliche Werte STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
58 +ENUM entspricht einem Dropdown-Menü, in dem man aus vordefinierte Werte auswählen kann:
119 119  
60 +(% class="box" %)
61 +(((
62 +globalLogLevel:
63 + display_name: Loglevel
64 + optional: true
65 + type: ENUM
66 + values:
67 + - none
68 + - compact
69 + - detailed
70 + - full
71 +)))
120 120  
73 +example = Gibt eine grauen Beispielwert für die Variable vor.
74 +
75 +systems = für welches Betriebssystem existieren Skripte in der Autoconf-Regel
76 +
77 +
78 +Die eigentliche Skripte liegen direkt unterhalb der Autoconf-Regel im Verzeichnis {{box}}win{{/box}} neben dem Ordner {{box}}meta{{/box}}. Dort kann das Script main.ps1 heißen oder je nach dem in welcher Phase des Deployment es ausgeführt werden soll auch custom.ps1, setup.ps1, audit.ps1.
79 +
80 +
121 121  ==== **Beispielaufbau der main.ps1** ====
122 122  
123 -Im Verzeichnis {{box}} win/ {{/box}} können sich unterschiedliche Powershell-Skripte befinden. In dieser Rolle liegt das allgemeingültige Skript main.ps1 vor.
83 +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.
124 124  
125 -{{code width="50%"}}
85 +{{code}}
86 +user.ps1 = user Phase, nach der Anmeldung
87 +
88 +custom.ps1 = custom Phase
89 +
90 +audit.ps1 = audit Phase
91 +
92 +setup.ps1 = setup Phase
93 +
94 +main.ps1 = alle Phasen
95 +
126 126  root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
127 127  
128 128  Param
... ... @@ -178,43 +178,16 @@
178 178   Remove-Item -Path $file -Force
179 179  }
180 180  
181 -Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokalen Variablen.
151 +Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokale Variablen.
182 182  {{/code}}
183 183  
184 184  ==== ====
185 185  
186 -(% class="wikigeneratedid" %)
187 -==== ====
156 +==== **Neue AutoConf-Regel freigeben** ====
188 188  
189 -(% class="wikigeneratedid" %)
190 -==== ====
158 +Neue Autoconf-Regel müssen mit dem Befehl {{box}}update-autoconf-archive{{/box}} eingelesen werden. 
159 +Ansonsten werden die Autoconfrollen auch zeitbasiert (Alle 4 Stunden) neu eingelesen.
160 +Drücken Sie Im Controlcenter mit aktivieren Expertenmodus folgenden Knopfen, damit dort auch die neuen Autoconf-Regeln verfügbar werden.
191 191  
192 -(% class="wikigeneratedid" %)
193 -==== ====
194 -
195 -(% class="wikigeneratedid" %)
196 -==== ====
197 -
198 -(% class="wikigeneratedid" %)
199 -==== ====
200 -
201 -(% class="wikigeneratedid" %)
202 -==== ====
203 -
204 -(% class="wikigeneratedid" %)
205 -==== ====
206 -
207 -==== **Neue AutoConf-Rollen freigeben** ====
208 -
209 -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.
210 -Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
211 -
212 -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.
213 -
214 -(% class="box infomessage" %)
215 -(((
216 -Der Expertenmodus wird in den **Einstellungen (Zahnrad oben rechts) -> Entwickleroptionen -> Expertenmodus aktivieren** aktiv geschaltet.
217 -)))
218 -
219 219  [[image:attach:autoconf.png||data-xwiki-image-style-border="true"]]
220 220  
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