Skip to content

Commit f63f395

Browse files
Bishoy Boktorgithub-actions[bot]
Bishoy Boktor
authored andcommitted
Changes config name in yml file to new non-deprecated name (#1485)
* Changes config name in yml file to new non-deprecated name * Fixes linting for branding and adds back old config name for bwc Signed-off-by: Bishoy Boktor <boktorbb@amazon.com> (cherry picked from commit 7ecc8e1)
1 parent 7beca62 commit f63f395

File tree

1 file changed

+24
-19
lines changed

1 file changed

+24
-19
lines changed

config/opensearch_dashboards.yml

+24-19
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@
3535
# Setting for an optimized healthcheck that only uses the local OpenSearch node to do Dashboards healthcheck.
3636
# This settings should be used for large clusters or for clusters with ingest heavy nodes.
3737
# It allows Dashboards to only healthcheck using the local OpenSearch node rather than fan out requests across all nodes.
38-
#
38+
#
3939
# It requires the user to create an OpenSearch node attribute with the same name as the value used in the setting
4040
# This node attribute should assign all nodes of the same cluster an integer value that increments with each new cluster that is spun up
41-
# e.g. in opensearch.yml file you would set the value to a setting using node.attr.cluster_id:
41+
# e.g. in opensearch.yml file you would set the value to a setting using node.attr.cluster_id:
4242
# Should only be enabled if there is a corresponding node attribute created in your OpenSearch config that matches the value here
4343
#opensearch.optimizedHealthcheckId: "cluster_id"
4444

@@ -85,12 +85,17 @@
8585
# For reference, the `threshold of memoryCircuitBreaker` = `max-old-space-size of NodeJS` * `opensearch.memoryCircuitBreaker.maxPercentage`
8686
#opensearch.memoryCircuitBreaker.maxPercentage: 1.0
8787

88+
# DEPRECATED: Use opensearch.requestHeadersAllowlist
8889
# List of OpenSearch Dashboards client-side headers to send to OpenSearch. To send *no* client-side
8990
# headers, set this value to [] (an empty list).
9091
#opensearch.requestHeadersWhitelist: [ authorization ]
9192

93+
# List of OpenSearch Dashboards client-side headers to send to OpenSearch. To send *no* client-side
94+
# headers, set this value to [] (an empty list).
95+
#opensearch.requestHeadersAllowlist: [ authorization ]
96+
9297
# Header names and values that are sent to OpenSearch. Any custom headers cannot be overwritten
93-
# by client-side headers, regardless of the opensearch.requestHeadersWhitelist configuration.
98+
# by client-side headers, regardless of the opensearch.requestHeadersAllowlist configuration.
9499
#opensearch.customHeaders: {}
95100

96101
# Time in milliseconds for OpenSearch to wait for responses from shards. Set to 0 to disable.
@@ -126,8 +131,8 @@
126131
# Set the allowlist to check input graphite Url. Allowlist is the default check list.
127132
#vis_type_timeline.graphiteAllowedUrls: ['https://www.hostedgraphite.com/UID/ACCESS_KEY/graphite']
128133

129-
# Set the blocklist to check input graphite Url. Blocklist is an IP list.
130-
# Below is an example for reference
134+
# Set the blocklist to check input graphite Url. Blocklist is an IP list.
135+
# Below is an example for reference
131136
# vis_type_timeline.graphiteBlockedIPs: [
132137
# //Loopback
133138
# '127.0.0.0/8',
@@ -159,22 +164,22 @@
159164
#vis_type_timeline.graphiteBlockedIPs: []
160165

161166
# opensearchDashboards.branding:
162-
# logo:
163-
# defaultUrl: ""
164-
# darkModeUrl: ""
165-
# mark:
166-
# defaultUrl: ""
167-
# darkModeUrl: ""
168-
# loadingLogo:
169-
# defaultUrl: ""
170-
# darkModeUrl: ""
171-
# faviconUrl: ""
172-
# applicationTitle: ""
173-
174-
# Set the value of this setting to true to capture region blocked warnings and errors
167+
# logo:
168+
# defaultUrl: ""
169+
# darkModeUrl: ""
170+
# mark:
171+
# defaultUrl: ""
172+
# darkModeUrl: ""
173+
# loadingLogo:
174+
# defaultUrl: ""
175+
# darkModeUrl: ""
176+
# faviconUrl: ""
177+
# applicationTitle: ""
178+
179+
# Set the value of this setting to true to capture region blocked warnings and errors
175180
# for your map rendering services.
176181
# map.showRegionBlockedWarning: false
177182

178183
# Set the value of this setting to false to suppress search usage telemetry
179184
# for reducing the load of OpenSearch cluster.
180-
# data.search.usageTelemetry.enabled: false
185+
# data.search.usageTelemetry.enabled: false

0 commit comments

Comments
 (0)