aboutsummaryrefslogtreecommitdiff
blob: eb556d9cca0ef68d803cd4abb152c8ef054c7289 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
<!--

lxc: linux Container library

(C) Copyright IBM Corp. 2007, 2008

Authors:
Daniel Lezcano <dlezcano at fr.ibm.com>

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

-->

<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [

<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]>

<refentry>

  <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>

  <refmeta>
    <refentrytitle>lxc-restart</refentrytitle>
    <manvolnum>1</manvolnum>
    <refmiscinfo>IBM</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>lxc-restart</refname>

    <refpurpose>
      restart a container from a file (not implemented yet)
    </refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>lxc-restart <optional>-f
	config_file</optional><optional>-s KEY=VAL</optional>
	--statefile=<replaceable>FILE</replaceable>
	--statefd=<replaceable>FD</replaceable></command>
      <arg choice="req"><option>--name=<replaceable>NAME</replaceable></option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para>
      <command>lxc-restart</command> is a command
      to restart an application from the state read in the specified
      <replaceable>FILE</replaceable>, in a container with the
      identifier <replaceable>NAME</replaceable>.
      If the option <option>--pause</option>
      is specified, the application will be stopped after the
      restart just before resuming execution. The command
      <command>lxc-unfreeze</command> will be needed to resume its
      execution.
    </para>
  </refsect1>

  <refsect1>
    <title>Restart Options</title>

    <variablelist>
      <varlistentry>
	<term><option>-S, --statefile=<replaceable>FILE</replaceable></option></term>
	<listitem>
	  <para>
	    read the state of the container in this
	    <replaceable>FILE</replaceable>.
	    This option is exclusive with <option>--statefd</option> below.
	  </para>
	</listitem>
      </varlistentry>

	<varlistentry>
	<term><option>-d, --statefd=<replaceable>FD</replaceable></option></term>
	<listitem>
	  <para>
	    read the state of the container in this
	    <replaceable>FD</replaceable> file descriptor.
	    This option is exclusive with above <option>--statefile</option>.
	  </para>
	</listitem>
	</varlistentry>

	<varlistentry>
	<term><option>-p</option></term>
	<listitem>
	  <para>
	    Pause container processes after restart. The container will be
	    stopped until you resume it with the lxc-unfreeze command.
	  </para>
	</listitem>
	</varlistentry>

	<varlistentry>
	<term><option>-f, --rcfile=<replaceable>config_file</replaceable></option></term>
	<listitem>
	  <para>
	    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 <command>lxc-execute</command>
	    or <command>lxc-start</command> 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 <command>lxc-create</command>, this option
	    is not needed, the configuration will be automatically
	    found.
	  </para>
	</listitem>
	</varlistentry>

	<varlistentry>
	<term>
	  <option>-s <replaceable>KEY=VAL</replaceable></option>
	</term>
	<listitem>
	  <para>
	    Assign value <replaceable>VAL</replaceable> to configuration
	    variable <replaceable>KEY</replaceable>. This overrides any
	    assignment done in <replaceable>config_file</replaceable>.
	  </para>
	</listitem>
      </varlistentry>

    </variablelist>

  </refsect1>

  &commonoptions;

  <refsect1>
    <title>Examples</title>
    <para>
      To start a new container <literal>123</literal> computing decimals of pi
    </para>
    <programlisting>
      lxc-execute -n 123 -- pi1 -d 500000
      lxc-execute --name=123 -- pi1 -d 500000
    </programlisting>

    <para>
      to checkpoint the same container in <emphasis>dump-death</emphasis>
      mode
    </para>
    <programlisting>
      lxc-checkpoint -n 123 -S /share/123/chkpt1 -k
      lxc-checkpoint --name=123 --statefile=/share/123/chkpt1 -k
    </programlisting>

    <para>
      and to restart the same container with a different id
    </para>
    <programlisting>
      lxc-restart -n 200 -S /share/123/chkpt1
      lxc-restart --name=200 --statefile=/share/123/chkpt1
    </programlisting>

   </refsect1>

  <refsect1>
    <title>Notes</title>
    <para>Actually, this command does not operate. Its description
    helps to define a CLI api for future Checkpoint / Restart
    solution</para>
  </refsect1>

  &seealso;

  <refsect1>
    <title>Author</title>
    <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
  </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->