Pass `--header` enrollment option to fleet-server #8071

blakerouse · 2025-05-02T19:16:46Z

What does this PR do?

Currently the --header enrollment flag is used when bootstrapping Fleet Server. Those headers should also be used when communicating with Fleet Server that is not being bootstrapped.

Why is it important?

When enrolling to a Fleet Server that is behind a proxy that requires specific headers for communication it is not possible to enroll the Elastic Agent into the Fleet Server.

Checklist

I have read and understood the pull request guidelines of this project.
My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
~~[ ] I have made corresponding change to the default configuration files~~
I have added tests that prove my fix is effective or that my feature works
I have added an entry in ./changelog/fragments using the changelog tool
~~[ ] I have added an integration test or an E2E test~~ (covered well in unit tests)

Disruptive User Impact

None

How to test this PR locally

Setup a Fleet Server behind a proxy that requires a specific header for traffic to flow. Then enroll the elastic-agent with the required header:

./elastic-agent enroll --url http://proxy-url --enrollment-token ${token} --header X-Custom-Header=TEST

Related issues

Closes --header is not used with communication to Fleet Server #6823

mergify · 2025-05-02T19:17:24Z

This pull request does not have a backport label. Could you fix it @blakerouse? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

backport-./d./d is the label that automatically backports to the 8./d branch. /d is the digit
backport-active-all is the label that automatically backports to all active branches.
backport-active-8 is the label that automatically backports to all active minor branches for the 8 major.
backport-active-9 is the label that automatically backports to all active minor branches for the 9 major.

elasticmachine · 2025-05-02T19:21:26Z

Pinging @elastic/elastic-agent-control-plane (Team:Elastic-Agent-Control-Plane)

elastic-sonarqube · 2025-05-02T20:40:57Z

Quality Gate failed

Failed conditions
37.5% Coverage on New Code (required ≥ 40%)

See analysis details on SonarQube

changelog/fragments/1746213492-Add-header-to-enrollment-communication-with-Fleet-Server.yaml

internal/pkg/remote/config.go

internal/pkg/agent/cmd/enroll_cmd_test.go

kaanyalti

Changes look good to me. Once the ci is green and Craig's comments are addressed I can approve

elastic-sonarqube · 2025-07-01T20:12:29Z

Quality Gate failed

Failed conditions
38.5% Coverage on New Code (required ≥ 40%)

See analysis details on SonarQube

elasticmachine · 2025-07-01T20:13:34Z

💚 Build Succeeded

Buildkite Build
Commit: 68f1146

History

💔 Build #23399 failed 9cd5211
💚 Build #20863 succeeded 09f458f

cc @blakerouse

blakerouse · 2025-07-02T13:57:40Z

@cmacknz @kaanyalti Can I get another review of the PR? I know its been sitting a while, I just wanted to bring it back to your attention.

* Work on adding HTTP header support to enroll. * Pass enroll headers to fleet. * Update --header command-line description. * Add changelog entry. * Fix typo. * Satisfy lint. * Add missing headers to container entry. * Update changelog. * Redact anything with auth in the key. * Add header test for checkin. * Fix imports. (cherry picked from commit 5e45823)

