Änderungen von Dokument Eigene Autoconf-Rolle erstellen

Zuletzt geändert von Tom Altenbrunn am 2023/03/17 08:03

Von 24.1 nach 23.1 Von 36.2 nach 36.1

Von Version 36.1

bearbeitet von Tom Altenbrunn
am 2023/03/16 10:46

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Auf Version 24.1

bearbeitet von Jonas Mayer
am 2023/03/15 21:41

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)
Anhänge (0 geändert, 0 hinzugefügt, 6 gelöscht)

Details

Seiteneigenschaften

Dokument-Autor

@@ -1,1 +1,1 @@
--XWiki.TomAltenbrunn@sbede
++XWiki.jonasmayer@sbede

Inhalt

@@ -1,6 +1,5 @@
  {{toc depth="3"/}}
------
  = (% style="font-size:22px" %)__**Allgemeines**__(%%) =
@@ -8,7 +8,7 @@
  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.
  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.
--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}}(%%).
++Diese fest integrierten Rollen befinden sich im LXC-Container ctrl-g1 im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
  [[image:image-20230315103418-1.png||height="103" width="1344" class="img-thumbnail"]]
@@ -18,7 +18,7 @@
  * bis Puppet-Version **1.4.x** : {{code language="bash"}}/var/lib/ld-autoconf/custom/{{/code}}
  * ab Puppet-Version **1.5.x **:  {{code language="bash" layout="LINENUMBERS"}}/data/ld/autoconf/custom/{{/code}}
--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.
++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.
  __Der strukturelle Aufbau eines AutoConf-Verzeichnisses grafisch dargestellt:__
@@ -28,7 +28,7 @@
  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:
--* **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
++* **main.ps1** - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei {{box}}meta/logodidact.yml{{/box}} festgelegt sind
  * (% 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.
  * (% 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.
  * (% 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.
@@ -40,13 +40,13 @@
  (% 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.
  )))
++
  ----
--
  = (% style="font-size:22px" %)__**Beispielaufbau einer logodidact.yml**__(%%) =
--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.
++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.
  == (% style="font-size:16px" %)**Beispiel zur Deklaration einer Autoconf Variable in logodidact.yml**(%%) ==
@@ -73,13 +73,13 @@
  **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.
  )))
++
  ----
--
  = (% style="font-size:22px" %)__**Neue AutoConf-Rollen nach Fertigstellung freigeben**__(%%) =
--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.
++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.
  Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
  Ü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.
@@ -92,12 +92,12 @@
  [[image:attach:autoconf.png||data-xwiki-image-style-border="true" class="img-thumbnail"]]
++
  ----
++= (% style="font-size:22px" %)__**Weiteres, funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“**__(%%) =
--= (% style="font-size:22px" %)__**Funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“**__(%%) =
--
  Zum besseren Verständnis wird nachfolgend eine feste Autoconf-Rolle zur Konfiguration eines WLAN-Profils (SSID inkl. PSK) an Clients näher beleuchtet.
  (% class="box" %)
@@ -113,13 +113,13 @@
    authors:
      - Marcel Petersen
    company: SBE network solutions GmbH
--(% style="color:#1abc9c" %)  display_name:(%%) WLAN Profil mit PSK anlegen
++(% style="color:#1abc9c" %)display_name:(%%) WLAN Profil mit PSK anlegen
    license: SBE
--(% style="color:#8e44ad" %)  uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
++(% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
    visible: true
--(% style="color:#19177c" %)  priority:(%%) 0
++  priority: 0
    applyAlways: false
--(% style="color:#f1c40f" %)  tags:(%%)
++(% style="color:#f1c40f" %) tags:(%%)
      - CUSTOM
  (% style="color:#e74c3c" %)  vars:(%%)
      ssid:
@@ -130,7 +130,7 @@
        display_name: Passwort
        optional: false
        type: PASSWORD
--(% style="color:#2980b9" %)  systems:(%%)
++(% style="color:#2980b9" %)systems:(%%)
      - WINDOWS
      - LINUX
  )))
@@ -139,8 +139,6 @@
  (% 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/]]
