]>
Commit | Line | Data |
---|---|---|
4019712d SG |
1 | |
2 | <!-- | |
3 | ||
4 | (C) Copyright Canonical Ltd. 2013 | |
5 | ||
6 | Authors: | |
7 | Stéphane Graber <stgraber@ubuntu.com> | |
8 | ||
9 | This library is free software; you can redistribute it and/or | |
10 | modify it under the terms of the GNU Lesser General Public | |
11 | License as published by the Free Software Foundation; either | |
12 | version 2.1 of the License, or (at your option) any later version. | |
13 | ||
14 | This library is distributed in the hope that it will be useful, | |
15 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
17 | Lesser General Public License for more details. | |
18 | ||
19 | You should have received a copy of the GNU Lesser General Public | |
20 | License along with this library; if not, write to the Free Software | |
250b1eec | 21 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
4019712d SG |
22 | |
23 | --> | |
24 | ||
7f951458 | 25 | <!DOCTYPE refentry PUBLIC @docdtd@ [ |
4019712d SG |
26 | |
27 | <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> | |
28 | ]> | |
29 | ||
30 | <refentry> | |
31 | ||
32 | <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo> | |
33 | ||
34 | <refmeta> | |
35 | <refentrytitle>lxc-start-ephemeral</refentrytitle> | |
36 | <manvolnum>1</manvolnum> | |
37 | </refmeta> | |
38 | ||
39 | <refnamediv> | |
40 | <refname>lxc-start-ephemeral</refname> | |
41 | ||
42 | <refpurpose> | |
43 | start an ephemeral copy of an existing container | |
44 | </refpurpose> | |
45 | </refnamediv> | |
46 | ||
47 | <refsynopsisdiv> | |
48 | <cmdsynopsis> | |
49 | <command>lxc-start-ephemeral</command> | |
50 | <arg choice="opt">-o</arg> | |
51 | <arg choice="opt">-n</arg> | |
52 | <arg choice="opt">-d</arg> | |
53 | <arg choice="opt">--bdir</arg> | |
54 | <arg choice="opt">--user</arg> | |
55 | <arg choice="opt">--key</arg> | |
8128cf42 | 56 | <arg choice="opt">--storage-type</arg> |
4019712d SG |
57 | <arg choice="opt">--union-type</arg> |
58 | <arg choice="opt">--keep-data</arg> | |
59 | <arg choice="opt">COMMAND</arg> | |
60 | </cmdsynopsis> | |
61 | </refsynopsisdiv> | |
62 | ||
63 | <refsect1> | |
64 | <title>Description</title> | |
65 | <para> | |
66 | <command>lxc-start-ephemeral</command> start an ephemeral copy of an | |
67 | existing container. | |
68 | </para> | |
69 | </refsect1> | |
70 | ||
71 | <refsect1> | |
72 | <title>Options</title> | |
73 | <variablelist> | |
74 | <varlistentry> | |
75 | <term> | |
1bc07a5b | 76 | <option>-o, --orig <replaceable>orig</replaceable></option> |
4019712d SG |
77 | </term> |
78 | <listitem> | |
79 | <para> | |
80 | Original container name | |
81 | </para> | |
82 | </listitem> | |
83 | </varlistentry> | |
84 | ||
85 | <varlistentry> | |
86 | <term> | |
1bc07a5b | 87 | <option>-n, --name <replaceable>name</replaceable></option> |
4019712d SG |
88 | </term> |
89 | <listitem> | |
90 | <para> | |
91 | Name of the ephemeral container (defaults to a random suffix). | |
92 | </para> | |
93 | </listitem> | |
94 | </varlistentry> | |
95 | ||
96 | <varlistentry> | |
97 | <term> | |
1bc07a5b | 98 | <option>-d, --daemon</option> |
4019712d SG |
99 | </term> |
100 | <listitem> | |
101 | <para> | |
102 | Start the container in background and print the name and IP. | |
103 | This option can't be used if a command is passed. | |
104 | </para> | |
105 | </listitem> | |
106 | </varlistentry> | |
107 | ||
108 | <varlistentry> | |
109 | <term> | |
1bc07a5b | 110 | <option>-b, --bdir <replaceable>bdir</replaceable></option> |
4019712d SG |
111 | </term> |
112 | <listitem> | |
113 | <para> | |
114 | Directory to bind mount into container. | |
115 | Can be passed multiple times. | |
116 | </para> | |
117 | </listitem> | |
118 | </varlistentry> | |
119 | ||
120 | <varlistentry> | |
121 | <term> | |
1bc07a5b | 122 | <option>-u, --user <replaceable>user</replaceable></option> |
4019712d SG |
123 | </term> |
124 | <listitem> | |
125 | <para> | |
126 | The user to connect to the container as. | |
127 | Used when passing a command to lxc-start-ephemeral. | |
128 | </para> | |
129 | </listitem> | |
130 | </varlistentry> | |
131 | ||
132 | <varlistentry> | |
133 | <term> | |
1bc07a5b | 134 | <option>-S, --key <replaceable>key</replaceable></option> |
4019712d SG |
135 | </term> |
136 | <listitem> | |
137 | <para> | |
138 | Copy the provided SSH public key into the container. | |
139 | </para> | |
140 | </listitem> | |
141 | </varlistentry> | |
142 | ||
8128cf42 KY |
143 | <varlistentry> |
144 | <term> | |
1bc07a5b | 145 | <option>-s, --storage-type <replaceable>storage type</replaceable></option> |
8128cf42 KY |
146 | </term> |
147 | <listitem> | |
148 | <para> | |
149 | Specify the type of storage used by the container. Valid types are tmpfs or dir. | |
150 | </para> | |
151 | </listitem> | |
152 | </varlistentry> | |
153 | ||
4019712d SG |
154 | <varlistentry> |
155 | <term> | |
1bc07a5b | 156 | <option>-U, --union-type <replaceable>union type</replaceable></option> |
4019712d SG |
157 | </term> |
158 | <listitem> | |
159 | <para> | |
160 | Force a specific union file system. | |
161 | Can be one of: overlayfs aufs | |
162 | </para> | |
163 | </listitem> | |
164 | </varlistentry> | |
165 | ||
166 | <varlistentry> | |
167 | <term> | |
1bc07a5b | 168 | <option>-k, --keep-data</option> |
4019712d SG |
169 | </term> |
170 | <listitem> | |
171 | <para> | |
172 | Use a persistent backend instead of tmpfs. | |
173 | With this option, you can lxc-stop and lxc-start the no longer so | |
174 | ephemeral container (it's still an overlay, but a persistent one). | |
175 | </para> | |
176 | </listitem> | |
177 | </varlistentry> | |
178 | ||
179 | <varlistentry> | |
180 | <term> | |
1bc07a5b | 181 | <option>COMMAND</option> |
4019712d SG |
182 | </term> |
183 | <listitem> | |
184 | <para> | |
185 | Immediately run the provided command in the container. | |
56e4a185 KY |
186 | This uses attach if the kernel supports it, otherwise uses ssh. |
187 | This is incompatible with daemon mode. | |
4019712d SG |
188 | </para> |
189 | </listitem> | |
190 | </varlistentry> | |
191 | </variablelist> | |
192 | </refsect1> | |
193 | ||
194 | <refsect1> | |
195 | <title>See Also</title> | |
196 | ||
197 | <simpara> | |
198 | <citerefentry> | |
199 | <refentrytitle>lxc-start</refentrytitle> | |
200 | <manvolnum>1</manvolnum> | |
201 | </citerefentry>, | |
202 | </simpara> | |
d438f5a0 | 203 | </refsect1> |
4019712d | 204 | |
d438f5a0 | 205 | <refsect1> |
4019712d SG |
206 | <title>Examples</title> |
207 | <variablelist> | |
208 | <varlistentry> | |
209 | <term>lxc-start-ephemeral -o p1</term> | |
210 | <listitem> | |
211 | <para> | |
212 | Simply start an ephemeral container and attach to the console. | |
213 | This container will be based on existing container "p1". | |
214 | </para> | |
215 | </listitem> | |
216 | </varlistentry> | |
217 | ||
218 | <varlistentry> | |
219 | <term>lxc-start-ephemeral -o p1 -n p1-ephemeral -d</term> | |
220 | <listitem> | |
221 | <para> | |
222 | Start an ephemeral container based on p1 called p1-ephemeral and | |
223 | print its IP and name to the console instead of attaching. | |
224 | </para> | |
225 | </listitem> | |
226 | </varlistentry> | |
227 | </variablelist> | |
228 | </refsect1> | |
229 | ||
02e5d92b CB |
230 | <refsect1> |
231 | <title>Notes</title> | |
232 | <para> | |
2ae6732f | 233 | <command>lxc-start-ephemeral</command> is deprecated in favor of |
02e5d92b CB |
234 | <command>lxc-copy</command>. |
235 | </para> | |
236 | </refsect1> | |
237 | ||
4019712d SG |
238 | &seealso; |
239 | ||
240 | <refsect1> | |
241 | <title>Author</title> | |
242 | <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para> | |
243 | </refsect1> | |
244 | </refentry> | |
245 | ||
246 | <!-- Keep this comment at the end of the file | |
247 | Local variables: | |
248 | mode: sgml | |
249 | sgml-omittag:t | |
250 | sgml-shorttag:t | |
251 | sgml-minimize-attributes:nil | |
252 | sgml-always-quote-attributes:t | |
253 | sgml-indent-step:2 | |
254 | sgml-indent-data:t | |
255 | sgml-parent-document:nil | |
256 | sgml-default-dtd-file:nil | |
257 | sgml-exposed-tags:nil | |
258 | sgml-local-catalogs:nil | |
259 | sgml-local-ecat-files:nil | |
260 | End: | |
261 | --> |