mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 01:38:56 -04:00
This reverts commit c3afa57fa4.
This commit is contained in:
CJ Cenizal
GitHub
parent
98b9c98768
commit
830e0806db
3 changed files with 74 additions and 88 deletions
|
|
@ -34,9 +34,11 @@ Elasticsearch. This value must be a positive integer.
|
|||
`elasticsearch.shardTimeout:`:: *Default: 30000* Time in milliseconds for Elasticsearch to wait for responses from shards. Set to 0 to disable.
|
||||
|
||||
`elasticsearch.ssl.certificate:` and `elasticsearch.ssl.key:`:: Optional settings that provide the paths to the PEM-format SSL
|
||||
certificate and key files. These files are used to verify the identity of Kibana to Elasticsearch and are required when `xpack.ssl.verification_mode` in Elasticsearch is set to either `certificate` or `full`.
|
||||
certificate and key files. These files are used to verify the identity of Kibana to Elasticsearch and are required when
|
||||
`xpack.ssl.verification_mode` in Elasticsearch is set to either `certificate` or `full`.
|
||||
|
||||
`elasticsearch.ssl.certificateAuthorities:`:: Optional setting that enables you to specify a list of paths to the PEM file for the certificate authority for your Elasticsearch instance.
|
||||
`elasticsearch.ssl.certificateAuthorities:`:: Optional setting that enables you to specify a list of paths to the PEM file for the certificate
|
||||
authority for your Elasticsearch instance.
|
||||
|
||||
`elasticsearch.ssl.keyPassphrase:`:: The passphrase that will be used to decrypt the private key. This value is optional as the key may not be encrypted.
|
||||
|
||||
|
|
@ -53,6 +55,32 @@ queries.
|
|||
these settings provide the username and password that the Kibana server uses to perform maintenance on the Kibana index at
|
||||
startup. Your Kibana users still need to authenticate with Elasticsearch, which is proxied through the Kibana server.
|
||||
|
||||
`elasticsearch.tribe.customHeaders:`:: *Default: `{}`* Header names and values to send to Elasticsearch. Any custom headers
|
||||
cannot be overwritten by client-side headers, regardless of the `elasticsearch.tribe.requestHeadersWhitelist` configuration.
|
||||
|
||||
`elasticsearch.tribe.pingTimeout:`:: *Default: the value of the `elasticsearch.tribe.requestTimeout` setting* Time in milliseconds to wait for Elasticsearch to respond to pings.
|
||||
|
||||
`elasticsearch.tribe.requestHeadersWhitelist:`:: *Default: `[ 'authorization' ]`* List of Kibana client-side headers to send to Elasticsearch.
|
||||
To send *no* client-side headers, set this value to [] (an empty list).
|
||||
|
||||
`elasticsearch.tribe.requestTimeout:`:: *Default: 30000* Time in milliseconds to wait for responses from the back end or
|
||||
Elasticsearch. This value must be a positive integer.
|
||||
|
||||
`elasticsearch.tribe.ssl.certificate:` and `elasticsearch.tribe.ssl.key:`:: Optional settings that provide the paths to the PEM-format SSL
|
||||
certificate and key files. These files validate that your Elasticsearch backend uses the same key files.
|
||||
|
||||
`elasticsearch.tribe.ssl.certificateAuthorities:`:: Optional setting that enables you to specify a path to the PEM file for the certificate
|
||||
authority for your tribe Elasticsearch instance.
|
||||
|
||||
`elasticsearch.tribe.ssl.keyPassphrase:`:: The passphrase that will be used to decrypt the private key. This value is optional as the key may not be encrypted.
|
||||
|
||||
`elasticsearch.tribe.ssl.verificationMode:`:: *Default: full* Controls the verification of certificates. Valid values are `none`, `certificate`, and `full`. `full` performs hostname verification, and `certificate` does not.
|
||||
|
||||
`elasticsearch.tribe.url:`:: Optional URL of the Elasticsearch tribe instance to use for all your
|
||||
queries.
|
||||
|
||||
`elasticsearch.tribe.username:` and `elasticsearch.tribe.password:`:: If your Elasticsearch is protected with basic authentication, these settings provide the username and password that the Kibana server uses to perform maintenance on the Kibana index at startup. Your Kibana users still need to authenticate with Elasticsearch, which is proxied through the Kibana server.
|
||||
|
||||
`kibana.defaultAppId:`:: *Default: "discover"* The default application to load.
|
||||
|
||||
`kibana.index:`:: *Default: ".kibana"* Kibana uses an index in Elasticsearch to store saved searches, visualizations and
|
||||
|
|
@ -72,13 +100,20 @@ error messages.
|
|||
`map.includeElasticMapsService:`:: *Default: true* Turns on or off whether layers from the Elastic Maps Service should be included in the vector and tile layer option list.
|
||||
By turning this off, only the layers that are configured here will be included.
|
||||
|
||||
[[regionmap-settings]] `map.regionmap:`:: Specifies additional vector layers for use in <<regionmap, Region Map>> visualizations. Supported on Elastic Cloud Enterprise.
|
||||
Each layer object points to an external vector file that contains a geojson FeatureCollection.
|
||||
`path.data:`:: *Default: `data`* The path where Kibana stores persistent data not saved in Elasticsearch.
|
||||
|
||||
`pid.file:`:: Specifies the path where Kibana creates the process ID file.
|
||||
|
||||
`ops.interval:`:: *Default: 5000* Set the interval in milliseconds to sample system and process performance metrics.
|
||||
The minimum value is 100.
|
||||
|
||||
[[regionmap-settings]] `regionmap:`:: Specifies additional vector layers for use in <<regionmap, Region Map>> visualizations.
|
||||
Each layer object points to an external vector file that contains a geojson FeatureCollection. Supported on Elastic Cloud Enterprise.
|
||||
The file must use the https://en.wikipedia.org/wiki/World_Geodetic_System[WGS84 coordinate reference system] and only include polygons.
|
||||
If the file is hosted on a separate domain from Kibana, the server needs to be CORS-enabled so Kibana can download the file.
|
||||
The following example shows a valid regionmap configuration.
|
||||
|
||||
map.regionmap:
|
||||
regionmap:
|
||||
includeElasticMapsService: false
|
||||
layers:
|
||||
- name: "Departments of France"
|
||||
|
|
@ -90,46 +125,28 @@ The following example shows a valid regionmap configuration.
|
|||
- name: "INSEE"
|
||||
description: "INSEE numeric identifier"
|
||||
|
||||
[[regionmap-name]]`map.regionmap.layers[].name:`:: Mandatory. A description of the map being provided. Supported on Elastic Cloud Enterprise.
|
||||
[[regionmap-name]]`regionmap.layers[].name:`:: Mandatory. A description of the map being provided. Supported on Elastic Cloud Enterprise.
|
||||
|
||||
[[regionmap-url]]`map.regionmap.layers[].url:`:: Mandatory. The location of the geojson file as provided by a webserver. Supported on Elastic Cloud Enterprise.
|
||||
[[regionmap-url]]`regionmap.layers[].url:`:: Mandatory. The location of the geojson file as provided by a webserver. Supported on Elastic Cloud Enterprise.
|
||||
|
||||
[[regionmap-attribution]]`map.regionmap.layers[].attribution:`:: Optional. References the originating source of the geojson file. Supported on Elastic Cloud Enterprise.
|
||||
[[regionmap-attribution]]`regionmap.layers[].attribution:`:: Optional. References the originating source of the geojson file. Supported on Elastic Cloud Enterprise.
|
||||
|
||||
[[regionmap-fields]]`map.regionmap.layers[].fields[]:`:: Mandatory. Each layer can contain multiple fields to indicate what properties from the geojson features you wish to expose. The example above shows how to define multiple properties. Supported on Elastic Cloud Enterprise.
|
||||
[[regionmap-fields]]`regionmap.layers[].fields[]:`:: Mandatory. Each layer can contain multiple fields to indicate what properties from the geojson features you wish to expose. The example above shows how to define multiple properties. Supported on Elastic Cloud Enterprise.
|
||||
|
||||
[[regionmap-field-name]]`map.regionmap.layers[].fields[].name:`:: Mandatory. This value is used to do an inner-join between the document stored in Elasticsearch and the geojson file. e.g. if the field in the geojson is called `Location` and has city names, there must be a field in Elasticsearch that holds the same values that Kibana can then use to lookup for the geoshape data. Supported on Elastic Cloud Enterprise.
|
||||
[[regionmap-field-name]]`regionmap.layers[].fields[].name:`:: Mandatory. This value is used to do an inner-join between the document stored in Elasticsearch and the geojson file. e.g. if the field in the geojson is called `Location` and has city names, there must be a field in Elasticsearch that holds the same values that Kibana can then use to lookup for the geoshape data. Supported on Elastic Cloud Enterprise.
|
||||
|
||||
[[regionmap-field-description]]`map.regionmap.layers[].fields[].description:`:: Mandatory. The human readable text that is shown under the Options tab when building the Region Map visualization. Supported on Elastic Cloud Enterprise.
|
||||
[[regionmap-field-description]]`regionmap.layers[].fields[].description:`:: Mandatory. The human readable text that is shown under the Options tab when building the Region Map visualization. Supported on Elastic Cloud Enterprise.
|
||||
|
||||
[[regionmap-ES-map]]`map.regionmap.includeElasticMapsService:`:: turns on or off whether layers from the Elastic Maps Service should be included in the vector layer option list. Supported on Elastic Cloud Enterprise.
|
||||
[[regionmap-ES-map]]`regionmap.includeElasticMapsService:`:: turns on or off whether layers from the Elastic Maps Service should be included in the vector layer option list. Supported on Elastic Cloud Enterprise.
|
||||
By turning this off, only the layers that are configured here will be included. The default is true.
|
||||
|
||||
[[tilemap-settings]] `map.tilemap.options.attribution:`:: *Default: `"© [Elastic Maps Service](https://www.elastic.co/elastic-maps-service)"`* The map attribution string. Supported on Elastic Cloud Enterprise.
|
||||
|
||||
[[tilemap-max-zoom]]`map.tilemap.options.maxZoom:`:: *Default: 10* The maximum zoom level. Supported on Elastic Cloud Enterprise.
|
||||
|
||||
[[tilemap-min-zoom]]`map.tilemap.options.minZoom:`:: *Default: 1* The minimum zoom level. Supported on Elastic Cloud Enterprise.
|
||||
|
||||
[[tilemap-subdomains]]`map.tilemap.options.subdomains:`:: An array of subdomains used by the tile service.
|
||||
Specify the position of the subdomain the URL with the token `{s}`. Supported on Elastic Cloud Enterprise.
|
||||
|
||||
[[tilemap-url]]`map.tilemap.url:`:: The URL to the tileservice that Kibana uses to display map tiles in tilemap visualizations. Supported on Elastic Cloud Enterprise.
|
||||
By default, Kibana reads this url from an external metadata service, but users can still override this parameter to use their own Tile Map Service. For example: `"https://tiles.elastic.co/v2/default/{z}/{x}/{y}.png?elastic_tile_service_tos=agree&my_app_name=kibana"`
|
||||
`server.basePath:`:: Enables you to specify a path to mount Kibana at if you are running behind a proxy. Use the `server.rewriteBasePath` setting to tell Kibana if it should remove the basePath from requests it receives, and to prevent a deprecation warning at startup. This setting cannot end in a slash (`/`).
|
||||
|
||||
`path.data:`:: *Default: `data`* The path where Kibana stores persistent data not saved in Elasticsearch.
|
||||
|
||||
`pid.file:`:: Specifies the path where Kibana creates the process ID file.
|
||||
|
||||
`ops.interval:`:: *Default: 5000* Set the interval in milliseconds to sample system and process performance metrics.
|
||||
The minimum value is 100.
|
||||
|
||||
`server.rewriteBasePath:`:: *Default: false* Specifies whether Kibana should rewrite requests that are prefixed with `server.basePath` or require that they are rewritten by your reverse proxy. This setting was effectively always `false` before Kibana 6.3 and will default to `true` starting in Kibana 7.0.
|
||||
|
||||
`server.customResponseHeaders:`:: *Default: `{}`* Header names and values to send on all responses to the client from the Kibana server.
|
||||
|
||||
[[server-default]]`server.defaultRoute:`:: *Default: "/app/kibana"* This setting specifies the default route when opening Kibana. You can use this setting to modify the landing page when opening Kibana. Supported on Elastic Cloud Enterprise.
|
||||
`server.defaultRoute:`:: *Default: "/app/kibana"* This setting specifies the default route when opening Kibana. You can use this setting to modify the landing page when opening Kibana.
|
||||
|
||||
`server.host:`:: *Default: "localhost"* This setting specifies the host of the back end server.
|
||||
|
||||
|
|
@ -154,4 +171,17 @@ The minimum value is 100.
|
|||
`server.ssl.supportedProtocols:`:: *Default: TLSv1, TLSv1.1, TLSv1.2* Supported protocols with versions. Valid protocols: `TLSv1`, `TLSv1.1`, `TLSv1.2`
|
||||
|
||||
`status.allowAnonymous:`:: *Default: false* If authentication is enabled, setting this to `true` allows
|
||||
unauthenticated users to access the Kibana server status API and status page.
|
||||
unauthenticated users to access the Kibana server status API and status page.
|
||||
|
||||
[[tilemap-settings]] `tilemap.options.attribution:`:: *Default: `"© [Elastic Maps Service](https://www.elastic.co/elastic-maps-service)"`* The map attribution string. Supported on Elastic Cloud Enterprise.
|
||||
|
||||
[[tilemap-max-zoom]]`tilemap.options.maxZoom:`:: *Default: 10* The maximum zoom level. Supported on Elastic Cloud Enterprise.
|
||||
|
||||
[[tilemap-min-zoom]]`tilemap.options.minZoom:`:: *Default: 1* The minimum zoom level. Supported on Elastic Cloud Enterprise.
|
||||
|
||||
[[tilemap-subdomains]]`tilemap.options.subdomains:`:: An array of subdomains used by the tile service. Supported on Elastic Cloud Enterprise.
|
||||
Specify the position of the subdomain the URL with the token `{s}`.
|
||||
|
||||
[[tilemap-url]]`tilemap.url:`:: The URL to the tileservice that Kibana uses to display map tiles in tilemap visualizations. By default, Kibana reads this url from an external metadata service, but users can still override this parameter to use their own Tile Map Service. For example: `"https://tiles.elastic.co/v2/default/{z}/{x}/{y}.png?elastic_tile_service_tos=agree&my_app_name=kibana"`
|
||||
|
||||
`vega.enableExternalUrls:`:: *Default: false* Set this value to true to allow Vega to use any URL to access external data sources and images. If false, Vega can only get data from Elasticsearch.
|
||||
|
|
|
|||
|
|
@ -23,25 +23,14 @@ export function injectVars(server) {
|
|||
//DEPRECATED SETTINGS
|
||||
//if the url is set, the old settings must be used.
|
||||
//keeping this logic for backward compatibility.
|
||||
const configuredUrl = serverConfig.get('tilemap.url');
|
||||
const configuredUrl = server.config().get('tilemap.url');
|
||||
const isOverridden = typeof configuredUrl === 'string' && configuredUrl !== '';
|
||||
const tilemapConfig = serverConfig.get('tilemap');
|
||||
const regionmapsConfig = serverConfig.get('regionmap');
|
||||
const mapConfig = serverConfig.get('map');
|
||||
|
||||
// Fall back to top-level legacy map config settings if needed. Warn on usage
|
||||
const tilemapsConfig = serverConfig.get('map.tilemap') || serverConfig.get('tilemap');
|
||||
const regionmapsConfig = serverConfig.get('map.regionmap') || serverConfig.get('regionmap');
|
||||
|
||||
['tilemap', 'regionmap'].forEach(legacyMap => {
|
||||
const hasLegacyMap = serverConfig.has(legacyMap);
|
||||
const legacyMapDef = serverConfig.get(legacyMap);
|
||||
if (hasLegacyMap && typeof legacyMapDef !== 'undefined') {
|
||||
server.log(['warning', 'deprecated'],
|
||||
`Use of "${legacyMap}" in the kibana configuration is deprecated. ` +
|
||||
`Use "map.${legacyMap}" instead`);
|
||||
}
|
||||
});
|
||||
|
||||
regionmapsConfig.layers = (regionmapsConfig.layers) ? regionmapsConfig.layers : [];
|
||||
regionmapsConfig.layers = (regionmapsConfig.layers) ? regionmapsConfig.layers : [];
|
||||
|
||||
return {
|
||||
kbnDefaultAppId: serverConfig.get('kibana.defaultAppId'),
|
||||
|
|
@ -50,7 +39,7 @@ export function injectVars(server) {
|
|||
tilemapsConfig: {
|
||||
deprecated: {
|
||||
isOverridden: isOverridden,
|
||||
config: tilemapsConfig,
|
||||
config: tilemapConfig,
|
||||
}
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -126,6 +126,7 @@ export default async () => Joi.object({
|
|||
then: Joi.valid(false).default(false),
|
||||
otherwise: Joi.default(false)
|
||||
}),
|
||||
|
||||
events: Joi.any().default({}),
|
||||
dest: Joi.string().default('stdout'),
|
||||
filter: Joi.any().default({}),
|
||||
|
|
@ -135,8 +136,10 @@ export default async () => Joi.object({
|
|||
then: Joi.default(!process.stdout.isTTY),
|
||||
otherwise: Joi.default(true)
|
||||
}),
|
||||
|
||||
useUTC: Joi.boolean().default(true),
|
||||
}).default(),
|
||||
})
|
||||
.default(),
|
||||
|
||||
ops: Joi.object({
|
||||
interval: Joi.number().default(5000),
|
||||
|
|
@ -191,42 +194,6 @@ export default async () => Joi.object({
|
|||
allowAnonymous: Joi.boolean().default(false)
|
||||
}).default(),
|
||||
map: Joi.object({
|
||||
tilemap: Joi.object({
|
||||
url: Joi.string(),
|
||||
options: Joi.object({
|
||||
attribution: Joi.string(),
|
||||
minZoom: Joi.number().min(0, 'Must be 0 or higher').default(0),
|
||||
maxZoom: Joi.number().default(10),
|
||||
tileSize: Joi.number(),
|
||||
subdomains: Joi.array().items(Joi.string()).single(),
|
||||
errorTileUrl: Joi.string().uri(),
|
||||
tms: Joi.boolean(),
|
||||
reuseTiles: Joi.boolean(),
|
||||
bounds: Joi.array().items(Joi.array().items(Joi.number()).min(2).required()).min(2)
|
||||
}).default()
|
||||
}).default(),
|
||||
regionmap: Joi.object({
|
||||
includeElasticMapsService: Joi.boolean().default(true),
|
||||
layers: Joi.array().items(Joi.object({
|
||||
url: Joi.string(),
|
||||
format: Joi.object({
|
||||
type: Joi.string().default('geojson')
|
||||
}).default({
|
||||
type: 'geojson'
|
||||
}),
|
||||
meta: Joi.object({
|
||||
feature_collection_path: Joi.string().default('data')
|
||||
}).default({
|
||||
feature_collection_path: 'data'
|
||||
}),
|
||||
attribution: Joi.string(),
|
||||
name: Joi.string(),
|
||||
fields: Joi.array().items(Joi.object({
|
||||
name: Joi.string(),
|
||||
description: Joi.string()
|
||||
}))
|
||||
}))
|
||||
}).default(),
|
||||
manifestServiceUrl: Joi.when('$dev', {
|
||||
is: true,
|
||||
then: Joi.string().default('https://staging-dot-catalogue-dot-elastic-layer.appspot.com/v2/manifest'),
|
||||
|
|
@ -246,8 +213,8 @@ export default async () => Joi.object({
|
|||
tms: Joi.boolean(),
|
||||
reuseTiles: Joi.boolean(),
|
||||
bounds: Joi.array().items(Joi.array().items(Joi.number()).min(2).required()).min(2)
|
||||
})
|
||||
}).notes('Deprecated'),
|
||||
}).default()
|
||||
}).default(),
|
||||
regionmap: Joi.object({
|
||||
includeElasticMapsService: Joi.boolean().default(true),
|
||||
layers: Joi.array().items(Joi.object({
|
||||
|
|
@ -269,7 +236,7 @@ export default async () => Joi.object({
|
|||
description: Joi.string()
|
||||
}))
|
||||
}))
|
||||
}).notes('Deprecated'),
|
||||
}).default(),
|
||||
|
||||
i18n: Joi.object({
|
||||
defaultLocale: Joi.string().default('en'),
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue