Merge branch 'master' into telemetry/pull-live-kibana-stats

elastic · Dec 6, 2018 · 1972606 · 1972606
2 parents b90815d + 23effa5
commit 1972606
Show file tree

Hide file tree

Showing 114 changed files with 4,640 additions and 395 deletions.
diff --git a/.ci/jobs.yml b/.ci/jobs.yml
@@ -21,6 +21,7 @@ JOB:
   - x-pack-ciGroup4
   - x-pack-ciGroup5
   - x-pack-ciGroup6
+  - x-pack-ciGroup7
 
 # `~` is yaml for `null`
 exclude: ~
diff --git a/docs/api.asciidoc b/docs/api.asciidoc
@@ -24,6 +24,8 @@ wherever possible.
 have breaking changes in any version of Kibana, or it might even be removed
 entirely.
 
+NOTE: You cannot access these APIs via the Console in Kibana.
+
 [float]
 == APIs
 * <<spaces-api>>

diff --git a/docs/api/dashboard-import.asciidoc b/docs/api/dashboard-import.asciidoc
@@ -10,6 +10,8 @@ documents directly to the `.kibana` index. *Do not do this!* Writing directly
 to the `.kibana` index is not safe and it _will_ result in corrupted data that
 permanently breaks Kibana in a future version.
 
+NOTE: You cannot access these endpoints via the Console in Kibana.
+
 * <<dashboard-import-api-import>>
 * <<dashboard-import-api-export>>
 

diff --git a/docs/api/dashboard-import/export.asciidoc b/docs/api/dashboard-import/export.asciidoc
@@ -7,6 +7,8 @@ The dashboard export API allows people to export dashboards along with all of
 their corresponding saved objects such as visualizations, saved searches, and
 index patterns.
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 ==== Request
 
 `GET /api/kibana/dashboards/export`

diff --git a/docs/api/dashboard-import/import.asciidoc b/docs/api/dashboard-import/import.asciidoc
@@ -7,6 +7,8 @@ The dashboard import API allows people to import dashboards along with all of
 their corresponding saved objects such as visualizations, saved searches, and
 index patterns.
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 ==== Request
 
 `POST /api/kibana/dashboards/import`

