Änderungen von Dokument Eigene Autoconf-Rolle erstellen

Zusammenfassung

• Seiteneigenschaften (3 geändert, 0 hinzugefügt, 0 gelöscht)
• Anhänge (0 geändert, 1 hinzugefügt, 0 gelöscht)
  • autoconf.png

Details

Seiteneigenschaften

Titel

...	...	@@ -1,1 +1,1 @@
1		-Autoconf-Konfiguration erstellen
	1	+Eigene Autoconf-Rolle erstellen

Dokument-Autor

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

Inhalt

...	...	@@ -1,13 +1,25 @@
1		-Autoconf liegt wie der Vorgänger Ansible im ctrl-g1 Container.
2		-Dort im Pfad /usr/lib/ld-autoconf/logodidact/roles/ finden sich die bestehenden Rollen.
3		-Für eigene Rollen sollte die Rolle unter  /var/lib/ld-autoconf/custom abgelegt werden. Nach einem LD-Update geht so die Arbeit nicht verloren!
	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.
4	4
5		-Eine Autoconf-Regel besteht aus den Informationen zur Regel, die in der logodidact.yml im Ordner meta liegen und den jeweiligen Skripten für Windows im Unterordner win.
6		-Linux-Skripte würden sich im Unterordner lin befinden.
7		-\\**Beispielaufbau der logodidact.yml:**
	3	+Logodidact ist bereits standardmäßig mit zahlreichen eigenen Autoconf-Rollen bestückt, um ein möglichst breites Spektrum verschiedenster Anforderungen des allgemeinen Schulbetriebs abzudecken.
8	8
	5	+Von SBE ausgelieferte Rollen befinden sich Im Pfad {{box}}/usr/lib/ld-autoconf/logodidact/roles/{{/box}}.
	6	+
	7	+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.
	8	+
	9	+Der Aufbau einer Autoconf-Rolle muss einer Struktur folgen, damit der Server diese Interpretieren kann.
	10	+
	11	+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.
	12	+
	13	+
	14	+==== **Beispielaufbau der logodidact.yml:** ====
	15	+
	16	+(% class="box" %)
	17	+(((
9	9	root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/meta/logodidact.yml
	19	+)))
10	10
	21	+(% class="box" %)
	22	+(((
11	11	ld_info:
12	12	authors:
13	13	- Marcel Petersen
...	...	@@ -32,20 +32,31 @@
32	32	systems:
33	33	- WINDOWS
34	34	- LINUX
	47	+)))
35	35
36		-uuid = ID der Autoconf-Regel, muss einmalig sein. Bei einer eigenen Autoconf-Regel muss der Wert am besten neugeniert werden. [[https:~~/~~/www.uuidgenerator.net/>>url:https://www.uuidgenerator.net/]]
	49	+display_name = Anzeigename der Autoconf-Rolle im LD Control Center
37	37
38		-tags = beschreibt in welcher Phase die Autoconf-Regel aktiv ist.
	51	+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/]]
39	39
40		-vars = definiert Variablen die den Skripten übergeben werden
	53	+tags = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
41	41
42		-display_name = Name der Variable im ctrl
	55	+systems = Legt fest, welche Betriebssystem-Typen durch die Autoconf-Rolle unterstützt werden. Gültige Systeme sind: WINDOWS / LINUX
43	43
44		-optional = bestimmt ob die Option in der Autoconf-Regel  optional ist
	57	+vars = definiert mögliche Variablen, die den Skripten übergeben werden
45	45
46		-type = bestimmt den Wert der Variable. Mögliche Werte STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
47		-ENUM entspricht einem Dropdown-Menü, in dem man aus vordefinierte Werte auswählen kann:
	59	+ ~* display_name = Name der konfigurierbaren Variable im Control Center
48	48
	61	+ ~* example = Zeigt einen grau eingefärbten Beispieltext innerhalb Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
	62	+
	63	+ ~* optional = bestimmt, ob die Variable zwingend mit einem Wert belegt werden muss
	64	+
	65	+ ~* type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
	66	+
	67	+
	68	+**Beispiel für eine Variable:**
	69	+
	70	+(% class="box" %)
	71	+(((
49	49	globalLogLevel:
50	50	display_name: Loglevel
51	51	optional: true
...	...	@@ -55,14 +55,28 @@
55	55	- compact
56	56	- detailed
57	57	- full
	81	+)))
58	58
59		-example = Gibt eine grauen Beispielwert für die Variable vor.
	83	+(% style="font-size:12px" %)**Tipp:** Der Variablentyp ENUM aus dem Beispiel entspricht einem Dropdown-Menü, in dem man aus vordefinierte Werte auswählen kann:
60	60
61		-systems = für welches Betriebssystem existieren Skripte in der Autoconf-Regel
62	62
63		-**Beispielaufbau der main.ps1**
	86	+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:
