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

Incorrect format for istio gateways in docs #1104

Closed
chlunde opened this issue Feb 8, 2022 · 13 comments · Fixed by #1489
Closed

Incorrect format for istio gateways in docs #1104

chlunde opened this issue Feb 8, 2022 · 13 comments · Fixed by #1489
Labels

Comments

@chlunde
Copy link
Contributor

chlunde commented Feb 8, 2022

Describe the bug

The documentation and some tests uses gw.ns(.svc.cluster.local) for gateways.

I think this is the correct format for istio gateways: <gateway namespace>/<gateway name>

Like here:

- istio-system/istio-ingressgateway

re. https://istio.io/latest/docs/reference/config/networking/virtual-service/#VirtualService

Examples for the alternate syntax:

gateways = append(gateways, "test-gateway.istio-system")

flagger/docs/gitbook/faq.md

Lines 505 to 506 in 9c7db58

gateways:
- public-gateway.istio-system.svc.cluster.local

gateways:
- public-gateway.istio-system.svc.cluster.local

@stefanprodan
Copy link
Member

I think both formats work, the dot separator was deprecated in favor of the /, we should update the docs for the latest Istio.

@Abhishek-569
Copy link

So we have to replace for example public-gateway.istio-system.svc.cluster.local with public-gateway/istio-system.svc.cluster.local everywhere present in docs?

@stefanprodan
Copy link
Member

@Abhishek-569 yes, please open a PR if you have time. Thanks

@Abhishek-569
Copy link

Should I open a single PR for all docs ?

@stefanprodan
Copy link
Member

Yes please

@Abhishek-569
Copy link

Abhishek-569 commented Feb 21, 2023

okay and there should be more docs that needed these changes other than above mentioned. is there any way to find them once or I have to make changes individually?

@stefanprodan
Copy link
Member

Search for gateways in ./docs

@Abhishek-569
Copy link

I have found all changes in docs , Do I need to check pkg and artifacts thoroughly?

@stefanprodan
Copy link
Member

artifacts/examples yes, pkg no, as in there there are only unit tests that set gateways.

@Abhishek-569
Copy link

ok and what about test ?

@stefanprodan
Copy link
Member

Oh yeah test/istio needs changing as we use there Istio for e2e and we should test with the latest supported format.

@Abhishek-569
Copy link

Created PR in #1377 for this issue.

@Abhishek-569
Copy link

I have made the recommended changes. Please have a look into it. Thanks.

sonbui00 added a commit to sonbui00/flagger that referenced this issue Aug 26, 2023
sonbui00 added a commit to sonbui00/flagger that referenced this issue Aug 26, 2023
Signed-off-by: Son Bui <sonbv00@gmail.com>
sonbui00 added a commit to sonbui00/flagger that referenced this issue Aug 28, 2023
Signed-off-by: Son Bui <sonbv00@gmail.com>
S-mishina pushed a commit to S-mishina/flagger that referenced this issue Oct 15, 2023
Signed-off-by: Son Bui <sonbv00@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
3 participants