opensearch_dashboards.yml 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223
  1. ---
  2. # Copyright OpenSearch Contributors
  3. # SPDX-License-Identifier: Apache-2.0
  4. # Description:
  5. # Default configuration for OpenSearch Dashboards
  6. # OpenSearch Dashboards is served by a back end server. This setting specifies the port to use.
  7. # server.port: 5601
  8. # Specifies the address to which the OpenSearch Dashboards server will bind. IP addresses and host names are both valid values.
  9. # The default is 'localhost', which usually means remote machines will not be able to connect.
  10. # To allow connections from remote users, set this parameter to a non-loopback address.
  11. # server.host: "localhost"
  12. # Enables you to specify a path to mount OpenSearch Dashboards at if you are running behind a proxy.
  13. # Use the `server.rewriteBasePath` setting to tell OpenSearch Dashboards if it should remove the basePath
  14. # from requests it receives, and to prevent a deprecation warning at startup.
  15. # This setting cannot end in a slash.
  16. # server.basePath: ""
  17. # Specifies whether OpenSearch Dashboards should rewrite requests that are prefixed with
  18. # `server.basePath` or require that they are rewritten by your reverse proxy.
  19. # server.rewriteBasePath: false
  20. # The maximum payload size in bytes for incoming server requests.
  21. # server.maxPayloadBytes: 1048576
  22. # The OpenSearch Dashboards server's name. This is used for display purposes.
  23. # server.name: "your-hostname"
  24. # The URLs of the OpenSearch instances to use for all your queries.
  25. # opensearch.hosts: ["http://localhost:9200"]
  26. # OpenSearch Dashboards uses an index in OpenSearch to store saved searches, visualizations and
  27. # dashboards. OpenSearch Dashboards creates a new index if the index doesn't already exist.
  28. # opensearchDashboards.index: ".opensearch_dashboards"
  29. # The default application to load.
  30. # opensearchDashboards.defaultAppId: "home"
  31. # Setting for an optimized healthcheck that only uses the local OpenSearch node to do Dashboards healthcheck.
  32. # This settings should be used for large clusters or for clusters with ingest heavy nodes.
  33. # It allows Dashboards to only healthcheck using the local OpenSearch node rather than fan out requests across all nodes.
  34. #
  35. # It requires the user to create an OpenSearch node attribute with the same name as the value used in the setting
  36. # This node attribute should assign all nodes of the same cluster an integer value that increments with each new cluster that is spun up
  37. # e.g. in opensearch.yml file you would set the value to a setting using node.attr.cluster_id:
  38. # Should only be enabled if there is a corresponding node attribute created in your OpenSearch config that matches the value here
  39. # opensearch.optimizedHealthcheckId: "cluster_id"
  40. # If your OpenSearch is protected with basic authentication, these settings provide
  41. # the username and password that the OpenSearch Dashboards server uses to perform maintenance on the OpenSearch Dashboards
  42. # index at startup. Your OpenSearch Dashboards users still need to authenticate with OpenSearch, which
  43. # is proxied through the OpenSearch Dashboards server.
  44. # opensearch.username: "opensearch_dashboards_system"
  45. # opensearch.password: "pass"
  46. # Enables SSL and paths to the PEM-format SSL certificate and SSL key files, respectively.
  47. # These settings enable SSL for outgoing requests from the OpenSearch Dashboards server to the browser.
  48. # server.ssl.enabled: false
  49. # server.ssl.certificate: /path/to/your/server.crt
  50. # server.ssl.key: /path/to/your/server.key
  51. # Optional settings that provide the paths to the PEM-format SSL certificate and key files.
  52. # These files are used to verify the identity of OpenSearch Dashboards to OpenSearch and are required when
  53. # xpack.security.http.ssl.client_authentication in OpenSearch is set to required.
  54. # opensearch.ssl.certificate: /path/to/your/client.crt
  55. # opensearch.ssl.key: /path/to/your/client.key
  56. # Optional setting that enables you to specify a path to the PEM file for the certificate
  57. # authority for your OpenSearch instance.
  58. # opensearch.ssl.certificateAuthorities: [ "/path/to/your/CA.pem" ]
  59. # To disregard the validity of SSL certificates, change this setting's value to 'none'.
  60. # opensearch.ssl.verificationMode: full
  61. # Time in milliseconds to wait for OpenSearch to respond to pings. Defaults to the value of
  62. # the opensearch.requestTimeout setting.
  63. # opensearch.pingTimeout: 1500
  64. # Time in milliseconds to wait for responses from the back end or OpenSearch. This value
  65. # must be a positive integer.
  66. # opensearch.requestTimeout: 30000
  67. # List of OpenSearch Dashboards client-side headers to send to OpenSearch. To send *no* client-side
  68. # headers, set this value to [] (an empty list).
  69. # opensearch.requestHeadersWhitelist: [ authorization ]
  70. # Header names and values that are sent to OpenSearch. Any custom headers cannot be overwritten
  71. # by client-side headers, regardless of the opensearch.requestHeadersWhitelist configuration.
  72. # opensearch.customHeaders: {}
  73. # Time in milliseconds for OpenSearch to wait for responses from shards. Set to 0 to disable.
  74. # opensearch.shardTimeout: 30000
  75. # Logs queries sent to OpenSearch. Requires logging.verbose set to true.
  76. # opensearch.logQueries: false
  77. # Specifies the path where OpenSearch Dashboards creates the process ID file.
  78. # pid.file: /var/run/opensearchDashboards.pid
  79. # Enables you to specify a file where OpenSearch Dashboards stores log output.
  80. # logging.dest: stdout
  81. # Set the value of this setting to true to suppress all logging output.
  82. # logging.silent: false
  83. # Set the value of this setting to true to suppress all logging output other than error messages.
  84. # logging.quiet: false
  85. # Set the value of this setting to true to log all events, including system usage information
  86. # and all requests.
  87. # logging.verbose: false
  88. # Set the interval in milliseconds to sample system and process performance
  89. # metrics. Minimum is 100ms. Defaults to 5000.
  90. # ops.interval: 5000
  91. # Specifies locale to be used for all localizable strings, dates and number formats.
  92. # Supported languages are the following: English - en , by default , Chinese - zh-CN .
  93. # i18n.locale: "en"
  94. # Set the allowlist to check input graphite Url. Allowlist is the default check list.
  95. # vis_type_timeline.graphiteAllowedUrls: ['https://www.hostedgraphite.com/UID/ACCESS_KEY/graphite']
  96. # Set the blocklist to check input graphite Url. Blocklist is an IP list.
  97. # Below is an example for reference
  98. # vis_type_timeline.graphiteBlockedIPs: [
  99. # //Loopback
  100. # '127.0.0.0/8',
  101. # '::1/128',
  102. # //Link-local Address for IPv6
  103. # 'fe80::/10',
  104. # //Private IP address for IPv4
  105. # '10.0.0.0/8',
  106. # '172.16.0.0/12',
  107. # '192.168.0.0/16',
  108. # //Unique local address (ULA)
  109. # 'fc00::/7',
  110. # //Reserved IP address
  111. # '0.0.0.0/8',
  112. # '100.64.0.0/10',
  113. # '192.0.0.0/24',
  114. # '192.0.2.0/24',
  115. # '198.18.0.0/15',
  116. # '192.88.99.0/24',
  117. # '198.51.100.0/24',
  118. # '203.0.113.0/24',
  119. # '224.0.0.0/4',
  120. # '240.0.0.0/4',
  121. # '255.255.255.255/32',
  122. # '::/128',
  123. # '2001:db8::/32',
  124. # 'ff00::/8',
  125. # ]
  126. # vis_type_timeline.graphiteBlockedIPs: []
  127. # opensearchDashboards.branding:
  128. # logo:
  129. # defaultUrl: ""
  130. # darkModeUrl: ""
  131. # mark:
  132. # defaultUrl: ""
  133. # darkModeUrl: ""
  134. # loadingLogo:
  135. # defaultUrl: ""
  136. # darkModeUrl: ""
  137. # faviconUrl: ""
  138. # applicationTitle: ""
  139. # Set the value of this setting to true to capture region blocked warnings and errors
  140. # for your map rendering services.
  141. # map.showRegionBlockedWarning: false%
  142. # Set the value of this setting to false to suppress search usage telemetry
  143. # for reducing the load of OpenSearch cluster.
  144. # data.search.usageTelemetry.enabled: false
  145. # 2.4 renames 'wizard.enabled: false' to 'vis_builder.enabled: false'
  146. # Set the value of this setting to false to disable VisBuilder
  147. # functionality in Visualization.
  148. # vis_builder.enabled: false
  149. # 2.4 New Experimental Feature
  150. # Set the value of this setting to true to enable the experimental multiple data source
  151. # support feature. Use with caution.
  152. # data_source.enabled: false
  153. # Set the value of these settings to customize crypto materials to encryption saved credentials
  154. # in data sources.
  155. # data_source.encryption.wrappingKeyName: 'changeme'
  156. # data_source.encryption.wrappingKeyNamespace: 'changeme'
  157. # data_source.encryption.wrappingKey: [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]
  158. # 2.6 New ML Commons Dashboards Feature
  159. # Set the value of this setting to true to enable the ml commons dashboards
  160. # ml_commons_dashboards.enabled: false
  161. # 2.12 New experimental Assistant Dashboards Feature
  162. # Set the value of this setting to true to enable the assistant dashboards
  163. # assistant.chat.enabled: false
  164. # 2.13 New Query Assistant Feature
  165. # Set the value of this setting to false to disable the query assistant
  166. # observability.query_assist.enabled: false
  167. # 2.14 Enable Ui Metric Collectors in Usage Collector
  168. # Set the value of this setting to true to enable UI Metric collections
  169. # usageCollection.uiMetric.enabled: false
  170. opensearch.hosts: [https://localhost:9200]
  171. opensearch.ssl.verificationMode: none
  172. opensearch.username: admin
  173. opensearch.password: 'Qazwsxedc!@#123'
  174. opensearch.requestHeadersWhitelist: [authorization, securitytenant]
  175. opensearch_security.multitenancy.enabled: true
  176. opensearch_security.multitenancy.tenants.preferred: [Private, Global]
  177. opensearch_security.readonly_mode.roles: [kibana_read_only]
  178. # Use this setting if you are running opensearch-dashboards without https
  179. opensearch_security.cookie.secure: false
  180. server.host: '0.0.0.0'