64	64
	88	+* **main.ps1** - Skript wird in allen Phasen ausgeführt, die innerhalb der Beschreibungsdatei {{box}}meta/logodidact.yml{{/box}} festgelegt sind
	89	+* (% style="color:#8e44ad" %)**setup.ps1**(%%) - Skript wird ausschließlich in der SETUP-Phase während des Deployments ausgeführt.
	90	+* (% style="color:#8e44ad" %)**custom.ps1**(%%) - Skript wird ausschließlich in der CUSTOM-Phase während des Deployments ausgeführt.
	91	+* (% style="color:#8e44ad" %)**user.ps1**(%%) - Skript wird ausschließlich in der USER-Phase während des Deployments ausgeführt.
	92	+* (% style="color:#8e44ad" %)**audit.ps1**(%%) - Skript wird ausschließlich in der AUDIT-Phase während des Deployments ausgeführt.
	93	+* **collect.ps1** - Sonderfall. Dieses Skript wird ausgeführt, wenn durch einen Anwender aktiv die Phase COLLECT zum Einsammeln von Einstellungen am Client aufgerufen werden.
	94	+
	95	+(% 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.
	96	+
	97	+
	98	+==== **Beispielaufbau der main.ps1** ====
	99	+
65	65	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.
	101	+
	102	+{{code}}
66	66	user.ps1 = user Phase, nach der Anmeldung
67	67
68	68	custom.ps1 = custom Phase
...	...	@@ -73,7 +73,7 @@
73	73
74	74	main.ps1 = alle Phasen
75	75
76		-root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
	113	+root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
77	77
78	78	Param
79	79	(
...	...	@@ -84,9 +84,10 @@
84	84	[String]
85	85	$psk
86	86	)
87		-\\if ($ssid -ne '' -and $psk -ne '') {
	124	+
	125	+if ($ssid -ne '' -and $psk -ne '') {
88	88	$profile = @'
89		-<WLANProfile xmlns="http:~/~/www.microsoft.com/networking/WLAN/profile/v1">
	127	+<WLANProfile xmlns="http://www.microsoft.com/networking/WLAN/profile/v1">
90	90	<name>{0}</name>
91	91	<SSIDConfig>
92	92	<SSID>
...	...	@@ -111,24 +111,33 @@
111	111	</MSM>
112	112	</WLANProfile>
113	113	'@ -f $ssid, $psk
114		-\\ $file = "$AUTOCONF_TEMP_DIR\ld_wlan_psk\wlan.xml"
115		-\\ $profile | Out-File (New-Item $file -Force)
116		-\\ Get-NetAdapter | Where-Object { $_.PhysicalMediaType -eq 'Native 802.11' -or `
	152	+
	153	+ $file = "$AUTOCONF_TEMP_DIR\ld_wlan_psk\wlan.xml"
	154	+
	155	+ $profile | Out-File (New-Item $file -Force)
	156	+
	157	+ Get-NetAdapter | Where-Object { $_.PhysicalMediaType -eq 'Native 802.11' -or `
117	117	$_.PhysicalMediaType -eq 'Wireless LAN' -or `
118	118	$_.PhysicalMediaType -eq 'Wireless WAN' } | ForEach-Object {
119		-\\ Write-Verbose "Creating wlan profile for '$ssid' on interface '$($_.Name)'"
	160	+
	161	+ Write-Verbose "Creating wlan profile for '$ssid' on interface '$($_.Name)'"
120	120	netsh wlan add profile filename= "$file" interface= "$($_.Name)"
121	121	}
122		-\\ Remove-Item -Path $file -Force
	164	+
	165	+ Remove-Item -Path $file -Force
123	123	}
124	124
125	125	Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokale Variablen.
	169	+{{/code}}
126	126
127		-**Neue AutoConf-Regel freigeben**
	171	+==== ====
128	128
129		-Neue Autoconf-Regel müssen mit dem Befehl update-autoconf-archive eingelesen werden.
130		-Ansonsten werden die Autoconfrollen auch zeitbasiert (Alle 4 Stunden) neu eingelesen.
131		-Im Controlcenter im Expertenmodus dann folgenden Knopfen drücken, damit dort auch die neuen Autoconf-Regeln eingelesen werden.
132		-
	173	+==== **Neue AutoConf-Rollen freigeben** ====
133	133
134		-[[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"]]
	175	+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.
	176	+Alternativ werden alle Autoconf-Rollen auch zeitbasiert alle 4 Stunden am Server eingelesen. Dies passiert automatisch im Hintergrund.
	177	+
	178	+Betätigen Sie außerdem im LD Control Center (mit aktiviertem Expertenmodus) folgenden Knopf, damit selbst hinzugefügte Autoconf-Rollen verfügbar werden.
	179	+
	180	+[[image:attach:autoconf.png||data-xwiki-image-style-border="true"]]
	181	+

autoconf.png

Author

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

Größe

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

Inhalt