Blame SOURCES/autofs-5.1.6-update-sss-timeout-documentation.patch

63b9c2
autofs-5.1.6 - update sss timeout documentation
63b9c2
63b9c2
From: Ian Kent <raven@themaw.net>
63b9c2
63b9c2
Update then man page documentation and the configuration file
63b9c2
comments to reflect the changes to map reading and key lookups
63b9c2
with the sss lookup module.
63b9c2
---
63b9c2
 CHANGELOG                      |    1 +
63b9c2
 man/autofs.conf.5.in           |   20 +++++++++++++-------
63b9c2
 redhat/autofs.conf.default.in  |   28 +++++++++++++++++++---------
63b9c2
 samples/autofs.conf.default.in |   26 ++++++++++++++++++--------
63b9c2
 4 files changed, 51 insertions(+), 24 deletions(-)
63b9c2
63b9c2
diff --git a/CHANGELOG b/CHANGELOG
63b9c2
index 2d98a3a..e48e2c0 100644
63b9c2
--- a/CHANGELOG
63b9c2
+++ b/CHANGELOG
63b9c2
@@ -105,6 +105,7 @@ xx/xx/2018 autofs-5.1.5
63b9c2
 - sss introduce calculate_retry_count() function.
63b9c2
 - move readall into struct master.
63b9c2
 - sss introduce a flag to indicate map being read.
63b9c2
+- update sss timeout documentation.
63b9c2
 
63b9c2
 19/12/2017 autofs-5.1.4
63b9c2
 - fix spec file url.
63b9c2
diff --git a/man/autofs.conf.5.in b/man/autofs.conf.5.in
63b9c2
index 8dbc313..57dd421 100644
63b9c2
--- a/man/autofs.conf.5.in
63b9c2
+++ b/man/autofs.conf.5.in
63b9c2
@@ -31,9 +31,11 @@ overrides this and sets the timeout to 5 minutes to be consistent
63b9c2
 with earlier autofs releases.
63b9c2
 .TP
63b9c2
 .B master_wait
63b9c2
-sets the default maximum time to wait for the master map to become
63b9c2
-available if it cannot be read at program start (program default 10,
63b9c2
-wait for 10 seconds then continue).
63b9c2
+Sets the default maximum number of retries (actaul iterations is half
63b9c2
+this, each is delayed by 2 seconds before retrying) waiting for the
63b9c2
+master map to become available if it cannot be read at program start
63b9c2
+(program default 10, then continue). This can be longer if the map
63b9c2
+source itself waits for availability (such as sss).
63b9c2
 .TP
63b9c2
 .B negative_timeout
63b9c2
 .br
63b9c2
@@ -160,10 +162,14 @@ behaviour and so is an opt-in setting.
63b9c2
 .TP
63b9c2
 .B sss_master_map_wait
63b9c2
 .br
