Skip to content

Commit 5fd89dd

Browse files
michel-latermanmergify[bot]
authored andcommitted
Add known issue for orphaned status blocking upgrades (#1566)
* Add known issue for orphaned status blocking upgrades * Update docs/en/ingest-management/release-notes/release-notes-8.16.asciidoc * Update docs/en/ingest-management/release-notes/release-notes-8.16.asciidoc * Update docs/en/ingest-management/release-notes/release-notes-8.16.asciidoc * Update docs/en/ingest-management/release-notes/release-notes-8.17.asciidoc --------- Co-authored-by: David Kilfoyle <[email protected]> (cherry picked from commit 241d839) # Conflicts: # docs/en/ingest-management/release-notes/release-notes-8.17.asciidoc
1 parent 89f03b4 commit 5fd89dd

File tree

2 files changed

+326
-2
lines changed

2 files changed

+326
-2
lines changed

docs/en/ingest-management/release-notes/release-notes-8.16.asciidoc

Lines changed: 82 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,34 @@ Also see:
3030

3131
Review important information about the {fleet} and {agent} 8.16.2 release.
3232

33+
[discrete]
34+
[[known-issues-8.16.2]]
35+
=== Known Issues
36+
37+
[discrete]
38+
[[known-issue-6213-8-16-2]]
39+
.An {agent} with the Defend integration may report an Orphaned status and will not be able to be issued an upgrade action through {fleet}.
40+
[%collapsible]
41+
====
42+
*Details* +
43+
A known issue in the {agent} may prevent it from being targetted with an upgrade action for a future release.
44+
This may occur if the Defend integration is used and the agent is stopped on a running instance for too long.
45+
An agent may be stopped as part of an upgrade process.
46+
47+
*Impact* +
48+
A bug fix is present in the 8.16.3 and 8.17.1 releases of {fleet} that will prevent this from occuring.
49+
50+
If you have agents that are affected, the workaround is as follows:
51+
[source,shell]
52+
----
53+
# Get a Token to issue an update_by_query request:
54+
curl -XPOST --user elastic:${SUPERUSER_PASS} -H 'x-elastic-product-origin:fleet' -H'content-type:application/json' "https://${ELASTICSEARCH_HOST}/_security/service/elastic/fleet-server/credential/token/fix-unenrolled"
55+
56+
# Issue an update_by_query request that targets effected agents:
57+
curl -XPOST -H 'Authorization: Bearer ${TOKEN}' -H 'x-elastic-product-origin:fleet' -H 'content-type:application/json' "https://${ELASTICSEARCH_HOST}/.fleet-agents/_update_by_query" -d '{"query": {"bool": {"must": [{ "exists": { "field": "unenrolled_at" } }],"must_not": [{ "term": { "active": "false" } }]}},"script": {"source": "ctx._source.unenrolled_at = null;","lang": "painless"}}'
58+
----
59+
====
60+
3361
[discrete]
3462
[[enhancements-8.16.2]]
3563
=== Enhancements
@@ -51,6 +79,34 @@ In this release we've introduced an image based on the hardened link:https://git
5179

5280
Review important information about the {fleet} and {agent} 8.16.1 release.
5381

82+
[discrete]
83+
[[known-issues-8.16.1]]
84+
=== Known Issues
85+
86+
[discrete]
87+
[[known-issue-6213-8-16-1]]
88+
.An {agent} with the Defend integration may report an Orphaned status and will not be able to be issued an upgrade action through {fleet}.
89+
[%collapsible]
90+
====
91+
*Details* +
92+
A known issue in the {agent} may prevent it from being targetted with an upgrade action for a future release.
93+
This may occur if the Defend integration is used and the agent is stopped on a running instance for too long.
94+
An agent may be stopped as part of an upgrade process.
95+
96+
*Impact* +
97+
A bug fix is present in the 8.16.3 and 8.17.1 releases of the {fleet} that will prevent this from occuring.
98+
99+
If you have agents that are affected, the workaround is as follows:
100+
[source,shell]
101+
----
102+
# Get a Token to issue an update_by_query request:
103+
curl -XPOST --user elastic:${SUPERUSER_PASS} -H 'x-elastic-product-origin:fleet' -H'content-type:application/json' "https://${ELASTICSEARCH_HOST}/_security/service/elastic/fleet-server/credential/token/fix-unenrolled"
104+
105+
# Issue an update_by_query request that targets effected agents:
106+
curl -XPOST -H 'Authorization: Bearer ${TOKEN}' -H 'x-elastic-product-origin:fleet' -H 'content-type:application/json' "https://${ELASTICSEARCH_HOST}/.fleet-agents/_update_by_query" -d '{"query": {"bool": {"must": [{ "exists": { "field": "unenrolled_at" } }],"must_not": [{ "term": { "active": "false" } }]}},"script": {"source": "ctx._source.unenrolled_at = null;","lang": "painless"}}'
107+
----
108+
====
109+
54110
[discrete]
55111
[[bug-fixes-8.16.1]]
56112
=== Bug fixes
@@ -104,7 +160,7 @@ This error can happen if the {agents} being searched and listed in the UI are us
104160
105161
*Impact* +
106162
107-
As a workaround for the issue, you can upgrade your {stack} to verion 8.16.1. The issue has been resolved by {kib} link:https://github.com/elastic/kibana/pull/199325[#199325].
163+
As a workaround for the issue, you can upgrade your {stack} to verion 8.16.1. The issue has been resolved by {kib} link:https://github.com/elastic/kibana/pull/199325[#199325].
108164
109165
====
110166

@@ -154,6 +210,30 @@ As a workaround, we recommend trying again to uninstall the agent.
154210
155211
====
156212

213+
[discrete]
214+
[[known-issue-6213-8-16-0]]
215+
.An {agent} with the Defend integration may report an Orphaned status and will not be able to be issued an upgrade action through {fleet}.
216+
[%collapsible]
217+
====
218+
*Details* +
219+
A known issue in the {agent} may prevent it from being targetted with an upgrade action for a future release.
220+
This may occur if the Defend integration is used and the agent is stopped on a running instance for too long.
221+
An agent may be stopped as part of an upgrade process.
222+
223+
*Impact* +
224+
A bug fix is present in the 8.16.3 and 8.17.1 releases of {fleet} that will prevent this from occuring.
225+
226+
If you have agents that are affected, the workaround is as follows:
227+
[source,shell]
228+
----
229+
# Get a Token to issue an update_by_query request:
230+
curl -XPOST --user elastic:${SUPERUSER_PASS} -H 'x-elastic-product-origin:fleet' -H'content-type:application/json' "https://${ELASTICSEARCH_HOST}/_security/service/elastic/fleet-server/credential/token/fix-unenrolled"
231+
232+
# Issue an update_by_query request that targets effected agents:
233+
curl -XPOST -H 'Authorization: Bearer ${TOKEN}' -H 'x-elastic-product-origin:fleet' -H 'content-type:application/json' "https://${ELASTICSEARCH_HOST}/.fleet-agents/_update_by_query" -d '{"query": {"bool": {"must": [{ "exists": { "field": "unenrolled_at" } }],"must_not": [{ "term": { "active": "false" } }]}},"script": {"source": "ctx._source.unenrolled_at = null;","lang": "painless"}}'
234+
----
235+
====
236+
157237
[discrete]
158238
[[new-features-8.16.0]]
159239
=== New features
@@ -172,7 +252,7 @@ The 8.16.0 release Added the following new and notable features.
172252

173253
{fleet-server}::
174254
* Add `/api/fleet/agents/:id/audit/unenroll` API that an {agent} or Endpoint process may use to report that an agent was uninstalled or unenrolled to {fleet}. {fleet-server-pull}3818[#3818] {agent-issue}484[#484]
175-
* Add a `secret_paths` attribute to the policy data sent to agents. This attribute is a list of keys that {fleet-server} has replaced with a reference to a secret value. {fleet-server-pull}3908[#3908] {fleet-server-issue}3657[#3657]
255+
* Add a `secret_paths` attribute to the policy data sent to agents. This attribute is a list of keys that {fleet-server} has replaced with a reference to a secret value. {fleet-server-pull}3908[#3908] {fleet-server-issue}3657[#3657]
176256

177257
{agent}::
178258
* Uninstalling a {fleet}-managed {agent} instance will now do a best-effort attempt to notify {fleet-server} of the agent removal so the agent status appears correctly in the {fleet} UI (related to {fleet-server-pull}3818[#3818] above). {agent-pull}5302[#5302] {agent-issue}484[#484]
Lines changed: 244 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,244 @@
1+
// Use these for links to issue and pulls.
2+
:kibana-issue: https://github.com/elastic/kibana/issues/
3+
:kibana-pull: https://github.com/elastic/kibana/pull/
4+
:beats-issue: https://github.com/elastic/beats/issues/
5+
:beats-pull: https://github.com/elastic/beats/pull/
6+
:agent-libs-pull: https://github.com/elastic/elastic-agent-libs/pull/
7+
:agent-issue: https://github.com/elastic/elastic-agent/issues/
8+
:agent-pull: https://github.com/elastic/elastic-agent/pull/
9+
:fleet-server-issue: https://github.com/elastic/fleet-server/issues/
10+
:fleet-server-pull: https://github.com/elastic/fleet-server/pull/
11+
12+
[[release-notes]]
13+
= Release notes
14+
15+
This section summarizes the changes in each release.
16+
17+
* <<release-notes-8.17.0>>
18+
19+
Also see:
20+
21+
* {kibana-ref}/release-notes.html[{kib} release notes]
22+
* {beats-ref}/release-notes.html[{beats} release notes]
23+
24+
// begin 8.17.0 relnotes
25+
26+
[[release-notes-8.17.0]]
27+
== {fleet} and {agent} 8.17.0
28+
29+
Review important information about the {fleet} and {agent} 8.17.0 release.
30+
31+
[discrete]
32+
[[breaking-changes-8.17.0]]
33+
=== Breaking changes
34+
35+
Breaking changes can prevent your application from optimal operation and
36+
performance. Before you upgrade, review the breaking changes, then mitigate the
37+
impact to your application.
38+
39+
{agent}::
40+
* {agent} is now compiled using Debian 11 and linked against glibc 2.31 instead of 2.19. Drops support for Debian 10. {agent-pull}5847[#5847]
41+
42+
[discrete]
43+
[[known-issues-8.17.0]]
44+
=== Known Issues
45+
46+
[discrete]
47+
[[known-issue-6213-8-17-0]]
48+
.An {agent} with the Defend integration may report an Orphaned status and will not be able to be issued an upgrade action through {fleet}.
49+
[%collapsible]
50+
====
51+
*Details* +
52+
A known issue in the {agent} may prevent it from being targetted with an upgrade action for a future release.
53+
This may occur if the Defend integration is used and the agent is stopped on a running instance for too long.
54+
An agent may be stopped as part of an upgrade process.
55+
56+
*Impact* +
57+
A bug fix is present in the 8.17.1 release of {fleet} that will prevent this from occuring.
58+
59+
If you have agents that are affected, the workaround is as follows:
60+
[source,shell]
61+
----
62+
# Get a Token to issue an update_by_query request:
63+
curl -XPOST --user elastic:${SUPERUSER_PASS} -H 'x-elastic-product-origin:fleet' -H'content-type:application/json' "https://${ELASTICSEARCH_HOST}/_security/service/elastic/fleet-server/credential/token/fix-unenrolled"
64+
65+
# Issue an update_by_query request that targets effected agents:
66+
curl -XPOST -H 'Authorization: Bearer ${TOKEN}' -H 'x-elastic-product-origin:fleet' -H 'content-type:application/json' "https://${ELASTICSEARCH_HOST}/.fleet-agents/_update_by_query" -d '{"query": {"bool": {"must": [{ "exists": { "field": "unenrolled_at" } }],"must_not": [{ "term": { "active": "false" } }]}},"script": {"source": "ctx._source.unenrolled_at = null;","lang": "painless"}}'
67+
----
68+
====
69+
70+
[discrete]
71+
[[new-features-8.17.0]]
72+
=== New features
73+
74+
The 8.17.0 release Added the following new and notable features.
75+
76+
{fleet}::
77+
* Expose advanced file logging configuration in the UI. {kibana-pull}200274[#200274]
78+
79+
{agent}::
80+
* Add support for running as a pre-existing user when installing in unprivileged mode, with technical preview support for pre-existing Windows Active Directory users. {agent-pull}5988[#5988] {agent-issue}4585[#4585]
81+
* Add a new custom link:https://github.com/elastic/integrations/tree/main/packages/filestream[Filestream logs integration]. This will enable migration from the custom log integration which is based on a log input that is planned for deprecation. https://github.com/elastic/integrations/pull/11332[#11332].
82+
83+
[discrete]
84+
[[enhancements-8.17.0]]
85+
=== Enhancements
86+
87+
{fleet}::
88+
* Filter the integrations/packages list shown in the UI depending on the `policy_templates_behavior` field. {kibana-pull}200605[#200605]
89+
* Add a `<type>@custom` component template to integrations index template's `composed_of` array. {kibana-pull}192731[#192731]
90+
91+
{fleet-server}::
92+
* Update `elastic-agent-libs` to version `0.14.0`. {fleet-server-pull}4042[#4042]
93+
94+
{agent}::
95+
* Enable persistence in the configuration provided with our OTel Collector distribution. {agent-pull}5549[#5549]
96+
* Restrict using the CLI to upgrade for {fleet}-managed {agents}. {agent-pull}5864[#5864] {agent-issue}4890[#4890]
97+
* Add `os_family`, `os_platform` and `os_version` to the {agent} host provider, enabling differentiating Linux distributions. This is required to support Debian 12 and other distributions that are moving away from traditional log files in favour of Journald. {agent-pull}5941[#5941] https://github.com/elastic/integrations/issues/10797[10797] https://github.com/elastic/integrations/pull/11618[11618]
98+
* Emit Pod data only for Pods that are running in the Kubernetes provider. {agent-pull}6011[#6011] {agent-issue}5835[#5835] {agent-issue}5991[#5991]
99+
* Remove {endpoint-sec} from Linux container images. {endpoint-sec} cannot run in containers since it has a systemd dependency. {agent-pull}6016[#6016] {agent-issue}5495[#5495]
100+
* Update OTel components to v0.114.0. {agent-pull}6113[#6113]
101+
* Redact common secrets like API keys and passwords in the output from `elastic-agent inspect` command. {agent-pull}6224[#6224]
102+
103+
[discrete]
104+
[[bug-fixes-8.17.0]]
105+
=== Bug fixes
106+
107+
{fleet}::
108+
* Allow creation of an integration policy with no agent policies. {kibana-pull}201051[#201051]
109+
110+
{fleet-server}::
111+
* Fix `server.address` field which was appearing empty in HTTP request logs. {fleet-server-pull}4142[#4142]
112+
* Remove a race condition that may occur when remote ES outputs are used. {fleet-server-pull}4171[#4171] {fleet-server-pull}4170[#4170]
113+
114+
{agent}::
115+
* Make redaction of common keys in diagnostics case insensitive. {agent-pull}6109[#6109]
116+
117+
118+
// end 8.17.0 relnotes
119+
120+
// ---------------------
121+
//TEMPLATE
122+
//Use the following text as a template. Remember to replace the version info.
123+
124+
// begin 8.7.x relnotes
125+
126+
//[[release-notes-8.7.x]]
127+
//== {fleet} and {agent} 8.7.x
128+
129+
//Review important information about the {fleet} and {agent} 8.7.x release.
130+
131+
//[discrete]
132+
//[[security-updates-8.7.x]]
133+
//=== Security updates
134+
135+
//{fleet}::
136+
//* add info
137+
138+
//{agent}::
139+
//* add info
140+
141+
//[discrete]
142+
//[[breaking-changes-8.7.x]]
143+
//=== Breaking changes
144+
145+
//Breaking changes can prevent your application from optimal operation and
146+
//performance. Before you upgrade, review the breaking changes, then mitigate the
147+
//impact to your application.
148+
149+
//[discrete]
150+
//[[breaking-PR#]]
151+
//.Short description
152+
//[%collapsible]
153+
//====
154+
//*Details* +
155+
//<Describe new behavior.> For more information, refer to {kibana-pull}PR[#PR].
156+
157+
//*Impact* +
158+
//<Describe how users should mitigate the change.> For more information, refer to {fleet-guide}/fleet-server.html[Fleet Server].
159+
//====
160+
161+
//[discrete]
162+
//[[notable-changes-8.13.0]]
163+
//=== Notable changes
164+
165+
//The following are notable, non-breaking updates to be aware of:
166+
167+
//* Changes to features that are in Technical Preview.
168+
//* Changes to log formats.
169+
//* Changes to non-public APIs.
170+
//* Behaviour changes that repair critical bugs.
171+
172+
//{fleet}::
173+
//* add info
174+
175+
//{agent}::
176+
//* add info
177+
178+
//[discrete]
179+
//[[known-issues-8.7.x]]
180+
//=== Known issues
181+
182+
//[[known-issue-issue#]]
183+
//.Short description
184+
//[%collapsible]
185+
//====
186+
187+
//*Details*
188+
189+
//<Describe known issue.>
190+
191+
//*Impact* +
192+
193+
//<Describe impact or workaround.>
194+
195+
//====
196+
197+
//[discrete]
198+
//[[deprecations-8.7.x]]
199+
//=== Deprecations
200+
201+
//The following functionality is deprecated in 8.7.x, and will be removed in
202+
//8.7.x. Deprecated functionality does not have an immediate impact on your
203+
//application, but we strongly recommend you make the necessary updates after you
204+
//upgrade to 8.7.x.
205+
206+
//{fleet}::
207+
//* add info
208+
209+
//{agent}::
210+
//* add info
211+
212+
//[discrete]
213+
//[[new-features-8.7.x]]
214+
//=== New features
215+
216+
//The 8.7.x release Added the following new and notable features.
217+
218+
//{fleet}::
219+
//* add info
220+
221+
//{agent}::
222+
//* add info
223+
224+
//[discrete]
225+
//[[enhancements-8.7.x]]
226+
//=== Enhancements
227+
228+
//{fleet}::
229+
//* add info
230+
231+
//{agent}::
232+
//* add info
233+
234+
//[discrete]
235+
//[[bug-fixes-8.7.x]]
236+
//=== Bug fixes
237+
238+
//{fleet}::
239+
//* add info
240+
241+
//{agent}::
242+
//* add info
243+
244+
// end 8.7.x relnotes

0 commit comments

Comments
 (0)