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

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