Skip to content

Commit 24d0c35

Browse files
authored
added instructions for basic test, to troubleshooting guide (#10873)
1 parent 94a635a commit 24d0c35

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

docs/troubleshooting.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,43 @@ Do not move it without providing redirects.
88

99
# Troubleshooting
1010

11+
## A simple test of the basic ingress controller routing
12+
- Install the ingress-nginx controller as per documentation
13+
- Deploy the httpbun example echoserver application
14+
```console
15+
$ kubectl create deploy httpbun --image registry.k8s.io/ingress-nginx/e2e-test-httpbun:v20231011-8b53cabe0
16+
```
17+
- Create a service of --type ClusterIP for httpbun
18+
```console
19+
$ kubectl expose deploy httpbun --port 80
20+
```
21+
- Create a ingress for httpbun (This command assumes the ingressClass name to be _**nginx**_. Change the ingressClass name below, if you are using a different ingressClass name)
22+
```console
23+
$ kubectl create ingress httpbun --class nginx --rule httpbun.foo.com/"*"=httpbun:80
24+
```
25+
- Get the name of the ingress-nginx-controller pod (This command assumes that the ingress-nginx-controller was installed in the namespace called **_ingress-nginx_**)
26+
```console
27+
$ kubectl -n ingress-nginx get po
28+
```
29+
- Open a terminal to tail the logs of the ingress-nginx-controller pod
30+
```console
31+
$ kubectl -n ingress-nginx logs -f <ingress-nginx-controller-podname>
32+
```
33+
- Note the last line of log messages. Hit the return/enter key a couple of times to get some blank lines. Makes it easier to mark newer log lines from your next step
34+
- Open a second terminal, to send a request to httpbun (replace the external-ip or LB name as needed)
35+
```console
36+
$ curl -v --resolve httpbun.foo.com:80:<external-ip> httpbun.foo.com/get
37+
```
38+
- Check if there were new log messages related to your curl command
39+
- Provide all info and the log messages in the issue you create or in the slack chat thread, formatted as a code-snippet
40+
- kubectl get po,svc -n ingress-nginx
41+
- kubectl get po,svc,ing | grep -i httpbun
42+
- kubectl describe svc httpbun
43+
- kubectl describe ing httpbun
44+
- Entire curl command as is and its output
45+
- log messages of the ingress-nginx-controller pod
46+
47+
1148
## Ingress-Controller Logs and Events
1249

1350
There are many ways to troubleshoot the ingress-controller. The following are basic troubleshooting

0 commit comments

Comments
 (0)