…ng-oblt-cli * upstream: (37 commits) [AutoOps] Add `autoops-es.yml` to Packages (elastic#8728) EDOT collector: include the forward connector. (elastic#8753) Revert "ci: pin elastic-agent version (elastic#8736)" (elastic#8754) bk: retry Start ESS stack for integration tests (elastic#8553) Re-enable TestStandaloneUpgradeRollbackOnRestarts on windows (elastic#8718) removed reviewers from dependabot.yml (elastic#8709) Pass `--header` enrollment option to fleet-server (elastic#8071) Add ability for local output configuration to add to policy configuration (elastic#8766) Bump up github.com/go-viper/mapstructure/v2 dependency (elastic#8764) [Synthetics] Upgrade node to latest lts v20 (elastic#8712) [CI] BK Vault plugin for EC access (elastic#8377) feat: singleTest mage target for each integration test package (elastic#8691) ci: always include 8.19 LTS release branch in snapshots of test versions (elastic#8761) build(deps): bump github.com/elastic/mito from 1.19.0 to 1.20.0 (elastic#8755) chore: fix elastic-agent helm chart examples (elastic#8765) feat: support onboarding-id for kubernetes (elastic#8692) [main][Automation] Bump VM Image version to 1751072471 (elastic#8734) ci: revert deployment_csp_configuration.yaml to create_deployment_csp_configuration.yaml (elastic#8746) kustomize: pin kube-state-metrics version (elastic#8739) ci: pin elastic-agent version (elastic#8736) ...

* upstream: (39 commits) Fix otel extension status reporting (#8696) Refactor user change on service (#8347) [AutoOps] Add `autoops-es.yml` to Packages (#8728) EDOT collector: include the forward connector. (#8753) Revert "ci: pin elastic-agent version (#8736)" (#8754) bk: retry Start ESS stack for integration tests (#8553) Re-enable TestStandaloneUpgradeRollbackOnRestarts on windows (#8718) removed reviewers from dependabot.yml (#8709) Pass `--header` enrollment option to fleet-server (#8071) Add ability for local output configuration to add to policy configuration (#8766) Bump up github.com/go-viper/mapstructure/v2 dependency (#8764) [Synthetics] Upgrade node to latest lts v20 (#8712) [CI] BK Vault plugin for EC access (#8377) feat: singleTest mage target for each integration test package (#8691) ci: always include 8.19 LTS release branch in snapshots of test versions (#8761) build(deps): bump github.com/elastic/mito from 1.19.0 to 1.20.0 (#8755) chore: fix elastic-agent helm chart examples (#8765) feat: support onboarding-id for kubernetes (#8692) [main][Automation] Bump VM Image version to 1751072471 (#8734) ci: revert deployment_csp_configuration.yaml to create_deployment_csp_configuration.yaml (#8746) ...

blakerouse added 3 commits May 2, 2025 13:26

Work on adding HTTP header support to enroll.

20d706d

Pass enroll headers to fleet.

a605062

Update --header command-line description.

735671e

mergify bot assigned blakerouse May 2, 2025

Add changelog entry.

8d5d663

blakerouse marked this pull request as ready for review May 2, 2025 19:20

blakerouse requested a review from a team as a code owner May 2, 2025 19:20

blakerouse requested review from kaanyalti and andrzej-stencel May 2, 2025 19:20

Merge branch 'main' into enroll-http-headers

7a181cd

blakerouse added Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team backport-9.0 Automated backport to the 9.0 branch backport-8.19 Automated backport to the 8.19 branch labels May 2, 2025

blakerouse removed the backport-9.0 Automated backport to the 9.0 branch label May 2, 2025

blakerouse added 2 commits May 2, 2025 15:22

Fix typo.

36e7d3e

Satisfy lint.

09f458f

cmacknz reviewed May 5, 2025

View reviewed changes

changelog/fragments/1746213492-Add-header-to-enrollment-communication-with-Fleet-Server.yaml Outdated Show resolved Hide resolved

internal/pkg/remote/config.go Show resolved Hide resolved

internal/pkg/agent/cmd/enroll_cmd_test.go Show resolved Hide resolved

kaanyalti reviewed May 6, 2025

View reviewed changes

blakerouse marked this pull request as draft May 8, 2025 15:04

blakerouse added 4 commits June 30, 2025 10:32

Merge branch 'main' into enroll-http-headers

8394465

Add missing headers to container entry.

35cea5c

Merge remote-tracking branch 'upstream/main' into enroll-http-headers

1b696a5

Update changelog.

c4bde5e

blakerouse added the backport-9.1 Automated backport to the 9.1 branch label Jul 1, 2025

blakerouse added 2 commits July 1, 2025 10:28

Redact anything with auth in the key.

9ed9cae

Add header test for checkin.

9cd5211

blakerouse marked this pull request as ready for review July 1, 2025 14:46

Fix imports.

68f1146

cmacknz approved these changes Jul 2, 2025

View reviewed changes

blakerouse merged commit 5e45823 into elastic:main Jul 2, 2025
18 of 19 checks passed

mergify bot mentioned this pull request Jul 2, 2025

[8.19] (backport #8071) Pass --header enrollment option to fleet-server #8808

Merged

6 tasks

mergify bot mentioned this pull request Jul 2, 2025

[9.1] (backport #8071) Pass --header enrollment option to fleet-server #8809

Merged

6 tasks

blakerouse pushed a commit that referenced this pull request Jul 2, 2025

Pass --header enrollment option to fleet-server (#8071) (#8809)

45f36e8

blakerouse pushed a commit that referenced this pull request Jul 2, 2025

Pass --header enrollment option to fleet-server (#8071) (#8808)

92643a4

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Pass `--header` enrollment option to fleet-server #8071

Pass `--header` enrollment option to fleet-server #8071

Uh oh!

blakerouse commented May 2, 2025 •

edited

Loading

Uh oh!

mergify bot commented May 2, 2025

Uh oh!

elasticmachine commented May 2, 2025

Uh oh!

elastic-sonarqube bot commented May 2, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kaanyalti left a comment

Uh oh!

elastic-sonarqube bot commented Jul 1, 2025

Uh oh!

elasticmachine commented Jul 1, 2025

Uh oh!

blakerouse commented Jul 2, 2025

Uh oh!

Uh oh!

Uh oh!

Pass --header enrollment option to fleet-server #8071

Pass --header enrollment option to fleet-server #8071

Uh oh!

Conversation

blakerouse commented May 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Why is it important?

Checklist

Disruptive User Impact

How to test this PR locally

Related issues

Uh oh!

mergify bot commented May 2, 2025

Uh oh!

elasticmachine commented May 2, 2025

Uh oh!

elastic-sonarqube bot commented May 2, 2025

Quality Gate failed

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kaanyalti left a comment

Choose a reason for hiding this comment

Uh oh!

elastic-sonarqube bot commented Jul 1, 2025

Quality Gate failed

Uh oh!

elasticmachine commented Jul 1, 2025

💚 Build Succeeded

History

Uh oh!

blakerouse commented Jul 2, 2025

Uh oh!

Uh oh!

Uh oh!

Pass `--header` enrollment option to fleet-server #8071

Pass `--header` enrollment option to fleet-server #8071

blakerouse commented May 2, 2025 •

edited

Loading