Douglas Schilling Landgraf has uploaded a new change for review. Change subject: Add man page for vdsm.conf ...................................................................... Add man page for vdsm.conf Show to user the vdsm.conf options. Change-Id: Id8e5a47d484fa06070d4566a39cab8a7a53ea717 Signed-off-by: Douglas Schilling Landgraf <dougsland(a)redhat.com&gt; --- M debian/vdsm.install M vdsm.spec.in M vdsm/Makefile.am A vdsm/vdsm.conf.5 4 files changed, 400 insertions(+), 0 deletions(-) git pull ssh://gerrit.ovirt.org:29418/vdsm refs/changes/91/22891/1 diff --git a/debian/vdsm.install b/debian/vdsm.install index ef46ed3..0c2b137 100644 --- a/debian/vdsm.install +++ b/debian/vdsm.install @@ -31,6 +31,7 @@ ./usr/libexec/vdsm/unpersist-vdsm-hook ./usr/libexec/vdsm/vdsm-gencerts.sh ./usr/libexec/vdsm/vdsmd_init_common.sh +./usr/share/man/man5/vdsm.conf.5 ./usr/share/man/man8/vdsmd.8 ./usr/share/vdsm/API.py ./usr/share/vdsm/BindingJsonRpc.py diff --git a/vdsm.spec.in b/vdsm.spec.in index 385a29b..364997b 100644 --- a/vdsm.spec.in +++ b/vdsm.spec.in @@ -1014,6 +1014,7 @@ %{python_sitelib}/sos/plugins/vdsm.py* /lib/udev/rules.d/12-vdsm-lvm.rules /etc/security/limits.d/99-vdsm.conf +%{_mandir}/man5/vdsm.conf.5* %{_mandir}/man8/vdsmd.8* %if 0%{?rhel} %dir %{_localstatedir}/log/core diff --git a/vdsm/Makefile.am b/vdsm/Makefile.am index 3834f55..1c1671e 100644 --- a/vdsm/Makefile.am +++ b/vdsm/Makefile.am @@ -89,6 +89,9 @@ vdsm-restore-net-config \ $(NULL) +dist_man5_MANS = \ + vdsm.conf.5 + nodist_man8_MANS = \ vdsmd.8 diff --git a/vdsm/vdsm.conf.5 b/vdsm/vdsm.conf.5 new file mode 100644 index 0000000..98b4ccd --- /dev/null +++ b/vdsm/vdsm.conf.5 @@ -0,0 +1,395 @@ +.\"Copyright 2010-2013 Red Hat, Inc. and/or its affiliates. +.\" +.\"Licensed to you under the GNU General Public License as published by +.\"the Free Software Foundation; either version 2 of the License, or +.\"(at your option) any later version. See the files README and +.\"LICENSE_GPL_v2 which accompany this distribution. +.\" +.\" +.\" File Name macro definition plagiarized from bash. +.\" +.de FN +\fI\|\\$1\|\fP +.. +.TH VDSM.CONF 5 "December 6, 2013" "" "" +.SH NAME +vdsm.conf \- The configuration file for Virtual Desktops and Servers Manager (VDSM) +.br +.SH SYNOPSIS +.PP +The +vdsm\&.conf +file is a configuration file for VDSM. +vdsm\&.conf +contains runtime configuration information for the VDSM\&. +The complete description of the file format and possible parameters held within are here for reference +purposes\&. +.SH "FILE FORMAT" +.PP +The file consists of sections and parameters\&. A section begins with the name of the section in square brackets and +continues until the next section begins\&. Sections contain parameters of the form: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fIname\fR = \fIvalue \fR +.fi +.if n \{\ +.RE +.\} + +.SH CONFIGURATION BY SECTION (EXAMPLE) +.PP +.B [vars] + +\fBcore_dump_enable\fR = true +.br +Enable core dump + +\fBhost_mem_reserve\fR = 256 +.br +Reserves memory for the host to prevent VMs from using all the physical pages. The values are in Mbytes. + +\fBguest_ram_overhead\fR = 65 + +\fBextra_mem_reserve\fR = 65 +.br +Memory reserved for non-vds-administered programs. + +\fBfake_nics\fR +.br +Comma-separated list of fnmatch-patterns for dummy hosts nics to be shown to vdsm. + +\fBnic_model\fR = rtl8139,pv +.br +NIC model is rtl8139, ne2k_pci pv or any other valid device recognized by kvm/qemu if a coma separated list +given then a NIC per device will be created. + +\fBmigration_timeout\fR = 300 +.br +Maximum time the destination waits for migration to end. Source waits twice aslong (to avoid races) + +\fBmigration_listener_timeout\fR = 30 +.br +Time to wait (in seconds) for migration destination to start listening before migration begins. + +\fBmigration_max_bandwidth\fR = 32 +.br +Maximum bandwidth for migration, in MiBps, 0 means libvirt's default, since 0.10.x default in libvirt is unlimited + +\fBmigration_monitor_intervang\fR = 10 +.br +How often (in seconds) should the monitor thread pulse, 0 means the thread is disabled + +\fBhidden_nics\fR = wlan*,usb* +.br +Comma-separated list of fnmatch-patterns for host nics to be hidden from vdsm. + +\fBdefault_bridge\fR = engine +.br +Default bridge + +\fBmigration_downtime\fR = 500 +.br +Maxmium allowed downtime for live migration in milliseconds (anything below 100ms is ignored) if you do not care about +liveness of migration, set to a very high value, such as 600000. + +\fBmigration_downtime_steps\fR = 10 +.br +Incremental steps used to reach migration_downtime + +\fBmax_outgoing_migrations\fR = 3 +.br +Maximum concurrent outgoing migrations + +\fBsys_shutdown_timeout\fR = 10 +.br +Destroy and shutdown timeouts (in sec) before completing the action. + +\fBuser_shutdown_timeout\fR = 30 +.br +Grace period (seconds) to let guest user close his applications before shutdown. + +\fBguest_agent_timeout\fR = 30 +.br +Time (in sec) to wait for guest agent. + +\fBvm_command_timeout\fR = 60 +.br +Time to wait (in seconds) for vm to respond to a monitor command, 30 secs is a nice default. Set to 300 if the vm is expected to freeze during cluster failover. + +\fBvm_watermark_interval\fR = 2 +.br +How often should we sample each vm for statistics (seconds). + +\fBvm_sample_cpu_interval\fR = 15 +.br +Interval to collect sampe from CPU + +\fBvm_sample_cpu_window\fR = 2 +.br +Interval to collect from CPU window + +\fBvm_sample_disk_interval\fR = 60 +.br +Interval to collect sample from disk + +\fBvm_sample_disk_window\fR = 2 +.br +Interval to collect disk window + +\fBvm_sample_disk_latency_interval\fR = 60 +.br +Interval to collect disk latency + +\fBvm_sample_disk_latency_window\fR = 2 +.br +Interval to collect disk latency window + +\fBvm_sample_net_interval\fR = 5 +.br +Interval to collect sample from net + +\fBvm_sample_net_window\fR = 2 +.br +Interval to collect sample from net window + +\fBtrust_store_path\fR = /etc/pki/vdsm +.br +Where the certificates and keys are situated + +\fBssl\fR = true +.br +Whether to use ssl encryption and authentication. + +\fBvds_responsiveness_timeout\fR = 60 +.br +Responsiveness timeout + +\fBvdsm_nice\fR = -5 +.br +Set vdsm scheduling priority + +\fBqemu_drive_cache\fR = none +.br +Qemu drive cache + +\fBfake_kvm_support\fR = false +.br +Emulate kvm support + +\fBxmlrpc_enable\fR = true +.br +Enable the xmlrpc server + +\fBjsonrpc_enable\fR = true +.br +Enable the JSON RPC server + +\fBreport_host_threads_as_cores\fR = false +.br +Count each cpu hyperthread as an individual core + +\fBlibvirt_env_variable_log_filters\fR +.br +Specify the log filters to track libvirt calls + +\fBlibvirt_env_variable_log_outputs\fR +.br +Specify the output to track libvirt calls + +.B [ksm] +.br +\fBksm_monitor_thread\fR = true +.br +KSM Monitor + +.br +.B [mom] +.br +\fBconf\fR = /etc/vdsm/mom.conf +.br +Mom conf file +.br + +.B [irs] +.br +\fBirs_enable\fR = true +.br +Enable IRS + +\fBrepository\fR = path to repository +.br +Image Repository + +\fBhsm_tasks\fR = (repository)/hsm +.br +hsm dir + +\fBimages\fR = images/ +.br +images dir + +\fBirsd\fR = (images)/irsd +.br +irsd dir + +\fBimages_check_times\fR = 0 +.br +Image repository check period (seconds). + +\fBvolume_utilization_percent\fR = 50 +.br +Volume utilization percent + +\fBvolume_utilization_chunk_mb\fR = 1024 +.br +Volume utilization chunk of mb + +\fBvol_size_sample_interval\fR = 60 +.br +How often should the volume size be checked (seconds). + +\fBsd_validate_timeout\fR = 80 +.br +Storage domain validate timeout, the maximum number of seconds to wait until all the domains will be validated. + +\fBscsi_rescan_minimal_timeout\fR = 2 +.br +The minimum number of seconds to wait for scsi scan to return. + +\fBscsi_rescan_maximal_timeout\fR = 30 +.br +The maximal number of seconds to wait for scsi scan to return. + +\fBsd_health_check_delay\fR = 10 +.br +Storage domain health check delay, the amount of seconds to wait between two successive run of the domain health check. + +\fBnfs_mount_options\fR = soft,nosharecache +.br +NFS mount options, comma-separated list (NB: no white space allowed!) + +\fBpools_data_dir\fR = /var/run/vdsm/pools +.br +Pool data dir + +\fBvol_extend_policy\fR = ON +.br +Volume extend policy + +\fBlock_util_path\fR = /usr/libexec/vdsm +.br +Block util path + +\fBlock_cmd\fR = spmprotect.sh +.br +The lock command + +\fBfree_lock_cmd\fR = spmstop.sh +.br +The free lock command + +\fBthread_pool_size\fR = 10 +.br +Thread pool size + +\fBmax_tasks\fR = 500 +.br +Number max of tasks + +\fBlvm_dev_whitelist\fR +.br +LVM whitelist + +\fBmd_backup_versions\fR = 30 +.br +Versions of backup + +\fBmd_backup_dir\fR = /var/log/vdsm/backup +.br +Backup dir + +\fBmaximum_allowed_pvs\fR = 8 +.br +The number of PVs per VG has a hard-coded limit of 10. + +\fBrepo_stats_cache_refresh_timeout\fR = 300 +.br +Repo stats cache refresh + +\fBtask_resource_default_timeout\fR = 120000 +.br +Task resource default timeout + +\fBprepare_image_timeout\fR = 600000 +.br +Prepare image timeout + +\fBgc_blocker_force_collect_interval\fR = 60 +.br +Force collect interval + +\fBmaximum_domains_in_pool\fR = 100 +.br +Process pool configuration. + +\fBprocess_pool_size\fR = 100 +.br +Pool size + +\fBprocess_pool_timeout\fR = 60 +.br +Pool timeout + +\fBprocess_pool_grace_period\fR = 2 +.br +Pool grace period + +\fBprocess_pool_max_slots_per_domain\fR = 10 +.br +Max slots per domain + +\fBiscsi_default_ifaces\fR = default +.br +Comma seperated ifaces to connect with. i.e. iser,default + +\fBuse_volume_leases\fR = false +.br +Whether to use the volume leases or not. + +.B [address] +.br +\fBmanagement_port\fR = 54321 +.br +Port on which the vdsmd server listens to network clients + +\fBss_pool_timeoutjson_port\fR = 4044 +.br +Port on which the vdsmd Json RPC server listens to network clients + +\fBmanagement_ip\fR +.br +IP address of management server + +\fBguests_gateway_ip\fR +.br +Guests gateway IP address + +.SH "SEE ALSO" +.PP + +\fBvdsClient\fR(1), +\fBvdsmd\fR(8) + +.SH AUTHOR +VDSM was written by Ayal Baron, Barak Azulay, Cyril Plisko, Dan Kenigsberg, +Doron Fediuck, Igor Lvovsky, Saggi Mizrahi, Shahar Frank, Simon Grinberg and +others. + +.SH BUGS +Report bugs to <http://bugzilla.redhat.com> + +.SH COPYRIGHT +Copyright 2010-2013 Red Hat, Inc. License GPLv2: GNU GPL Version 2 <http://gnu.org/licenses/gpl.html>;. -- To view, visit http://gerrit.ovirt.org/22891 To unsubscribe, visit http://gerrit.ovirt.org/settings Gerrit-MessageType: newchange Gerrit-Change-Id: Id8e5a47d484fa06070d4566a39cab8a7a53ea717 Gerrit-PatchSet: 1 Gerrit-Project: vdsm Gerrit-Branch: master Gerrit-Owner: Douglas Schilling Landgraf <dougsland(a)redhat.com&gt;