<!-- 
RSS generated by JIRA (9.4.14#940014-sha1:734e6822bbf0d45eff9af51f82432957f73aa32c) at Sat Feb 10 03:41:24 UTC 2024

It is possible to restrict the fields that are returned in this document by specifying the 'field' parameter in your request.
For example, to request only the issue key and summary append 'field=key&field=summary' to the URL of your request.
-->
<rss version="0.92" >
<channel>
    <title>Whamcloud Community JIRA</title>
    <link>https://jira.whamcloud.com</link>
    <description>This file is an XML representation of an issue</description>
    <language>en-us</language>    <build-info>
        <version>9.4.14</version>
        <build-number>940014</build-number>
        <build-date>05-12-2023</build-date>
    </build-info>


<item>
            <title>[LUDOC-247] recovery_time_soft and recovery_time_hard default value descriptions are misleading</title>
                <link>https://jira.whamcloud.com/browse/LUDOC-247</link>
                <project id="10070" key="LUDOC">Lustre Documentation</project>
                    <description>&lt;p&gt;The documentation for the OST mount options recovery_time_soft and recovery_time_hard is misleading in the way that it describes the default values for these parameters.&lt;/p&gt;

&lt;p&gt;For recovery_time_soft, it says: &quot;The default soft recovery timeout is 300 seconds (5 minutes).&quot;&lt;/p&gt;

&lt;p&gt;For recovery_time_hard, it says: &quot;The default hard recovery timeout is set to 900 seconds (15 minutes).&quot;&lt;/p&gt;

&lt;p&gt;The default (if the recovery_time_{soft,hard} mount options are not given) is actually dependent upon the value of the RPC timeout value which is described in section 32.5.2 of the Lustre manual as &quot;The time that a client waits for a server to complete an RPC....&quot;.&lt;/p&gt;

&lt;p&gt;The recovery_time_{soft,hard} values are set at mount time in the function server_calc_timeout().  If no recovery_time_{soft,hard} options are given to the mount command, the values are set as follows:&lt;/p&gt;

&lt;div class=&quot;code panel&quot; style=&quot;border-width: 1px;&quot;&gt;&lt;div class=&quot;codeContent panelContent&quot;&gt;
&lt;pre class=&quot;code-java&quot;&gt;        &lt;span class=&quot;code-keyword&quot;&gt;if&lt;/span&gt; (soft == 0)
                soft = OBD_RECOVERY_TIME_SOFT;
        &lt;span class=&quot;code-keyword&quot;&gt;if&lt;/span&gt; (hard == 0)
                hard = OBD_RECOVERY_TIME_HARD;
&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;

&lt;p&gt;Those macros are defined as follows:&lt;/p&gt;

&lt;div class=&quot;code panel&quot; style=&quot;border-width: 1px;&quot;&gt;&lt;div class=&quot;codeContent panelContent&quot;&gt;
&lt;pre class=&quot;code-java&quot;&gt;#define OBD_RECOVERY_TIME_HARD          (obd_timeout * 9)
#define OBD_RECOVERY_TIME_SOFT          (obd_timeout * 3)
&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;

&lt;p&gt;Thus, the default values of recovery_time_soft and recovery_time_hard are actually 3 times the RPC timeout and 9 times the RPC timeout, respectively.  If the RPC timeout is set to the default 100 seconds (at OST mount time), then the default values of recovery_time_soft and recovery_time_hard are 300 and 900 seconds, respectively.&lt;/p&gt;</description>
                <environment></environment>
        <key id="25451">LUDOC-247</key>
            <summary>recovery_time_soft and recovery_time_hard default value descriptions are misleading</summary>
                <type id="1" iconUrl="https://jira.whamcloud.com/secure/viewavatar?size=xsmall&amp;avatarId=11303&amp;avatarType=issuetype">Bug</type>
                                            <priority id="4" iconUrl="https://jira.whamcloud.com/images/icons/priorities/minor.svg">Minor</priority>
                        <status id="5" iconUrl="https://jira.whamcloud.com/images/icons/statuses/resolved.png" description="A resolution has been taken, and it is awaiting verification by reporter. From here issues are either reopened, or are closed.">Resolved</status>
                    <statusCategory id="3" key="done" colorName="success"/>
                                    <resolution id="1">Fixed</resolution>
                                        <assignee username="rhenwood">Richard Henwood</assignee>
                                    <reporter username="haasken">Ryan Haasken</reporter>
                        <labels>
                    </labels>
                <created>Mon, 7 Jul 2014 14:57:10 +0000</created>
                <updated>Tue, 16 Feb 2016 16:18:29 +0000</updated>
                            <resolved>Tue, 16 Feb 2016 16:18:29 +0000</resolved>
                                                                        <due></due>
                            <votes>0</votes>
                                    <watches>3</watches>
                                                                            <comments>
                            <comment id="88275" author="haasken" created="Mon, 7 Jul 2014 15:06:03 +0000"  >&lt;p&gt;I would suggest the following changes to section 37.15.3.&lt;/p&gt;

&lt;p&gt;For recovery_time_soft: &quot;The default soft recovery timeout is 3 times the RPC timeout value (see section 32.5.2).  The default RPC timeout is 100 seconds, which would make the soft recovery timeout default to 300 seconds (5 minutes).  The soft recovery timeout is set at mount time and will not change if the RPC timeout is changed after mount time.&quot;&lt;/p&gt;

&lt;p&gt;For recovery_time_hard: &quot;The default hard recovery timeout is 9 times the RPC timeout value (see section 32.5.2).  The default RPC timeout is 100 seconds, which would make the hard recovery timeout default to 900 seconds (15 minutes).  The hard recovery timeout is set at mount time and will not change if the RPC timeout is changed after mount time.&quot;&lt;/p&gt;</comment>
                            <comment id="88296" author="haasken" created="Mon, 7 Jul 2014 15:32:15 +0000"  >&lt;p&gt;I&apos;m working on a patch, but I don&apos;t see anywhere on the Intel HPDD wiki that describes how to make a link to another section in the Lustre manual.  I&apos;m looking at examples, but I don&apos;t understand how an id for a section is generated.  &lt;/p&gt;

&lt;p&gt;For example, in the See Also section, 37.15.5, there is this link&lt;/p&gt;

&lt;div class=&quot;preformatted panel&quot; style=&quot;border-width: 1px;&quot;&gt;&lt;div class=&quot;preformattedContent panelContent&quot;&gt;
&lt;pre&gt;          &amp;lt;para&amp;gt;  &amp;lt;xref linkend=&quot;dbdoclet.50438219_75432&quot;/&amp;gt;&amp;lt;/para&amp;gt;
&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;

&lt;p&gt;This is a link to section 37.14 &quot;mkfs.lustre&quot;.  That section has the matching id in the XML:&lt;/p&gt;

&lt;div class=&quot;preformatted panel&quot; style=&quot;border-width: 1px;&quot;&gt;&lt;div class=&quot;preformattedContent panelContent&quot;&gt;
&lt;pre&gt;  &amp;lt;section xml:id=&quot;dbdoclet.50438219_75432&quot;&amp;gt;
&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;

&lt;p&gt;How is the id generated?&lt;/p&gt;

&lt;p&gt;It seems like a common enough task that is should be documented here:  &lt;a href=&quot;https://wiki.hpdd.intel.com/display/PUB/Making+changes+to+the+Lustre+Manual+source&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://wiki.hpdd.intel.com/display/PUB/Making+changes+to+the+Lustre+Manual+source&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="93810" author="haasken" created="Thu, 11 Sep 2014 21:14:50 +0000"  >&lt;p&gt;I guess there was already a unique id assigned to section 32.5.2 of the manual, so I was able to just use that id in the link.&lt;/p&gt;

&lt;p&gt;Here is a patch:&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;http://review.whamcloud.com/#/c/11885/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;http://review.whamcloud.com/#/c/11885/&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="142267" author="gerrit" created="Tue, 16 Feb 2016 16:17:56 +0000"  >&lt;p&gt;Richard Henwood (richard.henwood@intel.com) merged in patch &lt;a href=&quot;http://review.whamcloud.com/11885/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;http://review.whamcloud.com/11885/&lt;/a&gt;&lt;br/&gt;
Subject: &lt;a href=&quot;https://jira.whamcloud.com/browse/LUDOC-247&quot; title=&quot;recovery_time_soft and recovery_time_hard default value descriptions are misleading&quot; class=&quot;issue-link&quot; data-issue-key=&quot;LUDOC-247&quot;&gt;&lt;del&gt;LUDOC-247&lt;/del&gt;&lt;/a&gt; mount: Clarify recovery_time_&lt;/p&gt;
{soft,hard}
&lt;p&gt; defaults&lt;br/&gt;
Project: doc/manual&lt;br/&gt;
Branch: master&lt;br/&gt;
Current Patch Set: &lt;br/&gt;
Commit: ebee985b34dcbef204bc7fd609da9a525467ce67&lt;/p&gt;</comment>
                            <comment id="142268" author="rhenwood" created="Tue, 16 Feb 2016 16:18:29 +0000"  >&lt;p&gt;Thanks for the patch Ryan!&lt;/p&gt;</comment>
                    </comments>
                    <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                                                                                                                                <customfield id="customfield_10890" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummary">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_10390" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1|hzwqp3:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10090" key="com.pyxis.greenhopper.jira:gh-global-rank">
                        <customfieldname>Rank (Obsolete)</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>14791</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                            <customfield id="customfield_10060" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
                        <customfieldname>Severity</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="10022"><![CDATA[3]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                        </customfields>
    </item>
</channel>
</rss>