]>
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> | |
56 | <arg choice="opt">--union-type</arg> | |
57 | <arg choice="opt">--keep-data</arg> | |
58 | <arg choice="opt">COMMAND</arg> | |
59 | </cmdsynopsis> | |
60 | </refsynopsisdiv> | |
61 | ||
62 | <refsect1> | |
63 | <title>Description</title> | |
64 | <para> | |
65 | <command>lxc-start-ephemeral</command> start an ephemeral copy of an | |
66 | existing container. | |
67 | </para> | |
68 | </refsect1> | |
69 | ||
70 | <refsect1> | |
71 | <title>Options</title> | |
72 | <variablelist> | |
73 | <varlistentry> | |
74 | <term> | |
75 | <option>-o</option> | |
76 | </term> | |
77 | <listitem> | |
78 | <para> | |
79 | Original container name | |
80 | </para> | |
81 | </listitem> | |
82 | </varlistentry> | |
83 | ||
84 | <varlistentry> | |
85 | <term> | |
86 | <option><optional>-n</optional></option> | |
87 | </term> | |
88 | <listitem> | |
89 | <para> | |
90 | Name of the ephemeral container (defaults to a random suffix). | |
91 | </para> | |
92 | </listitem> | |
93 | </varlistentry> | |
94 | ||
95 | <varlistentry> | |
96 | <term> | |
97 | <option><optional>-d</optional></option> | |
98 | </term> | |
99 | <listitem> | |
100 | <para> | |
101 | Start the container in background and print the name and IP. | |
102 | This option can't be used if a command is passed. | |
103 | </para> | |
104 | </listitem> | |
105 | </varlistentry> | |
106 | ||
107 | <varlistentry> | |
108 | <term> | |
109 | <option><optional>--bdir</optional></option> | |
110 | </term> | |
111 | <listitem> | |
112 | <para> | |
113 | Directory to bind mount into container. | |
114 | Can be passed multiple times. | |
115 | </para> | |
116 | </listitem> | |
117 | </varlistentry> | |
118 | ||
119 | <varlistentry> | |
120 | <term> | |
121 | <option><optional>--user</optional></option> | |
122 | </term> | |
123 | <listitem> | |
124 | <para> | |
125 | The user to connect to the container as. | |
126 | Used when passing a command to lxc-start-ephemeral. | |
127 | </para> | |
128 | </listitem> | |
129 | </varlistentry> | |
130 | ||
131 | <varlistentry> | |
132 | <term> | |
133 | <option><optional>--key</optional></option> | |
134 | </term> | |
135 | <listitem> | |
136 | <para> | |
137 | Copy the provided SSH public key into the container. | |
138 | </para> | |
139 | </listitem> | |
140 | </varlistentry> | |
141 | ||
142 | <varlistentry> | |
143 | <term> | |
144 | <option><optional>--union-type</optional></option> | |
145 | </term> | |
146 | <listitem> | |
147 | <para> | |
148 | Force a specific union file system. | |
149 | Can be one of: overlayfs aufs | |
150 | </para> | |
151 | </listitem> | |
152 | </varlistentry> | |
153 | ||
154 | <varlistentry> | |
155 | <term> | |
156 | <option><optional>--keep-data</optional></option> | |
157 | </term> | |
158 | <listitem> | |
159 | <para> | |
160 | Use a persistent backend instead of tmpfs. | |
161 | With this option, you can lxc-stop and lxc-start the no longer so | |
162 | ephemeral container (it's still an overlay, but a persistent one). | |
163 | </para> | |
164 | </listitem> | |
165 | </varlistentry> | |
166 | ||
167 | <varlistentry> | |
168 | <term> | |
169 | <option><optional>COMMAND</optional></option> | |
170 | </term> | |
171 | <listitem> | |
172 | <para> | |
173 | Immediately run the provided command in the container. | |
174 | This currently uses ssh (not attach) and is incompatible | |
175 | with daemon mode. | |
176 | </para> | |
177 | </listitem> | |
178 | </varlistentry> | |
179 | </variablelist> | |
180 | </refsect1> | |
181 | ||
182 | <refsect1> | |
183 | <title>See Also</title> | |
184 | ||
185 | <simpara> | |
186 | <citerefentry> | |
187 | <refentrytitle>lxc-start</refentrytitle> | |
188 | <manvolnum>1</manvolnum> | |
189 | </citerefentry>, | |
190 | </simpara> | |
191 | ||
192 | <title>Examples</title> | |
193 | <variablelist> | |
194 | <varlistentry> | |
195 | <term>lxc-start-ephemeral -o p1</term> | |
196 | <listitem> | |
197 | <para> | |
198 | Simply start an ephemeral container and attach to the console. | |
199 | This container will be based on existing container "p1". | |
200 | </para> | |
201 | </listitem> | |
202 | </varlistentry> | |
203 | ||
204 | <varlistentry> | |
205 | <term>lxc-start-ephemeral -o p1 -n p1-ephemeral -d</term> | |
206 | <listitem> | |
207 | <para> | |
208 | Start an ephemeral container based on p1 called p1-ephemeral and | |
209 | print its IP and name to the console instead of attaching. | |
210 | </para> | |
211 | </listitem> | |
212 | </varlistentry> | |
213 | </variablelist> | |
214 | </refsect1> | |
215 | ||
216 | &seealso; | |
217 | ||
218 | <refsect1> | |
219 | <title>Author</title> | |
220 | <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para> | |
221 | </refsect1> | |
222 | </refentry> | |
223 | ||
224 | <!-- Keep this comment at the end of the file | |
225 | Local variables: | |
226 | mode: sgml | |
227 | sgml-omittag:t | |
228 | sgml-shorttag:t | |
229 | sgml-minimize-attributes:nil | |
230 | sgml-always-quote-attributes:t | |
231 | sgml-indent-step:2 | |
232 | sgml-indent-data:t | |
233 | sgml-parent-document:nil | |
234 | sgml-default-dtd-file:nil | |
235 | sgml-exposed-tags:nil | |
236 | sgml-local-catalogs:nil | |
237 | sgml-local-ecat-files:nil | |
238 | End: | |
239 | --> |