Codebase list puppet-module-gnocchi / 8ba78b6
Use standard parameter description format for wsgi::apache Currently parameter description of the <module>::wsgi::apache classes are formatted differently in individual modules, and this is making the maintenance effort quite difficult. This change updates the description format following the standard one we are globally using in our modules to reduce undesired differences between modules. Change-Id: Id99d044171b1fafefd310fafff2ce2f4de1e9fa8 Takashi Kajinami 1 year, 8 months ago
1 changed file(s) with 96 addition(s) and 94 deletion(s). Raw diff Collapse all Expand all
+96
-94
manifests/wsgi/apache.pp less more
2323 #
2424 # == Parameters
2525 #
26 # [*servername*]
27 # The servername for the virtualhost.
28 # Optional. Defaults to $::fqdn
29 #
30 # [*port*]
31 # The port.
32 # Optional. Defaults to 8041
33 #
34 # [*bind_host*]
35 # The host/ip address Apache will listen on.
36 # Optional. Defaults to undef (listen on all ip addresses).
37 #
38 # [*path*]
39 # The prefix for the endpoint.
40 # Optional. Defaults to '/'
41 #
42 # [*ssl*]
43 # Use ssl ? (boolean)
44 # Optional. Defaults to false
45 #
46 # [*workers*]
47 # Number of WSGI workers to spawn.
48 # Optional. Defaults to $::os_workers
49 #
50 # [*priority*]
51 # (optional) The priority for the vhost.
52 # Defaults to 10
53 #
54 # [*threads*]
55 # (optional) The number of threads for the vhost.
56 # Defaults to 1
57 #
58 # [*wsgi_process_display_name*]
59 # (optional) Name of the WSGI process display-name.
60 # Defaults to undef
61 #
62 # [*ssl_cert*]
63 # [*ssl_key*]
64 # [*ssl_chain*]
65 # [*ssl_ca*]
66 # [*ssl_crl_path*]
67 # [*ssl_crl*]
68 # [*ssl_certs_dir*]
69 # apache::vhost ssl parameters.
70 # Optional. Default to apache::vhost 'ssl_*' defaults.
71 #
72 # [*access_log_file*]
73 # The log file name for the virtualhost.
74 # Optional. Defaults to undef.
75 #
76 # [*access_log_pipe*]
77 # Specifies a pipe where Apache sends access logs for the virtualhost.
78 # Optional. Defaults to undef.
79 #
80 # [*access_log_syslog*]
81 # Sends the virtualhost access log messages to syslog.
82 # Optional. Defaults to undef.
83 #
84 # [*access_log_format*]
85 # The log format for the virtualhost.
86 # Optional. Defaults to undef.
87 #
88 # [*error_log_file*]
89 # The error log file name for the virtualhost.
90 # Optional. Defaults to undef.
91 #
92 # [*error_log_pipe*]
93 # Specifies a pipe where Apache sends error logs for the virtualhost.
94 # Optional. Defaults to undef.
95 #
96 # [*error_log_syslog*]
97 # Sends the virtualhost error log messages to syslog.
98 # Optional. Defaults to undef.
99 #
100 # [*custom_wsgi_process_options*]
101 # (optional) gives you the opportunity to add custom process options or to
102 # overwrite the default options for the WSGI main process.
103 # eg. to use a virtual python environment for the WSGI process
104 # you could set it to:
105 # { python-path => '/my/python/virtualenv' }
106 # Defaults to {}
107 #
108 # [*headers*]
109 # (optional) Headers for the vhost.
110 # Defaults to undef
111 #
112 # [*request_headers*]
113 # (optional) Modifies collected request headers in various ways.
114 # Defaults to undef
115 #
116 # [*vhost_custom_fragment*]
117 # (optional) Passes a string of custom configuration
118 # directives to be placed at the end of the vhost configuration.
119 # Defaults to undef.
26 # [*servername*]
27 # (Optional) The servername for the virtualhost.
28 # Defaults to $::fqdn
29 #
30 # [*port*]
31 # (Optional) The port.
32 # Defaults to 8041
33 #
34 # [*bind_host*]
35 # (Optional) The host/ip address Apache will listen on.
36 # Defaults to undef (listen on all ip addresses).
37 #
38 # [*path*]
39 # (Optional) The prefix for the endpoint.
40 # Defaults to '/'
41 #
42 # [*ssl*]
43 # (Optional) Use ssl ? (boolean)
44 # Defaults to false
45 #
46 # [*workers*]
47 # (Optional) Number of WSGI workers to spawn.
48 # Defaults to $::os_workers
49 #
50 # [*priority*]
51 # (Optional) The priority for the vhost.
52 # Defaults to 10
53 #
54 # [*threads*]
55 # (Optional) The number of threads for the vhost.
56 # Defaults to 1
57 #
58 # [*wsgi_process_display_name*]
59 # (Optional) Name of the WSGI process display-name.
60 # Defaults to undef
61 #
62 # [*ssl_cert*]
63 # [*ssl_key*]
64 # [*ssl_chain*]
65 # [*ssl_ca*]
66 # [*ssl_crl_path*]
67 # [*ssl_crl*]
68 # [*ssl_certs_dir*]
69 # (Optional) apache::vhost ssl parameters.
70 # Default to apache::vhost 'ssl_*' defaults.
71 #
72 # [*access_log_file*]
73 # (Optional) The log file name for the virtualhost.
74 # Defaults to undef.
75 #
76 # [*access_log_pipe*]
77 # (Optional) Specifies a pipe where Apache sends access logs for
78 # the virtualhost.
79 # Defaults to undef.
80 #
81 # [*access_log_syslog*]
82 # (Optional) Sends the virtualhost access log messages to syslog.
83 # Defaults to undef.
84 #
85 # [*access_log_format*]
86 # (Optional) The log format for the virtualhost.
87 # Defaults to undef.
88 #
89 # [*error_log_file*]
90 # (Optional) The error log file name for the virtualhost.
91 # Defaults to undef.
92 #
93 # [*error_log_pipe*]
94 # (Optional) Specifies a pipe where Apache sends error logs for
95 # the virtualhost.
96 # Defaults to undef.
97 #
98 # [*error_log_syslog*]
99 # (Optional) Sends the virtualhost error log messages to syslog.
100 # Defaults to undef.
101 #
102 # [*custom_wsgi_process_options*]
103 # (Optional) gives you the opportunity to add custom process options or to
104 # overwrite the default options for the WSGI main process.
105 # eg. to use a virtual python environment for the WSGI process
106 # you could set it to:
107 # { python-path => '/my/python/virtualenv' }
108 # Defaults to {}
109 #
110 # [*headers*]
111 # (Optional) Headers for the vhost.
112 # Defaults to undef
113 #
114 # [*request_headers*]
115 # (Optional) Modifies collected request headers in various ways.
116 # Defaults to undef
117 #
118 # [*vhost_custom_fragment*]
119 # (Optional) Passes a string of custom configuration
120 # directives to be placed at the end of the vhost configuration.
121 # Defaults to undef.
120122 #
121123 # == Dependencies
122124 #