Clarify broker_krb_service_name documentation

sdodson · sdodson · commit e216389224d5 · 2014-12-09T14:56:59.000-05:00
broker_krb_service_name is prefxied with 'HTTP/' string and used by mod_auth_krb
where as bind_krb_principal is expected to be the full principal name. We could
normalize those two but for now just document the proper use.
diff --git a/README.asciidoc b/README.asciidoc
@@ -673,7 +673,10 @@ Options:
 Default: htpasswd
 
 === broker_krb_service_name
-The KrbServiceName value for mod_auth_kerb configuration
+The KrbServiceName value for mod_auth_kerb configuration. This value will be
+prefixed with 'HTTP/' to create the krb5 service principal.
+
+Default: hostname
 
 === broker_krb_auth_realms
 The KrbAuthRealms value for mod_auth_kerb configuration
diff --git a/manifests/init.pp b/manifests/init.pp
@@ -477,7 +477,9 @@
 #   Default: htpasswd
 #
 # [*broker_krb_service_name*]
-#   The KrbServiceName value for mod_auth_kerb configuration
+#   The KrbServiceName value for mod_auth_kerb configuration. This value will be
+#   prefixed with 'HTTP/' to create the krb5 service principal value.
+# Default: $hostname
 #
 # [*broker_krb_auth_realms*]
 # The KrbAuthRealms value for mod_auth_kerb configuration

Original file line number	Diff line number	Diff line change
`@@ -477,7 +477,9 @@`
`477`	`477`	`# Default: htpasswd`
`478`	`478`	`#`
`479`	`479`	`# [broker_krb_service_name]`
`480`		`-# The KrbServiceName value for mod_auth_kerb configuration`
	`480`	`+# The KrbServiceName value for mod_auth_kerb configuration. This value will be`
	`481`	`+# prefixed with 'HTTP/' to create the krb5 service principal value.`
	`482`	`+# Default: $hostname`
`481`	`483`	`#`
`482`	`484`	`# [broker_krb_auth_realms]`
`483`	`485`	`# The KrbAuthRealms value for mod_auth_kerb configuration`