Skip to content

(fleet) simplify proxy configuration #29024

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

(fleet) simplify proxy configuration #29024

wants to merge 11 commits into from

Conversation

arbll
Copy link
Member

@arbll arbll commented Apr 29, 2025

This PR simplifies our proxy documentation:

  • It splits out squid/haproxy/nginx examples to their own private pages
  • Rewrite of the main proxy documentation, with much less fluff and trivia, focusing on the golden path
  • Link out to examples, discouraging the use of nginx / haproxy

@arbll arbll requested a review from a team as a code owner April 29, 2025 08:54
@aliciascott
Copy link
Contributor

Created editorial card for our Agent SME to review further

@aliciascott aliciascott added the editorial review Waiting on a more in-depth review label Apr 29, 2025
Copy link
Contributor

@sgnn7 sgnn7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@arbll Few small comments but a great improvement!

@Yqnn Yqnn requested a review from Copilot April 30, 2025 09:52
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR simplifies our proxy documentation by splitting out proxy examples for Squid, HAProxy, and NGINX into their own dedicated pages and streamlining the main proxy documentation to focus on the golden path.

  • Introduces a new Squid proxy example with configuration instructions.
  • Adds a detailed NGINX proxy example with both HTTP and HTTPS configurations.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
content/en/agent/configuration/proxy_example_squid.md New Squid proxy example documentation with configuration details.
content/en/agent/configuration/proxy_example_nginx.md New NGINX proxy example documentation outlining both HTTP and HTTPS configurations and related Agent setup instructions.

@hestonhoffman hestonhoffman self-assigned this May 2, 2025
@hestonhoffman
Copy link
Contributor

Just a heads up, I'm going to push some updates to this one instead of doing a straightforward review

@hestonhoffman hestonhoffman requested a review from a team as a code owner May 2, 2025 20:27
Copy link
Contributor

@hestonhoffman hestonhoffman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, this is so much better than old page! Thanks for taking the time to update this stuff for us. I pushed up some edits and I'm going to go ahead and approve.

Change summary:

  • Moved the haproxy and nginx pages to the faq section of the docs. The faq section can only be reached if you know the URL. Stuff in there is unindexed by default. This is handy for pages we don't want users to stumble upon, but we like to keep it organized so that support can find these pages if they need them.
  • I didn't move the squid file and I've switched that one to indexed. If we're recommending it as an option for users who don't have a dedicated proxy server, it needs to be findable. But I've added some language to the top of the page directing them back to the main doc if they do have a proxy server. I also added this file to the sidenav, nested under the proxy doc
  • Lots of style / signposting edits

@github-actions github-actions bot added Architecture Everything related to the Doc backend FAQ Content impacting a FAQ labels May 2, 2025
@hestonhoffman hestonhoffman requested a review from sgnn7 May 2, 2025 20:47
Copy link
Contributor

@brooklynebkbk brooklynebkbk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

preview links appear as expected!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review FAQ Content impacting a FAQ
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants