From 95680a792d17c181b26621d0ade9aed9324ec941 Mon Sep 17 00:00:00 2001 From: Martin Kopec Date: Wed, 23 Jun 2021 12:31:19 +0000 Subject: [PATCH] Update refstack.conf.sample The sample config file hasn't been regenerated for years. A few config options got changed over the years, mainly those from oslo. The file has just been regenerated by oslo-config-generator - 'tox -egenconfig'. Change-Id: I298baf65460fa4f1bb4c43dbd5d4758df35c9f18 --- etc/refstack.conf.sample | 229 +++++++++++++++++++++++++-------------- 1 file changed, 147 insertions(+), 82 deletions(-) diff --git a/etc/refstack.conf.sample b/etc/refstack.conf.sample index 6edcd194..9416bcb6 100644 --- a/etc/refstack.conf.sample +++ b/etc/refstack.conf.sample @@ -4,82 +4,132 @@ # From oslo.log # -# Print debugging output (set logging level to DEBUG instead of -# default WARNING level). (boolean value) +# If set to true, the logging level will be set to DEBUG instead of +# the default INFO level. (boolean value) +# Note: This option can be changed without restarting. #debug = false -# Print more verbose output (set logging level to INFO instead of -# default WARNING level). (boolean value) -#verbose = false - # The name of a logging configuration file. This file is appended to # any existing logging configuration files. For details about logging # configuration files, see the Python logging module documentation. +# Note that when logging configuration files are used then all logging +# configuration is set in the configuration file and other logging +# configuration options are ignored (for example, log-date-format). # (string value) +# Note: This option can be changed without restarting. # Deprecated group/name - [DEFAULT]/log_config #log_config_append = -# DEPRECATED. A logging.Formatter log message format string which may -# use any of the available logging.LogRecord attributes. This option -# is deprecated. Please use logging_context_format_string and -# logging_default_format_string instead. (string value) -#log_format = - -# Format string for %%(asctime)s in log records. Default: %(default)s -# . (string value) +# Defines the format string for %%(asctime)s in log records. Default: +# %(default)s . This option is ignored if log_config_append is set. +# (string value) #log_date_format = %Y-%m-%d %H:%M:%S -# (Optional) Name of log file to output to. If no default is set, -# logging will go to stdout. (string value) +# (Optional) Name of log file to send logging output to. If no default +# is set, logging will go to stderr as defined by use_stderr. This +# option is ignored if log_config_append is set. (string value) # Deprecated group/name - [DEFAULT]/logfile #log_file = -# (Optional) The base directory used for relative --log-file paths. -# (string value) +# (Optional) The base directory used for relative log_file paths. +# This option is ignored if log_config_append is set. (string value) # Deprecated group/name - [DEFAULT]/logdir #log_dir = -# Use syslog for logging. Existing syslog format is DEPRECATED during -# I, and changed in J to honor RFC5424. (boolean value) +# Uses logging handler designed to watch file system. When log file is +# moved or removed this handler will open a new log file with +# specified path instantaneously. It makes sense only if log_file +# option is specified and Linux platform is used. This option is +# ignored if log_config_append is set. (boolean value) +#watch_log_file = false + +# Use syslog for logging. Existing syslog format is DEPRECATED and +# will be changed later to honor RFC5424. This option is ignored if +# log_config_append is set. (boolean value) #use_syslog = false -# (Optional) Enables or disables syslog rfc5424 format for logging. If -# enabled, prefixes the MSG part of the syslog message with APP-NAME -# (RFC5424). The format without the APP-NAME is deprecated in K, and -# will be removed in M, along with this option. (boolean value) -# This option is deprecated for removal. -# Its value may be silently ignored in the future. -#use_syslog_rfc_format = true +# Enable journald for logging. If running in a systemd environment you +# may wish to enable journal support. Doing so will use the journal +# native protocol which includes structured metadata in addition to +# log messages.This option is ignored if log_config_append is set. +# (boolean value) +#use_journal = false -# Syslog facility to receive log lines. (string value) +# Syslog facility to receive log lines. This option is ignored if +# log_config_append is set. (string value) #syslog_log_facility = LOG_USER -# Log output to standard error. (boolean value) -#use_stderr = true +# Use JSON formatting for logging. This option is ignored if +# log_config_append is set. (boolean value) +#use_json = false -# Format string to use for log messages with context. (string value) +# Log output to standard error. This option is ignored if +# log_config_append is set. (boolean value) +#use_stderr = false + +# Log output to Windows Event Log. (boolean value) +#use_eventlog = false + +# The amount of time before the log files are rotated. This option is +# ignored unless log_rotation_type is set to "interval". (integer +# value) +#log_rotate_interval = 1 + +# Rotation interval type. The time of the last file change (or the +# time when the service was started) is used when scheduling the next +# rotation. (string value) +# Possible values: +# Seconds - +# Minutes - +# Hours - +# Days - +# Weekday - +# Midnight - +#log_rotate_interval_type = days + +# Maximum number of rotated log files. (integer value) +#max_logfile_count = 30 + +# Log file maximum size in MB. This option is ignored if +# "log_rotation_type" is not set to "size". (integer value) +#max_logfile_size_mb = 200 + +# Log rotation type. (string value) +# Possible values: +# interval - Rotate logs at predefined time intervals. +# size - Rotate logs once they reach a predefined size. +# none - Do not rotate log files. +#log_rotation_type = none + +# Format string to use for log messages with context. Used by +# oslo_log.formatters.ContextFormatter (string value) #logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s -# Format string to use for log messages without context. (string -# value) +# Format string to use for log messages when context is undefined. +# Used by oslo_log.formatters.ContextFormatter (string value) #logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s -# Data to append to log format when level is DEBUG. (string value) +# Additional data to append to log message when logging level for the +# message is DEBUG. Used by oslo_log.formatters.ContextFormatter +# (string value) #logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d -# Prefix each line of exception output with this format. (string -# value) +# Prefix each line of exception output with this format. Used by +# oslo_log.formatters.ContextFormatter (string value) #logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s -# List of logger=LEVEL pairs. (list value) -#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN +# Defines the format string for %(user_identity)s that is used in +# logging_context_format_string. Used by +# oslo_log.formatters.ContextFormatter (string value) +#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s + +# List of package logging levels in logger=LEVEL pairs. This option is +# ignored if log_config_append is set. (list value) +#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,oslo_messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN,keystoneauth=WARN,oslo.cache=INFO,oslo_policy=INFO,dogpile.core.dogpile=INFO # Enables or disables publication of error events. (boolean value) #publish_errors = false -# Enables or disables fatal status of deprecations. (boolean value) -#fatal_deprecations = false - # The format for an instance that is passed with the log message. # (string value) #instance_format = "[instance: %(uuid)s] " @@ -88,6 +138,19 @@ # (string value) #instance_uuid_format = "[instance: %(uuid)s] " +# Interval, number of seconds, of log rate limiting. (integer value) +#rate_limit_interval = 0 + +# Maximum number of logged messages per rate_limit_interval. (integer +# value) +#rate_limit_burst = 0 + +# Log level name used by rate limiting: CRITICAL, ERROR, INFO, +# WARNING, DEBUG or empty string. Logs with level greater or equal to +# rate_limit_except_level are not filtered. An empty string means that +# all levels are filtered. (string value) +#rate_limit_except_level = CRITICAL + # Enables or disables fatal status of deprecations. (boolean value) #fatal_deprecations = false @@ -95,40 +158,40 @@ # From refstack # -# Url of user interface for Refstack. Need for redirects after sign in +# Url of user interface for RefStack. Need for redirects after sign in # and sign out. (string value) #ui_url = https://refstack.openstack.org # The backend to use for database. (string value) #db_backend = sqlalchemy -# The alembic version table name to use within the -# database. To allow RefStack to upload and store -# the full set of subunit data. set this option to -# refstack_alembic_version. +# The alembic version table name to use within the database. To allow +# RefStack to upload and store the full set of subunit data, set this +# option to refstack_alembic_version. (string value) #version_table = alembic_version + [api] # # From refstack # -# Url of public Refstack API. (string value) +# Url of public RefStack API. (string value) #api_url = https://refstack.openstack.org/api -# The directory where your static files can be found. Pecan comes with -# middleware that can be used to serve static files (like CSS and +# The directory where your static files can be found. Pecan comes +# with middleware that can be used to serve static files (like CSS and # Javascript files) during development. Here, a special variable -# %(project_root)s can be used to point to the root directory of Refstack -# project's main module, so paths can be specified relative to that. -# (string value) +# %(project_root)s can be used to point to the root directory of the +# Refstack project's module, so paths can be specified relative to +# that. (string value) #static_root = refstack-ui/app -# Points to the directory where your template files live. Here, a special -# variable %(project_root)s can be used to point to the root directory of -# the Refstack project's main module, so paths can be specified relative to -# that. (string value) +# Points to the directory where your template files live. Here, a +# special variable %(project_root)s can be used to point to the root +# directory of the Refstack project's main module, so paths can be +# specified relative to that. (string value) #template_path = refstack-ui/app # List of sites allowed cross-site resource access. If this is empty, @@ -144,14 +207,15 @@ # Template for test result url. (string value) #test_results_url = /#/results/%s -# The opendev API URL of the repository and location of the -# Interop Working Group capability files. -# This URL is used to get a listing of all capability files. (string value) -#opendev_api_capabilities_url = https://opendev.org/api/v1/repos/osf/interop/contents +# The GitHub API URL of the repository and location of the Interop +# Working Group capability files. This URL is used to get a listing of +# all capability files. (string value) +#opendev_api_capabilities_url = https://opendev.org/api/v1/repos/osf/interop/contents/guidelines -# The opendev API URL of the repository and location of any additional +# The GitHub API URL of the repository and location of any additional # guideline sources which will need to be parsed by the refstack API. -#additional_capability_urls = https://opendev.org/api/v1/repos/osf/interop/contents/add-ons +# (string value) +#additional_capability_urls = https://opendev.org/api/v1/repos/osf/interop/contents/add-ons/guidelines # This is the base URL that is used for retrieving specific capability # files. Capability file names will be appended to this URL to get the @@ -160,7 +224,7 @@ # Enable or disable anonymous uploads. If set to False, all clients # will need to authenticate and sign with a public/private keypair -# previously uploaded to their user account. +# previously uploaded to their user account. (boolean value) #enable_anonymous_upload = true # Number of results for one page (integer value) @@ -176,12 +240,7 @@ # From oslo.db # -# The file name to use with SQLite. (string value) -# Deprecated group/name - [DEFAULT]/sqlite_db -#sqlite_db = oslo.sqlite - # If True, SQLite uses synchronous mode. (boolean value) -# Deprecated group/name - [DEFAULT]/sqlite_synchronous #sqlite_synchronous = true # The back end to use for the database. (string value) @@ -205,23 +264,23 @@ # Example: mysql_sql_mode= (string value) #mysql_sql_mode = TRADITIONAL -# Timeout before idle SQL connections are reaped. (integer value) +# If True, transparently enables support for handling MySQL Cluster +# (NDB). (boolean value) +#mysql_enable_ndb = false + +# Connections which have been present in the connection pool longer +# than this number of seconds will be replaced with a new one the next +# time they are checked out from the pool. (integer value) +# Deprecated group/name - [DATABASE]/idle_timeout +# Deprecated group/name - [database]/idle_timeout # Deprecated group/name - [DEFAULT]/sql_idle_timeout # Deprecated group/name - [DATABASE]/sql_idle_timeout # Deprecated group/name - [sql]/idle_timeout -#idle_timeout = 3600 +#connection_recycle_time = 3600 -# Minimum number of SQL connections to keep open in a pool. (integer -# value) -# Deprecated group/name - [DEFAULT]/sql_min_pool_size -# Deprecated group/name - [DATABASE]/sql_min_pool_size -#min_pool_size = 1 - -# Maximum number of SQL connections to keep open in a pool. (integer -# value) -# Deprecated group/name - [DEFAULT]/sql_max_pool_size -# Deprecated group/name - [DATABASE]/sql_max_pool_size -#max_pool_size = +# Maximum number of SQL connections to keep open in a pool. Setting a +# value of 0 indicates no limit. (integer value) +#max_pool_size = 5 # Maximum number of database connection retries during startup. Set to # -1 to specify an infinite retry count. (integer value) @@ -239,10 +298,12 @@ # value) # Deprecated group/name - [DEFAULT]/sql_max_overflow # Deprecated group/name - [DATABASE]/sqlalchemy_max_overflow -#max_overflow = +#max_overflow = 50 # Verbosity of SQL debugging information: 0=None, 100=Everything. # (integer value) +# Minimum value: 0 +# Maximum value: 100 # Deprecated group/name - [DEFAULT]/sql_connection_debug #connection_debug = 0 @@ -275,6 +336,10 @@ # (integer value) #db_max_retries = 20 +# Optional URL parameters to append onto the connection URL at connect +# time; specify as param1=value1¶m2=value2&... (string value) +#connection_parameters = + [osid]