From: Cory Spitz <cory.spitz@hpe.com>
Date: Fri, 20 Jan 2023 20:58:17 +0000 (-0600)
Subject: LUDOC-512 manual: add append_pool and append_stripe_count
X-Git-Url: https://git.whamcloud.com/?a=commitdiff_plain;h=3141132e3a777d5432681718ecd4fc244fbfa23c;p=doc%2Fmanual.git

LUDOC-512 manual: add append_pool and append_stripe_count

append_pool and append_stripe_count are recommend for O_APPEND

Signed-off-by: Cory Spitz <cory.spitz@hpe.com>
Change-Id: I132d0dc0438d33ecee3f80dd49b9b3e7a9e6a54e
Signed-off-by: Cory Spitz <cory.spitz@hpe.com>
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/49725
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Petros Koutoupis <petros.koutoupis@hpe.com>
Reviewed-by: Jian Yu <yujian@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
---

diff --git a/ManagingStripingFreeSpace.xml b/ManagingStripingFreeSpace.xml
index a84da3d..6cb5c52 100644
--- a/ManagingStripingFreeSpace.xml
+++ b/ManagingStripingFreeSpace.xml
@@ -140,6 +140,21 @@
           in their entirety. Many users would prefer to lose some of their files entirely than all
           of their files partially.</para>
       </listitem>
+      <listitem>
+        <para><emphasis role="bold">Small files.</emphasis> Small files do not benefit from striping
+          because they can be efficiently stored and accessed as a single OST object or even with
+          Data on MDT.</para>
+      </listitem>
+      <listitem>
+        <para><emphasis role="bold">O_APPEND mode.</emphasis> When files are opened for append, they
+          instantiate all uninitialized components expressed in the layout.  Typically, log files are
+          opened for append, and complex layouts can be inefficient.</para>
+        <note>
+          <para>The <literal>mdd.*.append_stripe_count</literal> and <literal>mdd.*.append_pool
+            </literal> options can be used to specify special default striping for files created
+            with <literal> O_APPEND</literal>.</para>
+        </note>
+      </listitem>
     </itemizedlist>
     <section remap="h3">
         <title><indexterm><primary>striping</primary><secondary>size</secondary></indexterm>
@@ -297,6 +312,13 @@ obdidx     objid        objid           group
       <para>To change the striping pattern for a sub-directory, create a directory with desired file
         layout as described above. Sub-directories inherit the file layout of the root/parent
         directory.</para>
+      <note>
+        <para>Special default striping can be used for files created with <literal>O_APPEND</literal>.
+          Files with uninitialized layouts opened with <literal>O_APPEND</literal> will
+          override a directory's default striping configuration and abide by the <literal>
+          mdd.*.append_pool</literal> and <literal>mdd.*.append_stripe_count</literal> options (if
+          they are specified).</para>
+      </note>
     </section>
     <section remap="h3">
       <title><indexterm>
@@ -312,6 +334,13 @@ obdidx     objid        objid           group
           to any new child directories created in the root directory, unless striping settings have
           been specified for the child directory.</para>
       </note>
+      <note>
+        <para>Special default striping can be used for files created with <literal>O_APPEND</literal>.
+          Files with uninitialized layouts opened with <literal>O_APPEND</literal> will
+          override a file system's default striping configuration and abide by the <literal>
+          mdd.*.append_pool</literal> and <literal>mdd.*.append_stripe_count</literal> options (if
+          they are specified).</para>
+      </note>
     </section>
     <section remap="h3">
       <title><indexterm>