openstack
/
puppet-heat
Code Issues Proposed changes

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: Icec870fce75185f2ca902c565dd94c467b9f6638
This commit is contained in:
Takashi Kajinami 2022-08-28 01:02:04 +09:00
parent bd92c63d41
commit 3a8ae230cc
3 changed files with 227 additions and 219 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
manifests/wsgi/apache.pp
View File

@ -22,38 +22,38 @@
# == Parameters # == Parameters
# #
# [*title*] # [*title*]
# The heat API that will be running over this vhost. # (Required) The heat API that will be running over this vhost.
# The valid options are "api" and "api_cfn" # The valid options are "api" and "api_cfn"
# #
# [*port*] # [*port*]
# The port for the specific API. # (Required) The port for the specific API.
# #
# [*servername*] # [*servername*]
# The servername for the virtualhost. # (Optional) The servername for the virtualhost.
# Optional. Defaults to $::fqdn # Defaults to $::fqdn
# #
# [*bind_host*] # [*bind_host*]
# The host/ip address Apache will listen on. # (Optional) The host/ip address Apache will listen on.
# Optional. Defaults to undef (listen on all ip addresses). # Defaults to undef (listen on all ip addresses).
# #
# [*path*] # [*path*]
# The prefix for the endpoint. # (Optional) The prefix for the endpoint.
# Optional. Defaults to '/' # Defaults to '/'
# #
# [*ssl*] # [*ssl*]
# Use ssl ? (boolean) # (Optional) Use ssl ? (boolean)
# Optional. Defaults to false # Defaults to false
# #
# [*workers*] # [*workers*]
# Number of WSGI workers to spawn. # (Optional) Number of WSGI workers to spawn.
# Optional. Defaults to $::os_workers # Defaults to $::os_workers
# #
# [*priority*] # [*priority*]
# (optional) The priority for the vhost. # (Optional) The priority for the vhost.
# Defaults to 10 # Defaults to 10
# #
# [*threads*] # [*threads*]
# (optional) The number of threads for the vhost. # (Optional) The number of threads for the vhost.
# Defaults to 1 # Defaults to 1
# #
# [*ssl_cert*] # [*ssl_cert*]
@ -63,39 +63,41 @@
# [*ssl_crl_path*] # [*ssl_crl_path*]
# [*ssl_crl*] # [*ssl_crl*]
# [*ssl_certs_dir*] # [*ssl_certs_dir*]
# apache::vhost ssl parameters. # (Optional) apache::vhost ssl parameters.
# Optional. Default to apache::vhost 'ssl_*' defaults. # Default to apache::vhost 'ssl_*' defaults.
# #
# [*access_log_file*] # [*access_log_file*]
# The log file name for the virtualhost. # (Optional) The log file name for the virtualhost.
# Optional. Defaults to undef. # Defaults to undef.
# #
# [*access_log_pipe*] # [*access_log_pipe*]
# Specifies a pipe where Apache sends access logs for the virtualhost. # (Optional) Specifies a pipe where Apache sends access logs for
# Optional. Defaults to undef. # the virtualhost.
# Defaults to undef.
# #
# [*access_log_syslog*] # [*access_log_syslog*]
# Sends the virtualhost access log messages to syslog. # (Optional) Sends the virtualhost access log messages to syslog.
# Optional. Defaults to undef. # Defaults to undef.
# #
# [*access_log_format*] # [*access_log_format*]
# The log format for the virtualhost. # (Optional) The log format for the virtualhost.
# Optional. Defaults to undef. # Defaults to undef.
# #
# [*error_log_file*] # [*error_log_file*]
# The error log file name for the virtualhost. # (Optional) The error log file name for the virtualhost.
# Optional. Defaults to undef. # Defaults to undef.
# #
# [*error_log_pipe*] # [*error_log_pipe*]
# Specifies a pipe where Apache sends error logs for the virtualhost. # (Optional) Specifies a pipe where Apache sends error logs for
# Optional. Defaults to undef. # the virtualhost.
# Defaults to undef.
# #
# [*error_log_syslog*] # [*error_log_syslog*]
# Sends the virtualhost error log messages to syslog. # (Optional) Sends the virtualhost error log messages to syslog.
# Optional. Defaults to undef. # Defaults to undef.
# #
# [*custom_wsgi_process_options*] # [*custom_wsgi_process_options*]
# (optional) gives you the opportunity to add custom process options or to # (Optional) gives you the opportunity to add custom process options or to
# overwrite the default options for the WSGI main process. # overwrite the default options for the WSGI main process.
# eg. to use a virtual python environment for the WSGI process # eg. to use a virtual python environment for the WSGI process
# you could set it to: # you could set it to:
@ -103,19 +105,19 @@
# Defaults to {} # Defaults to {}
# #
# [*wsgi_process_display_name*] # [*wsgi_process_display_name*]
# (optional) Name of the WSGI process display-name. # (Optional) Name of the WSGI process display-name.
# Defaults to undef # Defaults to undef
# #
# [*headers*] # [*headers*]
# (optional) Headers for the vhost. # (Optional) Headers for the vhost.
# Defaults to undef # Defaults to undef
# #
# [*request_headers*] # [*request_headers*]
# (optional) Modifies collected request headers in various ways. # (Optional) Modifies collected request headers in various ways.
# Defaults to undef # Defaults to undef
# #
# [*vhost_custom_fragment*] # [*vhost_custom_fragment*]
# (optional) Additional vhost configuration, if applicable. # (Optional) Additional vhost configuration, if applicable.
# #
# == Dependencies # == Dependencies
# #