diff --git a/docs/api/logstash-configuration-management.asciidoc b/docs/api/logstash-configuration-management.asciidoc
@@ -9,6 +9,8 @@ Traditionally users would perform this integration by accessing the the `.logsta
 directly. *Do not do this!* The structure of this index is subject to change, which could
 cause your integration to break. Instead, use the following API.
 
+NOTE: You cannot access these endpoints via the Console in Kibana.
+
 * <<logstash-configuration-management-api-create>>
 * <<logstash-configuration-management-api-retrieve>>
 * <<logstash-configuration-management-api-delete>>

diff --git a/docs/api/logstash-configuration-management/create.asciidoc b/docs/api/logstash-configuration-management/create.asciidoc
@@ -7,6 +7,8 @@ experimental[This functionality is *experimental* and may be changed or removed
 The Create Pipeline API enables you to create a centrally-managed Logstash pipeline. You can also use
 it to update an existing pipeline.
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 [float]
 ==== Request
 

diff --git a/docs/api/logstash-configuration-management/delete.asciidoc b/docs/api/logstash-configuration-management/delete.asciidoc
@@ -6,6 +6,8 @@ experimental[This functionality is *experimental* and may be changed or removed
 
 The Delete Pipeline API enables you to delete a centrally-managed Logstash pipeline.
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 [float]
 ==== Request
 

diff --git a/docs/api/logstash-configuration-management/list.asciidoc b/docs/api/logstash-configuration-management/list.asciidoc
@@ -6,6 +6,8 @@ experimental[This functionality is *experimental* and may be changed or removed
 
 The List Pipelines API enables you to list all centrally-managed Logstash pipelines.
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 [float]
 ==== Request
 

diff --git a/docs/api/logstash-configuration-management/retrieve.asciidoc b/docs/api/logstash-configuration-management/retrieve.asciidoc
@@ -6,6 +6,8 @@ experimental[This functionality is *experimental* and may be changed or removed
 
 The Retrieve Pipeline API enables you to retrieve a centrally-managed Logstash pipeline.
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 [float]
 ==== Request
 

diff --git a/docs/api/role-management.asciidoc b/docs/api/role-management.asciidoc
@@ -9,6 +9,8 @@ It is *not* supported to do so using the
 {ref}/security-api.html#security-role-apis[{es} role management APIs], and doing 
 so will likely cause {kib}'s authorization to behave unexpectedly. 
 
+NOTE: You cannot access these endpoints via the Console in Kibana.
+
 * <<role-management-api-put>>
 * <<role-management-api-get>>
 * <<role-management-api-delete>>

diff --git a/docs/api/role-management/delete.asciidoc b/docs/api/role-management/delete.asciidoc
@@ -3,6 +3,8 @@
 
 experimental[This API is experimental and may be changed or removed completely in a future release. Although the underlying mechanism of enforcing role-based access control is stable, the APIs for managing the roles are currently experimental.]
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 ==== Authorization
 
 To use this API, you must have at least the `manage_security` cluster privilege.

diff --git a/docs/api/role-management/get.asciidoc b/docs/api/role-management/get.asciidoc
@@ -5,6 +5,8 @@ experimental[This API is experimental and may be changed or removed completely i
 
 Retrieves all {kib} roles, or a specific role.
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 ==== Authorization
 
 To use this API, you must have at least the `manage_security` cluster privilege.

diff --git a/docs/api/role-management/put.asciidoc b/docs/api/role-management/put.asciidoc
@@ -6,6 +6,8 @@ experimental[This API is experimental and may be changed or removed completely i
 Creates a new {kib} role or updates the attributes of an existing role. {kib} roles are stored in the
 {es} native realm.
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 ==== Authorization
 
 To use this API, you must have at least the `manage_security` cluster privilege.

diff --git a/docs/api/saved-objects.asciidoc b/docs/api/saved-objects.asciidoc
@@ -9,6 +9,8 @@ documents directly to the `.kibana` index. *Do not do this!* Writing directly
 to the `.kibana` index is not safe and it _will_ result in corrupted data that
 permanently breaks Kibana in a future version.
 
+NOTE: You cannot access these endpoints via the Console in Kibana.
+
 * <<saved-objects-api-get>>
 * <<saved-objects-api-bulk-get>>
 * <<saved-objects-api-find>>

diff --git a/docs/api/saved-objects/bulk_create.asciidoc b/docs/api/saved-objects/bulk_create.asciidoc
@@ -6,6 +6,8 @@ experimental[This functionality is *experimental* and may be changed or removed
 The bulk-create saved object API enables you to persist multiple Kibana saved
 objects.
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 ==== Request
 
 `POST /api/saved_objects/_bulk_create`

diff --git a/docs/api/saved-objects/bulk_get.asciidoc b/docs/api/saved-objects/bulk_get.asciidoc
@@ -6,6 +6,8 @@ experimental[This functionality is *experimental* and may be changed or removed
 The bulk-get saved object API enables you to retrieve multiple Kibana saved
 objects by id.
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 ==== Request
 
 `POST /api/saved_objects/_bulk_get`

diff --git a/docs/api/saved-objects/create.asciidoc b/docs/api/saved-objects/create.asciidoc
@@ -5,6 +5,8 @@ experimental[This functionality is *experimental* and may be changed or removed
 
 The create saved object API enables you to persist a Kibana saved object.
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 ==== Request
 
 `POST /api/saved_objects/<type>` +

diff --git a/docs/api/saved-objects/delete.asciidoc b/docs/api/saved-objects/delete.asciidoc
@@ -6,6 +6,8 @@ experimental[This functionality is *experimental* and may be changed or removed
 The delete saved object API permanently removes a Kibana saved object. Once a
 saved object has been deleted, _it cannot be recovered_.
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 ==== Request
 
 `DELETE /api/saved_objects/<type>/<id>`

diff --git a/docs/api/saved-objects/find.asciidoc b/docs/api/saved-objects/find.asciidoc
@@ -6,6 +6,8 @@ experimental[This functionality is *experimental* and may be changed or removed
 The find saved object API enables you to retrieve a paginated set of Kibana
 saved objects by various conditions.
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 ==== Request
 
 `GET /api/saved_objects/_find`

diff --git a/docs/api/saved-objects/get.asciidoc b/docs/api/saved-objects/get.asciidoc
@@ -6,6 +6,8 @@ experimental[This functionality is *experimental* and may be changed or removed
 The get saved object API enables you to retrieve a single Kibana saved object
 by id.
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 ==== Request
 
 `GET /api/saved_objects/<type>/<id>`

diff --git a/docs/api/saved-objects/update.asciidoc b/docs/api/saved-objects/update.asciidoc
@@ -6,6 +6,8 @@ experimental[This functionality is *experimental* and may be changed or removed
 The update saved object API enables you to update the attributes for an
 existing Kibana saved object.
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 ==== Request
 
 `PUT /api/saved_objects/<type>/<id>`

diff --git a/docs/api/spaces-management.asciidoc b/docs/api/spaces-management.asciidoc
@@ -6,6 +6,8 @@ experimental[This API is *experimental* and may be changed or removed completely
 
 The spaces API allows people to manage their spaces within {kib}.
 
+NOTE: You cannot access these endpoints via the Console in Kibana.
+
 * <<spaces-api-post>>
 * <<spaces-api-put>>
 * <<spaces-api-get>>

diff --git a/docs/api/spaces-management/delete.asciidoc b/docs/api/spaces-management/delete.asciidoc
@@ -8,6 +8,8 @@ experimental[This API is *experimental* and may be changed or removed completely
 Deleting a space will automatically delete all saved objects that belong to that space. This operation cannot be undone!
 ==================================================
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 ==== Request
 
 To delete a space, submit a DELETE request to the `/api/spaces/space/<space_id>`

diff --git a/docs/api/spaces-management/get.asciidoc b/docs/api/spaces-management/get.asciidoc
@@ -5,6 +5,8 @@ experimental[This API is *experimental* and may be changed or removed completely
 
 Retrieves all {kib} spaces, or a specific space.
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 ==== Get all {kib} spaces
 
 ===== Request

diff --git a/docs/api/spaces-management/post.asciidoc b/docs/api/spaces-management/post.asciidoc
@@ -5,6 +5,8 @@ experimental[This API is *experimental* and may be changed or removed completely
 
 Creates a new {kib} space. To update an existing space, use the PUT command.
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 ==== Request
 
 To create a space, issue a POST request to the 

diff --git a/docs/api/spaces-management/put.asciidoc b/docs/api/spaces-management/put.asciidoc
@@ -5,6 +5,8 @@ experimental[This API is *experimental* and may be changed or removed completely
 
 Updates an existing {kib} space. To create a new space, use the POST command.
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 ==== Request
 
 To update a space, issue a PUT request to the 

diff --git a/docs/api/url-shortening.asciidoc b/docs/api/url-shortening.asciidoc
@@ -6,6 +6,8 @@ Internet Explorer has URL length restrictions, and some wiki and markup parsers
 
 The short URLs enabled by this API are designed to make sharing Kibana URLs easier.
 
+NOTE: You cannot access these endpoints via the Console in Kibana.
+
 * <<url-shortening-api-api-shorten-url>>
 
 include::url_shortening/shorten_url.asciidoc[]
diff --git a/docs/api/url_shortening/shorten_url.asciidoc b/docs/api/url_shortening/shorten_url.asciidoc
@@ -3,6 +3,8 @@
 
 The Shorten URL API allows for converting a Kibana URL into a token.
 
+Note: You cannot access this endpoint via the Console in Kibana.
+
 ==== Request
 
 `POST /api/shorten_url`

diff --git a/docs/canvas.asciidoc b/docs/canvas.asciidoc
@@ -16,12 +16,29 @@ you make neat stuff and you want to show that neat stuff to others. Canvas is
 for makers who are a little bit creative, a little bit technical, and whole lot 
 of curious.
 
-We've put together <<canvas-getting-started, this Getting Started>> to teach you 
-how to get the most out of Canvas. 
+[role="screenshot"]
+image::images/canvas_workpad_weblog.png[]
+
+
+We've put together <<canvas-getting-started, this Getting Started>> to get you
+up and running with Canvas. 
+
+If you want to dig into the expression language and the functions that drive 
+Canvas, see the <<canvas-common-functions>> and 
+<<canvas-tinymath-functions>>.
 
 --
 
 include::canvas/canvas-getting-started.asciidoc[]
 
 include::canvas/canvas-workpad.asciidoc[]
 
+include::canvas/canvas-function-reference.asciidoc[]
+
+include::canvas/canvas-common-functions.asciidoc[]
+
+include::canvas/canvas-server-functions.asciidoc[]
+
+include::canvas/canvas-client-functions.asciidoc[]
+
+include::canvas/canvas-tinymath-functions.asciidoc[]
diff --git a/docs/canvas/canvas-client-functions.asciidoc b/docs/canvas/canvas-client-functions.asciidoc
@@ -0,0 +1,82 @@
+[[canvas-client-functions]]
+=== Canvas client functions
+
+beta[]These functions must execute in a browser. They are only available
+from within the Canvas application, not via the Canvas HTTP API. These functions must 
+execute in the browser because they use browser specific APIs, such as location, 
+or interact with the workpad to read filters.
+
+A *** denotes a required argument.
+
+[float]
+=== asset
+
+Uses Canvas workpad asset objects to provide argument values. Usually images.
+
+*Accepts:* null
+
+[cols="3*^<"]
+|===
+s|Argument
+s|Type
+s|Description
+
+|_Unnamed_*
+|string
+|The ID of the asset value to return
+|===
+
+*Returns:* string
+
+
+[float]
+=== browser
+
+Forces the interpreter to return to the browser.
+
+*Accepts:* Anything or nothing
+
+*Returns:* Depends on your input and arguments
+
+[float]
+=== filters
+
+Collects element filters on the workpad, usually to provide them to a data source.
+
+*Accepts:* null
+
+*Returns:* filter
+
+[float]
+=== location
+
+Uses the browser's location functionality to get your current location. Usually 
+quite slow, but fairly accurate.
+
+*Accepts:* null
+
+*Returns:* datatable
+
+[float]
+=== urlparam
+
+Accesses URL parameters and use them in expressions. This will always return a string.
+
+*Accepts:* null
+
+[cols="3*^<"]
+|===
+s|Argument
+s|Type
+s|Description
+
+|_Unnamed_*  (Aliases: `var`, `variable`)
+|string
+|The URL hash parameter to access
+
+|default
+|string
+|Return this string if the url parameter is not defined  (default: `""`)
+|===
+
+*Returns:* string
-Original file line number
+Diff line change
@@ Expand Up @@
     The Delete Pipeline API enables you to delete a centrally-managed Logstash pipeline.
+    Note: You cannot access this endpoint via the Console in Kibana.
     [float]
     ==== Request
@@ Expand Down @@