ArielGlenn has submitted this change and it was merged.
Change subject: doc for proxy_configuration define
......................................................................
doc for proxy_configuration define
Quick documentation for the proxy_configuration() define.
Change-Id: I468672b694a138960faea90fa50d1fdb45816ca8
---
M manifests/protoproxy.pp
1 file changed, 51 insertions(+), 1 deletion(-)
Approvals:
ArielGlenn: Verified; Looks good to me, approved
jenkins-bot: Verified
diff --git a/manifests/protoproxy.pp b/manifests/protoproxy.pp
index 0074890..9fef300 100644
--- a/manifests/protoproxy.pp
+++ b/manifests/protoproxy.pp
@@ -1,4 +1,54 @@
-define proxy_configuration( $proxy_addresses, $proxy_server_name,
$proxy_server_cert_name, $proxy_backend, $enabled=false,
$proxy_listen_flags='', $proxy_port='80', $ipv6_enabled=false, $ssl_backend={}
) {
+# == Definition: proxy_configuration
+#
+# This class creates a nginx site. The parameters are merely expanded in the
+# templates which has all of the logic.
+#
+# The resulting site will always listen on the server real IP.
+#
+# === Parameters:
+#
+# [*proxy_addresses*]
+# Additional IP address to listen to. IPv6 addresses will be skipped
+# unless *IpV6_enabled* is true. The hash first level is made of sites
+# entries, the IP are passed as an array.
+#
+# [*proxy_server_name*]
+#
+# [*proxy_server_cert_name*]
+#
+# [*proxy_backend*]
+#
+# [*enabled*]
+# Whether to enable the site configuration. It will always be generated under
+# /etc/nginx/sites-available , enabling this parameter will create a symbolic
+# link under /etc/nginx/sites-enabled.
+# Defaults to false
+#
+# [*proxy_listen_flags*]
+# Defaults to ''
+#
+# [*proxy_port*]
+# The TCP port to listen on.
+# Defaults to '80'
+#
+# [*ipV6_enabled*]
+# Whether to have the site listen on IPv6 addresses set via *proxy_addresses*
+# Defaults to false
+#
+# [*ssl_backend*]
+# Defaults to {}
+#
+define proxy_configuration(
+ $proxy_addresses,
+ $proxy_server_name,
+ $proxy_server_cert_name,
+ $proxy_backend,
+ $enabled=false,
+ $proxy_listen_flags='',
+ $proxy_port='80',
+ $ipv6_enabled=false,
+ $ssl_backend={},
+) {
nginx_site { $name:
template => 'proxy',
--
To view, visit https://gerrit.wikimedia.org/r/62976
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I468672b694a138960faea90fa50d1fdb45816ca8
Gerrit-PatchSet: 1
Gerrit-Project: operations/puppet
Gerrit-Branch: production
Gerrit-Owner: Hashar <[email protected]>
Gerrit-Reviewer: ArielGlenn <[email protected]>
Gerrit-Reviewer: Hashar <[email protected]>
Gerrit-Reviewer: jenkins-bot
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
