Yedidyah Bar David has uploaded a new change for review. Change subject: packaging: setup: Doc conf files in engine-setup.8 ......................................................................
packaging: setup: Doc conf files in engine-setup.8 Add to the engine-setup manpage documentation of the configuration files and related options, and some other stuff. Related-To: https://bugzilla.redhat.com/1014372 Related-To: https://bugzilla.redhat.com/1040016 Change-Id: Icd600c457b06aa3f8758da451f2b6a8fe76c02f9 Signed-off-by: Yedidyah Bar David <d...@redhat.com> --- M packaging/man/man8/engine-setup.8 M packaging/setup/bin/ovirt-engine-setup 2 files changed, 47 insertions(+), 5 deletions(-) git pull ssh://gerrit.ovirt.org:29418/ovirt-engine refs/changes/89/22389/1 diff --git a/packaging/man/man8/engine-setup.8 b/packaging/man/man8/engine-setup.8 index eb1c8b5..a9a9a44 100644 --- a/packaging/man/man8/engine-setup.8 +++ b/packaging/man/man8/engine-setup.8 @@ -15,14 +15,17 @@ and ready for use. Where a run of the engine\-setup utility is unsuccessful, comprehensive logging and error information is output both to standard output and to the engine\-setup log file. +.Pp +engine\-setup should also be used to update Open Virtualization Manager +to newer versions when these are available. .Sh OPTIONS .Bl -tag -width "AA" .It \-\-log=file -write log to this file. +Write log to this file. .It \-\-config=file -Load configuration files. +Load configuration from this file. .It \-\-config-append=file -Load extra configuration files. +Load configuration from this file, as addition to default files. .It \-\-offline Offline mode. .It \-\-generate-answer=file @@ -30,5 +33,44 @@ .It \-\-jboss-home=dir Use this jboss. .El +.Sh FILES +.Bl -tag -width "AA" +.It /etc/ovirt\-engine\-setup.conf +The default configuration file. +Both this, and arguments to \-\-config and \-\-config\-append, are +first checked themselves, and then ".d" is added to form a directory +name, and all files inside it ending with ".conf" are checked. So by +default, all of /etc/ovirt\-engine\-setup.conf and +/etc/ovirt\-engine\-setup.conf.d/*.conf are read. Some +files are preinstalled in /etc/ovirt\-engine\-setup.conf.d, and some +are written there by engine\-setup to be read by further invocations +of it. This means that in practice, \-\-config should seldom be used, +as engine\-setup will not read these files, and normally, to read +answer files, \-\-config-append should be used. +.It /var/log/ovirt\-engine/setup/ovirt\-engine\-setup\-DATETIME.log +Default log file. +.It /var/lib/ovirt\-engine/setup/answers/DATETIME\-setup.conf +An answer file written at end of each run. +.It Various files under /etc/ovirt\-engine/ +Configuration files of the engine and related tools. Some of these are +written by engine\-setup. +.It Various files under /etc/pki/ovirt\-engine +PKI files (keys, certs etc) for the engine and related tools. Some of +these are written by engine\-setup. +.It /etc/ovirt\-engine/uninstall.d/DATETIME\-uninstall.conf +Lists of files that were created or changed by engine\-setup, together +with their md5 hash, if intended to be removed by engine\-cleanup, +or the actual lines added or deleted, if intended to be reverted by +engine\-cleanup to their previous state. +.It Other files +Depending on system configuration and answers to questions asked +during its run, engine\-setup might add or change other files, +including e.g. /etc/httpd/conf.d/, /etc/firewalld/ or +/etc/sysconfig/iptables, /etc/sysconfig/nfs and /etc/exports, etc. +.It /etc/yum/pluginconf.d/versionlock.list +This file is edited by engine\-setup to include a list of packages +that should not be updated by yum directly. These packages should +only be updated by engine\-setup itself. This is done to prevent +incompatibilities between the database and the engine. .Sh BUGS Report bugs at https://bugzilla.redhat.com/. diff --git a/packaging/setup/bin/ovirt-engine-setup b/packaging/setup/bin/ovirt-engine-setup index 43ebb1d..fecd802 100755 --- a/packaging/setup/bin/ovirt-engine-setup +++ b/packaging/setup/bin/ovirt-engine-setup @@ -22,9 +22,9 @@ --log=file write log to this file. --config=file - Load configuration files. + Load configuration from this file. --config-append=file - Load extra configuration files. + Load configuration from this file, as addition to default files. --offline Offline mode. --generate-answer=file -- To view, visit http://gerrit.ovirt.org/22389 To unsubscribe, visit http://gerrit.ovirt.org/settings Gerrit-MessageType: newchange Gerrit-Change-Id: Icd600c457b06aa3f8758da451f2b6a8fe76c02f9 Gerrit-PatchSet: 1 Gerrit-Project: ovirt-engine Gerrit-Branch: master Gerrit-Owner: Yedidyah Bar David <d...@redhat.com> _______________________________________________ Engine-patches mailing list Engine-patches@ovirt.org http://lists.ovirt.org/mailman/listinfo/engine-patches