Zum Inhalt springen

Änderungen von Dokument Eigene Autoconf-Rolle erstellen

Zuletzt geändert von Tom Altenbrunn am 2023/03/17 08:03
Von Version 28.1
bearbeitet von Jonas Mayer
am 2023/03/16 07:55
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 41.2
bearbeitet von Tom Altenbrunn
am 2023/03/16 10:53
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.jonasmayer@sbede
1 +XWiki.TomAltenbrunn@sbede
Inhalt
... ... @@ -2,7 +2,6 @@
2 2  
3 3  ----
4 4  
5 -
6 6  = (% style="font-size:22px" %)__**Allgemeines**__(%%) =
7 7  
8 8  
... ... @@ -9,7 +9,7 @@
9 9  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.
10 10  
11 11  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.
12 -Diese fest integrierten Rollen befinden sich im LXC-Container ctrl-g1 im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
11 +Diese fest integrierten Rollen befinden sich im LXC-Container ctrl-g1 im Pfad (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container">/usr/lib/ld-autoconf/logodidact/roles/{{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}(%%).
13 13  
14 14  [[image:image-20230315103418-1.png||height="103" width="1344" class="img-thumbnail"]]
15 15  
... ... @@ -19,7 +19,7 @@
19 19  * bis Puppet-Version **1.4.x** : {{code language="bash"}}/var/lib/ld-autoconf/custom/{{/code}}
20 20  * ab Puppet-Version **1.5.x **:  {{code language="bash" layout="LINENUMBERS"}}/data/ld/autoconf/custom/{{/code}}
21 21  
22 -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.
21 +Der Aufbau einer Autoconf-Rolle unterliegt einer vordefinierten Struktur, bestehend aus einer Beschreibungsdatei (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container">meta/logodidact.yml{{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 (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container"> win/ {{box}} win/ {{/box}}(%%) (//Windows//) oder (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container"> lin/ {{box}} lin/ {{/box}}(%%) (//Linux//) abgespeichert sein. Zusätzlich besteht auch die Möglichkeit, in einem weiteren Unterordner (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container"> files/ {{box}} files/ {{/box}}(%%) beliebige Dateien in der Autoconf-Rolle mitzuliefern, wie zum Beispiel Bilder, Videos, etc.
23 23  
24 24  __Der strukturelle Aufbau eines AutoConf-Verzeichnisses grafisch dargestellt:__
25 25  
... ... @@ -29,7 +29,7 @@
29 29  
30 30  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:
31 31  
32 -* **main.ps1** - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei {{box}}meta/logodidact.yml{{/box}} festgelegt sind
31 +* **main.ps1** - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container">meta/logodidact.yml{{box}}meta/logodidact.yml{{/box}}(%%) festgelegt sind
33 33  * (% 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.
34 34  * (% 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.
35 35  * (% 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.
... ... @@ -47,7 +47,7 @@
47 47  = (% style="font-size:22px" %)__**Beispielaufbau einer logodidact.yml**__(%%) =
48 48  
49 49  
50 -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.
49 +Eine Autoconf-Beispielvorlage liegt serverseitig im Unterordner (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container">/data/ld/autoconf/custom/example/{{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.
51 51  
52 52  == (% style="font-size:16px" %)**Beispiel zur Deklaration einer Autoconf Variable in logodidact.yml**(%%) ==
53 53  
... ... @@ -80,7 +80,7 @@
80 80  = (% style="font-size:22px" %)__**Neue AutoConf-Rollen nach Fertigstellung freigeben**__(%%) =
81 81  
82 82  
83 -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.
82 +Neue Autoconf-Rollen können am Server durch Aufruf des Befehls (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container">update-autoconf-archive{{box}}update-autoconf-archive{{/box}}(%%) im LXC ctrl-g1 aktualisiert werden. Der Aufruf dieses Kommandos ist auch nach Änderungen an Autoconf-Rollen nötig.
84 84  Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
85 85  
86 86  Über den Button "AutoConf Rollen neu einlesen" im LD Control Center (mit aktiviertem Expertenmodus) werden die neu erstellten Rollen im Anschluss sichtbar und sind wie gewohnt Betriebssystemen zuordenbar.
... ... @@ -96,7 +96,7 @@
96 96  ----
97 97  
98 98  
99 -= (% style="font-size:22px" %)__**Weiteres, funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“**__(%%) =
98 += (% style="font-size:22px" %)__**Funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“**__(%%) =
100 100  
101 101  
102 102  Zum besseren Verständnis wird nachfolgend eine feste Autoconf-Rolle zur Konfiguration eines WLAN-Profils (SSID inkl. PSK) an Clients näher beleuchtet.
... ... @@ -158,8 +158,8 @@
158 158  
159 159  == (% style="font-size:16px" %)**Inhalt des PowerShell-Skripts main.ps1, das die Variablen entgegennimmt**(%%) ==
160 160  
161 -Im Unterverzeichnis {{box}} win/ {{/box}} oder {{box}} lin/ {{/box}} der Autoconf-Rolle können sich wie erläutert unterschiedliche PowerShell-Skripte zur Ausführung in den verschiedenen Phasen befinden.
162 -In dieser Rolle liegt konkret das allgemeingültige Skript {{box}}main.ps1{{/box}} vor, welches die Variablen als Parameter ##$ssid## und ##$psk## intern verwendet.
160 +Im Unterverzeichnis (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container"> win/ {{box}} win/ {{/box}}(%%) oder (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container"> lin/ {{box}} lin/ {{/box}}(%%) der Autoconf-Rolle können sich wie erläutert unterschiedliche PowerShell-Skripte zur Ausführung in den verschiedenen Phasen befinden.
161 +In dieser Rolle liegt konkret das allgemeingültige Skript (% data-xwiki-non-generated-content="java.util.List" %)" class="xwiki-metadata-container">main.ps1{{box}}main.ps1{{/box}}(%%) vor, welches die Variablen als Parameter ##$ssid## und ##$psk## intern verwendet.
163 163  
164 164  
165 165  (% style="color:#19177c" %)**Windows Variante**
... ... @@ -226,8 +226,8 @@
226 226  
227 227  (% style="color:#19177c" %)**Linux Variante (Network Manager)**
228 228  
229 -{{code width="50%" language="text"}}
230 -root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
228 +{{code language="text" width="50%"}}
229 +root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/lin/main.ps1
231 231  {{/code}}
232 232  
233 233  {{code language="powershell" width="50%"}}
... ... @@ -289,3 +289,19 @@
289 289   exit 1
290 290  }
291 291  {{/code}}
291 +
292 +----
293 +
294 += (% style="font-size:22px" %)__**Weiteres Beispiel: eigene AutoConf-Rolle zur "Deaktivierung der Suchhervorhebung in Windows"**__(%%) =
295 +
296 +Im nachfolgenden Beispiel wird eine einfache Rolle zur Deaktivierung der Suchvorhebung in Windows deklariert.
297 +\\[[image:image-20230316103442-2.png||height="530" width="1142" class="img-thumbnail"]]
298 +
299 +----
300 +
301 +== (% style="font-size:16px" %)**Aufbau der Logodidact.yml:**(%%) ==
302 +
303 +Neben den allgemeinen Informationen über die Autoren (authors), Unternehmen (company), einer Beschreibung (description), dem Anzeigenamen (display_name) im LD Control Center, usw, beginnt im Abschnitt Makro:codevars die eigentliche Definition der Variable
304 +"**Makro:codedisableSearchHighlight** ".
305 +
306 +
image-20230316094933-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,0 +1,1 @@
1 +43.3 KB
Inhalt
image-20230316095106-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,0 +1,1 @@
1 +47.8 KB
Inhalt
image-20230316102252-3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,0 +1,1 @@
1 +166.3 KB
Inhalt
image-20230316102302-4.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,0 +1,1 @@
1 +166.3 KB
Inhalt
image-20230316103224-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,0 +1,1 @@
1 +166.3 KB
Inhalt
image-20230316103442-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,0 +1,1 @@
1 +201.2 KB
Inhalt