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

Jump to bottom

docs: Update ESS and Elasticsearch output documentation #20074

Merged
merged 4 commits into from
Jul 22, 2020
Merged

docs: Update ESS and Elasticsearch output documentation #20074

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
555d949
docs: update to correct ESS terminology
bmorelli25 Jul 20, 2020
060411b
docs: update elasticsearch output
bmorelli25 Jul 20, 2020
bc60555
docs: fix build
bmorelli25 Jul 20, 2020
06935dd
docs: review feedback
bmorelli25 Jul 21, 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
17 changes: 8 additions & 9 deletions libbeat/docs/output-cloud.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
[[configure-cloud-id]]
=== Configure the output for the {ecloud}
=== Configure the output for {ess} on {ecloud}

[subs="attributes"]
++++
<titleabbrev>{ecloud}</titleabbrev>
<titleabbrev>{ess}</titleabbrev>
++++

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

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

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

==== `cloud.id`

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

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.
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.

==== `cloud.auth`

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

20 changes: 10 additions & 10 deletions libbeat/docs/outputs-list.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@

//# tag::outputs-list[]

ifndef::no_cloud_id[]
* <<configure-cloud-id>>
endif::[]
ifndef::no_es_output[]
* <<elasticsearch-output>>
endif::[]
Expand All @@ -21,13 +24,17 @@ endif::[]
ifndef::no_console_output[]
* <<console-output>>
endif::[]
ifndef::no_cloud_id[]
* <<configure-cloud-id>>
endif::[]

//# end::outputs-list[]

//# tag::outputs-include[]
ifndef::no_cloud_id[]
ifdef::requires_xpack[]
[role="xpack"]
endif::[]
include::output-cloud.asciidoc[]
endif::[]

ifndef::no_es_output[]
ifdef::requires_xpack[]
[role="xpack"]
Expand Down Expand Up @@ -70,13 +77,6 @@ endif::[]
include::{libbeat-outputs-dir}/console/docs/console.asciidoc[]
endif::[]

ifndef::no_cloud_id[]
ifdef::requires_xpack[]
[role="xpack"]
endif::[]
include::output-cloud.asciidoc[]
endif::[]

ifndef::no_codec[]
ifdef::requires_xpack[]
[role="xpack"]
Expand Down
Loading