Skip to content
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

Update Documentation to Reflect GatewayD’s Support for Multiple Proxies and Configuration Blocks #61

Conversation

sinadarbouy
Copy link
Collaborator

@sinadarbouy sinadarbouy commented Jul 30, 2024

Ticket

Closes #62

Description

This pull request updates the GatewayD documentation to include new information regarding the support for multiple proxies and configuration blocks. The changes ensure that the documentation accurately reflects recent updates and enhancements in GatewayD’s configuration capabilities. Key updates include:

  • Introduction of Configuration Blocks: Added a new section to the glossary (glossary.md) describing the concept of configuration blocks. These blocks allow for more granular configuration within each configuration group for objects such as clients, pools, and proxies.
  • Updated Configuration Examples: Revised configuration examples in configuration.md, clients.md, pools.md, and proxies.md to demonstrate the use of configuration blocks (e.g., activeWrites) and highlight their application in various configuration objects.
  • Clarified Multi-Proxy Support: Enhanced the documentation in proxies.md to explain the support for multiple proxies, each managing its own pool of connections, and ensuring proper connection handling according to capacity.
  • Added Load Balancer Configuration: Updated servers.md to include new parameters related to load balancer configuration, such as the load balancing strategy.

Copy link

vercel bot commented Jul 30, 2024

@sinadarbouy is attempting to deploy a commit to the GatewayD Labs Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Jul 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 5, 2024 8:24pm

Copy link
Member

@mostafa mostafa left a comment

Choose a reason for hiding this comment

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

LGTM! The environment variables section of the configurations should also be updated to account for configuration blocks.

- Update configuration example to reflect new nested block structure for clients and servers
- Adjust environment variable section to include the new five-part structure
- Update Mermaid diagram to illustrate the five-part environment variable breakdown
@sinadarbouy
Copy link
Collaborator Author

LGTM! The environment variables section of the configurations should also be updated to account for configuration blocks.

hmm added doc related here but did not notice the environment variable for block or nested configurations for GatewayD. It probably needs to be checked and a test case added for the environment variables if it does not already exist. I will take a look at it later.

using-gatewayd/configuration.md Outdated Show resolved Hide resolved
using-gatewayd/configuration.md Outdated Show resolved Hide resolved
sinadarbouy and others added 2 commits August 3, 2024 19:21
Co-authored-by: Mostafa Moradian <[email protected]>
Signed-off-by: sina <[email protected]>
Co-authored-by: Mostafa Moradian <[email protected]>
Signed-off-by: sina <[email protected]>
@mostafa
Copy link
Member

mostafa commented Aug 5, 2024

@sinadarbouy I think the config files and examples should be updated.

@mostafa
Copy link
Member

mostafa commented Aug 22, 2024

@sinadarbouy I think this should be updated with the latest changes.

@mostafa mostafa added the documentation Improvements or additions to documentation label Aug 22, 2024
- Added detailed descriptions for new load balancer configuration options:
  - `consistentHash` settings with `useSourceIp` parameter.
  - Support for `loadBalancingRules` and `distribution` parameters for strategies like `WEIGHTED_ROUND_ROBIN`.
- Expanded possible values for `loadBalancer.strategy` to include `RANDOM` and `WEIGHTED_ROUND_ROBIN`.
- Updated example configuration to reflect the new settings and provide clarity on usage.
@mostafa mostafa merged commit 2dc2557 into gatewayd-io:main Sep 10, 2024
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update env-var structure
2 participants