Skip to content

Commit 0c61ca1

Browse files
committed
Merge remote-tracking branch 'origin/main' into eedugon/kustomize_troubleshooting
2 parents 65c53ba + 0f1c582 commit 0c61ca1

14 files changed

+343
-40
lines changed

.backportrc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"repoOwner": "elastic",
33
"repoName": "ingest-docs",
4-
"targetBranchChoices": ["main", "8.x","8.15","8.14","8.13","8.12", "8.11", "8.10", "8.9", "8.8", "8.7", "8.6", "7.17"],
4+
"targetBranchChoices": ["main", "8.x","8.16","8.15","8.14","8.13","8.12", "8.11", "8.10", "8.9", "8.8", "8.7", "8.6", "7.17"],
55
"autoMerge": true,
66
"autoMergeMethod": "squash",
77
"branchLabelMapping": {

.mergify.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,20 @@ pull_request_rules:
2929
title: "[{{ destination_branch }}] {{ title }} (backport #{{ number }})"
3030
labels:
3131
- backport
32+
- name: backport patches to 8.16 branch
33+
conditions:
34+
- merged
35+
- base=main
36+
- label=backport-8.16
37+
actions:
38+
backport:
39+
assignees:
40+
- "{{ author }}"
41+
branches:
42+
- "8.16"
43+
title: "[{{ destination_branch }}] {{ title }} (backport #{{ number }})"
44+
labels:
45+
- backport
3246
- name: backport patches to 8.15 branch
3347
conditions:
3448
- merged

docs/en/ingest-management/commands.asciidoc

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1106,16 +1106,19 @@ to remove files.
11061106

11071107
[IMPORTANT]
11081108
====
1109-
Be sure to run the `uninstall` command from the directory where {agent} is installed and not from the directory where you previously ran the `install` command.
1109+
Be sure to run the `uninstall` command from a directory outside of where {agent} is installed.
11101110
1111-
--
1112-
1113-
include::{ingest-docs-root}/docs/en/ingest-management/tab-widgets/uninstall-widget.asciidoc[]
1111+
For example, on a Windows system the install location is `C:\Program Files\Elastic\Agent`. Run the uninstall command from `C:\Program Files\Elastic` or `\tmp`, or even your default home directory:
11141112
1115-
--
1113+
[source,shell]
1114+
----
1115+
C:\"Program Files"\Elastic\Agent\elastic-agent.exe uninstall
1116+
----
11161117
11171118
====
11181119

1120+
include::{ingest-docs-root}/docs/en/ingest-management/tab-widgets/uninstall-widget.asciidoc[]
1121+
11191122
[discrete]
11201123
=== Synopsis
11211124

docs/en/ingest-management/elastic-agent/configuration/autodiscovery/elastic-agent-kubernetes-autodiscovery.asciidoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,28 @@
33

44
When you run applications on containers, they become moving targets to the monitoring system. Autodiscover allows you to track them and adapt settings as changes happen. By defining configuration templates, the autodiscover subsystem can monitor services as they start running.
55

6-
To use autodiscovery, you will need to modify the manifest file of the {agent}. Refer to <<running-on-kubernetes-standalone>> to learn how to retrieve and configure it.
6+
To use autodiscover, you will need to modify the manifest file of the {agent}. Refer to <<running-on-kubernetes-standalone>> to learn how to retrieve and configure it.
77

8-
There are two different ways to use autodiscovery:
8+
There are two different ways to use autodiscover:
99

1010
* <<conditions-based-autodiscover>>
1111

1212
* <<hints-annotations-autodiscovery>>
1313

1414

1515
[discrete]
16-
== How to configure autodiscovery
16+
== How to configure autodiscover
1717

18-
`Conditions Based Autodiscovery` is more suitable for scenarios when users know the different group of containers they want to monitor in advance. It is advisable to choose conditions-based configuration when administrators can configure specific conditions that match their needs. Conditions are supported in both Managed and Standalone {agent}.
18+
`Conditions Based Autodiscover` is more suitable for scenarios when users know the different group of containers they want to monitor in advance. It is advisable to choose conditions-based configuration when administrators can configure specific conditions that match their needs. Conditions are supported in both Managed and Standalone {agent}.
1919

20-
`Hints Based Autodiscovry` is suitable for more generic scenarios, especially when users don't know the exact configuration of the system to monitor and can not create in advance conditions. Additionally a big advantage of Hints Autodiscovery is the ability to offer dynamic configuration of inputs based on annotations from Pods/Containers. If dynamic configuration is needed, then Hints should be enabled. Hints are supported only in Standalone {agent} mode.
20+
`Hints Based Autodiscover` is suitable for more generic scenarios, especially when users don't know the exact configuration of the system to monitor and can not create in advance conditions. Additionally a big advantage of Hints Autodiscover is the ability to offer dynamic configuration of inputs based on annotations from Pods/Containers. If dynamic configuration is needed, then Hints should be enabled. Hints are supported only in Standalone {agent} mode.
2121

22-
*Best Practises when you configure autodiscovery:*
22+
*Best Practises when you configure autodiscover:*
2323

2424
- Always define alternatives and default values to your variables that are used in conditions or [hint templates](eg. See `auth.basic` set as `auth.basic.user: ${kubernetes.hints.nginx.access.username|kubernetes.hints.nginx.username|''}`` in [nginx.yml](https://github.com/elastic/elastic-agent/blob/main/deploy/kubernetes/elastic-agent-standalone/templates.d/nginx.yml#L8))
2525

2626
IMPORTANT: When an input uses a variable substitution that is not present in the current key/value mappings being evaluated, the input is removed in the result. (See more information in <<dynamic-input-configuration>>)
2727

2828
- To debug configurations that include variable substitution and conditions, use the inspect command of {agent}. (See more information in <<dynamic-input-configuration>> in *Debugging* Section)
2929

30-
- In Condition Based autodiscovery is advisable to define a generic last condition that will act as your default condition and will be validated when all others fail or don't apply. If applicable, such conditions might help to identify processing and troubleshoot possible problems.
30+
- In Condition Based autodiscover is advisable to define a generic last condition that will act as your default condition and will be validated when all others fail or don't apply. If applicable, such conditions might help to identify processing and troubleshoot possible problems.

docs/en/ingest-management/elastic-agent/configuration/env/container-envs.asciidoc

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,6 @@ Settings used to prepare the {fleet} plugin in {kib}.
6868
|===
6969
| Settings | Description
7070

71-
include::shared-env.asciidoc[tag=kibana-fleet-setup]
72-
7371
include::shared-env.asciidoc[tag=kibana-fleet-host]
7472

7573
include::shared-env.asciidoc[tag=kibana-fleet-username]
@@ -100,6 +98,12 @@ include::shared-env.asciidoc[tag=fleet-server-elasticsearch-host]
10098

10199
include::shared-env.asciidoc[tag=fleet-server-elasticsearch-ca]
102100

101+
include::shared-env.asciidoc[tag=fleet-server-es-cert]
102+
103+
include::shared-env.asciidoc[tag=fleet-server-es-cert-key]
104+
105+
include::shared-env.asciidoc[tag=fleet-server-insecure-http]
106+
103107
include::shared-env.asciidoc[tag=fleet-server-service-token]
104108

105109
include::shared-env.asciidoc[tag=fleet-server-service-token-path]
@@ -118,8 +122,14 @@ include::shared-env.asciidoc[tag=fleet-server-cert-key]
118122

119123
include::shared-env.asciidoc[tag=fleet-server-cert-key-passphrase]
120124

125+
include::shared-env.asciidoc[tag=fleet-server-client-auth]
126+
121127
include::shared-env.asciidoc[tag=fleet-server-es-ca-trusted-fingerprint]
122128

129+
include::shared-env.asciidoc[tag=fleet-daemon-timeout]
130+
131+
include::shared-env.asciidoc[tag=fleet-server-timeout]
132+
123133
|===
124134

125135
[discrete]
@@ -135,10 +145,16 @@ Settings used to enroll an {agent} into a {fleet-server}.
135145
|===
136146
| Settings | Description
137147

148+
include::shared-env.asciidoc[tag=elastic-agent-cert]
149+
150+
include::shared-env.asciidoc[tag=elastic-agent-cert-key]
151+
138152
include::shared-env.asciidoc[tag=elastic-agent-tag]
139153

140154
include::shared-env.asciidoc[tag=fleet-enroll]
141155

156+
include::shared-env.asciidoc[tag=fleet-force]
157+
142158
include::shared-env.asciidoc[tag=fleet-url]
143159

144160
include::shared-env.asciidoc[tag=fleet-enrollment-token]

docs/en/ingest-management/elastic-agent/configuration/env/shared-env.asciidoc

Lines changed: 112 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,30 +17,37 @@ OPTIONAL INFO AND EXAMPLE
1717

1818
// =============================================================================
1919

20-
// tag::elastic-agent-tag[]
20+
// tag::elastic-agent-cert[]
2121
|
22-
[id="env-{type}-elastic-agent-tag"]
23-
`ELASTIC_AGENT_TAGS`
22+
[id="env-{type}-elastic-agent-cert"]
23+
`ELASTIC_AGENT_CERT`
2424

25-
| (string) A comma-separated list of tags to apply to {fleet}-managed {agent}s.
26-
You can use these tags to filter the list of agents in {fleet}.
25+
| (string) The path to the mutual TLS client certificate that {agent} will use to connect to {fleet-server}.
2726

28-
// end::elastic-agent-tag[]
27+
// end::elastic-agent-cert[]
2928

3029
// =============================================================================
3130

32-
// tag::kibana-fleet-setup[]
31+
// tag::elastic-agent-cert-key[]
3332
|
34-
[id="env-{type}-kibana-fleet-setup"]
35-
`KIBANA_FLEET_SETUP`
33+
[id="env-{type}-elastic-agent-cert-key"]
34+
`ELASTIC_AGENT_CERT_KEY`
3635

37-
| (int) Set to `1` to enable {fleet} setup.
38-
Enabling {fleet} is required before {fleet-server} will start.
39-
When this action is not performed, a user must manually log in to {kib} and visit the {fleet} page to enable setup.
36+
| (string) The path to the mutual TLS private key that {agent} will use to connect to {fleet-server}.
4037

41-
*Default:* none
38+
// end::elastic-agent-cert-key[]
39+
40+
// =============================================================================
4241

43-
// end::kibana-fleet-setup[]
42+
// tag::elastic-agent-tag[]
43+
|
44+
[id="env-{type}-elastic-agent-tag"]
45+
`ELASTIC_AGENT_TAGS`
46+
47+
| (string) A comma-separated list of tags to apply to {fleet}-managed {agent}s.
48+
You can use these tags to filter the list of agents in {fleet}.
49+
50+
// end::elastic-agent-tag[]
4451

4552
// =============================================================================
4653

@@ -105,6 +112,20 @@ contains your CA's certificate.
105112

106113
// =============================================================================
107114

115+
// tag::fleet-force[]
116+
|
117+
[id="env-{type}-fleet-force"]
118+
`FLEET_FORCE`
119+
120+
| (bool) Set to `true` to force overwrite of the current {agent} configuration without prompting for confirmation.
121+
This flag is helpful when using automation software or scripted deployments.
122+
123+
*Default:* `false`
124+
125+
// end::fleet-force[]
126+
127+
// =============================================================================
128+
108129
// tag::fleet-server-enable[]
109130
|
110131
[id="env-{type}-fleet-server-enable"]
@@ -273,6 +294,21 @@ Overrides the port defined in the policy.
273294

274295
// =============================================================================
275296

297+
// tag::fleet-server-client-auth[]
298+
|
299+
[id="env-{type}-fleet-server-client-auth"]
300+
`FLEET_SERVER_CLIENT_AUTH`
301+
302+
| (string) One of `none`, `optional`, or `required`.
303+
{fleet-server}'s client authentication option for client mTLS connections.
304+
If `optional` or `required` is specified, client certificates are verified using CAs.
305+
306+
*Default:* `none`
307+
308+
// end::fleet-server-client-auth[]
309+
310+
// =============================================================================
311+
276312
// tag::fleet-server-es-ca-trusted-fingerprint[]
277313
|
278314
[id="env-{type}-fleet-server-es-ca-trusted-fingerprint"]
@@ -288,6 +324,68 @@ by {agent} for communication. This flag is required when using self-signed certi
288324
289325
// =============================================================================
290326
327+
// tag::fleet-server-es-cert[]
328+
|
329+
[id="env-{type}-fleet-server-es-cert"]
330+
`FLEET_SERVER_ES_CERT`
331+
332+
| (string) The path to the mutual TLS client certificate that {fleet-server} will use to connect to {es}.
333+
334+
*Default:* `""`
335+
336+
// end::fleet-server-es-cert[]
337+
338+
// =============================================================================
339+
340+
// tag::fleet-server-es-cert-key[]
341+
|
342+
[id="env-{type}-fleet-server-es-cert-key"]
343+
`FLEET_SERVER_ES_CERT_KEY`
344+
345+
| (string) The path to the mutual TLS private key that {fleet-server} will use to connect to {es}.
346+
347+
*Default:* `""`
348+
349+
// end::fleet-server-es-cert-key[]
350+
351+
// =============================================================================
352+
353+
// tag::fleet-server-insecure-http[]
354+
|
355+
[id="env-{type}-fleet-server-insecure-http"]
356+
`FLEET_SERVER_INSECURE_HTTP`
357+
358+
| (bool) When `true`, {fleet-server} is exposed over insecure or unverified HTTP.
359+
Setting this to `true` is not recommended.
360+
361+
*Default:* `false`
362+
363+
// end::fleet-server-insecure-http[]
364+
365+
// =============================================================================
366+
367+
// tag::fleet-daemon-timeout[]
368+
|
369+
[id="env-{type}-fleet-daemon-timeout"]
370+
`FLEET_DAEMON_TIMEOUT`
371+
372+
| (duration) Set to indicate how long {fleet-server} will wait during the bootstrap process for {elastic-agent}.
373+
374+
// end::fleet-daemon-timeout[]
375+
376+
// =============================================================================
377+
378+
// tag::fleet-server-timeout[]
379+
|
380+
[id="env-{type}-fleet-server-timeout"]
381+
`FLEET_SERVER_TIMEOUT`
382+
383+
| (duration) Set to indicate how long {agent} will wait for {fleet-server} to check in as healthy.
384+
385+
// end::fleet-server-timeout[]
386+
387+
// =============================================================================
388+
291389
// tag::fleet-enroll[]
292390
|
293391
[id="env-{type}-fleet-enroll"]

docs/en/ingest-management/elastic-agent/configuration/outputs/output-kafka.asciidoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,13 @@ outputs:
4646

4747
== Kafka output and using {ls} to index data to {es}
4848

49-
If you are considering using {ls} to ship the data from `kafka` to {es}, please
50-
be aware Elastic is not currently testing this kind of setup.
49+
If you are considering using {ls} to ship the data from `kafka` to {es}, please be aware the
50+
structure of the documents sent from {agent} to `kafka` must not be modified by {ls}.
51+
We suggest disabling `ecs_compatibility` on both the `kafka` input and the `json` codec in order
52+
to make sure the input doesn't edit the fields and their contents.
5153

52-
The structure of the documents sent from {agent} to `kafka` must not be modified by {ls}.
53-
We suggest disabling `ecs_compatibility` on both the `kafka` input and the `json` codec.
54+
The data streams set up by the integrations expect to receive events having the same structure and
55+
field names as they were sent directly from an {agent}.
5456

5557
Refer to <<logstash-output,{ls} output for {agent}>> documentation for more details.
5658

docs/en/ingest-management/elastic-agent/uninstall-elastic-agent.asciidoc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,18 @@
77
To uninstall {agent}, run the `uninstall` command from the directory where
88
{agent} is running.
99

10-
IMPORTANT: Be sure to run the `uninstall` command from the directory where {agent} is running, as shown in the example below, and not from the directory where you previously ran the `install` command. Running the command from the wrong directory can leave the agent in an inconsistent state.
10+
[IMPORTANT]
11+
====
12+
Be sure to run the `uninstall` command from a directory outside of where {agent} is installed.
13+
14+
For example, on a Windows system the install location is `C:\Program Files\Elastic\Agent`. Run the uninstall command from `C:\Program Files\Elastic` or `\tmp`, or even your default home directory:
15+
16+
[source,shell]
17+
----
18+
C:\"Program Files"\Elastic\Agent\elastic-agent.exe uninstall
19+
----
20+
21+
====
1122

1223
--
1324
include::{ingest-docs-root}/docs/en/ingest-management/tab-widgets/uninstall-widget.asciidoc[]

docs/en/ingest-management/fleet/fleet-settings-output-kafka.asciidoc

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@ Specify these settings to send data over a secure connection to Kafka. In the {f
88
== Kafka output and using {ls} to index data to {es}
99

1010
If you are considering using {ls} to ship the data from `kafka` to {es}, please
11-
be aware Elastic is not currently testing this kind of setup.
11+
be aware the structure of the documents sent from {agent} to `kafka` must not be modified by {ls}.
12+
We suggest disabling `ecs_compatibility` on both the `kafka` input and the `json` codec in order
13+
to make sure the input doesn't edit the fields and their contents.
14+
15+
The data streams setup by the integrations expect to receive events having the same structure and
16+
field names as they were sent directly from an {agent}.
1217

1318
The structure of the documents sent from {agent} to `kafka` must not be modified by {ls}.
1419
We suggest disabling `ecs_compatibility` on both the `kafka` input and the `json` codec.
@@ -214,7 +219,18 @@ Use this option to set the Kafka topic for each {agent} event.
214219
[id="kafka-output-topics-default"]
215220
**Default topic**
216221

217-
| Set a default topic to use for events sent by {agent} to the Kafka output, for example `elastic-agent`.
222+
| Set a default topic to use for events sent by {agent} to the Kafka output.
223+
224+
You can set a static topic, for example `elastic-agent`, or you can choose to set a topic dynamically based on an {ecs-ref}/ecs-reference.html[Elastic Common Scheme (ECS)] field. Available fields include:
225+
226+
* `data_stream_type`
227+
* `data_stream.dataset`
228+
* `data_stream.namespace`
229+
* `@timestamp`
230+
* `event-dataset`
231+
232+
You can also set a custom field. This is useful if you're using the <<add_fields-processor,`add_fields` processor>> as part of your {agent} input.
233+
Otherwise, setting a custom field is not recommended.
218234

219235
|===
220236

docs/en/ingest-management/fleet/fleet-settings.asciidoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,3 +132,16 @@ in the agent policy.
132132

133133
You can specify a proxy server to be used in {fleet-server}, {agent} outputs, or for any agent binary download sources.
134134
For full details about proxy configuration refer to <<fleet-agent-proxy-support,Using a proxy server with {agent} and {fleet}>>.
135+
136+
[discrete]
137+
[[delete-unenrolled-agents-setting]]
138+
== Delete unenrolled agents
139+
140+
After an {agent} has been unenrolled in {fleet}, a number of documents about the agent are retained just in case the agent needs to be recovered at some point. You can choose to have all data related to an unenrolled agent deleted automatically.
141+
142+
Note that this option can also be enabled by adding the `xpack.fleet.enableDeleteUnenrolledAgents: true` setting to the {kibana-ref}/[{kib} settings file].
143+
144+
To enable automatic deletion of unenrolled agents:
145+
146+
. Go to **{fleet} -> Settings**.
147+
. Under **Advanced Settings**, enable the **Delete unenrolled agents** option.

0 commit comments

Comments
 (0)