Attachment 3322 Details for Bug 22745

Integration von UCR in erstellte Pakete

integration-von-ucr-in-paketen.tex (text/x-tex), 6.23 KB, created by Moritz Muehlenhoff on 2011-06-15 16:36 CEST

(hide)

Description:

Filename:

MIME Type:

Creator: Moritz Muehlenhoff

Created: 2011-06-15 16:36 CEST

Size: 6.23 KB

patch

obsolete

>\section{\ucsUCR{} in selbst erstellten Paketen}
>
>In dem Verzeichnis mit den Paketquellen muss ein
>Unterverzeichnis mit dem Namen \emph{conffiles} erzeugt werden, in das die
>gewÃ¼nschten Konfigurationsdateien mit etwaigen Unterverzeichnissen
>kopiert werden. Soll beispielsweise die
>Datei \ucsURL{/etc/ldap/slapd.conf} durch \ucsUCR{}
>verwaltet werden, kopiert man sie nach \ucsURL{conffiles/etc/ldap/slapd.conf}.
>
>Nun kÃ¶nnen Platzhalter fÃ¼r die Variablen und eventuell notwendiger
>Python-Code in die Konfigurationsdateien unterhalb von \emph{conffiles}
>integriert werden.
>
>In jedem Fall kÃ¶nnen Defaultwerte fÃ¼r die durch das jeweilige
>BinÃ¤rpaket verwendeten Variablen in \ucsURL{debian/postinst}
>bzw. \ucsURL{debian/<binÃ¤rpaket>.postinst} durch bedingtes Setzen (siehe
>Kapitel~\ref{neue_baseconfig}) vergeben werden.
>
>In den Abschnitt \emph{install} der \ucsName{debian/rules}-Datei muss die Zeile
>
>\begin{ucsConfigFile}
>univention-install-config-registry
>\end{ucsConfigFile}
>
>eingefÃ¼gt werden, damit \ucsUCR{} beim Erzeugen des
>Paketes mit einbezogen wird.
>
>ZusÃ¤tzlich muss die Datei \ucsName{debian/control} angepasst, 
>das Quellpaket um eine AbhÃ¤ngigkeit auf \ucsName{univention-config-dev} und
>alle \ucsUCR{} nutzenden BinÃ¤rpakete um eine AbhÃ¤ngigkeit auf
>\ucsName{\ucsUCRb{}} erweitert werden.
>
>AuÃerdem muss fÃ¼r jedes BinÃ¤rpaket eine Datei mit dem Namen
>\ucsURL{debian/<binÃ¤rpaket>.\ucsUCRb{}} angelegt werden, in der
>angegeben ist, welche Dateien und Skripte durch \ucsUCR{}
>verwaltet werden sollen und welche Variablen in diesen enthalten sind.
>
>Die Syntax der Datei ist wie in den folgenden Beispielen ersichtlich:
>
>\begin{itemize}
>
>\item Zwei Konfigurationsdateien und die in ihnen verwendeten Variablen.
>Die Zuordnung von Variablen zu Dateien kann entfallen, wenn kein
>Python-Code in der entsprechenden Konfigurationsdatei verwendet wird.
>
>\begin{ucsConsoleInput}
># cat univention-dhcp.info
>Type: file
>File: etc/dhcp3/dhcpd.conf
>Variables: ldap/base
>Variables: dhcpd/ldap/base
>Variables: ldap/server/name
>Variables: dhcpd/enable
>
>Type: file
>File: etc/init.d/dhcp3-server
>\end{ucsConsoleInput}
>
>\item  Neben Konfigurationsdateien kÃ¶nnen auch Skripte in \ucsUCR{}
>integriert werden. Diese Skripte kÃ¶nnen ausgefÃ¼hrt werden, wenn
>bestimmte Variablen gesetzt werden. Mit Paketen installierte Skripte werden unter 
>\ucsURL{/etc/univention/templates/scripts} abgelegt. Weitere Skripte,
>die einzeln erstellt und nachtrÃ¤glich mit \ucsUCR{}
>registriert werden sollen, mÃ¼ssen ebenfalls in das Verzeichnis kopiert
>werden. AuÃerdem mÃ¼ssen zusÃ¤tzliche Skripte in die
>\ucsUCR{"=Info"=Dateien} eingetragen werden. Sie mÃ¼ssen  ausfÃ¼hrbar sein
>und ebenfalls in das Verzeichnis conffiles kopiert werden.
>
>Im folgenden Beispiel wird bei Ãnderung der Werte der Variablen \emph{interfaces/eth0/address}
>oder \emph{interfaces/eth0/network} das Skript \ucsURL{interfaces.sh} ausgefÃ¼hrt:
>
>\begin{ucsConfigFile}
>Type: script
>Script: interfaces.sh
>Variables: interfaces/eth0/address
>Variables: interfaces/eth0/network
>\end{ucsConfigFile}
>
>\item Das folgende Beispiel zeigt eine Datei (Multifile), die aus
>mehreren Einzeldateien (Subfile) zusammengesetzt wird, wenn der Wert
>einer Variable geÃ¤ndert wird. Auf diese Art und Weise kÃ¶nnen
>verschiedene Pakete einzelne Teile einer Konfigurationsdatei
>mitbringen, die so zusammengefÃ¼gt werden.
>
>\begin{ucsConfigFile}
>Type: multifile
>Multifile: etc/ldap/slapd.conf
>
>Type: subfile
>Multifile: etc/ldap/slapd.conf
>Subfile: etc/ldap/slapd.conf.d/10schema-core
>Variables: ldap/base
>
>Type: subfile
>Multifile: etc/ldap/slapd.conf
>Subfile: etc/ldap/slapd.conf.d/20acl
>Variables: ldap/base
>\end{ucsConfigFile}
>
>\end{itemize}
>
>Um eine Konfigurationsdatei aus mehreren Templates zu generieren, muss ein
>Multifile-Template erzeugt werden. Hierbei wird ein Verzeichnis
>angelegt, dessen Name aus dem Template"=Namen und der Endung \emph{.d}
>gebildet wird. In diesem Verzeichnis kÃ¶nnen nun mehrere Teil-Templates
>angelegt werden.
>
>Die Dateinamen dieser Teil-Templates mÃ¼ssen mit zweistelligen Ziffern
>beginnen, welche die Reihenfolge vorgeben, in der die Teile
>ausgewertet und zusammengesetzt werden. Dies ist insbesondere
>nÃ¼tzlich, wenn die einzelnen Teile von verschiedenen Paketen
>mitgebracht oder verwaltet werden oder eigene Erweiterungen fÃ¼r
>Konfigurationsdateien eingepflegt werden sollen.
>
>In \ucsURL{/etc/univention/templates/files/etc/} liegt beispielsweise das
>Verzeichnis \ucsURL{config.d}. In diesem befinden sich die Dateien \ucsURL{00Header},
>\ucsURL{05Grundkonfig} und \ucsURL{11Erweiterungen}. Diese werden von 
>\ucsUCR{} in aufsteigender Reihenfolge ihrer numerischen PrÃ¤fixe
>zusammengefÃ¼gt und ausgewertet, um die Datei \ucsURL{/etc/config} zu erzeugen.
>
>Wurden die Templates (einfach oder Multifile) erstellt, so mÃ¼ssen sie
>registriert werden, bevor sie im \ucsUCR{"=Mechanismus}
>verwendet werden kÃ¶nnen (siehe Kapitel~\ref{bc_include_config}).
>
>\section{Einbinden zusÃ¤tzlicher Konfigurationsdateien}
>\label{bc_include_config}
>Es ist mÃ¶glich, Konfigurationsdateien, die nicht aus einem
>Installationspaket stammen, in \ucsUCR{} zu
>registrieren. Die folgende Beschreibung gilt nur fÃ¼r
>Konfigurationsdateien, die nicht von einem Paket installiert wurden.
>
>Zuerst mÃ¼ssen eine oder mehrere Vorlagendateien erzeugt bzw. angepasst
>und unterhalb des Verzeichnisses \ucsURL{/etc/univention/templates/files}
>abgelegt werden. Syntax und genauer Speicherort der Vorlagendateien
>sind in Kapitel~\ref{baseconfig_registrierung} beschrieben.
>
>Im Verzeichnis \ucsURL{/etc/univention/templates/info} muss eine Datei
>angelegt werden, in der die verwendeten Konfigurationsdateien und die
>in ihnen enthaltenen Variablen aufgefÃ¼hrt werden. Der Name der
>anzulegenden Datei ist frei wÃ¤hlbar, sie muss allerdings auf \emph{.info}
>enden. Die Syntax entspricht dem in Kapitel~\ref{baseconfig_lokal}
>fÃ¼r die Datei \ucsURL{debian/<binÃ¤rpaket>.\ucsUCRb{}}
>genannten Schema.
>
>AbschlieÃend muss die Cachedatei \ucsURL{/var/cache/univention-config/cache}
>gelÃ¶scht werden. Die zusÃ¤tzlichen Konfigurationsdateien sind beim
>nÃ¤chsten Aufruf registriert. Sobald eine fÃ¼r diese Datei registrierte
>\ucsUCR{"=Variable} verÃ¤ndert wird oder der Befehl
>\emph{univention-config-registry commit} fÃ¼r diese Datei aufgerufen wird, wird aus
>der Vorlagedatei unter BerÃ¼cksichtigung der
>\ucsUCR{"=Variablen} eine neue Konfigurationsdatei erstellt.
>

Actions: View

Attachments on bug 22745: 3322 | 3323