Skip to content

docs: update reference configuration examples #2606

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

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: update reference configuration examples #2606

wants to merge 1 commit into from
+63 −14

Conversation

kayx23
Copy link
Member

@kayx23 kayx23 commented Oct 17, 2025 •
edited
Loading

Type of change:

  • Bugfix
  • New feature provided
  • Improve performance
  • Backport patches
  • Documentation
  • Refactor
  • Chore
  • CI/CD or Tests

What this PR does / why we need it:

In reference, configuration examples:

  1. update annotations
  2. add provider configuration to Gateway Proxy resource, as it is required
  3. correct the service name in publishService

Pre-submission checklist:

  • Did you explain what problem does this PR solve? Or what new features have been added?
  • Have you added corresponding test cases?
  • Have you modified the corresponding document?
  • Is this PR backward compatible? If it is not backward compatible, please discuss on the mailing list first

@kayx23 kayx23 requested review from juzhiyuan and ronething October 17, 2025 02:52
ronething
ronething reviewed Oct 20, 2025
View reviewed changes
docs/en/latest/reference/example.md
scope: Namespace # 6
```

❶ The controller name should be customized if you are running multiple distinct instances of the APISIX Ingress Controller in the same cluster (not a single instance with multiple replicas). Each ingress controller instance must use a unique controllerName in its [configuration file](configuration-file.md), and the corresponding GatewayClass should reference that value.
Copy link
Contributor

Choose a reason for hiding this comment

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

and the corresponding GatewayClass should reference that value.

But the example you provided is IngressClass?

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

Reviewers

@ronething ronething ronething left review comments

@juzhiyuan juzhiyuan juzhiyuan approved these changes

At least 2 approving reviews are required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@kayx23 @juzhiyuan @ronething