Skip to content

Commit ab972a6

Browse files
Merge branch 'master' into add-version-improve-types
2 parents 0e4c9e3 + ef875cf commit ab972a6

File tree

63 files changed

+2100
-814
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+2100
-814
lines changed

docs/dev-tools/grokdebugger/index.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ in ingest node and Logstash.
3232
This example walks you through using the *Grok Debugger*. This tool
3333
is automatically enabled in {kib}.
3434

35-
NOTE: If you're using {security}, you must have the `manage_pipeline`
35+
NOTE: If you're using {stack-security-features}, you must have the `manage_pipeline`
3636
permission to use the Grok Debugger.
3737

3838
. Open the menu, go to *Dev Tools*, then click *Grok Debugger*.

docs/settings/monitoring-settings.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
By default, the Monitoring application is enabled, but data collection
99
is disabled. When you first start {kib} monitoring, you are prompted to
10-
enable data collection. If you are using {security}, you must be
10+
enable data collection. If you are using {stack-security-features}, you must be
1111
signed in as a user with the `cluster:manage` privilege to enable
1212
data collection. The built-in `superuser` role has this privilege and the
1313
built-in `elastic` user has this role.

docs/setup/install.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ Formulae are available from the Elastic Homebrew tap for installing {kib} on mac
5353
<<brew>>
5454

5555
IMPORTANT: If your Elasticsearch installation is protected by
56-
{ref}/elasticsearch-security.html[{security}] see
57-
{kibana-ref}/using-kibana-with-security.html[Configuring security in Kibana] for
56+
{ref}/elasticsearch-security.html[{stack-security-features}] see
57+
{kibana-ref}/using-kibana-with-security.html[Configuring security in {kib}] for
5858
additional setup instructions.
5959

6060
include::install/targz.asciidoc[]

docs/user/monitoring/monitoring-kibana.asciidoc

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,10 @@ node in the production cluster. By default, it is is disabled (`false`).
2020
+
2121
--
2222
NOTE: You can specify this setting in either the `elasticsearch.yml` on each
23-
node or across the cluster as a dynamic cluster setting. If {es}
24-
{security-features} are enabled, you must have `monitor` cluster privileges to
25-
view the cluster settings and `manage` cluster privileges to change them.
23+
node or across the cluster as a dynamic cluster setting. If
24+
{stack-security-features} are enabled, you must have `monitor` cluster
25+
privileges to view the cluster settings and `manage` cluster privileges to
26+
change them.
2627

2728
--
2829

@@ -33,7 +34,7 @@ view the cluster settings and `manage` cluster privileges to change them.
3334
--
3435
By default, if you are running {kib} locally, go to `http://localhost:5601/`.
3536

36-
If {es} {security-features} are enabled, log in.
37+
If {security-features} are enabled, log in.
3738
--
3839

3940
... Open the menu, then go to *Stack Monitoring*. If data collection is
@@ -80,13 +81,13 @@ monitoring cluster prevents production cluster outages from impacting your
8081
ability to access your monitoring data. It also prevents monitoring activities
8182
from impacting the performance of your production cluster.
8283
83-
If {security} is enabled on the production cluster, use an HTTPS URL such
84-
as `https://<your_production_cluster>:9200` in this setting.
84+
If {security-features} are enabled on the production cluster, use an HTTPS
85+
URL such as `https://<your_production_cluster>:9200` in this setting.
8586
===============================
8687

8788
--
8889

89-
. If the Elastic {security-features} are enabled on the production cluster:
90+
. If {security-features} are enabled on the production cluster:
9091

9192
.. Verify that there is a
9293
valid user ID and password in the `elasticsearch.username` and

docs/user/reporting/chromium-sandbox.asciidoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22
[[reporting-chromium-sandbox]]
33
=== Chromium sandbox
44

5-
When {reporting} uses the Chromium browser for generating PDF reports, it's recommended to use the sandbox for
6-
an additional layer of security. The Chromium sandbox uses operating system provided mechanisms to ensure that
7-
code execution cannot make persistent changes to the computer or access confidential information. The specific
8-
sandboxing techniques differ for each operating system.
5+
When {report-features} uses the Chromium browser for generating PDF reports,
6+
it's recommended to use the sandbox for an additional layer of security. The
7+
Chromium sandbox uses operating system provided mechanisms to ensure that
8+
code execution cannot make persistent changes to the computer or access
9+
confidential information. The specific sandboxing techniques differ for each
10+
operating system.
911