--(% 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.
--
  (% style="color:#f1c40f" %)**tags**(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
  (% style="color:#e74c3c" %)**vars**(%%)** **= definiert mögliche Variablen, die den Skripten übergeben werden
@@ -150,24 +150,19 @@
  *  type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
  *  example = Zeigt einen grau eingefärbten Beispieltext innerhalb der definierten Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
--(% 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.
++(% 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.
++
  ----
--
  == (% style="font-size:16px" %)**Inhalt des PowerShell-Skripts main.ps1, das die Variablen entgegennimmt**(%%) ==
--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.
--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.
++Im Verzeichnis {{box}} win/ {{/box}} können sich unterschiedliche Powershell-Skripte befinden. In dieser Rolle liegt das allgemeingültige Skript main.ps1 vor, welches die Variablen als Parameter ##$ssid## und ##$psk## intern verwendet.
--(% style="color:#19177c" %)**Windows Variante**
--
--{{code language="text" width="50%"}}
++{{code width="50%"}}
  root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
--{{/code}}
--{{code width="50%" language="powershell"}}
  Param
  (
   [parameter(Mandatory=$false)]
@@ -220,159 +220,22 @@
    Remove-Item -Path $file -Force
  }
--{{/code}}
--
--(% style="color:#19177c" %)**Linux Variante (Network Manager)**
--
--{{code language="text" width="50%"}}
--root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/lin/main.ps1
++Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokalen Variablen.
  {{/code}}
--{{code language="powershell" width="50%"}}
--Param
--(
--  [parameter(Mandatory=$false)]
--  [String]
--  $ssid,
--  [parameter(Mandatory=$false)]
--  [String]
--  $psk
--)
++====  ====
--if ($ssid -ne '' -and $psk -ne '') {
--  if (Get-Command "nmcli" -ErrorAction SilentlyContinue) {
--    # Check if kernel modules are up
--    nmcli dev wifi rescan
-- if ($LASTEXITCODE -ne 0) {
--   Start-Sleep -Seconds 30
-- }
--
-- # Check again
-- nmcli dev wifi rescan
-- if ($LASTEXITCODE -ne 0) {
--   Write-Verbose "Skipping role. There might be no WiFi device installed."
--   exit 0
-- }
--
--    $config = "/etc/NetworkManager/system-connections/$ssid"
++====  ====
--    if (Test-Path -Path $config) {
--      Write-Verbose "Removing '$config'"
--      Remove-Item -Path $config -Recurse -Force
--    }
++====  ====
--    Write-Verbose "Connecting to '$ssid'"
--
--    nmcli device wifi connect """$ssid""" password """$psk"""
--
--    if ($LASTEXITCODE -eq 0) {
--      Start-Sleep -Seconds 5
--      nmcli con up """$ssid"""
++====  ====
--      if ($LASTEXITCODE -ne 0) {
--        Write-Verbose "Error: Credentials wrong?"
++====  ====
--        if (Test-Path -Path $config) {
--          Write-Verbose "Removing '$config'"
--          Remove-Item -Path $config -Recurse -Force
--        }
--      }
--    }
--
--    Write-Verbose "Exiting with code: $LASTEXITCODE"
--    exit $LASTEXITCODE
--  }
++====  ====
--  Write-Verbose "No suitable implementation found"
--  exit 1
--}
--{{/code}}
++====  ====
------
--
--=  =
--
--= (% style="font-size:22px" %)__**Weiteres Beispiel: eigene AutoConf-Rolle zur "Deaktivierung der Suchhervorhebung in Windows"**__(%%) =
--
--Im nachfolgenden Beispiel wird eine einfache Rolle zur Deaktivierung der Suchvorhebung in Windows deklariert.
--\\[[image:image-20230316103442-2.png||height="530" width="1142" class="img-thumbnail"]]
--
--(((
------
--
--== (% style="font-size:16px" %)**Aufbau der Logodidact.yml:**(%%) ==
--
--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 {{code language="bash"}}vars{{/code}} die eigentliche Definition der Variable
--"**{{code language="bash"}}disableSearchHighlight{{/code}}**".
--
--
--{{code language="yaml" width="45%"}}
--#logodidact.yml
--
--ld_info:
--  authors:
--    - Olav Krapp
--    - Marcel Petersen
--    - Kerim Ekin
--  company: SBE network solutions GmbH
--  description: |   #Beschreibung
--    Die Suchhervorhebung in der Windows Suchleiste wird deaktiviert
--  display_name: Windows Suchhervorhebung  #Anzeigename im LD Control Center
--  license: SBE
--  uuid: fec4ff30-b2a6-407f-a6b3-0a621cd7eaf7  #einmalige UUID
--  vars:  #Deklaration der Variablen
--    disableSearchHighlight:  #Name der Variable
--      display_name: Suchhervorhebung im Suchfeld deaktivieren #Anzeigename im LD Control Center
--      optional: true  #Auswahl optional
--      type: BOOLEAN  #Variablentyp Boolean = True/False
--      value: false  #Standardwert false
--  visible: true  #Sichtbarkeit der Variable im LD Control Center
--  priority: 0 #Abarbeitungspriorität
--  applyAlways: false #Rolle immer ausführen oder einmalig
--  tags:
--    - CUSTOM #Ausführungszeitpunkt während der/den Phase(n)
--  systems:
--    - WINDOWS  #Betriebssystem
--{{/code}}
--
--==  ==
--
------
--
--== (% style="font-size:16px" %)**Aufbau der main.ps1:**(%%) ==
--
--Danach erfolgt die Erstellung des ausführbaren Codes per Powershell. Im ersten Abschnitt (% style="color:#008000" %)**Param** (%%)werden die in der im vorigen Abschnitt definierten Variaben  {{code language="bash"}}vars{{/code}} aus der logodidact.yml aufgeführt und definiert. Bei der Variable "**{{code}}disableSearchHighlight{{/code}}**" handelt es sich um ein Boolean (True/False). Die Bedingung "**[parameter(Mandatory=$false)]**" setzt das Vorhandensein der Variable während dem Ablauf des Skriptes nicht als zwingend notwendig voraus, sodass bei einem darauffolgenden Verarbeitungsfehler o.ä. die Abarbeitung weiter erfolgt.
--\\{{code language="powershell"}}#main.ps1
--
--Param
--(
-- [parameter(Mandatory=$false)]  #Variable zwingend erforderlich?
--  [bool]  #Variablentyp
--  $disableSearchHighlight  #Name der def. Variable aus logodidact.yml
--)
--
--$SystemVersion=[System.Environment]::OSVersion.Version  #Hole Windows Systemversion
--
--#Beginn des eigentlichen Codes
--if ($SystemVersion.Major -eq 10 -and $SystemVersion.Build -ge 19044) {
--  $val = [int]!$disableSearchHighlight
--  Write-Verbose "Setting EnableDynamicContentInWSB to '$val'"
--  [Microsoft.Win32.Registry]::SetValue("HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Windows\Windows Search","EnableDynamicContentInWSB",$val,[Microsoft.Win32.RegistryValueKind]::DWord)
--} else {
--  Write-Host "Feature ist erst ab dem Release 21H2 verfügbar."
--}{{/code}}
--
------
--
--== (% style="font-size:16px" %)**Einlesen der AutoConf-Rollen am Server:**(%%) ==
--
--[[image:image-20230316103224-1.png||height="128" width="1226" class="img-thumbnail"]]
--
------
--
--== (% style="font-size:16px" %)**Ansicht im LD Control Center:**(%%) ==
--
--(% class="wikigeneratedid" %)
-- [[image:image-20230316095106-2.png||class="img-thumbnail"]]
--)))
++====  ====

image-20230316094933-1.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.TomAltenbrunn@sbede

Größe

...	...	@@ -1,1 +1,0 @@
1		-43.3 KB

Inhalt

image-20230316095106-2.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.TomAltenbrunn@sbede

Größe

...	...	@@ -1,1 +1,0 @@
1		-47.8 KB

Inhalt

image-20230316102252-3.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.TomAltenbrunn@sbede

Größe

...	...	@@ -1,1 +1,0 @@
1		-166.3 KB

Inhalt

image-20230316102302-4.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.TomAltenbrunn@sbede

Größe

...	...	@@ -1,1 +1,0 @@
1		-166.3 KB

Inhalt

image-20230316103224-1.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.TomAltenbrunn@sbede

Größe

...	...	@@ -1,1 +1,0 @@
1		-166.3 KB

Inhalt

image-20230316103442-2.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.TomAltenbrunn@sbede

Größe

...	...	@@ -1,1 +1,0 @@
1		-201.2 KB

Inhalt