Skip to content

Commit 0d6d5d5

Browse files
authored
docs: Update ESS and Elasticsearch output documentation (#20074) (#20157)
1 parent 67331ed commit 0d6d5d5

File tree

3 files changed

+107
-121
lines changed

3 files changed

+107
-121
lines changed

libbeat/docs/output-cloud.asciidoc

+8-9
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
[[configure-cloud-id]]
2-
=== Configure the output for the {ecloud}
2+
=== Configure the output for {ess} on {ecloud}
33

44
[subs="attributes"]
55
++++
6-
<titleabbrev>{ecloud}</titleabbrev>
6+
<titleabbrev>{ess}</titleabbrev>
77
++++
88

99
ifdef::apm-server[]
1010
NOTE: This page refers to using a separate instance of APM Server with an existing
11-
https://www.elastic.co/cloud/elasticsearch-service[{ess} deployment].
12-
If you want to use APM on {ecloud}, see the cloud docs:
13-
{cloud}/ec-create-deployment.html[Create your deployment] or
11+
{ess-product}[{ess} deployment].
12+
If you want to use APM on {ess}, see:
13+
{cloud}/ec-create-deployment.html[Create your deployment] and
1414
{cloud}/ec-manage-apm-settings.html[Add APM user settings].
1515
endif::apm-server[]
1616

1717
{beatname_uc} comes with two settings that simplify the output configuration
18-
when used together with https://cloud.elastic.co/[{ecloud}]. When defined,
18+
when used together with {ess-product}[{ess}]. When defined,
1919
these setting overwrite settings from other parts in the configuration.
2020

2121
Example:
@@ -37,16 +37,15 @@ These settings can be also specified at the command line, like this:
3737

3838
==== `cloud.id`
3939

40-
The Cloud ID, which can be found in the {ecloud} web console, is used by
40+
The Cloud ID, which can be found in the {ess} web console, is used by
4141
{beatname_uc} to resolve the {es} and {kib} URLs. This setting
4242
overwrites the `output.elasticsearch.hosts` and `setup.kibana.host` settings.
4343

44-
NOTE: The base64 encoded `cloud.id` found in the {ecloud} web console does not explicitly specify a port. This means that {beatname_uc} will default to using port 443 when using `cloud.id`, not the commonly configured cloud endpoint port 9243.
44+
NOTE: The base64 encoded `cloud.id` found in the {ess} web console does not explicitly specify a port. This means that {beatname_uc} will default to using port 443 when using `cloud.id`, not the commonly configured cloud endpoint port 9243.
4545

4646
==== `cloud.auth`
4747

4848
When specified, the `cloud.auth` overwrites the `output.elasticsearch.username` and
4949
`output.elasticsearch.password` settings. Because the Kibana settings inherit
5050
the username and password from the {es} output, this can also be used
5151
to set the `setup.kibana.username` and `setup.kibana.password` options.
52-

libbeat/docs/outputs-list.asciidoc

+10-10
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33

44
//# tag::outputs-list[]
55

6+
ifndef::no_cloud_id[]
7+
* <<configure-cloud-id>>
8+
endif::[]
69
ifndef::no_es_output[]
710
* <<elasticsearch-output>>
811
endif::[]
@@ -21,13 +24,17 @@ endif::[]
2124
ifndef::no_console_output[]
2225
* <<console-output>>
2326
endif::[]
24-
ifndef::no_cloud_id[]
25-
* <<configure-cloud-id>>
26-
endif::[]
2727

2828
//# end::outputs-list[]
2929

3030
//# tag::outputs-include[]
31+
ifndef::no_cloud_id[]
32+
ifdef::requires_xpack[]
33+
[role="xpack"]
34+
endif::[]
35+
include::output-cloud.asciidoc[]
36+
endif::[]
37+
3138
ifndef::no_es_output[]
3239
ifdef::requires_xpack[]
3340
[role="xpack"]
@@ -70,13 +77,6 @@ endif::[]
7077
include::{libbeat-outputs-dir}/console/docs/console.asciidoc[]
7178
endif::[]
7279

73-
ifndef::no_cloud_id[]
74-
ifdef::requires_xpack[]
75-
[role="xpack"]
76-
endif::[]
77-
include::output-cloud.asciidoc[]
78-
endif::[]
79-
8080
ifndef::no_codec[]
8181
ifdef::requires_xpack[]
8282
[role="xpack"]

0 commit comments

Comments
 (0)