1012
==== Linux sandbox
1113
The Linux sandbox depends on user namespaces, which were introduced with the 3.8 Linux kernel. However, many
12-
distributions don't have user namespaces enabled by default, or they require the CAP_SYS_ADMIN capability. {reporting}
14+
distributions don't have user namespaces enabled by default, or they require the CAP_SYS_ADMIN capability. The {report-features}
1315
will automatically disable the sandbox when it is running on Debian and CentOS as additional steps are required to enable
1416
unprivileged usernamespaces. In these situations, you'll see the following message in your {kib} startup logs:
1517
`Chromium sandbox provides an additional layer of protection, but is not supported for your OS.

docs/user/reporting/configuring-reporting.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
[[configuring-reporting]]
33
== Reporting configuration
44

5-
You can configure settings in `kibana.yml` to control how {reporting}
6-
communicates with the {kib} server, manages background jobs, and captures
5+
You can configure settings in `kibana.yml` to control how the {report-features}
6+
communicate with the {kib} server, manages background jobs, and captures
77
screenshots. See <<reporting-settings-kb, Reporting Settings>> for the complete
88
list of settings.
99

1010
[float]
1111
[[encryption-keys]]
1212
=== Encryption keys for multiple {kib} instances
1313

14-
By default, a new encryption key is generated for {reporting} each time
15-
you start {kib}. This means if a static encryption key is not persisted in the
16-
{kib} configuration, any pending reports will fail when you restart {kib}.
14+
By default, a new encryption key is generated for the {report-features} each
15+
time you start {kib}. This means if a static encryption key is not persisted in
16+
the {kib} configuration, any pending reports will fail when you restart {kib}.
1717

1818
If you are load balancing across multiple {kib} instances, they need to have
1919
the same reporting encryption key. Otherwise, report generation will fail if a

docs/user/reporting/development/index.asciidoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
[role="xpack"]
22
[[reporting-integration]]
33
== Reporting integration
4-
Integrating a {kib} application with {reporting} requires a minimum amount of code, and the goal is to not have to
5-
modify the Reporting code as we add additional applications. Instead, applications abide by a contract that Reporting
6-
uses to determine the information that is required to export CSVs and PDFs.
4+
Integrating a {kib} application with the {report-features} requires a minimum
5+
amount of code, and the goal is to not have to modify the reporting code as we
6+
add additional applications. Instead, applications abide by a contract that
7+
{report-features} use to determine the information that is required to export
8+
CSVs and PDFs.
79

810
[IMPORTANT]
911
==============================================
@@ -18,7 +20,7 @@ X-Pack uses the `share` plugin of the Kibana platform to register actions in the
1820

1921
[float]
2022
=== Generate job URL
21-
To generate a new {reporting} job, different export types require different `jobParams` that are Rison encoded into a URL
23+
To generate a new reporting job, different export types require different `jobParams` that are Rison encoded into a URL
2224
that abide by the following convention: `/api/reporting/generate?jobParams=${rison.encode(jobParams)}`. If you use the
2325
aforementioned <<reporting-nav-bar-extensions, nav bar extensions>> then this detail will be abstracted away, but if you
2426
provide a custom UI for generating the report, you will have to generate the URL and create a POST request to the URL.

docs/user/reporting/gs-index.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You can also <<automating-report-generation,generate reports automatically>>.
2121
IMPORTANT: Reports are stored in the `.reporting-*` indices. Any user with
2222
access to these indices has access to every report generated by all users.
2323

24-
To use {reporting} in a production environment,
24+
To use {report-features} in a production environment,
2525
<<securing-reporting,secure the Reporting endpoints>>.
2626
--
2727

docs/user/reporting/index.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ image::user/reporting/images/share-button.png["Share"]
1919
[float]
2020
== Setup
2121

22-
{reporting} is automatically enabled in {kib}. It runs a custom build of the Chromium web browser, which
22+
The {report-features} are automatically enabled in {kib}. It runs a custom build of the Chromium web browser, which
2323
runs on the server in headless mode to load {kib} and capture the rendered {kib} charts as images.
2424

2525
Chromium is an open-source project not related to Elastic, but the Chromium binary for {kib} has been custom-built by Elastic to ensure it

docs/user/reporting/script-example.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ curl \
1919
// CONSOLE
2020

2121
<1> `POST` method is required.
22-
<2> Provide user credentials for a user with permission to access Kibana and X-Pack reporting.
22+
<2> Provide user credentials for a user with permission to access Kibana and
23+
{report-features}.
2324
<3> The `kbn-version` header is required for all `POST` requests to Kibana.
2425
**The value must match the dotted-numeral version of the Kibana instance.**
2526
<4> The POST URL. You can copy and paste the URL for any report from the Kibana UI.

0 commit comments

Comments
 (0)