Configuration files - Revision history

Radostin: /* Configuration File Location */

2026-01-03T20:15:20Z

Configuration File Location

Radostin: Reword introduction

2018-11-26T23:56:54Z

Reword introduction

Xemul: Xemul moved page Configuration Files to Configuration files: Lowercase 2nd word

2018-11-06T10:52:01Z

Xemul moved page Configuration Files to Configuration files: Lowercase 2nd word

Adrian at 14:58, 2 August 2018

2018-08-02T14:58:16Z

Adrian at 11:41, 4 July 2018

2018-07-04T11:41:40Z

Adrian at 11:41, 4 July 2018

2018-07-04T11:41:07Z

Adrian at 20:40, 1 July 2018

2018-07-01T20:40:38Z

Adrian: Initial configuration file page

2018-07-01T16:24:57Z

Initial configuration file page

New page

== This Page Is Work In Progress - Not Ready ==

Many of CRIU's command-line options can also be influenced via configuration files. Configuration files are evaluated in [[CLI]] and [[RPC]] mode. It is important to know that configuration files are evaluated before the options set via CLI or RPC. This means that whatever is configured in the configuration files will be overwritten by explicitly set values via CLI or RPC.

=== Configuration File Location ===
The default configuration files parsed by CRIU, it they are present on the system, are first <code>/etc/criu/default.conf</code> and then <code>$HOME/.criu/default.conf</code>. Settings in the file <code>/etc/criu/default.conf</code> are overridden by settings in <code>$HOME/.criu/default.conf</code>.

Without any additional parameters CRIU configuration file parsing works like this:

# <code>/etc/criu/default.conf</code>; these values can be overridden by
# <code>$HOME/.criu/default.conf</code>; these values can be overridden by
# CLI or RPC configuration options

[[Category:CLI]]
[[Category:API]]

