Skip to content

Commit 8e00c87

Browse files
Doc: Add LS-to-svrless page for 8.19 (#18201) (#18244)
Update hosted content to align (cherry picked from commit e7ae92b) Co-authored-by: Karen Metts <[email protected]>
1 parent e1b1011 commit 8e00c87

File tree

3 files changed

+68
-4
lines changed

3 files changed

+68
-4
lines changed

docs/static/ls-to-cloud.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[connecting-to-cloud]]
2-
=== Sending data to Elastic Cloud (hosted Elasticsearch Service)
2+
=== Sending data to {ech}
33

44
Our hosted {ess} on https://cloud.elastic.co/[Elastic Cloud] simplifies safe, secure communication between {ls} and {es}.
55
When you configure the Elasticsearch output plugin to use <<plugins-outputs-elasticsearch-cloud_id,`cloud_id`>> with either the <<plugins-outputs-elasticsearch-cloud_auth,`cloud_auth` option>> or the <<plugins-outputs-elasticsearch-api_key,`api_key` option>>, no additional SSL configuration is needed.
@@ -31,16 +31,16 @@ If you change your Cloud password in the Cloud UI, remember to change it here, t
3131
[[cloud-id-plugins]]
3232
==== Using Cloud ID and Cloud Auth with plugins
3333

34-
The Elasticsearch input, output, and filter plugins support cloud_id and
35-
cloud_auth in their configurations.
34+
The Elasticsearch input, output, and filter plugins, as well as the Elastic_integration filter plugin, support cloud_id and cloud_auth in their configurations.
3635

3736
* <<plugins-inputs-elasticsearch-cloud_id,Elasticsearch input plugin>>
3837
* <<plugins-filters-elasticsearch-cloud_id,Elasticsearch filter plugin>>
3938
* <<plugins-outputs-elasticsearch-cloud_id,Elasticsearch output plugin>>
39+
* <<plugins-filters-elastic_integration-cloud_id,Elastic_integration filter plugin>>
4040

4141

4242
[[cloud-id-mgmt]]
43-
==== Sending {ls} management data to {es} Services
43+
==== Using {ls} Central Pipeline Management with {ech}
4444

4545
These settings in the `logstash.yml` config file can help you get set up to send
4646
management data to Elastic Cloud:
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
[[logstash-to-elasticsearch-serverless]]
2+
=== Sending data to {es-serverless}
3+
4+
When you use Elasticsearch on Elastic Cloud Serverless you don’t need to worry about managing the infrastructure that keeps Elasticsearch distributed and available. These resources are automated on the serverless platform and are designed to scale up and down with your workload.
5+
6+
7+
.{ls} to {serverless-full}
8+
****
9+
You’ll use the {ls} link:logstash-docs-md://lsr/plugins-outputs-elasticsearch.md[{es} output plugin] to send data to {serverless-full}.
10+
Note these differences between {es-serverless} and both {ech} and self-managed {es}:
11+
12+
* Use link:/reference/secure-connection.md#ls-api-keys[**API keys**] to access {serverless-full} from {ls} as it does not support native user authentication.
13+
Any user-based security settings in your link:logstash-docs-md://lsr/plugins-outputs-elasticsearch.md[{es} output plugin] configuration are ignored and may cause errors.
14+
* {serverless-full} uses **data streams** and link:docs-content://manage-data/lifecycle/data-stream.md[{dlm} ({dlm-init})] instead of {ilm} ({ilm-init}). Any {ilm-init} settings in your link:logstash-docs-md://lsr/plugins-outputs-elasticsearch.md[{es} output plugin] configuration are ignored and may cause errors.
15+
* **{ls} monitoring** is available through the link:https://github.com/elastic/integrations/blob/main/packages/logstash/_dev/build/docs/README.md[{ls} Integration] in link:docs-content://solutions/observability.md[Elastic Observability] on {serverless-full}.
16+
17+
*Known issue for Logstash to Elasticsearch Serverless.* +
18+
The logstash-output-elasticsearch `hosts` setting defaults to port :9200. +
19+
Set the value to port :443 instead.
20+
****
21+
22+
[[connecting-to-elasticsearch-serverless]]
23+
==== Communication between {ls} and {es-serverless}
24+
25+
link:docs-content://solutions/search/serverless-elasticsearch-get-started.md[{es-serverless}] simplifies safe, secure communication between {ls} and {es}.
26+
When you configure the Elasticsearch output plugin to use link:logstash-docs-md://lsr/plugins-outputs-elasticsearch.md#plugins-outputs-elasticsearch-cloud_id[`cloud_id`] and an link:logstash-docs-md://lsr/plugins-outputs-elasticsearch.md#plugins-outputs-elasticsearch-api_key[`api_key`], no additional SSL configuration is needed.
27+
28+
Example:
29+
30+
* `output {elasticsearch { cloud_id => "<cloud id>" api_key => "<api key>" } }`
31+
32+
Note that the value of the link:logstash-docs-md://lsr/plugins-outputs-elasticsearch.md#plugins-outputs-elasticsearch-api_key[`api_key` option] is in the format `id:api_key`, where `id` and `api_key` are the values returned by the link:https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key[Create API key API].
33+
34+
[[cloud-id-serverless]]
35+
===== Cloud ID
36+
37+
{ls} uses the Cloud ID, found in the Elastic Cloud web console, to build the Elasticsearch and Kibana hosts settings. It is a base64 encoded text value of about 120 characters made up of upper and lower case letters and numbers. If you have several Cloud IDs, you can add a label, which is ignored internally, to help you tell them apart. To add a label, prefix your Cloud ID with a label and a `:` separator in this format "<label>:<cloud-id>".
38+
39+
[[api-key-serverless]]
40+
===== API key
41+
42+
When you create an API key for {ls}, select *Logstash* from the *API key format* dropdown.
43+
This option formats the API key in the correct `id:api_key` format required by {ls}.
44+
45+
46+
[[plugins-serverless]]
47+
==== Using Cloud ID with plugins
48+
49+
The Elasticsearch input, output, and filter plugins, as well as the Elastic_integration filter plugin, support cloud_id in their configurations.
50+
51+
* link:logstash-docs-md://lsr/plugins-inputs-elasticsearch.md#plugins-inputs-elasticsearch-cloud_id[Elasticsearch input plugin]
52+
* link:logstash-docs-md://lsr/plugins-filters-elasticsearch.md#plugins-filters-elasticsearch-cloud_id[Elasticsearch filter plugin]
53+
* link:logstash-docs-md://lsr/plugins-outputs-elasticsearch.md#plugins-outputs-elasticsearch-cloud_id[Elasticsearch output plugin]
54+
* link:logstash-docs-md://lsr/plugins-filters-elastic_integration.md#plugins-filters-elastic_integration-cloud_id[Elastic_integration filter plugin]
55+
56+
[cpm-serverless]
57+
==== Using {ls} Central Pipeline Management with {es-serverless}
58+
59+
This setting in the `logstash.yml` config file can help you get set up to use Central Pipeline management in Elastic Cloud:
60+
61+
* `xpack.management.elasticsearch.cloud_id`
62+
63+
You can use the `xpack.management.elasticsearch.cloud_id` setting as an alternative to `xpack.management.elasticsearch.hosts`.

docs/static/pipeline-configuration.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -315,4 +315,5 @@ input { # comments can appear at the end of a line, too
315315
include::event-data.asciidoc[]
316316
include::env-vars.asciidoc[]
317317
include::ls-to-cloud.asciidoc[]
318+
include::ls-to-serverless.asciidoc[]
318319
include::pipeline-config-exps.asciidoc[]

0 commit comments

Comments
 (0)