github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

Add cloud icon for supported settings and embed single-sourced getting started (#65610) (#66658)

Browse source 
* Add cloud icon for supported settings

* Remove delimited block from single-sourced content, edits

* Remove delimited block from single-sourced content, edits

* Remove ifeval to simplify life

* Switch to docs-root

* Add ECE icons
This commit is contained in:
Nik Richers 2020-05-14 15:08:55 -07:00 • committed by GitHub
parent 51383c8cad
commit 48d38ac3ac
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 35 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

67
docs/setup/settings.asciidoc
View file

@ -225,11 +225,11 @@ If you configure a custom index, the name must be lowercase, and conform to the
{es} {ref}/indices-create-index.html[index name limitations].
*Default: `".kibana"`*
| `kibana.autocompleteTimeout:`
| `kibana.autocompleteTimeout:` {ess-icon}
| Time in milliseconds to wait for autocomplete suggestions from {es}.
This value must be a whole number greater than zero. *Default: `"1000"`*
| `kibana.autocompleteTerminateAfter:`
| `kibana.autocompleteTerminateAfter:` {ess-icon}
| Maximum number of documents loaded by each shard to generate autocomplete
suggestions. This value must be a whole number greater than zero.
*Default: `"100000"`*
@ -300,11 +300,11 @@ suppress all logging output. *Default: `false`*
(for example, `America/Los_Angeles`) to log events using that timezone. For a
list of timezones, refer to https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. *Default: `UTC`*
| [[logging-verbose]] `logging.verbose:`
| [[logging-verbose]] `logging.verbose:` {ece-icon}
| Set to `true` to log all events, including system usage information and all
requests. Supported on {ece}. *Default: `false`*
requests. *Default: `false`*
| `map.includeElasticMapsService:`
| `map.includeElasticMapsService:` {ess-icon}
| 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` are available in <<maps, Maps>>. *Default: `true`*
@ -313,9 +313,9 @@ and the tile layer configured by `map.tilemap.url` are available in <<maps, Maps
| Set to `true` to proxy all <<maps, Maps application>> Elastic Maps Service
requests through the {kib} server. *Default: `false`*
| [[regionmap-settings]] `map.regionmap:`
| [[regionmap-settings]] `map.regionmap:` {ess-icon} {ece-icon}
| Specifies additional vector layers for
use in <<maps, Maps>> visualizations. Supported on {ece}. Each layer
use in <<maps, Maps>> visualizations. Each layer
object points to an external vector file that contains a geojson
FeatureCollection. The file must use the
https://en.wikipedia.org/wiki/World_Geodetic_System[WGS84 coordinate reference system (ESPG:4326)]
@ -343,20 +343,19 @@ map.regionmap:
[cols="2*<"]
|===
| [[regionmap-ES-map]] `map.includeElasticMapsService:`
| [[regionmap-ES-map]] `map.includeElasticMapsService:` {ece-icon}
| Turns on or off whether layers from the Elastic Maps Service should be included in the vector
layer option list. Supported on {ece}. By turning this off,
layer option list. By turning this off,
only the layers that are configured here will be included. The default is `true`.
This also affects whether tile-service from the Elastic Maps Service will be available.
| [[regionmap-attribution]] `map.regionmap.layers[].attribution:`
| [[regionmap-attribution]] `map.regionmap.layers[].attribution:` {ess-icon} {ece-icon}
| Optional. References the originating source of the geojson file.
Supported on {ece}.
| [[regionmap-fields]] `map.regionmap.layers[].fields[]:`
| [[regionmap-fields]] `map.regionmap.layers[].fields[]:` {ess-icon} {ece-icon}
| Mandatory. Each layer
can contain multiple fields to indicate what properties from the geojson
features you wish to expose. Supported on {ece}. The following shows how to define multiple
features you wish to expose. The following shows how to define multiple
properties:
|===
@ -379,44 +378,44 @@ map.regionmap:
[cols="2*<"]
|===
| [[regionmap-field-description]] `map.regionmap.layers[].fields[].description:`
| [[regionmap-field-description]] `map.regionmap.layers[].fields[].description:` {ess-icon} {ece-icon}
| Mandatory. The human readable text that is shown under the Options tab when
building the Region Map visualization. Supported on {ece}.
building the Region Map visualization.
| [[regionmap-field-name]] `map.regionmap.layers[].fields[].name:`
| [[regionmap-field-name]] `map.regionmap.layers[].fields[].name:` {ess-icon} {ece-icon}
| Mandatory.
This value is used to do an inner-join between the document stored in
{es} and the geojson file. For example, if the field in the geojson is
called `Location` and has city names, there must be a field in {es}
that holds the same values that {kib} can then use to lookup for the geoshape
data. Supported on {ece}.
data.
| [[regionmap-name]] `map.regionmap.layers[].name:`
| [[regionmap-name]] `map.regionmap.layers[].name:` {ess-icon} {ece-icon}
| Mandatory. A description of
the map being provided. Supported on {ece}.
the map being provided.
| [[regionmap-url]] `map.regionmap.layers[].url:`
| [[regionmap-url]] `map.regionmap.layers[].url:` {ess-icon} {ece-icon}
| Mandatory. The location of the
geojson file as provided by a webserver. Supported on {ece}.
geojson file as provided by a webserver.
| [[tilemap-settings]] `map.tilemap.options.attribution:`
| The map attribution string. Supported on {ece}.
| [[tilemap-settings]] `map.tilemap.options.attribution:` {ess-icon} {ece-icon}
| The map attribution string.
*Default: `"© [Elastic Maps Service](https://www.elastic.co/elastic-maps-service)"`*
| [[tilemap-max-zoom]] `map.tilemap.options.maxZoom:`
| The maximum zoom level. Supported on {ece}. *Default: `10`*
| [[tilemap-max-zoom]] `map.tilemap.options.maxZoom:` {ess-icon} {ece-icon}
| The maximum zoom level. *Default: `10`*
| [[tilemap-min-zoom]] `map.tilemap.options.minZoom:`
| The minimum zoom level. Supported on {ece}. *Default: `1`*
| [[tilemap-min-zoom]] `map.tilemap.options.minZoom:` {ess-icon} {ece-icon}
| The minimum zoom level. *Default: `1`*
| [[tilemap-subdomains]] `map.tilemap.options.subdomains:`
| [[tilemap-subdomains]] `map.tilemap.options.subdomains:` {ess-icon} {ece-icon}
| An array of subdomains
used by the tile service. Specify the position of the subdomain the URL with
the token `{s}`. Supported on {ece}.
the token `{s}`.
| [[tilemap-url]] `map.tilemap.url:`
| [[tilemap-url]] `map.tilemap.url:` {ess-icon} {ece-icon}
| The URL to the tileservice that {kib} uses
to display map tiles in tilemap visualizations. Supported on {ece}. By default,
to display map tiles in tilemap visualizations. By default,
{kib} reads this URL from an external metadata service, but users can
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"`
@ -451,7 +450,7 @@ deprecation warning at startup. This setting cannot end in a slash (`/`).
proxy sitting in front of it. This determines whether HTTP compression may be used for responses, based on the request `Referer` header.
This setting may not be used when `server.compression.enabled` is set to `false`. *Default: `none`*
| `server.customResponseHeaders:`
| `server.customResponseHeaders:` {ess-icon}
| Header names and values to
send on all responses to the client from the {kib} server. *Default: `{}`*
@ -610,7 +609,7 @@ us improve your user experience. Your data is never shared with anyone. Set to
`false` to disable telemetry capabilities entirely. You can alternatively opt
out through *Advanced Settings*. *Default: `true`*
| `vis_type_vega.enableExternalUrls:`
| `vis_type_vega.enableExternalUrls:` {ess-icon}
| Set this value to true to allow Vega to use any URL to access external data
sources and images. When false, Vega can only get data from {es}. *Default: `false`*
@ -622,7 +621,7 @@ disable the License Management UI. *Default: `true`*
| Set this value to false to disable the
Rollup UI. *Default: true*
| `i18n.locale`
| `i18n.locale` {ess-icon}
| Set this value to change the {kib} interface language.
Valid locales are: `en`, `zh-CN`, `ja-JP`. *Default: `en`*

13
docs/user/getting-started.asciidoc
View file

@ -8,18 +8,9 @@ Ready to try out {kib} and see what it can do? To quickest way to get started wi
[float]
[[cloud-set-up]]
== Set up on Cloud
== Set up on cloud
To access {kib} in a single click, run our hosted Elasticsearch Service on Elastic Cloud.
. Log into the link:https://cloud.elastic.co/[Elasticsearch Service Console].
If you need an account, register for a link:https://www.elastic.co/cloud/elasticsearch-service/signup[free 14-day trial].
. Click *Create deployment*, then give your deployment a name.
. To use the default options, click *Create deployment*. You can modify the other deployment options, but the default options are great to get started.
Be sure to copy down the password for the `elastic` user and Cloud ID information. You'll need that later.
include::{docs-root}/shared/cloud/ess-getting-started.asciidoc[]
[float]
[[get-data-in]]