← Older revision		Revision as of 20:15, 3 January 2026
Line 15:		Line 15:

	The user can tell CRIU to completely ignore configuration files in one of the default locations (/etc or $HOME) with the <code>--no-default-config</code> option. In this case the user can still tell CRIU to use a configuration file with the <code>--config FILENAME</code> option. CRIU also honours the environment variable <code>CRIU_CONFIG_FILE</code> just as <code>--config FILENAME</code> option.		The user can tell CRIU to completely ignore configuration files in one of the default locations (/etc or $HOME) with the <code>--no-default-config</code> option. In this case the user can still tell CRIU to use a configuration file with the <code>--config FILENAME</code> option. CRIU also honours the environment variable <code>CRIU_CONFIG_FILE</code> just as <code>--config FILENAME</code> option.
		+
		+	Container runtimes such as '''runc''' and '''crun''' (since [https://github.com/containers/crun/releases/tag/1.26 version 1.26]) support container-specific CRIU config file with the [https://github.com/opencontainers/runc/blob/main/docs/checkpoint-restore.md <code>org.criu.config=FILE</code>] annotation, as well as runtime-specific config files that are passed to CRIU via RPC:
		+
		+	* <code>/etc/criu/runc.conf</code>
		+	* <code>/etc/criu/crun.conf</code>
		+
		+	These config files can be used to overwrite the default values of CRIU option set by the container runtime.

	=== Configuration File Syntax ===		=== Configuration File Syntax ===

← Older revision		Revision as of 23:56, 26 November 2018
Line 1:		Line 1:

−	Many of CRIU's command-line options can also be influenced via configuration files. ~~Configuration~~ files are evaluated in [[CLI]] and [[RPC]] mode~~. It is important to know that configuration files are evaluated~~ before the options set via CLI or RPC (except for the RPC configuration file). This means that whatever is configured in the ~~configuration~~ files will be overwritten by explicitly set values via CLI or RPC.	+	Many of CRIU's command-line options can also be influenced via configuration files. These files are evaluated in [[CLI]] and [[RPC]] mode, before the options set via CLI or RPC (except for the RPC configuration file). This means that whatever is configured in the files will be overwritten by explicitly set values via CLI or RPC.

	=== Configuration File Location ===		=== Configuration File Location ===

@@ Line 1: / Line 1: @@
-Many of CRIU's command-line options can also be influenced via configuration files. Configuration files are evaluated in [[CLI]] and [[RPC]] mode. It is important to know that configuration files are evaluated before the options set via CLI or RPC. This means that whatever is configured in the configuration files will be overwritten by explicitly set values via CLI or RPC.
+Many of CRIU's command-line options can also be influenced via configuration files. Configuration files are evaluated in [[CLI]] and [[RPC]] mode. It is important to know that configuration files are evaluated before the options set via CLI or RPC (except for the RPC configuration file). This means that whatever is configured in the configuration files will be overwritten by explicitly set values via CLI or RPC.
 === Configuration File Location ===
-The default configuration files parsed by CRIU, it they are present on the system, are first <code>/etc/criu/default.conf</code> and then <code>$HOME/.criu/default.conf</code>. Settings in the file <code>/etc/criu/default.conf</code> are overridden by settings in <code>$HOME/.criu/default.conf</code>.
+The default configuration files parsed by CRIU, if they are present on the system, are first <code>/etc/criu/default.conf</code> and then <code>$HOME/.criu/default.conf</code>. Settings in the file <code>/etc/criu/default.conf</code> are overridden by settings in <code>$HOME/.criu/default.conf</code>. CRIU also evaluates the configuration file specified via <code>CRIU_CONFIG_FILE</code>.
 Without any additional parameters CRIU configuration file parsing works like this:
@@ Line 10: / Line 9: @@
 # <code>/etc/criu/default.conf</code>; these values can be overridden by
 # <code>$HOME/.criu/default.conf</code>; these values can be overridden by
 # CLI or RPC configuration options
-The user can tell CRIU to completely ignore any configuration file in one of the default locations with the <code>--no-default-config</code> option. In this case the user can still tell CRIU to use a configuration file with the <code>--config FILENAME</code> option. CRIU also honours the environment variable <code>CRIU_CONFIG_FILE</code> just as <code>--config FILENAME</code> option.
+The user can tell CRIU to completely ignore configuration files in one of the default locations (/etc or $HOME) with the <code>--no-default-config</code> option. In this case the user can still tell CRIU to use a configuration file with the <code>--config FILENAME</code> option. CRIU also honours the environment variable <code>CRIU_CONFIG_FILE</code> just as <code>--config FILENAME</code> option.
 === Configuration File Syntax ===
@@ Line 25: / Line 27: @@
 === Configuration Files in RPC Mode ===
-As configuration file settings are overridden by CLI and RPC mode, there is a special RPC options which lets configuration file settings override RPC settings. This is different than the normal sequence and can lead to situation which break the RPC client -> CRIU setup. As this can lead to broken setups the RPC client has to explicitly enable this mode: <code>opts.prefer_config_file = True</code>.
+As configuration file settings are overridden by CLI and RPC mode, there is a special RPC option which let's the RPC user define a configuration file that will overwrite all other configuration file or RPC settings. Using <code>"req.opts.config_file = '/path/to/file'"</code> it is possible to provide such a configuration file that overwrites all other settings.
 === Related ===

@@ Line 27: / Line 27: @@
 As configuration file settings are overridden by CLI and RPC mode, there is a special RPC options which lets configuration file settings override RPC settings. This is different than the normal sequence and can lead to situation which break the RPC client -> CRIU setup. As this can lead to broken setups the RPC client has to explicitly enable this mode: <code>opts.prefer_config_file = True</code>.
-=== Related ==
+=== Related ===
 * [https://github.com/checkpoint-restore/criu/issues/278 CRIU issue #278 : Add /etc/criu.conf and/or /etc/criu.d/ dir]
 * [https://github.com/checkpoint-restore/criu/issues/506 CRIU issue #506 : Pass options from docker cli to criu]

@@ Line 1: / Line 1: @@
-== This Page Is Work In Progress - Not Ready ==
+== This Page Is Work In Progress - Not Ready - Not Merged into master ==
 Many of CRIU's command-line options can also be influenced via configuration files. Configuration files are evaluated in [[CLI]] and [[RPC]] mode. It is important to know that configuration files are evaluated before the options set via CLI or RPC. This means that whatever is configured in the configuration files will be overwritten by explicitly set values via CLI or RPC.
@@ Line 26: / Line 26: @@
 === Configuration Files in RPC Mode ===
 As configuration file settings are overridden by CLI and RPC mode, there is a special RPC options which lets configuration file settings override RPC settings. This is different than the normal sequence and can lead to situation which break the RPC client -> CRIU setup. As this can lead to broken setups the RPC client has to explicitly enable this mode: <code>opts.prefer_config_file = True</code>.
 [[Category:CLI]]
 [[Category:API]]

← Older revision	Revision as of 10:52, 6 November 2018
(No difference)