Ä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 2.1
bearbeitet von Christian Germann
am 2022/08/09 10:53
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -Eigene Autoconf-Rolle erstellen
1 +Autoconf-Konfiguration erstellen
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.TomAltenbrunn@sbede
1 +XWiki.cge@sbede
Inhalt
... ... @@ -1,13 +1,12 @@
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.
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 -
4 4  Von SBE ausgelieferte Rollen befinden sich 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.
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  
8 -Der Aufbau einer Autoconf-Rolle muss einer Struktur folgen, damit der Server diese Interpretieren kann.
7 +Der Aufbau einer Autoconf-Regel 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.
9 +Unterhalb der Regel muss ein Ordner mit Namen {{box}}meta{{/box}} mit einer {{box}}logodidact.yml{{/box}} liegen.
11 11  
12 12  
13 13  ==== **Beispielaufbau der logodidact.yml:** ====
... ... @@ -45,27 +45,19 @@
45 45   - LINUX
46 46  )))
47 47  
48 -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/]]
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/]]
49 +tags = beschreibt in welcher Phase die Autoconf-Regel aktiv ist.
51 51  
52 -tags = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
51 +vars = definiert Variablen die den Skripten übergeben werden
53 53  
54 -systems = Legt fest, welche Betriebssystem-Typen durch die Autoconf-Rolle unterstützt werden. Gültige Systeme sind: WINDOWS / LINUX
53 +display_name = Name der Variable im ctrl
55 55  
56 -vars = definiert mögliche Variablen, die den Skripten übergeben werden
55 +optional = bestimmt ob die Option in der Autoconf-Rege optional ist
57 57  
58 - ~* display_name = Name der konfigurierbaren Variable im Control Center
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:
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 -
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 -**Beispiel für eine Variable:**
68 -
69 69  (% class="box" %)
70 70  (((
71 71  globalLogLevel:
... ... @@ -79,26 +79,17 @@
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:
73 +example = Gibt eine grauen Beispielwert für die Variable vor.
83 83  
75 +systems = für welches Betriebssystem existieren Skripte in der Autoconf-Regel
84 84  
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  
87 -* **main.ps1** - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei {{box}}meta/logodidact.yml{{/box}} festgelegt sind
88 -* (% style="color:#8e44ad" %)**setup.ps1**(%%) - Skript wird ausschließlich in der SETUP-Phase während des Deployments ausgeführt.
89 -* (% style="color:#8e44ad" %)**custom.ps1**(%%) - Skript wird ausschließlich in der CUSTOM-Phase während des Deployments ausgeführt.
90 -* (% style="color:#8e44ad" %)**user.ps1**(%%) - Skript wird ausschließlich in der USER-Phase während des Deployments ausgeführt.
91 -* (% style="color:#8e44ad" %)**audit.ps1**(%%) - Skript wird ausschließlich in der AUDIT-Phase während des Deployments ausgeführt.
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.
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.
93 93  
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.
95 95  
96 -
97 97  ==== **Beispielaufbau der main.ps1** ====
98 98  
99 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.
100 -
101 -{{code}}
102 102  user.ps1 = user Phase, nach der Anmeldung
103 103  
104 104  custom.ps1 = custom Phase
... ... @@ -109,7 +109,7 @@
109 109  
110 110  main.ps1 = alle Phasen
111 111  
112 -root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
94 +root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
113 113  
114 114  Param
115 115  (
... ... @@ -120,10 +120,9 @@
120 120   [String]
121 121   $psk
122 122  )
123 -
124 -if ($ssid -ne '' -and $psk -ne '') {
105 +\\if ($ssid -ne '' -and $psk -ne '') {
125 125   $profile = @'
126 -<WLANProfile xmlns="http://www.microsoft.com/networking/WLAN/profile/v1">
107 +<WLANProfile xmlns="http:~/~/www.microsoft.com/networking/WLAN/profile/v1">
127 127   <name>{0}</name>
128 128   <SSIDConfig>
129 129   <SSID>
... ... @@ -148,33 +148,24 @@
148 148   </MSM>
149 149  </WLANProfile>
150 150  '@ -f $ssid, $psk
151 -
152 - $file = "$AUTOCONF_TEMP_DIR\ld_wlan_psk\wlan.xml"
153 -
154 - $profile | Out-File (New-Item $file -Force)
155 -
156 - Get-NetAdapter | Where-Object { $_.PhysicalMediaType -eq 'Native 802.11' -or `
132 +\\ $file = "$AUTOCONF_TEMP_DIR\ld_wlan_psk\wlan.xml"
133 +\\ $profile | Out-File (New-Item $file -Force)
134 +\\ Get-NetAdapter | Where-Object { $_.PhysicalMediaType -eq 'Native 802.11' -or `
157 157   $_.PhysicalMediaType -eq 'Wireless LAN' -or `
158 158   $_.PhysicalMediaType -eq 'Wireless WAN' } | ForEach-Object {
159 -
160 - Write-Verbose "Creating wlan profile for '$ssid' on interface '$($_.Name)'"
137 +\\ Write-Verbose "Creating wlan profile for '$ssid' on interface '$($_.Name)'"
161 161   netsh wlan add profile filename= "$file" interface= "$($_.Name)"
162 162   }
163 -
164 - Remove-Item -Path $file -Force
140 +\\ Remove-Item -Path $file -Force
165 165  }
166 166  
167 167  Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokale Variablen.
168 -{{/code}}
169 169  
170 -==== ====
145 +**Neue AutoConf-Regel freigeben**
171 171  
172 -==== **Neue AutoConf-Rollen freigeben** ====
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.
175 -Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
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.
178 -
179 -[[image:attach:autoconf.png||data-xwiki-image-style-border="true"]]
147 +Neue Autoconf-Regel müssen mit dem Befehl update-autoconf-archive eingelesen werden. 
148 +Ansonsten werden die Autoconfrollen auch zeitbasiert (Alle 4 Stunden) neu eingelesen.
149 +Im Controlcenter im Expertenmodus dann folgenden Knopfen drücken, damit dort auch die neuen Autoconf-Regeln eingelesen werden.
180 180  
151 +
152 +[[image:https://wiki.sbe.de/xwiki/bin/download/Main/SBE_intern/LogoDIDACT2.0/Lddeploy/Autoconf%20erstellen/WebHome/autoconf.png?rev=1.1||alt="autoconf.png"]]
autoconf.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.cge@sbede
Größe
... ... @@ -1,1 +1,0 @@
1 -73.0 KB
Inhalt