71
manifests/wsgi/apache_api.pp
View File

@ -21,34 +21,35 @@
# == Parameters # == Parameters
# #
# [*port*] # [*port*]
# The port for the specific API. # (Optional) The port for the specific API.
# Defaults to 8004
# #
# [*servername*] # [*servername*]
# The servername for the virtualhost. # (Optional) The servername for the virtualhost.
# Optional. Defaults to $::fqdn # Defaults to $::fqdn
# #
# [*bind_host*] # [*bind_host*]
# The host/ip address Apache will listen on. # (Optional) The host/ip address Apache will listen on.
# Optional. Defaults to undef (listen on all ip addresses). # Defaults to undef (listen on all ip addresses).
# #
# [*path*] # [*path*]
# The prefix for the endpoint. # (Optional) The prefix for the endpoint.
# Optional. Defaults to '/' # Defaults to '/'
# #
# [*ssl*] # [*ssl*]
# Use ssl ? (boolean) # (Optional) Use ssl ? (boolean)
# Optional. Defaults to false # Defaults to false
# #
# [*workers*] # [*workers*]
# Number of WSGI workers to spawn. # (Optional) Number of WSGI workers to spawn.
# Optional. Defaults to $::os_workers # Defaults to $::os_workers
# #
# [*priority*] # [*priority*]
# (optional) The priority for the vhost. # (Optional) The priority for the vhost.
# Defaults to 10 # Defaults to 10
# #
# [*threads*] # [*threads*]
# (optional) The number of threads for the vhost. # (Optional) The number of threads for the vhost.
# Defaults to 1 # Defaults to 1
# #
# [*ssl_cert*] # [*ssl_cert*]
@ -58,39 +59,41 @@
# [*ssl_crl_path*] # [*ssl_crl_path*]
# [*ssl_crl*] # [*ssl_crl*]
# [*ssl_certs_dir*] # [*ssl_certs_dir*]
# apache::vhost ssl parameters. # (Optional) apache::vhost ssl parameters.
# Optional. Default to apache::vhost 'ssl_*' defaults. # Default to apache::vhost 'ssl_*' defaults.
# #
# [*access_log_file*] # [*access_log_file*]
# The log file name for the virtualhost. # (Optional) The log file name for the virtualhost.
# Optional. Defaults to undef. # Defaults to undef.
# #
# [*access_log_pipe*] # [*access_log_pipe*]
# Specifies a pipe where Apache sends access logs for the virtualhost. # (Optional) Specifies a pipe where Apache sends access logs for
# Optional. Defaults to undef. # the virtualhost.
# Defaults to undef.
# #
# [*access_log_syslog*] # [*access_log_syslog*]
# Sends the virtualhost access log messages to syslog. # (Optional) Sends the virtualhost access log messages to syslog.
# Optional. Defaults to undef. # Defaults to undef.
# #
# [*access_log_format*] # [*access_log_format*]
# The log format for the virtualhost. # (Optional) The log format for the virtualhost.
# Optional. Defaults to undef. # Defaults to undef.
# #
# [*error_log_file*] # [*error_log_file*]
# The error log file name for the virtualhost. # (Optional) The error log file name for the virtualhost.
# Optional. Defaults to undef. # Defaults to undef.
# #
# [*error_log_pipe*] # [*error_log_pipe*]
# Specifies a pipe where Apache sends error logs for the virtualhost. # (Optional) Specifies a pipe where Apache sends error logs for
# Optional. Defaults to undef. # the virtualhost.
# Defaults to undef.
# #
# [*error_log_syslog*] # [*error_log_syslog*]
# Sends the virtualhost error log messages to syslog. # (Optional) Sends the virtualhost error log messages to syslog.
# Optional. Defaults to undef. # Defaults to undef.
# #
# [*custom_wsgi_process_options*] # [*custom_wsgi_process_options*]
# (optional) gives you the opportunity to add custom process options or to # (Optional) gives you the opportunity to add custom process options or to
# overwrite the default options for the WSGI main process. # overwrite the default options for the WSGI main process.
# eg. to use a virtual python environment for the WSGI process # eg. to use a virtual python environment for the WSGI process
# you could set it to: # you could set it to:
@ -98,19 +101,19 @@
# Defaults to {} # Defaults to {}
# #
# [*wsgi_process_display_name*] # [*wsgi_process_display_name*]
# (optional) Name of the WSGI process display-name. # (Optional) Name of the WSGI process display-name.
# Defaults to undef # Defaults to undef
# #
# [*headers*] # [*headers*]
# (optional) Headers for the vhost. # (Optional) Headers for the vhost.
# Defaults to undef # Defaults to undef
# #
# [*request_headers*] # [*request_headers*]
# (optional) Modifies collected request headers in various ways. # (Optional) Modifies collected request headers in various ways.
# Defaults to undef # Defaults to undef
# #
# [*vhost_custom_fragment*] # [*vhost_custom_fragment*]
# (optional) Additional vhost configuration, if applicable. # (Optional) Additional vhost configuration, if applicable.
# Defaults to undef # Defaults to undef
# #
# == Dependencies # == Dependencies

