File: lxc-start-ephemeral.sgml.in

package info (click to toggle)
lxc 1%3A1.0.6-6%2Bdeb8u2~bpo70%2B1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy-backports
  • size: 5,280 kB
  • sloc: ansic: 33,888; sh: 11,928; python: 1,223; makefile: 735
file content (241 lines) | stat: -rw-r--r-- 6,184 bytes parent folder | download | duplicates (3)
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241

<!--

(C) Copyright Canonical Ltd. 2013

Authors:
St├ęphane Graber <stgraber@ubuntu.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

-->

<!DOCTYPE refentry PUBLIC @docdtd@ [

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

<refentry>

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

  <refmeta>
    <refentrytitle>lxc-start-ephemeral</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>lxc-start-ephemeral</refname>

    <refpurpose>
      start an ephemeral copy of an existing container
    </refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>lxc-start-ephemeral</command>
      <arg choice="opt">-o</arg>
      <arg choice="opt">-n</arg>
      <arg choice="opt">-d</arg>
      <arg choice="opt">--bdir</arg>
      <arg choice="opt">--user</arg>
      <arg choice="opt">--key</arg>
      <arg choice="opt">--union-type</arg>
      <arg choice="opt">--keep-data</arg>
      <arg choice="opt">COMMAND</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>
    <para>
      <command>lxc-start-ephemeral</command> start an ephemeral copy of an
      existing container.
    </para>
  </refsect1>

  <refsect1>
    <title>Options</title>
    <variablelist>
      <varlistentry>
        <term>
          <option>-o</option>
        </term>
        <listitem>
          <para>
            Original container name
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option><optional>-n</optional></option>
        </term>
        <listitem>
          <para>
            Name of the ephemeral container (defaults to a random suffix).
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option><optional>-d</optional></option>
        </term>
        <listitem>
          <para>
            Start the container in background and print the name and IP.
            This option can't be used if a command is passed.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option><optional>--bdir</optional></option>
        </term>
        <listitem>
          <para>
            Directory to bind mount into container.
            Can be passed multiple times.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option><optional>--user</optional></option>
        </term>
        <listitem>
          <para>
            The user to connect to the container as.
            Used when passing a command to lxc-start-ephemeral.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option><optional>--key</optional></option>
        </term>
        <listitem>
          <para>
            Copy the provided SSH public key into the container.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option><optional>--union-type</optional></option>
        </term>
        <listitem>
          <para>
            Force a specific union file system.
            Can be one of: overlayfs aufs
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option><optional>--keep-data</optional></option>
        </term>
        <listitem>
          <para>
            Use a persistent backend instead of tmpfs.
            With this option, you can lxc-stop and lxc-start the no longer so
            ephemeral container (it's still an overlay, but a persistent one).
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option><optional>COMMAND</optional></option>
        </term>
        <listitem>
          <para>
            Immediately run the provided command in the container.
            This currently uses ssh (not attach) and is incompatible
            with daemon mode.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>See Also</title>

    <simpara>
      <citerefentry>
        <refentrytitle>lxc-start</refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry>,
    </simpara>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <variablelist>
      <varlistentry>
        <term>lxc-start-ephemeral -o p1</term>
        <listitem>
        <para>
          Simply start an ephemeral container and attach to the console.
          This container will be based on existing container "p1".
        </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>lxc-start-ephemeral -o p1 -n p1-ephemeral -d</term>
        <listitem>
        <para>
          Start an ephemeral container based on p1 called p1-ephemeral and
          print its IP and name to the console instead of attaching.
        </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  &seealso;

  <refsect1>
    <title>Author</title>
    <para>St├ęphane Graber <email>stgraber@ubuntu.com</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:
-->