-
Notifications
You must be signed in to change notification settings - Fork 581
HDDS-14077. [Docs] Multiple S3 gateway using proxy #9431
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
base: master
Are you sure you want to change the base?
Conversation
This commit adds a new user documentation page for using multiple S3 gateways with a proxy for load balancing. The document explains the architecture, benefits, and provides an HAProxy configuration example and references to Docker Compose examples in the source tree. The page is located under Architecture -> Ozone S3 Gateway in the navigation. Change-Id: Ie88862cad69a3b1a20d1747ed32fdbab3a769b0a
Change-Id: If8febb034cb3cd57421410c9b999d563de70d3f4
There was a problem hiding this 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 adds new user documentation for setting up multiple S3 gateways with a load balancer (HAProxy) in Ozone. The documentation explains the stateless nature of S3 gateways that enables horizontal scaling and provides references to Docker Compose examples in the source tree.
Key Changes:
- Adds a new documentation page explaining S3 Gateway load balancing concepts
- Documents the stateless architecture that enables multiple S3 Gateway instances
- References Docker Compose examples with HAProxy configuration for practical implementation
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| This document describes how to set up multiple S3 gateways with a proxy for load balancing. | ||
| menu: | ||
| main: | ||
| parent: "Ozone S3 Gateway" |
Copilot
AI
Dec 4, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The menu parent should be "Architecture" instead of "Ozone S3 Gateway". All other concept documentation files (Overview.md, OzoneS3Gateway.md, Recon.md, Datanodes.md) use "Architecture" as the parent in the menu structure. This ensures consistent navigation hierarchy in the documentation site.
Suggested change:
menu:
main:
parent: "Architecture"| parent: "Ozone S3 Gateway" | |
| parent: "Architecture" |
| linkTitle: "S3 Gateway Load Balancing" | ||
| date: 2023-11-29 | ||
| weight: 1 | ||
| description: > |
Copilot
AI
Dec 4, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The frontmatter uses "description:" field, but other documentation files in the concept directory consistently use "summary:" instead. For consistency with the existing documentation structure (see Overview.md, OzoneS3Gateway.md, Recon.md), this should be changed to "summary:".
Suggested change:
summary: >
This document describes how to set up multiple S3 gateways with a proxy for load balancing.| description: > | |
| summary: > |
What changes were proposed in this pull request?
Provide a one-liner summary of the changes in the PR Title field above.
HDDS-14077. [Docs] Multiple S3 gateway using proxy
Please describe your PR in detail:
The page is located under Architecture -> Ozone S3 Gateway in the navigation.
What is the link to the Apache JIRA
https://issues.apache.org/jira/browse/HDDS-14077
How was this patch tested?
User doc only no code.