63b9c2
-Set the time to wait and retry if sssd returns "no such entry" when starting
63b9c2
-up. When sssd is starting up it can sometimes return "no such entry" for a
63b9c2
-short time until it has read in the LDAP map information. Default is 0 seconds,
63b9c2
-don't wait.
63b9c2
+Set the time to wait and retry if sssd is unable to read the master map
63b9c2
+at program start. Program default is 0 (don't wait) or 10 if sss supports
63b9c2
+returning EHSTDOWN when the provider isn't available.
63b9c2
+
63b9c2
+If the sss library supports returning EHOSTDOWN when the provider is down
63b9c2
+then this value is how long to wait between retries reading the master map.
63b9c2
+When reading dependent maps or looking up a map key this value is multiplied
63b9c2
+by the number of retries that would be used when reading the master map.
63b9c2
 .TP
63b9c2
 .B use_mount_request_log_id
63b9c2
 .br
63b9c2
diff --git a/redhat/autofs.conf.default.in b/redhat/autofs.conf.default.in
63b9c2
index bd52730..2a5a1c2 100644
63b9c2
--- a/redhat/autofs.conf.default.in
63b9c2
+++ b/redhat/autofs.conf.default.in
63b9c2
@@ -14,10 +14,13 @@
63b9c2
 #
63b9c2
 timeout = 300
63b9c2
 #
63b9c2
-# master_wait - set the default maximum time to wait for the
63b9c2
-# 		master map to become available if it cannot
63b9c2
-# 		be read at program start (default 10, wait
63b9c2
-# 		for 10 seconds then continue).
63b9c2
+# master_wait - set the default maximum number of retries (actual
63b9c2
+# 		iterations is half this, each is delayed by 2 seconds
63b9c2
+# 		before retrying) waiting for the master map to become
63b9c2
+# 		available if it cannot be read at program start
63b9c2
+# 		(default 10, then continue). This can be longer
63b9c2
+# 		if the map source itself waits for availability
63b9c2
+# 		(such as sss).
63b9c2
 #
63b9c2
 #master_wait = 10
63b9c2
 #
63b9c2
@@ -193,12 +196,19 @@ mount_nfs_default_protocol = 4
63b9c2
 #use_ignore_mount_option = no
63b9c2
 #
63b9c2
 # sss_master_map_wait - When sssd is starting up it can sometimes return
63b9c2
-# 			"no such entry" for a short time until it has read
63b9c2
+#			"no such entry" for a short time until it has read
63b9c2
 # 			in the LDAP map information. Internal default is 0
63b9c2
-# 			seconds, don't wait but if there is a problem with
63b9c2
-# 			autofs not finding the master map at startup (when
63b9c2
-# 			it should) then try setting this to 10 to work
63b9c2
-# 			around it.
63b9c2
+# 			(don't wait) or 10 if sss supports returning EHSTDOWN.
63b9c2
+# 			If there is a problem with autofs not finding the
63b9c2
+# 			master map at startup (when it should) then try setting
63b9c2
+# 			this to 10 or more. If the sss library supports returning
63b9c2
+# 			EHOSTDOWN when the provider is down then this value
63b9c2
+# 			is how long to wait between retries reading the
63b9c2
+# 			master map. When reading dependent maps or looking
63b9c2
+# 			up a map key this value is multiplied by the number
63b9c2
+# 			of retries that would be used when reading the master
63b9c2
+# 			map. (Default, 0 or 10 if sss suppprts returning
63b9c2
+# 			EHOSTDOWN).
63b9c2
 #
63b9c2
 #sss_master_map_wait = 0
63b9c2
 #
63b9c2
diff --git a/samples/autofs.conf.default.in b/samples/autofs.conf.default.in
63b9c2
index 1f55709..dd716c6 100644
63b9c2
--- a/samples/autofs.conf.default.in
63b9c2
+++ b/samples/autofs.conf.default.in
63b9c2
@@ -14,10 +14,13 @@
63b9c2
 #
63b9c2
 timeout = 300
63b9c2
 #
63b9c2
-# master_wait - set the default maximum time to wait for the
63b9c2
-# 		master map to become available if it cannot
63b9c2
-# 		be read at program start (default 10, wait
63b9c2
-# 		for 10 seconds then continue).
63b9c2
+# master_wait - set the default maximum number of retries (actual
63b9c2
+# 		iterations is half this, each is delayed by 2 seconds
63b9c2
+# 		before retrying) waiting for the master map to become
63b9c2
+# 		available if it cannot be read at program start
63b9c2
+# 		(default 10, then continue). This can be longer
63b9c2
+# 		if the map source itself waits for availability
63b9c2
+# 		(such as sss).
63b9c2
 #
63b9c2
 # master_wait = 10
63b9c2
 #
63b9c2
@@ -194,10 +197,17 @@ browse_mode = no
63b9c2
 # sss_master_map_wait - When sssd is starting up it can sometimes return
63b9c2
 #			"no such entry" for a short time until it has read
63b9c2
 # 			in the LDAP map information. Internal default is 0
63b9c2
-# 			seconds, don't wait but if there is a problem with
63b9c2
-# 			autofs not finding the master map at startup (when
63b9c2
-# 			it should) then try setting this to 10 to work
63b9c2
-# 			around it.
63b9c2
+# 			(don't wait) or 10 if sss supports returning EHSTDOWN.
63b9c2
+# 			If there is a problem with autofs not finding the
63b9c2
+# 			master map at startup (when it should) then try setting
63b9c2
+# 			this to 10 or more. If the sss library supports returning
63b9c2
+# 			EHOSTDOWN when the provider is down then this value
63b9c2
+# 			is how long to wait between retries reading the
63b9c2
+# 			master map. When reading dependent maps or looking
63b9c2
+# 			up a map key this value is multiplied by the number
63b9c2
+# 			of retries that would be used when reading the master
63b9c2
+# 			map. (Default, 0 or 10 if sss suppprts returning
63b9c2
+# 			EHOSTDOWN).
63b9c2
 #
63b9c2
 #sss_master_map_wait = 0
63b9c2
 #