Skip to content

Commit 09358ff

Browse files
Add known issue for PGP key access problem (#470) (#472)
* Add known issue for PGP key access problem * Add link to repos docs (cherry picked from commit 42ff6b2) Co-authored-by: David Kilfoyle <[email protected]>
1 parent 22c20f7 commit 09358ff

File tree

2 files changed

+77
-0
lines changed

2 files changed

+77
-0
lines changed

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

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,76 @@ Review important information about the {fleet} and {agent} 8.9.0 release.
9191
{fleet-server}::
9292
* Use a verified base image for building Fleet Server binaries. {fleet-server-pull}2339[#2339]
9393

94+
95+
96+
97+
98+
99+
100+
[discrete]
101+
[[known-issues-8.9.0]]
102+
=== Known issues
103+
104+
[[known-issue-3375]]
105+
.PGP key download fails in an air-gapped environment
106+
[%collapsible]
107+
====
108+
109+
*Details*
110+
111+
Starting from version 8.9.0, when {agent} tries to perform an upgrade, it first verifies the binary signature with the key bundled in the agent.
112+
This process has a backup mechanism that will use the key coming from `https://artifacts.elastic.co/GPG-KEY-elastic-agent` instead of the one it already has.
113+
114+
In an air-gapped environment, the Agent won't be able to download the remote key and therefore cannot be upgraded.
115+
116+
*Impact* +
117+
118+
As a workaround, the agent needs to download the remote key from a server accessible from the air-gapped environment.
119+
As this URL is not customizable, we have to "trick" the system by pointing `https://artifacts.elastic.co/` to another host that will have the file.
120+
121+
The following examples require a server in your air-gapped environment that will expose the key you will have downloaded from `https://artifacts.elastic.co/GPG-KEY-elastic-agent``.
122+
123+
*Example 1: Manual*
124+
125+
Edit the {agent} server hosts file to add the following content:
126+
127+
[source,sh]
128+
----
129+
<YOUR_HOST_IP> artifacts.elastic.co
130+
----
131+
132+
The Linux hosts file path is `/etc/hosts`.
133+
134+
Windows hosts file path is `C:\Windows\System32\drivers\etc\hosts`.
135+
136+
*Example 2: Puppet*
137+
138+
[source,yaml]
139+
----
140+
host { 'elastic-artifacts':
141+
ensure => 'present'
142+
comment => 'Workaround for PGP check'
143+
ip => '<YOUR_HOST_IP>'
144+
}
145+
----
146+
147+
*Example 3: Ansible*
148+
149+
[source,yaml]
150+
----
151+
- name : 'elastic-artifacts'
152+
hosts : 'all'
153+
become: 'yes'
154+
155+
tasks:
156+
- name: 'Add entry to /etc/hosts'
157+
lineinfile:
158+
path: '/etc/hosts'
159+
line: '<YOUR_HOST_IP> artifacts.elastic.co'
160+
----
161+
162+
====
163+
94164
[discrete]
95165
[[breaking-changes-8.9.0]]
96166
=== Breaking changes

docs/en/ingest-management/troubleshooting/troubleshooting.asciidoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -648,3 +648,10 @@ curl -u elastic:<password> --request POST \
648648
--header 'Content-Type: application/json' \
649649
--header 'kbn-xsrf: xyz' \
650650
----
651+
652+
[discrete]
653+
[[php-key-download-fail]]
654+
== Air-gapped {agent} upgrade can fail due to an inaccessible PGP key
655+
656+
In versions 8.9 and above, an {agent} upgrade may fail when the upgrader can't access a PGP key required to verify the binary signature. For details and a workaround, refer to the <<known-issue-3375,PGP key download fails in an air-gapped environment>> known issue in the version 8.9.0 Release Notes or to the link:https://github.com/elastic/elastic-agent/blob/main/docs/pgp-workaround.md[workaround documentation] in the elastic-agent GitHub repository.
657+

0 commit comments

Comments
 (0)