Zum Inhalt springen

Änderungen von Dokument Eigene Autoconf-Rolle erstellen

Zuletzt geändert von Tom Altenbrunn am 2023/03/17 08:03
Von Version 19.1
bearbeitet von Tom Altenbrunn
am 2023/03/15 14:08
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 27.1
bearbeitet von Jonas Mayer
am 2023/03/16 07:48
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.TomAltenbrunn@sbede
1 +XWiki.jonasmayer@sbede
Inhalt
... ... @@ -1,6 +1,8 @@
1 1  {{toc depth="3"/}}
2 2  
3 +----
3 3  
5 +
4 4  = (% style="font-size:22px" %)__**Allgemeines**__(%%) =
5 5  
6 6  
... ... @@ -17,7 +17,7 @@
17 17  * bis Puppet-Version **1.4.x** : {{code language="bash"}}/var/lib/ld-autoconf/custom/{{/code}}
18 18  * ab Puppet-Version **1.5.x **:  {{code language="bash" layout="LINENUMBERS"}}/data/ld/autoconf/custom/{{/code}}
19 19  
20 -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.
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 21  
22 22  __Der strukturelle Aufbau eines AutoConf-Verzeichnisses grafisch dargestellt:__
23 23  
... ... @@ -31,7 +31,7 @@
31 31  * (% 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.
32 32  * (% 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.
33 33  * (% 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.
34 -* (% 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.
36 +* (% 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.
35 35  * **collect.ps1** - Sonderfall. Dieses Skript wird ausgeführt, wenn durch einen Anwender aktiv die Phase COLLECT zum Einsammeln von Einstellungen am Client aufgerufen wird.
36 36  
37 37  (% class="box warningmessage" %)
... ... @@ -39,9 +39,9 @@
39 39  (% 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.
40 40  )))
41 41  
42 -
43 43  ----
44 44  
46 +
45 45  = (% style="font-size:22px" %)__**Beispielaufbau einer logodidact.yml**__(%%) =
46 46  
47 47  
... ... @@ -72,9 +72,9 @@
72 72  **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.
73 73  )))
74 74  
75 -
76 76  ----
77 77  
79 +
78 78  = (% style="font-size:22px" %)__**Neue AutoConf-Rollen nach Fertigstellung freigeben**__(%%) =
79 79  
80 80  
... ... @@ -91,13 +91,21 @@
91 91  [[image:attach:autoconf.png||data-xwiki-image-style-border="true" class="img-thumbnail"]]
92 92  
93 93  
94 -
95 95  ----
96 96  
98 +
99 +
100 +
101 +
102 +
103 +
104 +
105 +
106 +
97 97  = (% style="font-size:22px" %)__**Weiteres, funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“**__(%%) =
98 98  
99 99  
100 -Zum besseren Verständnis wird nachfolgend eine mitgelieferte Autoconf-Rolle zur Konfiguration eines WLAN-Profils (SSID inkl. PSK) an Clients näher beleuchtet.
110 +Zum besseren Verständnis wird nachfolgend eine feste Autoconf-Rolle zur Konfiguration eines WLAN-Profils (SSID inkl. PSK) an Clients näher beleuchtet.
101 101  
102 102  (% class="box" %)
103 103  (((
... ... @@ -104,7 +104,7 @@
104 104  root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
105 105  )))
106 106  
107 -== (% style="font-size:16px" %)** Struktureller Aufbau der logodidact.yml**(%%) ==
117 +== (% style="font-size:16px" %)**Struktureller Aufbau der logodidact.yml**(%%) ==
108 108  
109 109  (% class="box" %)
110 110  (((
... ... @@ -112,13 +112,13 @@
112 112   authors:
113 113   - Marcel Petersen
114 114   company: SBE network solutions GmbH
115 -(% style="color:#1abc9c" %)display_name:(%%) WLAN Profil mit PSK anlegen
125 +(% style="color:#1abc9c" %) display_name:(%%) WLAN Profil mit PSK anlegen
116 116   license: SBE
117 -(% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
127 +(% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
118 118   visible: true
119 - priority: 0
129 + (% style="color:#19177c" %)priority:(%%) 0
120 120   applyAlways: false
121 -(% style="color:#f1c40f" %) tags:(%%)
131 +(% style="color:#f1c40f" %) tags:(%%)
122 122   - CUSTOM
123 123  (% style="color:#e74c3c" %) vars:(%%)
124 124   ssid:
... ... @@ -129,7 +129,7 @@
129 129   display_name: Passwort
130 130   optional: false
131 131   type: PASSWORD
132 -(% style="color:#2980b9" %)systems:(%%)
142 +(% style="color:#2980b9" %) systems:(%%)
133 133   - WINDOWS
134 134   - LINUX
135 135  )))
... ... @@ -138,6 +138,8 @@
138 138  
139 139  (% 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/]]
140 140  
151 +(% style="color:#19177c" %)**priority**(% style="color:#2980b9" %)** **(%%)= Legt die Verarbeitungsreihenfolge der Autoconf-Rolle gegenüber weiteren Rollen fest, die in derselben Phase ausgeführt werden. Bei gleicher Priorität findet die Abarbeitung alphabetisch statt. Eine höhere Priorität führt zu früherer Ausführung.
152 +
141 141  (% style="color:#f1c40f" %)**tags**(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
142 142  
143 143  (% style="color:#e74c3c" %)**vars**(%%)** **= definiert mögliche Variablen, die den Skripten übergeben werden
... ... @@ -147,19 +147,23 @@
147 147  * type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
148 148  * example = Zeigt einen grau eingefärbten Beispieltext innerhalb der definierten Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
149 149  
150 -(% 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.
162 +(% 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.
151 151  
152 -
153 153  ----
154 154  
155 -===== **Aufbau der main.ps1** =====
156 156  
167 +== (% style="font-size:16px" %)**Inhalt des PowerShell-Skripts main.ps1, das die Variablen entgegennimmt**(%%) ==
157 157  
158 -Im Verzeichnis {{box}} win/ {{/box}} können sich unterschiedliche Powershell-Skripte befinden. In dieser Rolle liegt das allgemeingültige Skript main.ps1 vor.
169 +Im Unterverzeichnis {{box}} win/ {{/box}} oder {{box}} lin/ {{/box}} der Autoconf-Rolle können sich unterschiedliche PowerShell-Skripte zur Ausführung in den Phasen befinden. In dieser Rolle liegt das allgemeingültige Skript {{box}}main.ps1{{/box}} vor, welches die Variablen als Parameter ##$ssid## und ##$psk## intern verwendet.
159 159  
160 -{{code width="50%"}}
161 -root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
171 +(% class="box" %)
172 +(((
173 +(% style="color:#27ae60" %)# Windows Variante(%%)
174 +root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
175 +)))
162 162  
177 +
178 +{{code width="50%"}}
163 163  Param
164 164  (
165 165   [parameter(Mandatory=$false)]
... ... @@ -212,8 +212,6 @@
212 212  
213 213   Remove-Item -Path $file -Force
214 214  }
215 -
216 -Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokalen Variablen.
217 217  {{/code}}
218 218  
219 219  ==== ====