Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 6 commits into from
May 14, 2020
Merged

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

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bbec112
Add cloud icon for supported settings
May 7, 2020
de3dd88
Remove delimited block from single-sourced content, edits
May 7, 2020
fc31aef
Remove delimited block from single-sourced content, edits
May 7, 2020
6490b34
Remove ifeval to simplify life
May 7, 2020
5dd34c1
Switch to docs-root
May 7, 2020
c945e20
Add ECE icons
May 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions docs/setup/settings.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"`*
Expand Down Expand Up @@ -304,7 +304,7 @@ list of timezones, refer to https://en.wikipedia.org/wiki/List_of_tz_database_ti
| Set to `true` to log all events, including system usage information and all
requests. Supported on {ece}. *Default: `false`*
nrichers marked this conversation as resolved.
Show resolved Hide resolved

| `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`*
Expand All @@ -313,7 +313,7 @@ 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}
| Specifies additional vector layers for
use in <<maps, Maps>> visualizations. Supported on {ece}. Each layer
nrichers marked this conversation as resolved.
Show resolved Hide resolved
object points to an external vector file that contains a geojson
Expand Down Expand Up @@ -349,11 +349,11 @@ layer option list. Supported on {ece}. 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}
| Optional. References the originating source of the geojson file.
Supported on {ece}.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This setting is also supported on ECE.


| [[regionmap-fields]] `map.regionmap.layers[].fields[]:`
| [[regionmap-fields]] `map.regionmap.layers[].fields[]:` {ess-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
nrichers marked this conversation as resolved.
Show resolved Hide resolved
Expand All @@ -379,42 +379,42 @@ map.regionmap:
[cols="2*<"]
|===

| [[regionmap-field-description]] `map.regionmap.layers[].fields[].description:`
| [[regionmap-field-description]] `map.regionmap.layers[].fields[].description:` {ess-icon}
| Mandatory. The human readable text that is shown under the Options tab when
building the Region Map visualization. Supported on {ece}.
nrichers marked this conversation as resolved.
Show resolved Hide resolved

| [[regionmap-field-name]] `map.regionmap.layers[].fields[].name:`
| [[regionmap-field-name]] `map.regionmap.layers[].fields[].name:` {ess-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}.
nrichers marked this conversation as resolved.
Show resolved Hide resolved

| [[regionmap-name]] `map.regionmap.layers[].name:`
| [[regionmap-name]] `map.regionmap.layers[].name:` {ess-icon}
| Mandatory. A description of
the map being provided. Supported on {ece}.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This setting is also supported on ECE.


| [[regionmap-url]] `map.regionmap.layers[].url:`
| [[regionmap-url]] `map.regionmap.layers[].url:` {ess-icon}
| Mandatory. The location of the
geojson file as provided by a webserver. Supported on {ece}.
nrichers marked this conversation as resolved.
Show resolved Hide resolved

| [[tilemap-settings]] `map.tilemap.options.attribution:`
| [[tilemap-settings]] `map.tilemap.options.attribution:` {ess-icon}
| The map attribution string. Supported on {ece}.
nrichers marked this conversation as resolved.
Show resolved Hide resolved
*Default: `"© [Elastic Maps Service](https://www.elastic.co/elastic-maps-service)"`*

| [[tilemap-max-zoom]] `map.tilemap.options.maxZoom:`
| [[tilemap-max-zoom]] `map.tilemap.options.maxZoom:` {ess-icon}
| The maximum zoom level. Supported on {ece}. *Default: `10`*
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This setting is also supported on ECE.


| [[tilemap-min-zoom]] `map.tilemap.options.minZoom:`
| [[tilemap-min-zoom]] `map.tilemap.options.minZoom:` {ess-icon}
| The minimum zoom level. Supported on {ece}. *Default: `1`*
nrichers marked this conversation as resolved.
Show resolved Hide resolved

| [[tilemap-subdomains]] `map.tilemap.options.subdomains:`
| [[tilemap-subdomains]] `map.tilemap.options.subdomains:` {ess-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}.
nrichers marked this conversation as resolved.
Show resolved Hide resolved

| [[tilemap-url]] `map.tilemap.url:`
| [[tilemap-url]] `map.tilemap.url:` {ess-icon}
| The URL to the tileservice that {kib} uses
to display map tiles in tilemap visualizations. Supported on {ece}. By default,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This setting is also supported on ECE.

{kib} reads this URL from an external metadata service, but users can
Expand Down Expand Up @@ -451,7 +451,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: `{}`*

Expand Down Expand Up @@ -610,7 +610,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`*

Expand All @@ -622,7 +622,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`*

Expand Down
11 changes: 1 addition & 10 deletions docs/user/getting-started.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,7 @@ Ready to try out {kib} and see what it can do? To quickest way to get started wi
[[cloud-set-up]]
== 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]]
Expand Down