71
manifests/wsgi/apache_api_cfn.pp
View File

@ -21,34 +21,35 @@
# == Parameters # == Parameters
# #
# [*port*] # [*port*]
# The port for the specific API. # (Optional) The port for the specific API.
# Defaults to 8000
# #
# [*servername*] # [*servername*]
# The servername for the virtualhost. # (Optional) The servername for the virtualhost.
# Optional. Defaults to $::fqdn # Defaults to $::fqdn
# #
# [*bind_host*] # [*bind_host*]
# The host/ip address Apache will listen on. # (Optional) The host/ip address Apache will listen on.
# Optional. Defaults to undef (listen on all ip addresses). # Defaults to undef (listen on all ip addresses).
# #
# [*path*] # [*path*]
# The prefix for the endpoint. # (Optional) The prefix for the endpoint.
# Optional. Defaults to '/' # Defaults to '/'
# #
# [*ssl*] # [*ssl*]
# Use ssl ? (boolean) # (Optional) Use ssl ? (boolean)
# Optional. Defaults to false # Defaults to false
# #
# [*workers*] # [*workers*]
# Number of WSGI workers to spawn. # (Optional) Number of WSGI workers to spawn.
# Optional. Defaults to $::os_workers # Defaults to $::os_workers
# #
# [*priority*] # [*priority*]
# (optional) The priority for the vhost. # (Optional) The priority for the vhost.
# Defaults to 10 # Defaults to 10
# #
# [*threads*] # [*threads*]
# (optional) The number of threads for the vhost. # (Optional) The number of threads for the vhost.
# Defaults to 1 # Defaults to 1
# #
# [*ssl_cert*] # [*ssl_cert*]
@ -58,39 +59,41 @@
# [*ssl_crl_path*] # [*ssl_crl_path*]
# [*ssl_crl*] # [*ssl_crl*]
# [*ssl_certs_dir*] # [*ssl_certs_dir*]
# apache::vhost ssl parameters. # (Optional) apache::vhost ssl parameters.
# Optional. Default to apache::vhost 'ssl_*' defaults. # Default to apache::vhost 'ssl_*' defaults.
# #
# [*access_log_file*] # [*access_log_file*]
# The log file name for the virtualhost. # (Optional) The log file name for the virtualhost.
# Optional. Defaults to undef. # Defaults to undef.
# #
# [*access_log_pipe*] # [*access_log_pipe*]
# Specifies a pipe where Apache sends access logs for the virtualhost. # (Optional) Specifies a pipe where Apache sends access logs for
# Optional. Defaults to undef. # the virtualhost.
# Defaults to undef.
# #
# [*access_log_syslog*] # [*access_log_syslog*]
# Sends the virtualhost access log messages to syslog. # (Optional) Sends the virtualhost access log messages to syslog.
# Optional. Defaults to undef. # Defaults to undef.
# #
# [*access_log_format*] # [*access_log_format*]
# The log format for the virtualhost. # (Optional) The log format for the virtualhost.
# Optional. Defaults to undef. # Defaults to undef.
# #
# [*error_log_file*] # [*error_log_file*]
# The error log file name for the virtualhost. # (Optional) The error log file name for the virtualhost.
# Optional. Defaults to undef. # Defaults to undef.
# #
# [*error_log_pipe*] # [*error_log_pipe*]
# Specifies a pipe where Apache sends error logs for the virtualhost. # (Optional) Specifies a pipe where Apache sends error logs for
# Optional. Defaults to undef. # the virtualhost.
# Defaults to undef.
# #
# [*error_log_syslog*] # [*error_log_syslog*]
# Sends the virtualhost error log messages to syslog. # (Optional) Sends the virtualhost error log messages to syslog.
# Optional. Defaults to undef. # Defaults to undef.
# #
# [*custom_wsgi_process_options*] # [*custom_wsgi_process_options*]
# (optional) gives you the opportunity to add custom process options or to # (Optional) gives you the opportunity to add custom process options or to
# overwrite the default options for the WSGI main process. # overwrite the default options for the WSGI main process.
# eg. to use a virtual python environment for the WSGI process # eg. to use a virtual python environment for the WSGI process
# you could set it to: # you could set it to:
@ -98,19 +101,19 @@
# Defaults to {} # Defaults to {}
# #
# [*wsgi_process_display_name*] # [*wsgi_process_display_name*]
# (optional) Name of the WSGI process display-name. # (Optional) Name of the WSGI process display-name.
# Defaults to undef # Defaults to undef
# #
# [*headers*] # [*headers*]
# (optional) Headers for the vhost. # (Optional) Headers for the vhost.
# Defaults to undef # Defaults to undef
# #
# [*request_headers*] # [*request_headers*]
# (optional) Modifies collected request headers in various ways. # (Optional) Modifies collected request headers in various ways.
# Defaults to ['set Content-Type "application/json"'] # Defaults to ['set Content-Type "application/json"']
# #
# [*vhost_custom_fragment*] # [*vhost_custom_fragment*]
# (optional) Passes a string of custom configuration # (Optional) Passes a string of custom configuration
# directives to be placed at the end of the vhost configuration. # directives to be placed at the end of the vhost configuration.
# Defaults to undef # Defaults to undef
# #