[Maps] update docs for proxyElasticMapsServiceInMaps configuration (#36914) (#37027)

* [Maps] update docs for proxyElasticMapsServiceInMaps configuration

* Update docs/setup/settings.asciidoc

Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/setup/settings.asciidoc

Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/setup/settings.asciidoc

Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com>
This commit is contained in:
Nathan Reese 2019-05-23 16:33:54 -06:00 committed by GitHub
parent 30b1ee3a16
commit d8296b3248
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 21 deletions

View file

@ -4,14 +4,10 @@
https://www.elastic.co/elastic-maps-service[Elastic Maps Service (EMS)] is a service that hosts
tile layers and vector shapes of administrative boundaries.
If you are using Kibana's out-of-the box settings, the **Maps** application is already configured to use EMS.
If you are using Kibana's out-of-the-box settings, the **Maps** application is already configured to use EMS.
Requests to EMS are made with two methods:
* Requests for tile layer meta data, vector shapes meta data, and vector shapes are proxied through the Kibana server.
* Requests for EMS tiles are made directly from the browser to EMS.
NOTE: The legacy tilemap and regionmap visualizations make requests directly from the browser to EMS.
The **Maps** application makes requests directly from the browser to EMS.
To proxy EMS requests through the Kibana server, set `map.proxyElasticMapsServiceInMaps` to `true` in your <<settings, kibana.yml>> file.
[float]

View file

@ -1,11 +1,11 @@
[[settings]]
== Configuring Kibana
The Kibana server reads properties from the `kibana.yml` file on startup. The
location of this file differs depending on how you installed {kib}. For example,
if you installed {kib} from an archive distribution (`.tar.gz` or `.zip`), by
default it is in `$KIBANA_HOME/config`. By default, with package distributions
(Debian or RPM), it is in `/etc/kibana`.
The Kibana server reads properties from the `kibana.yml` file on startup. The
location of this file differs depending on how you installed {kib}. For example,
if you installed {kib} from an archive distribution (`.tar.gz` or `.zip`), by
default it is in `$KIBANA_HOME/config`. By default, with package distributions
(Debian or RPM), it is in `/etc/kibana`.
The default settings configure Kibana to run on `localhost:5601`. To change the
host or port number, or connect to Elasticsearch running on a different machine,
@ -118,22 +118,22 @@ 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.
`interpreter.enableInVisualize`:: *Default: true* Enables use of interpreter in
`interpreter.enableInVisualize`:: *Default: true* Enables use of interpreter in
Visualize.
`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 dashboards. Kibana creates a new index
if the index doesnt already exist. If you configure a custom index, the name must
if the index doesnt already exist. If you configure a custom index, the name must
be lowercase, and conform to {es} {ref}/indices-create-index.html[index name limitations].
`logging.dest:`:: *Default: `stdout`* Enables you specify a file where Kibana
stores log output.
`logging.json:`:: *Default: false* Logs output as JSON. When set to `true`, the
logs will be formatted as JSON strings that include timestamp, log level, context, message
text and any other metadata that may be associated with the log message itself.
`logging.json:`:: *Default: false* Logs output as JSON. When set to `true`, the
logs will be formatted as JSON strings that include timestamp, log level, context, message
text and any other metadata that may be associated with the log message itself.
If `logging.dest.stdout` is set and there is no interactive terminal ("TTY"), this setting
will default to `true`.
@ -151,10 +151,15 @@ be referenced at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
setting to `true` to log all events, including system usage information and all
requests. Supported on {ece}.
`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.
`map.includeElasticMapsService:`:: *Default: true*
Set to false to disable connections to Elastic Maps Service.
When `includeElasticMapsService` is turned off, only the vector layers configured by `map.regionmap`
and the tile layer configured by `map.tilemap.url` will be available in the <<maps, Maps application>>,
<<tilemap, Coordinate map visualizations>>, and <<regionmap, Region map visualizations>>.
`map.proxyElasticMapsServiceInMaps:`:: *Default: false*
Set to true to proxy all <<maps, Maps application>> Elastic Maps Service requests through the Kibana server.
This setting does not impact <<tilemap, Coordinate map visualizations>> and <<regionmap, Region map visualizations>>.
[[regionmap-settings]] `map.regionmap:`:: Specifies additional vector layers for
use in <<regionmap, Region Map>> visualizations. Supported on {ece}. Each layer