diff --git a/config/opensearch_dashboards.yml b/config/opensearch_dashboards.yml index 95bf8c6e6519..162545b2a1a5 100644 --- a/config/opensearch_dashboards.yml +++ b/config/opensearch_dashboards.yml @@ -35,10 +35,10 @@ # Setting for an optimized healthcheck that only uses the local OpenSearch node to do Dashboards healthcheck. # This settings should be used for large clusters or for clusters with ingest heavy nodes. # It allows Dashboards to only healthcheck using the local OpenSearch node rather than fan out requests across all nodes. -# +# # It requires the user to create an OpenSearch node attribute with the same name as the value used in the setting # This node attribute should assign all nodes of the same cluster an integer value that increments with each new cluster that is spun up -# e.g. in opensearch.yml file you would set the value to a setting using node.attr.cluster_id: +# e.g. in opensearch.yml file you would set the value to a setting using node.attr.cluster_id: # Should only be enabled if there is a corresponding node attribute created in your OpenSearch config that matches the value here #opensearch.optimizedHealthcheckId: "cluster_id" @@ -85,12 +85,17 @@ # For reference, the `threshold of memoryCircuitBreaker` = `max-old-space-size of NodeJS` * `opensearch.memoryCircuitBreaker.maxPercentage` #opensearch.memoryCircuitBreaker.maxPercentage: 1.0 +# DEPRECATED: Use opensearch.requestHeadersAllowlist # List of OpenSearch Dashboards client-side headers to send to OpenSearch. To send *no* client-side # headers, set this value to [] (an empty list). #opensearch.requestHeadersWhitelist: [ authorization ] +# List of OpenSearch Dashboards client-side headers to send to OpenSearch. To send *no* client-side +# headers, set this value to [] (an empty list). +#opensearch.requestHeadersAllowlist: [ authorization ] + # Header names and values that are sent to OpenSearch. Any custom headers cannot be overwritten -# by client-side headers, regardless of the opensearch.requestHeadersWhitelist configuration. +# by client-side headers, regardless of the opensearch.requestHeadersAllowlist configuration. #opensearch.customHeaders: {} # Time in milliseconds for OpenSearch to wait for responses from shards. Set to 0 to disable. @@ -126,8 +131,8 @@ # Set the allowlist to check input graphite Url. Allowlist is the default check list. #vis_type_timeline.graphiteAllowedUrls: ['https://www.hostedgraphite.com/UID/ACCESS_KEY/graphite'] -# Set the blocklist to check input graphite Url. Blocklist is an IP list. -# Below is an example for reference +# Set the blocklist to check input graphite Url. Blocklist is an IP list. +# Below is an example for reference # vis_type_timeline.graphiteBlockedIPs: [ # //Loopback # '127.0.0.0/8', @@ -159,22 +164,22 @@ #vis_type_timeline.graphiteBlockedIPs: [] # opensearchDashboards.branding: - # logo: - # defaultUrl: "" - # darkModeUrl: "" - # mark: - # defaultUrl: "" - # darkModeUrl: "" - # loadingLogo: - # defaultUrl: "" - # darkModeUrl: "" - # faviconUrl: "" - # applicationTitle: "" - -# Set the value of this setting to true to capture region blocked warnings and errors +# logo: +# defaultUrl: "" +# darkModeUrl: "" +# mark: +# defaultUrl: "" +# darkModeUrl: "" +# loadingLogo: +# defaultUrl: "" +# darkModeUrl: "" +# faviconUrl: "" +# applicationTitle: "" + +# Set the value of this setting to true to capture region blocked warnings and errors # for your map rendering services. # map.showRegionBlockedWarning: false # Set the value of this setting to false to suppress search usage telemetry # for reducing the load of OpenSearch cluster. -# data.search.usageTelemetry.enabled: false \ No newline at end of file +# data.search.usageTelemetry.enabled: false