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

docs: Add QA about exposing gateway as loadbalancer #1907

Merged
merged 3 commits into from
Aug 1, 2023

Conversation

Revolyssup
Copy link
Contributor

Type of change:

Solves #1895

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

What this PR does / why we need it:

This PR adds answer to a commonly asked question by users.

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

Signed-off-by: Ashish Tiwari <ashishjaitiwari15112000@gmail.com>

You will need to get the apisix-gateway service an external IP assigned for it to reflect on the Ingress's status.
1. While installing APISIX helm chart make sure to override gateway type with `--set gateway.type=LoadBalancer`.
2. Also make sure to pass ingressPublishService while installing Ingress controller with `--set ingress-controller.config.ingressPublishService=apisix-gateway`
Copy link
Member

Choose a reason for hiding this comment

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

The format of "service" is ns/service.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Applied suggestion

## Why does my Ingress resource not have an address?

You will need to get the apisix-gateway service an external IP assigned for it to reflect on the Ingress's status.
1. While installing APISIX helm chart make sure to override gateway type with `--set gateway.type=LoadBalancer`.
Copy link
Member

Choose a reason for hiding this comment

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

Setting it as NodePort will also work.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

But in case of NodePort, an external IP will not be allocated to it, right?

Copy link
Member

Choose a reason for hiding this comment

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

yes.

ingress_status_address: [] # when there is no available information on the Service

we can use ingress_status_address

see the comment:

when there is no available information on the Service
used for publishing on the data plane,
the static address provided here will be
used to update the status information of Ingress.
When ingress-publish-service is specified at the same time, ingress-status-address is preferred.
For example, no available LB exists in the bare metal environment.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Applied suggestion

Signed-off-by: revolyssup <ashishjaitiwari15112000@gmail.com>
Signed-off-by: revolyssup <ashishjaitiwari15112000@gmail.com>
@tao12345666333 tao12345666333 added the documentation Improvements or additions to documentation label Jul 31, 2023
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.

4 participants