From df9a4210732531594869ef6fc80f33aa55772df2 Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Tue, 17 Dec 2024 09:15:14 -0500 Subject: [PATCH] Add known issue for orphaned status blocking upgrades (#1566) (#1567) * 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 <41695641+kilfoyle@users.noreply.github.com> (cherry picked from commit 241d83966117058fcc4de45669ad364b1754a318) Co-authored-by: Michel Laterman <82832767+michel-laterman@users.noreply.github.com> --- .../release-notes/release-notes-8.16.asciidoc | 84 ++++++++++++++++++- .../release-notes/release-notes-8.17.asciidoc | 32 ++++++- 2 files changed, 112 insertions(+), 4 deletions(-) diff --git a/docs/en/ingest-management/release-notes/release-notes-8.16.asciidoc b/docs/en/ingest-management/release-notes/release-notes-8.16.asciidoc index 56347d91c..a05983ffd 100644 --- a/docs/en/ingest-management/release-notes/release-notes-8.16.asciidoc +++ b/docs/en/ingest-management/release-notes/release-notes-8.16.asciidoc @@ -30,6 +30,34 @@ Also see: Review important information about the {fleet} and {agent} 8.16.2 release. +[discrete] +[[known-issues-8.16.2]] +=== Known Issues + +[discrete] +[[known-issue-6213-8-16-2]] +.An {agent} with the Defend integration may report an Orphaned status and will not be able to be issued an upgrade action through {fleet}. +[%collapsible] +==== +*Details* + +A known issue in the {agent} may prevent it from being targetted with an upgrade action for a future release. +This may occur if the Defend integration is used and the agent is stopped on a running instance for too long. +An agent may be stopped as part of an upgrade process. + +*Impact* + +A bug fix is present in the 8.16.3 and 8.17.1 releases of {fleet} that will prevent this from occuring. + +If you have agents that are affected, the workaround is as follows: +[source,shell] +---- +# Get a Token to issue an update_by_query request: +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" + +# Issue an update_by_query request that targets effected agents: +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"}}' +---- +==== + [discrete] [[enhancements-8.16.2]] === Enhancements @@ -51,6 +79,34 @@ In this release we've introduced an image based on the hardened link:https://git Review important information about the {fleet} and {agent} 8.16.1 release. +[discrete] +[[known-issues-8.16.1]] +=== Known Issues + +[discrete] +[[known-issue-6213-8-16-1]] +.An {agent} with the Defend integration may report an Orphaned status and will not be able to be issued an upgrade action through {fleet}. +[%collapsible] +==== +*Details* + +A known issue in the {agent} may prevent it from being targetted with an upgrade action for a future release. +This may occur if the Defend integration is used and the agent is stopped on a running instance for too long. +An agent may be stopped as part of an upgrade process. + +*Impact* + +A bug fix is present in the 8.16.3 and 8.17.1 releases of the {fleet} that will prevent this from occuring. + +If you have agents that are affected, the workaround is as follows: +[source,shell] +---- +# Get a Token to issue an update_by_query request: +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" + +# Issue an update_by_query request that targets effected agents: +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"}}' +---- +==== + [discrete] [[bug-fixes-8.16.1]] === Bug fixes @@ -104,7 +160,7 @@ This error can happen if the {agents} being searched and listed in the UI are us *Impact* + -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]. +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]. ==== @@ -154,6 +210,30 @@ As a workaround, we recommend trying again to uninstall the agent. ==== +[discrete] +[[known-issue-6213-8-16-0]] +.An {agent} with the Defend integration may report an Orphaned status and will not be able to be issued an upgrade action through {fleet}. +[%collapsible] +==== +*Details* + +A known issue in the {agent} may prevent it from being targetted with an upgrade action for a future release. +This may occur if the Defend integration is used and the agent is stopped on a running instance for too long. +An agent may be stopped as part of an upgrade process. + +*Impact* + +A bug fix is present in the 8.16.3 and 8.17.1 releases of {fleet} that will prevent this from occuring. + +If you have agents that are affected, the workaround is as follows: +[source,shell] +---- +# Get a Token to issue an update_by_query request: +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" + +# Issue an update_by_query request that targets effected agents: +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"}}' +---- +==== + [discrete] [[new-features-8.16.0]] === New features @@ -172,7 +252,7 @@ The 8.16.0 release Added the following new and notable features. {fleet-server}:: * 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] -* 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] +* 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] {agent}:: * 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] diff --git a/docs/en/ingest-management/release-notes/release-notes-8.17.asciidoc b/docs/en/ingest-management/release-notes/release-notes-8.17.asciidoc index 395dbfeca..25d967d63 100644 --- a/docs/en/ingest-management/release-notes/release-notes-8.17.asciidoc +++ b/docs/en/ingest-management/release-notes/release-notes-8.17.asciidoc @@ -39,6 +39,34 @@ impact to your application. {agent}:: * {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] +[discrete] +[[known-issues-8.17.0]] +=== Known Issues + +[discrete] +[[known-issue-6213-8-17-0]] +.An {agent} with the Defend integration may report an Orphaned status and will not be able to be issued an upgrade action through {fleet}. +[%collapsible] +==== +*Details* + +A known issue in the {agent} may prevent it from being targetted with an upgrade action for a future release. +This may occur if the Defend integration is used and the agent is stopped on a running instance for too long. +An agent may be stopped as part of an upgrade process. + +*Impact* + +A bug fix is present in the 8.17.1 release of {fleet} that will prevent this from occuring. + +If you have agents that are affected, the workaround is as follows: +[source,shell] +---- +# Get a Token to issue an update_by_query request: +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" + +# Issue an update_by_query request that targets effected agents: +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"}}' +---- +==== + [discrete] [[new-features-8.17.0]] === New features @@ -50,7 +78,7 @@ The 8.17.0 release Added the following new and notable features. {agent}:: * 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] -* 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]. +* 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]. [discrete] [[enhancements-8.17.0]] @@ -67,7 +95,7 @@ The 8.17.0 release Added the following new and notable features. * Enable persistence in the configuration provided with our OTel Collector distribution. {agent-pull}5549[#5549] * Restrict using the CLI to upgrade for {fleet}-managed {agents}. {agent-pull}5864[#5864] {agent-issue}4890[#4890] * 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] -* 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] +* 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] * 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] * Update OTel components to v0.114.0. {agent-pull}6113[#6113] * Redact common secrets like API keys and passwords in the output from `elastic-agent inspect` command. {agent-pull}6224[#6224]