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.

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

docs: Add QA about exposing gateway as loadbalancer #1907

Merged
merged 3 commits into from
Aug 1, 2023
Merged

docs: Add QA about exposing gateway as loadbalancer #1907

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5ac4e58
docs: Add QA about exposing gateway as loadbalancer
Revolyssup Jul 26, 2023
4c79e9e
Apply suggestions
Revolyssup Jul 31, 2023
ab942ac
fix doc lint
Revolyssup Jul 31, 2023
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
9 changes: 9 additions & 0 deletions docs/en/latest/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,12 @@ You can change the Admin API key in two ways:

1. Modify the key in both [apisix/values.yaml](https://github.com/apache/apisix-helm-chart/blob/57cdbe461765cd49af2195cc6a1976cc55262e9b/charts/apisix/values.yaml#L181) and [apisix/apisix-ingress-controller/values.yaml](https://github.com/apache/apisix-helm-chart/blob/57cdbe461765cd49af2195cc6a1976cc55262e9b/charts/apisix-ingress-controller/values.yaml#L128) files.
2. You can also set this imperatively by passing the flag `--set ingress-controller.config.apisix.adminKey=<new key> --set admin.credentials.admin=<new key>` to the `helm install` command.


## 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.

apisix-ingress-controller/conf/config-default.yaml

Line 44 in e809cfb

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

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


Note: External IP is allocated either by cloud provider or some other controller like metallb(if you're using kind or minikube) so if you're deploying Ingress controller on minikube or kind then make sure to install and configure something like metallb with an address pool which can allocate external IP for service of type LoadBalancer.