Skip to content

Add trusted_addresses option to apisix configmap template #909

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.

Sign up for GitHub

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

Merged
Baoyuantop merged 4 commits into from
Nov 26, 2025
Merged

Add trusted_addresses option to apisix configmap template #909

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a3ebe12
Add trusted_addresses option to apisix configmap template
manueljishi Nov 25, 2025
ea43733
Address suggestions from PR
manueljishi Nov 25, 2025
866dbde
Update charts/apisix/values.yaml with comment for docs
manueljishi Nov 25, 2025
261fefa
Update helm docs with trustedAddresses type
manueljishi Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion charts/apisix/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 2.12.3
version: 2.12.4

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
Expand Down
1 change: 1 addition & 0 deletions charts/apisix/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ The command removes all the Kubernetes components associated with the chart and
| apisix.status.ip | string | `"0.0.0.0"` | |
| apisix.status.port | int | `7085` | |
| apisix.stream_plugins | list | `[]` | Customize the list of APISIX stream_plugins to enable. By default, APISIX's [default stream_plugins](https://github.com/apache/apisix/blob/master/apisix/cli/config.lua#L294) are automatically used. |
| apisix.trustedAddresses[0] | string | `"127.0.0.1"` | |
Copy link
Contributor

@dennispan dennispan Nov 25, 2025

Choose a reason for hiding this comment

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

Suggested change
| apisix.trustedAddresses[0] | string | `"127.0.0.1"` | |
| apisix.trustedAddresses | list | `["127.0.0.1"]` | |

Copy link
Contributor Author

@manueljishi manueljishi Nov 25, 2025

Choose a reason for hiding this comment

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

Is this auto generated or manually edited?

Copy link

@ngclinflows ngclinflows Nov 25, 2025

Choose a reason for hiding this comment

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

According to https://github.com/norwoodj/helm-docs, I think it was auto-generated. Adding a comment as I suggested will resolve this.

Documentation quote:

The following rules are used to determine which values will be added to the values table in the README:

  • By default, only leaf nodes, that is, fields of type int, string, float, bool, empty lists, and empty maps are added as rows in the values table. These fields will be added even if they do not have a description comment
  • Lists and maps which contain elements will not be added as rows in the values table unless they have a description comment which refers to them
  • Adding a description comment for a non-empty list or map in this way makes it so that leaf nodes underneath the described field will not be automatically added to the values table. In order to document both a non-empty list/map and a leaf node within that field, description comments must be added for both

Copy link
Contributor Author

@manueljishi manueljishi Nov 25, 2025

Choose a reason for hiding this comment

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

I see, will adapt the changes in a sec

Copy link
Contributor Author

@manueljishi manueljishi Nov 25, 2025

Choose a reason for hiding this comment

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

@ngclinflows as you said, after the comment, the docs show the correct type

| apisix.vault.enabled | bool | `false` | Enable or disable the vault integration |
| apisix.vault.host | string | `""` | The host address where the vault server is running. |
| apisix.vault.prefix | string | `""` | Prefix allows you to better enforcement of policies. |
Expand Down
5 changes: 5 additions & 0 deletions charts/apisix/templates/configmap.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,11 @@ data:
port: {{ default "7085" (.Values.apisix.status.port | toString) }}
{{- end}}

{{ if .Values.apisix.trustedAddresses }}
trusted_addresses:
{{- toYaml .Values.apisix.trustedAddresses | nindent 8 }}
{{ end }}

nginx_config: # config for render the template to genarate nginx.conf
error_log: "{{ .Values.apisix.nginx.logs.errorLog }}"
error_log_level: "{{ .Values.apisix.nginx.logs.errorLogLevel }}" # warn,error
Expand Down
3 changes: 3 additions & 0 deletions charts/apisix/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -585,6 +585,9 @@ apisix:
ip: "0.0.0.0"
port: 7085

trustedAddresses:
- 127.0.0.1

# -- external etcd configuration. If etcd.enabled is false, these configuration will be used.
externalEtcd:
# -- if etcd.enabled is false, use external etcd, support multiple address, if your etcd cluster enables TLS, please use https scheme, e.g. https://127.0.0.1:2379.
Expand Down