Skip to content

Conversation

@casperakos
Copy link

@casperakos casperakos commented Mar 4, 2025

I would like to add support for configuring the PROXY protocol in the APISIX helm chart. Currently, the PROXY protocol configuration exists in the template as commented code, but there's no way to enable or configure it via values.yaml.

Motivation

The PROXY protocol allows load balancers to pass client connection information to APISIX. This is especially useful in Kubernetes environments where APISIX is deployed behind a load balancer, and the original client IP needs to be preserved.

Implementation

  • Added proxy protocol configuration options to values.yaml with default values:

    proxyProtocol:
    enabled: false
    listenHTTPPort: 9181
    listenHTTPSPort: 9182
    enableTCPPP: false
    enableTCPPPToUpstream: false

  • Updated configmap.yaml to conditionally include proxy_protocol configuration when enabled

  • Added schema validation in values.schema.json for the new options

  • Updated README.md with documentation for the new configuration options

These changes allow users to easily enable and configure proxy protocol support through the helm chart values, rather than having to manually modify the configmap.

Fixes #812

@casperakos casperakos changed the title feat: add PROXY protocol support feat: add PROXY protocol support, Fixes #812 Mar 4, 2025
@casperakos casperakos changed the title feat: add PROXY protocol support, Fixes #812 feat: add PROXY protocol support Mar 4, 2025
@muratoreT
Copy link

Sorry to just ping you maintainers but any update on this? We are using the PROXY protocol in multiple APISIX deployments and have to manually overwrite the settings on any update or change of them. We'd really appreciate the merge of this PR. Thanks for your work

@muratoreT
Copy link

@juzhiyuan @guoqqqi Sorry to ping you but this is opened since mar 4, can you please have a look at the pr? thank you in advance ;)

Address review feedback to nest proxyProtocol configuration under the
apisix section for consistency with other APISIX-specific settings.

Updated references in configmap.yaml, values.schema.json, and README.md
to use .Values.apisix.proxyProtocol instead of .Values.proxyProtocol.
@casperakos
Copy link
Author

Hi @AlinsRan, I've addressed your feedback and moved the proxyProtocol configuration under the apisix section. The configuration is now accessible via .Values.apisix.proxyProtocol.enabled and related fields. Please let me know if there's anything else that needs to be changed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature Request: Add Proxy Protocol Configuration Support to APISIX Helm Chart

3 participants