From 396639d4247ffd9aaf09a814305fd1d57fef7b58 Mon Sep 17 00:00:00 2001 From: Daniel Lezcano Date: Fri, 28 May 2010 17:01:45 +0200 Subject: [PATCH] update lxc-checkpoint / lxc-restart man Add documentation for checkpoint / restart CLI. Signed-off-by: Daniel Lezcano --- configure.ac | 2 + doc/Makefile.am | 2 + doc/lxc-checkpoint.sgml.in | 191 ++++++++++++++++++++++++++++++++++ doc/lxc-kill.sgml.in | 43 ++++++-- doc/lxc-restart.sgml.in | 203 +++++++++++++++++++++++++++++++++++++ 5 files changed, 430 insertions(+), 11 deletions(-) create mode 100644 doc/lxc-checkpoint.sgml.in create mode 100644 doc/lxc-restart.sgml.in diff --git a/configure.ac b/configure.ac index 537027082..e91f69e07 100644 --- a/configure.ac +++ b/configure.ac @@ -105,6 +105,8 @@ AC_CONFIG_FILES([ doc/lxc-destroy.sgml doc/lxc-execute.sgml doc/lxc-start.sgml + doc/lxc-checkpoint.sgml + doc/lxc-restart.sgml doc/lxc-stop.sgml doc/lxc-console.sgml doc/lxc-freeze.sgml diff --git a/doc/Makefile.am b/doc/Makefile.am index 2ac522590..8530ee995 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -12,6 +12,8 @@ man_MANS = \ lxc-execute.1 \ lxc-start.1 \ lxc-stop.1 \ + lxc-checkpoint.1 \ + lxc-restart.1 \ lxc-console.1 \ lxc-freeze.1 \ lxc-unfreeze.1 \ diff --git a/doc/lxc-checkpoint.sgml.in b/doc/lxc-checkpoint.sgml.in new file mode 100644 index 000000000..94befe67f --- /dev/null +++ b/doc/lxc-checkpoint.sgml.in @@ -0,0 +1,191 @@ + + + + +]> + + + + @LXC_GENERATE_DATE@ + + + lxc-checkpoint + 1 + IBM + + + + lxc-checkpoint + + + checkpoint a running container + + + + + + lxc-checkpoint + --statefile=FILE + --statefd=FD + --name=NAME + | + + + + + Description + + + lxc-checkpoint is a command + to checkpoint the specified container + NAME and dumps its state into the file + FILE. If the + option is specified, the application + running in the container will terminate after the checkpoint + just before resuming its execution. If the + option is specified, the application + will be stopped after the checkpoint just before resuming + execution. The command lxc-unfreeze will + resume its execution. + + + + + + Checkpoint Options + + + + + + + + write the state of the container in this + FILE. + This option is exclusive with below. + + + + + + + + + write the state of the container in this + FD file descriptor. + This option is exclusive with above . + + + + + + + + + Kill container processes after checkpoint. the processes are sent + a SIGKILL signal. + + + This option is mutually exclusive with the following + option. + + + + + + + + + Pause container processes after checkpoint. The container + will be stopped until you resume it. This option is + mutually exclusive with previously mentionned + option. + + + + + + + + + &commonoptions; + + + Examples + + To start a new container 123 computing decimals of pi + + + lxc-execute -n 123 -- pi1 -d 500000 + lxc-execute --name=123 -- pi1 -d 500000 + + + + to checkpoint the same container in dump-death + mode + + + lxc-checkpoint -n 123 -S /share/123/chkpt1 -k + lxc-checkpoint --name=123 -S /share/123/chkpt1 -k + + + + to checkpoint the same container and pause it + + + lxc-checkpoint -n 123 -S /share/123/chkpt1 -p + lxc-checkpoint --name=123 -S /share/123/chkpt1 -p + + + + + &seealso; + + + Author + Daniel Lezcano daniel.lezcano@free.fr + + + + + diff --git a/doc/lxc-kill.sgml.in b/doc/lxc-kill.sgml.in index 2b06ab866..5bec92247 100644 --- a/doc/lxc-kill.sgml.in +++ b/doc/lxc-kill.sgml.in @@ -1,13 +1,32 @@ + + - - -mcr -"> - ]> @@ -41,10 +60,9 @@ lxc-kill send the SIGNUM signal to the first process of the container. - - The SIGNUM is a numeric value, - the signal name is not supported. + The SIGNUM is a numeric value, + the signal name is not supported. If this command is used on an application container ran by @@ -73,10 +91,13 @@ - ©rights; - &seealso; + + Author + Daniel Lezcano daniel.lezcano@free.fr + + + + + +]> + + + + @LXC_GENERATE_DATE@ + + + lxc-restart + 1 + IBM + + + + lxc-restart + + + restart a container from a file + + + + + + lxc-restart -f + config_file-s KEY=VAL + --statefile=FILE + --statefd=FD + + + + + + Description + + + lxc-restart is a command + to restart an application from the state read in the specified + FILE, in a container with the + identifier NAME. + If the option + is specified, the application will be stopped after the + restart just before resuming execution. The command + lxc-unfreeze will be needed to resume its + execution. + + + + + Restart Options + + + + + + + read the state of the container in this + FILE. + This option is exclusive with below. + + + + + + + + + read the state of the container in this + FD file descriptor. + This option is exclusive with above . + + + + + + + + + Pause container processes after restart. The container will be + stopped until you resume it with the lxc-unfreeze command. + + + + + + + + + Specify the configuration file to configure the + virtualization and isolation functionalities for the + container. This parameter should be specified if it was + specified for the lxc-execute + or lxc-start commands or if the + container configuration has to be changed at restart. The + latter may fail if the needed resources are not available + for the restart. If the container was created and + configured with lxc-create, this option + is not needed, the configuration will be automatically + found. + + + + + + + + + + + Assign value VAL to configuration + variable KEY. This overrides any + assignment done in config_file. + + + + + + + + + &commonoptions; + + + Examples + + To start a new container 123 computing decimals of pi + + + lxc-execute -n 123 -- pi1 -d 500000 + lxc-execute --name=123 -- pi1 -d 500000 + + + + to checkpoint the same container in dump-death + mode + + + lxc-checkpoint -n 123 -S /share/123/chkpt1 -k + lxc-checkpoint --name=123 --statefile=/share/123/chkpt1 -k + + + + and to restart the same container with a different id + + + lxc-restart -n 200 -S /share/123/chkpt1 + lxc-restart --name=200 --statefile=/share/123/chkpt1 + + + + + &seealso; + + + Author + Daniel Lezcano daniel.lezcano@free.fr + + + + + -- 2.47.2