Editing UBC consistency check

{{UBC toc}}

System resource control parameters have certain interdependencies. Constraints on the parameter settings are listed below. Indexes <code>bar and <code>lim</code> in the formulae below mean the barrier and the limit of the parameters, respectively.

Configuration of resource control parameters for a container
is invalid if these constraints are not satisfied. '''The best way to ensure the
validity of the configuration is to use the {{man|vzcfgvalidate|8}} utility.'''

All the interdependencies discussed below and their importance are summarized in [[UBC interdependencies table]].

The configured limits can be checked through
* /[[proc/user_beancounters]] interface;
* [[BC proc entries|/proc/bc/]] interface;
* {{Man|vzubc|8}} utility;
* container configuration files in <code>/etc/vz/conf/</code> directory;


== kmemsize should be enough for the expected number of processes ==
<math>kmemsize_{bar} \ge 40KB \cdot avnumproc + dcachesize_{lim}</math>

(<code>avnumproc</code> here stands for the expected average number of processes).

This constraint is important for applications to work reliably in the
container.
If it is not satisfied, applications will start to fail in the middle of
operations instead of failing while spawning more processes
and the application's ability to handle resource shortage will be very
limited.

== Memory allocation limits should not be less than the guarantee ==
<math> privvmpages_{bar} \ge vmguarpages_{bar}</math>

If this constraint is not satisfied, <code>vmguarpages</code> will not work.

== Send buffers should have enough space for all sockets ==
<math>tcpsndbuf_{lim} - tcpsndbuf_{bar} \ge 2.5KB \cdot numtcpsock</math>

<math>othersockbuf_{lim} - othersockbuf_{bar} \ge 2.5KB \cdot numothersock</math>

These constraints are also important.
If they are not satisfied, transmission of data over the sockets
may hang in some circumstances.

== Other TCP socket buffers should be big enough ==
<math>tcprcvbuf_{lim} - tcprcvbuf_{bar} \ge 2.5KB \cdot numtcpsock</math>

<math>tcprcvbuf_{bar} \ge 64KB</math>

<math>tcpsndbuf_{bar} \ge 64KB</math>

Selecting the left side equal to the right side in the inequalities
above ensures minimal performance of network communications.
Increasing the left side will increase performance to a certain extent.

== UDP socket buffers should be large enough if the system is not tight on memory ==
<math>dgramrcvbuf_{bar} \ge 129KB</math>

<math>othersockbuf_{bar} \ge 129KB</math>

These constraints are desired, but not essential.
Large enough buffers for UDP sockets improve reliability of datagram delivery.
However, note that if the UDP traffic is so bursty that it needs larger
buffers, the datagrams will likely be lost not because of resource control
limits, but because of other memory and performance limitations.

== Number of files limit should be adequate for the expected number of processes ==
<math>numfile \ge avnumproc \cdot 32</math>

Note that each process after a <code>execve(2)</code> system call
requires a file for each loaded shared library.
A too low <code>numfile</code> limit will increase the chances of failures
during <code>execve(2)</code> calls with error messages that are not clear
to the users.

== The limit on the total size of <code>dentry</code> and <code>inode</code> structures locked in memory should be adequate for allowed number of files ==

<math>dcachesize_{bar} \ge numfile \cdot 384\ \rm(bytes)</math>

A too low <code>dcachesize</code> limit will increase the chances of
file operation refusals resulting in unexpected application failures. 

== Barrier should be less or equal than limit ==
In addition to the conditions listed above,

<math>barrier \le limit</math>

should be maintained for each parameter.

== Code ==
See [[User:Grin/openvz checker.pl]] for a contributed code to check the consistency.

[[Category:Troubleshooting]]