Merge pull request #2806 from brauner/2019-01-27/bugfixes

[mirror_lxc.git] / doc / lxc-create.sgml.in

diff --git a/doc/lxc-create.sgml.in b/doc/lxc-create.sgml.in
index 3339bf3df7992e80541e4a7f7dfb2ac01b8e16b8..1e97c40b15dcde396b793aff0d2c51bf37483c67 100644 (file)
--- a/doc/lxc-create.sgml.in
+++ b/doc/lxc-create.sgml.in
@@ -92,7 +92,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
        <term>
-         <option>-f <replaceable>config_file</replaceable></option>
+         <option>-f, --config <replaceable>config_file</replaceable></option>
        </term>
        <listitem>
          <para>
@@ -104,7 +104,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
        <term>
-         <option>-t <replaceable>template</replaceable></option>
+         <option>-t, --template <replaceable>template</replaceable></option>
        </term>
        <listitem>
          <para>
@@ -122,11 +122,11 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
        <term>
-         <option>-B <replaceable>backingstore</replaceable></option>
+         <option>-B, --bdev <replaceable>backingstore</replaceable></option>
        </term>
        <listitem>
          <para>
-           'backingstore' is one of 'dir', 'lvm', 'loop', 'btrfs', 'zfs', or 'best'.  The
+           'backingstore' is one of 'dir', 'lvm', 'loop', 'btrfs', 'zfs', 'rbd', or 'best'.  The
            default is 'dir', meaning that the container root filesystem
            will be a directory under <filename>@LXCPATH@/container/rootfs</filename>.
            This backing store type allows the optional
@@ -157,6 +157,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
          <para>
            If backingstore is 'loop', you can use <replaceable>--fstype FSTYPE</replaceable> and <replaceable>--fssize SIZE</replaceable> as 'lvm'. The default values for these options are the same as 'lvm'.
          </para>
+         <para>
+           If backingstore is 'rbd', then you will need to have a valid configuration in <filename>ceph.conf</filename> and a <filename>ceph.client.admin.keyring</filename> defined.
+           You can specify the following options :
+           <replaceable>--rbdname RBDNAME</replaceable> will create a blockdevice named RBDNAME rather than the default, which is the container name.
+           <replaceable>--rbdpool POOL</replaceable> will create the blockdevice in the pool named POOL, rather than the default, which is 'lxc'.
+         </para>
          <para>
            If backingstore is 'best', then lxc will try, in order, btrfs,
            zfs, lvm, and finally a directory backing store.